Tutorial
Updated
Switch Homebrew development
Switch Homebrew development
I've seen quite a lot questions about how to get into Homebrew development for the switch recently so I decided to share some information I would have found useful when I started.
This Guide is made on Windows 10. Refer to other resources for the installation process on other operating systems. After the setup is done, pretty much everything will be the same.
First of all, here's all the topics I'm going to cover in this Guide:
This Guide is made on Windows 10. Refer to other resources for the installation process on other operating systems. After the setup is done, pretty much everything will be the same.
First of all, here's all the topics I'm going to cover in this Guide:
- What do I need?
- Setup and Installation
- Tools
- Examples and explanation
- FAQ
What do I need?Setup and InstallationToolsExamples and explanations
First of all you'll need a Nintendo Switch with a way to get into RCM and some way to start up the custom loader (Hekate for example). There are many tutorials out there on how use those.
Next, you'll need the following tools:
- devkitPro : Make sure devkitA64 is selected during installation.
- hb-menu : You need one of the latest commits to properly use nx-link later so you need to compile it from sources for now.
- Atom : A nice and advanced text editor. You can use any other text editor you want but I recommend this one.
- Cmder : An advanced console emulator for Windows. You can use the default Windows cmd but I recommend to switch to better one.
- (Git : Version control tool. I recommend using it to share your progress and to open source your project so the community can benefit from it. It's not necessary though)
- ASM/C/C++ knowledge : I'll try to explain everything as easy as possible but don't try getting into homebrew without any prior C programming experience.
- A lot of patience : We don't have GDB yet so your only way to debug right now is via printf.
Once you're sure you've got everything above you may continue to the next chapter.
After you've installed devkitPro, Atom Cmder and hopefully git AND you're running the latest version of the hb-menu we can start with the setup process.
First of all we need to correct the devkitPro environment variables. By default they get set to the paths used on Linux which won't work on Windows.
To change them, press Win + Pause/Break and click on Advanced system settings in the window that pops up. Now you press on the Environment Variables... button.
Now search in the System variables list for DEVKITARM, DEVKITPPC and DEVKITPRO. Change them to your devkitPro path. Now if it's not already there, add a DEVKITA64 variable and set the path to the devkitA64 folder path.
After you're finished, it should look something like this:
Now find the PATH variable and add the path to the ../devkitPro/tools/bin directory to it.
After this step you're basically done. You don't need any setup for Atom or Cmder. They just work out of the box.
For compilation and deployment we're going to use two things: make and nxlink. Both get installed by default together with devkitPro.
If you use the attached template project, all you'll need to do is to type make. This will take care of the whole compilation part. To deploy your compiled project to the Switch now we use nxlink.
First, enter the hbmenu on your Switch and press the Y Button. This brings you into the nxlink mode. The list of homebrews should disappear now. Now you can run the following command:
nxlink -s -a 192.168.xxx.xxx out\<homebrew_name>.nro
This nxlink command some arguments.
- -s stands for server. It's used for debugging. With this option enabled, printf output can get redirected to our console.
- -a stands for address. It's the IP address of the Switch. You can look it up either in your router settings or in the Switch settings.
- out\<homebrew_name>.nro is the path to your homebrew executable. By default it gets built inside the /out folder.
First of all, download the attached sample homebrew and load it up in Atom.
There are a lot of great examples for many different things inside the /devkitPro/examples/switch folder. Read through those first if you want to start developing. You can also look at the source code of EdiZon, Checkpoint, the hbmenu or any other homebrew to find out how they did certain stuff. We're all a community and learn from each others
. For any other questions consult the official documentation of libnx. You may ask here in this thread as well but I can't promise to be able to help everybody.
So, let's get started with the examples. More examples will come over time.
Button detection & console outputGraphics output
Code:#include <switch.h> #include <stdio.h> int main(int argc, char** argv) { u32 kdown = 0x00000000; u32 kdownOld = 0x00000000; gfxInitDefault(); consoleInit(nullptr); //Init the console while(appletMainLoop()) { hidScanInput(); //Scan for input kdown = hidKeysDown(CONTROLLER_P1_AUTO); //Read the currently pressed buttons and store that value into kdown //Edge detection. We don't want to print "Hello World" while A is pressed. We only want to print it once and then again on the next press if(kdown > kdownOld) { if(kdown & KEY_A) printf("Hello World\n"); //Prints to the console on screen } kdownOld = kdown; gfxFlushBuffers(); //Finish this frame gfxSwapBuffers(); //Display it on the screen gfxWaitForVsync(); //Wait till the last frame finished displaying before updating to avoid flickering } gfxExit(); return 0; }
Code:#include <switch.h> int main(int argc, char** argv) { u8 *framebuffer; u32 framebuffer_width; u32 framebuffer_height; gfxInitDefault(); framebuffer = gfxGetFramebuffer(&framebuffer_width, &framebuffer_height); //Gets the address of the framebuffer so we can draw to it while(appletMainLoop()) { //The framebuffer is layed out in RGBA8 format. We're coloring it entirely in Magenta (0xFF00FFFF) for(u16 x = 0; x < framebuffer_width; x++) { for(u16 y = 0; y < framebuffer_height; y++) { framebuffer[(x + y * framebuffer_width) * 4 + 0] = 0xFF; //Red framebuffer[(x + y * framebuffer_width) * 4 + 1] = 0x00; //Green framebuffer[(x + y * framebuffer_width) * 4 + 2] = 0xFF; //Blue framebuffer[(x + y * framebuffer_width) * 4 + 3] = 0xFF; //Alpha } } gfxFlushBuffers(); //Finish this frame gfxSwapBuffers(); //Display it on the screen gfxWaitForVsync(); //Wait till the last frame finished displaying before updating to avoid flickering } gfxExit(); return 0; }
Last edited by WerWolv,
