Getting Started: Difference between revisions

From devkitPro
Jump to navigation Jump to search
No edit summary
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
For Windows users getting started with devkitPro toolchains is made easy by the convenient [http://sourceforge.net/projects/devkitpro/files/Automated%20Installer/ Windows Installer/Updater] package. It is strongly recommended that windows users stick with this rather than attempting to set up the packages manually. The updater handles all the sticky little details of installation required for properly functioning toolchains. This is a web based installer so please ensure that you have a net connection, your Internet Explorer proxy settings are correct and that any firewall software you have installed allows the application to access the net.
= Setup =
devkitPro currently provide 3 toolchains, devkitARM, devkitPPC and devkitA64 along with a number of support libraries. All of them are managed via pacman.


For those of you who wish to install offline a "Download only" option is provided to download the packages without installing for later installation on another machine. This is best used by running the installer from a removable drive where it will store the downloaded packages. The "Download and install/install from downloaded files" option will pick up the packages from the directory the installer is running from.
'''''<span style="color:red">Please note: devkitPro is the organisation that provides the tools. We are not a software package, we don't have version numbers and the only way to have us compile your code is to pay us (or maybe if you ask nicely when you need help figuring out an issue)<span>'''''


For other platforms there are a few options available. Where possible you should stick to the binary distributions - building from source can be a path of frustration even for seasoned developers. The following pages cover each toolchain in detail.
On Windows, there's a [https://github.com/devkitPro/installer/releases/latest graphical installer]. On Unix-like platforms such as Linux/macOS, there's [https://devkitpro.org/wiki/devkitPro_pacman devkitPro pacman].


[[Getting_Started/devkitARM | Manual instructions for installing devkitARM]]
==Windows==


[[Getting_Started/devkitPPC | Manual instructions for installing devkitPPC]]
* If you already use msys2 then you can follow the instructions at https://devkitpro.org/wiki/devkitPro_pacman to add the devkitPro repositories.


[[Getting_Started/devkitPSP | Manual instructions for installing devkitPSP]]
Otherwise


Where a binary is not provided then you should use the most recent stable release of the [http://sourceforge.net/projects/devkitpro/files/buildscripts/ buildscripts]. SVN should be avoided since the buildscripts found there will often contain the next iteration of a given toolchain rather than the current stable release and may only be usable by our developers. Using these scripts is a simple matter of extracting the archive, running ./build-devkit.sh from a bash shell and following the prompts. The scripts will also build and install the current support libraries from the release tarballs.
* [https://github.com/devkitPro/installer/releases download the latest version of the graphical installer] from github and run it, following the instructions as you go.
* An Internet connection is required.
* Once the installer has finished, launch MSYS from:
** Windows 7 and earlier: Start -> All Programs -> devkitPro -> MSYS
** Windows 8 and 8.1: Right click on the Start screen and select 'All Apps'. You should find MSYS there.
** Windows 10 (pre-Anniversary Update): Start -> All Apps -> devkitPro -> MSYS
** Windows 10 (post-Anniversary Update): Start -> devkitPro -> MSYS
 
==macOS==
* To get the Xcode command line tools run `xcode-select --install` from Terminal.
* Use the [https://github.com/devkitPro/pacman/releases/latest pkg installer] to install [https://devkitpro.org/wiki/devkitPro_pacman devkitPro pacman].
* Reboot your mac to get environment set.
* Use dkp-pacman to install your chosen tools as per Unix like platforms below.
 
==Unix-like platforms==
 
 
* Follow the instructions to install pacman found at https://devkitpro.org/wiki/devkitPro_pacman
* run sudo (dkp-)pacman -S <console>-dev to install the tools and libraries for each console you wish to develop for. Groups currently available are :-
** gba-dev
** gp32-dev
** nds-dev
** 3ds-dev
** gamecube-dev
** wii-dev
** wiiu-dev
** switch-dev
* If you're using a bash shell logout and login again to get the environment settings needed, otherwise check /etc/profile.d/devkit-env.sh and set the variables for your chosen shell.
 
==buildscripts==
Where possible you should stick to the binary distributions - building from source can be a path of frustration even for seasoned developers. Where a binary is not provided then you should use the most recent stable release of the https://github.com/devkitPro/buildscripts/releases/latest buildscripts]. The buildscripts in the git repositories should be avoided since the buildscripts found there will often contain the next iteration of a given toolchain rather than the current stable release and may only be usable by our developers. Using these scripts is a simple matter of extracting the archive, running ./build-devkit.sh from a bash shell and following the prompts. The scripts will also build and install the current support libraries from the release tarballs. The readme supplied with the buildscripts details some dependencies which need to be in place before starting a build. Please do not distribute the binaries you obtain that way or recommend that people do this instead of using pacman.

Latest revision as of 22:58, 2 July 2020

Setup

devkitPro currently provide 3 toolchains, devkitARM, devkitPPC and devkitA64 along with a number of support libraries. All of them are managed via pacman.

Please note: devkitPro is the organisation that provides the tools. We are not a software package, we don't have version numbers and the only way to have us compile your code is to pay us (or maybe if you ask nicely when you need help figuring out an issue)

On Windows, there's a graphical installer. On Unix-like platforms such as Linux/macOS, there's devkitPro pacman.

Windows

Otherwise

  • download the latest version of the graphical installer from github and run it, following the instructions as you go.
  • An Internet connection is required.
  • Once the installer has finished, launch MSYS from:
    • Windows 7 and earlier: Start -> All Programs -> devkitPro -> MSYS
    • Windows 8 and 8.1: Right click on the Start screen and select 'All Apps'. You should find MSYS there.
    • Windows 10 (pre-Anniversary Update): Start -> All Apps -> devkitPro -> MSYS
    • Windows 10 (post-Anniversary Update): Start -> devkitPro -> MSYS

macOS

  • To get the Xcode command line tools run `xcode-select --install` from Terminal.
  • Use the pkg installer to install devkitPro pacman.
  • Reboot your mac to get environment set.
  • Use dkp-pacman to install your chosen tools as per Unix like platforms below.

Unix-like platforms

  • Follow the instructions to install pacman found at https://devkitpro.org/wiki/devkitPro_pacman
  • run sudo (dkp-)pacman -S <console>-dev to install the tools and libraries for each console you wish to develop for. Groups currently available are :-
    • gba-dev
    • gp32-dev
    • nds-dev
    • 3ds-dev
    • gamecube-dev
    • wii-dev
    • wiiu-dev
    • switch-dev
  • If you're using a bash shell logout and login again to get the environment settings needed, otherwise check /etc/profile.d/devkit-env.sh and set the variables for your chosen shell.

buildscripts

Where possible you should stick to the binary distributions - building from source can be a path of frustration even for seasoned developers. Where a binary is not provided then you should use the most recent stable release of the https://github.com/devkitPro/buildscripts/releases/latest buildscripts]. The buildscripts in the git repositories should be avoided since the buildscripts found there will often contain the next iteration of a given toolchain rather than the current stable release and may only be usable by our developers. Using these scripts is a simple matter of extracting the archive, running ./build-devkit.sh from a bash shell and following the prompts. The scripts will also build and install the current support libraries from the release tarballs. The readme supplied with the buildscripts details some dependencies which need to be in place before starting a build. Please do not distribute the binaries you obtain that way or recommend that people do this instead of using pacman.