Getting Started: Difference between revisions

From devkitPro
Jump to navigation Jump to search
 
(16 intermediate revisions by 2 users not shown)
Line 2: Line 2:
devkitPro currently provide 3 toolchains, devkitARM, devkitPPC and devkitA64 along with a number of support libraries. All of them are managed via pacman.
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)
'''''<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>'''''


On Windows, there's a [https://github.com/devkitPro/installer/releases/latest graphical installer]. On Unix-like platforms such as Linux/macOS/WSL, there's [https://github.com/devkitPro/pacman/releases/latest pacman].
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].


==Windows==
==Windows==


* If you already use msys2 then you can follow the instructions at https://github.com/devkitPro/pacman/releases/latest to add the devkitPro repositories.
* If you already use msys2 then you can follow the instructions at https://devkitpro.org/wiki/devkitPro_pacman to add the devkitPro repositories.


Otherwise
Otherwise
Line 19: Line 19:
** Windows 10 (pre-Anniversary Update): Start -> All Apps -> devkitPro -> MSYS
** Windows 10 (pre-Anniversary Update): Start -> All Apps -> devkitPro -> MSYS
** Windows 10 (post-Anniversary Update): Start -> 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==
==Unix-like platforms==
Note that Linux x86_64 binaries are usable under WSL.


* Follow the instructions to install pacman found at https://github.com/devkitPro/pacman/releases/latest
* run sudo (dkp-)pacman -S switch-dev to install the tools and libraries for switch development
* logout and login again to get the environment settings needed.


==BuildScripts==
* Follow the instructions to install pacman found at https://devkitpro.org/wiki/devkitPro_pacman
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.
* 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.