Setting up Development Environment
- Install devkitARM. If it's already installed, update it.
- Depending on the kind of homebrew you want to develop, you may be interested in installing and using additional libraries and tools which don't ship alongside devkitARM/libctru. A list of them can be found in Homebrew Libraries and Tools.
devkitPro provides Win32-native precompiled versions of devkitARM which can be run directly on Windows.
- download the latest version of the graphical installer from SourceForge and run it, following the instructions as you go.
- An Internet connection is required.
- You will want to make sure devkitARM is selected during the installation process to develop for the 3DS (and also the DS and GBA) - you can also install devkitPPC (for GameCube/Wii development) and devkitPSP (for PlayStation Portable development) if you wish.
- 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
Alternatively starting with Windows 10 Anniversary Update (Version 1607), the Windows Subsystem for Linux (WSL) may also be used to run the Linux version of devkitARM. Unless you have some particular need for WSL it's recommended that you stick to a more standard environment.
Currently devkitPro provides precompiled versions of devkitARM for the following Unix-like platforms: Linux (x86/x64), macOS (universal binary). Note that Linux x64 binaries are usable under WSL.
- First, you need to install curl so the installer can download the devkitARM packages, and you should also install Git - you'll need it to update libctru or share your code on GitHub, among many other things.
- Find your way into a shell (eg. by opening a Terminal window), and follow the instructions for your OS:
- Debian/Ubuntu/Linux Mint/WSL:
sudo apt-get install git curl
sudo yum install git curl
sudo zypper install git curl
- macOS: Download Git from  and install it. Curl is included with the OS.
- Debian/Ubuntu/Linux Mint/WSL:
- Next, we need to download, make executable and run the devkitARM updater (don't worry, the updater is also the installer.)
curl -L https://raw.githubusercontent.com/devkitPro/installer/master/perl/devkitARMupdate.pl -o devkitARMupdate.pl chmod +x ./devkitARMupdate.pl sudo ./devkitARMupdate.pl /opt/devkitpro
- Finally, we need to tell your shell where to find the devkitARM binaries.
echo "export DEVKITPRO=/opt/devkitpro" >> ~/.bashrc echo "export DEVKITARM=/opt/devkitpro/devkitARM" >> ~/.bashrc echo "export PATH=$PATH:/opt/devkitpro/devkitARM/bin" >> ~/.bashrc source ~/.bashrc
Building the examples
3DS examples are still being created; however, there are a growing number of examples available from the devkitPro/3ds-examples GitHub repository. There are now too many to list here in detail, so go ahead and browse them.
- To download these, if you installed Git (as you will have if you followed the above instructions), simply type
git clone https://github.com/devkitPro/3ds-examples.gitinto your shell in the directory you wish to store the 3ds-examples folder in.
These can be built from the command line.
To start a new homebrew project from the
bash shell, simply type the following (replacing
~/projects/my3dsproject with the place you would like your project to be stored, with
~ meaning your HOME directory):
cp -r $DEVKITPRO/examples/3ds/templates/application ~/projects/my3dsproject cd ~/projects/my3dsproject
The standard Makefile will use the folder as the name of the 3dsx that will be built. You can keep that behaviour or simply change the
TARGET := $(notdir $(CURDIR)) line in the Makefile to explicitly name your project.
To compile it, type
make in the project directory.
To run it on your 3DS, start the Homebrew Launcher, press Y to open the network loader, then on your PC type:
$DEVKITARM/bin/3dslink my3dsproject.3dsx, replacing my3dsproject with the name of the 3dsx file you want to run.)
If all goes well, you'll soon see your application running on your 3DS.
Building the examples on Linux with Netbeans
- Go to File->New Project...
- Select C/C++ Project with existing code
- Navigate to the examples directory and select the folder for the project you want to build; eg. /home/vtsingaras/3ds/examples/app_launch
- Leave Configuration Mode to 'Automatic' and click 'Finish'.
- It will fail to build. Now edit Makefile and insert these two lines, adjusting for your devkitpro path, at the top:
export DEVKITPRO=/opt/devkitpro export DEVKITARM=/opt/devkitpro/devkitARM
- Right-click the project and go to Properties->Code Assistance and click C Compiler.
- In include directories enter
adjusting again for your devkitPro path.
- Do the same for 'C++ Compiler'.
- Go to 'Run' and click 'Clean and Build Project'.
- Now right-click on the project and select Code Assistance->Reparse Project.
Now you can use Netbeans' code completion feature and build your project from the Run menu.
Building homebrew for distribution
To build your homebrew, open a Bash shell as described above, browse to the folder of the homebrew you wish to compile, and run
- This will build a .elf file and a .3dsx file (the homebrew executable itself).
- The Homebrew Launcher can only run homebrew in the 3DSX format.
I get the "Please set DEVKITARM in your environment." error.
Use the following command before installing :
sudo chown $USER /opt/devkitpro/ -R echo "export DEVKITPRO="/opt/devkitpro/" >> ~/.profile echo "export DEVKITARM="/opt/devkitpro/devkitARM/" >> ~/.profile source ~/.profile
For WSL users, you need to close the Bash shell, then reopen it for WSL to reload all of the variables from a clean state.