13 KiB
How To Compile SDFiles for Hekate
The Automated Way™
Use this!
The Manual Way
This guide could be pretty outdated, I would honestly recommend just using the automated 'LaunchpadNX' way
Subject | Topic |
---|---|
Preparations | Dependencies |
. | Updating Dependencies |
. | Installing/Updating LibNX |
Atmosphere | Atmosphere with Patches |
. | Atmopshere without Patches ("Complete Atmosphere") |
Homebrew and Module | General |
. | Homebrew Loader |
. | Creport |
Extra | Bootlogos |
Dependencies
- Install DevkitPro with Switch support
- Install needed packages:
- Linux:
sudo dkp-pacman -S devkitA64 switch-tools switch-curl switch-bzip2 switch-freetype switch-libjpeg-turbo switch-sdl2 switch-sdl2_gfx switch-sdl2_image switch-sdl2_ttf switch-zlib switch-libpng
- Windows
pacman -S devkitA64 switch-tools switch-curl switch-bzip2 switch-freetype switch-libjpeg-turbo switch-sdl2 switch-sdl2_gfx switch-sdl2_image switch-sdl2_ttf switch-zlib switch-libpng
- You may have to run this command through Msys2 if it doesn't work
- Linux:
- A clean clone of the compiler repo - This repo holds all submodules mentioned in this guide!
- For that simply
git clone https://github.com/tumGER/SDFilesCompiler.git
to your desired location- There are some weird issues on Windows if you have spaces somewhere in the path to your location so make sure to clone it somewhere where the Path doesn't include spaces
- For that simply
- LibNX
- The Hekate/ and "Resources" folder from https://github.com/tumGER/SDFilesSwitch
- Simply
git clone https://github.com/tumGER/SDFilesSwitch.git
to your desired location- We have to use the Hekate/ folder as some homebrew uses data that is otherwise not found when compiling it yourself
- Simply
Updating Dependencies
- Open your console in the root of the repo you just cloned
- Type
git submodule update --remote --force
to update the submodules - Success, the submodules should now be updated to the latest commit of their origin
LibNX
Make sure to Update Dependencies before updating LibNX
- Go into the LibNX submodule folder
- Type
make
- Wait till it finished compiling
- Type
make install
Atmosphere
Updating Atmosphere's Loader, SM and LayeredFS with Patches
Atmosphere sometimes even uses features that aren't even in LibNX yet, in that case follow the previous steps but use the Atmosphere LibNX fork by typing git clone https://github.com/Atmosphere-NX/libnx.git -b for-atmosphere
into your desired location
Make sure to Update Dependencies before compiling Atmosphere
Make sure to Update LibNX before compiling Atmosphere
Atmosphere needs some custom changes to it to work with current hekate and also to compile. While we don't need to compile Atmosphere completely, we will in this tutorial because it's easier and breaks much less (in my experience)
A. Use the patch
- Copy the atmosphere.patch from "Resources\Patches"
- cd into the Atmosphere submodule
- Paste the script onto the root of that folder
- Type
patch -p1 < atmosphere.patch
B. Do it manually
-
Go into "Atmosphere\stratosphere\loader\source" and find "ldr_main.cpp"
-
Remove
cpp /* Check for exosphere API compatibility. */ u64 exosphere_cfg; if (R_FAILED(splGetConfig((SplConfigItem)65000, &exosphere_cfg))) { //fatalSimple(0xCAFE << 4 | 0xFF); /* TODO: Does Loader need to know about target firmware/master key revision? If so, extract from exosphere_cfg. */ }
- This removes the Exosphere API Check from the Loader
-
In the same directory, find "ldr_npdm.cpp"
-
Find this function:
cpp
FILE *NpdmUtils::OpenNpdm(u64 title_id) {
FILE *f_out = OpenNpdmFromSdCard(title_id);
if (f_out != NULL) {
return f_out;
}
return OpenNpdmFromExeFS();
}
and replace it by this one:
cpp
FILE *NpdmUtils::OpenNpdm(u64 title_id) {
if (title_id == 0x010000000000100D) {
Result rc;
rc = hidInitialize();
if (R_FAILED(rc)){
fatalSimple(MAKERESULT(Module_Libnx, LibnxError_InitFail_HID));
}
hidScanInput();
u64 kDown = hidKeysDown(CONTROLLER_P1_AUTO);
if((kDown & KEY_R) == 0) {
hidExit();
FILE *f_out = OpenNpdmFromSdCard(title_id);
if (f_out != NULL) {
return f_out;
}
return OpenNpdmFromExeFS();
}
else {
hidExit();
return OpenNpdmFromExeFS();
}
}
else {
FILE *f_out = OpenNpdmFromSdCard(title_id);
if (f_out != NULL) {
return f_out;
}
return OpenNpdmFromExeFS();
}
}
- In the same directory, find "ldr_nso.cpp"
- Find this function:
cpp
FILE *NsoUtils::OpenNso(unsigned int index, u64 title_id) {
FILE *f_out = OpenNsoFromSdCard(index, title_id);
if (f_out != NULL) {
return f_out;
} else if (CheckNsoStubbed(index, title_id)) {
return NULL;
} else {
return OpenNsoFromExeFS(index);
}
}
and replace it by this one:
cpp
FILE *NsoUtils::OpenNso(unsigned int index, u64 title_id) {
if (title_id == 0x010000000000100D) {
Result rc;
rc = hidInitialize();
if (R_FAILED(rc)){
fatalSimple(MAKERESULT(Module_Libnx, LibnxError_InitFail_HID));
}
hidScanInput();
u64 kDown = hidKeysDown(CONTROLLER_P1_AUTO);
if((kDown & KEY_R) == 0) {
hidExit();
FILE *f_out = OpenNsoFromSdCard(index, title_id);
if (f_out != NULL) {
return f_out;
} else if (CheckNsoStubbed(index, title_id)) {
return NULL;
} else {
return OpenNsoFromExeFS(index);
}
}
else {
hidExit();
return OpenNsoFromExeFS(index); }
}
else {
FILE *f_out = OpenNsoFromSdCard(index, title_id);
if (f_out != NULL) {
return f_out;
} else if (CheckNsoStubbed(index, title_id)) {
return NULL;
} else {
return OpenNsoFromExeFS(index);
}
}
}
- Go into "Atmosphere\stratosphere\fs_mitm\source" and find "fsmitm_main.cpp"
- Remove
cpp
/* Check for exosphere API compatibility. */
u64 exosphere_cfg;
if (R_SUCCEEDED(splGetConfig((SplConfigItem)65000, &exosphere_cfg))) {
/* MitM requires Atmosphere API 0.1. */
u16 api_version = (exosphere_cfg >> 16) & 0xFFFF;
if (api_version < 0x0001) {
fatalSimple(0xCAFE << 4 | 0xFE);
}
} else {
fatalSimple(0xCAFE << 4 | 0xFF);
}
- Go into"Atmosphere\stratosphere\pm\source" and find "pm_main.cpp"
- Remove
/* Check for exosphere API compatibility. */
u64 exosphere_cfg;
if (R_FAILED(splGetConfig((SplConfigItem)65000, &exosphere_cfg))) {
fatalSimple(0xCAFE << 4 | 0xFF);
/* TODO: Does PM need to know about target firmware/master key revision? If so, extract from exosphere_cfg. */
}
- Go back into the root of the Atmosphere submodule
- Type "make"
- Wait a bit, this will take some time
- Copy "loader.kip" from "Atmosphere\stratosphere\loader" into:
- "SDFilesSwitch/Hekate/modules/newfirm/"
- Copy "fs_mitm.kip" from "Atmosphere\stratosphere\fs_mitm" into:
- "SDFilesSwitch/Hekate/modules/newfirm/"
- Copy "sm.kip" from "Atmosphere\stratosphere\sm" into:
- "SDFilesSwitch/Hekate/modules/newfirm/"
- Copy "pm.kip" from "Atmosphere\stratosphere\pm" into:
- "SDFilesSwitch/Hekate/modules/newfirm/"
- Copy the updated files to your SD and test them on your Switch
- If everything worked, congrats! You compiled Atmosphere's patched Loader, SM and LayeredFS :)
- If it didn't, you either messed something up or Atmosphere had some change to its code in the time I wrote this till now - In that case I'd guess contacting me over Twitter (@_tomGER [Or @tumGER since I check that more often]) is your best bet if I'm gone - If you're here because you just wanted to compile it yourself than contact me over tomGER #7462 on Discord.
Updating Atmosphere ("Complete")
Make sure to Update Dependencies before compiling Atmosphere
Make sure to Update LibNX before compiling Atmosphere
Atmosphere sometimes even uses features that aren't even in LibNX yet, in that case follow the previous steps but use the Atmosphere LibNX fork by typing git clone https://github.com/Atmosphere-NX/libnx.git -b for-atmosphere
into your desired location
- Apply steps 4-7 from Updating Atmosphere
- Type make on the root of the Atmosphere submodule
- Copy "sm.kip" from "Atmosphere\stratosphere\sm", "fs_mitm.kip" from "Atmosphere\stratosphere\fs_mitm", "pm.kip" from "Atmosphere\stratosphere\pm", "loader.kip" from "Atmosphere\stratosphere\loader" and "exosphere.bin" from "Atmosphere/exosphere" into "Hekate/modules/atmosphere"
Updating Homebrew and Modules
Make sure to Update Dependencies before compiling submodules
Make sure to Update LibNX before compiling submodules
Here comes the easy part :) Updating all other submodules is really really easy and all follow nearly the same steps:
- Go into each submodule folder
- Type "make"
- You need to type "make nx" for hbmenu
- It should now have compiled it - The location is often pretty easy to find:
- You'll get a .nro for EdiZon, AppstoreNX, SDFilesUpdater and hbmenu
- You'll get a .kip from sys-ftpd
- Replace the old one in the Hekate folder
Some files are called slightly different in the compiled folder - Please rename your newly compiled files in that case!
Submodule | Folder it has to go to |
---|---|
EdiZon | Replace the .nacp and .nro in Hekate/switch/edizon |
AppstoreNX | Replace the .nro in Hekate/switch/appstore |
SDFilesUpdater | Replace the .nro in Hekate/switch/SDFilesUpdater |
hbmenu | Replace the .nro on root |
sys-ftpd | Replace the .kip in Hekate/modules |
Homebrew Loader
- Go into the Homebrew Loader folder (hbl) and type
make
- Copy hbl.nso to "Hekate/atmosphere/titles/010000000000100D/exefs/" and rename it to main (No extension, just main)
- Copy hbl.npdm to "Hekate/atmosphere/titles/010000000000100D/exefs/" and rename it to main.npdm
Creport
- Go into atmosphere/stratosphere/creport
- Type
make
- Copy creport.nso to "Hekate\atmosphere\titles\0100000000000036\exefs" and rename it to main (No extension, just main)
- Copy creport.npdm to "Hekate\atmosphere\titles\0100000000000036\exefs" and rename it to main.npdm
Hekate Bootlogo
- Start your photo editor of choice (I use GIMP because I'm poor and actually kinda like GIMP) A. Open one of the three .xcf files and change the version number to the number of the release you want to make B. Create your own one
- Create a new 720 x 1280 canvas
- Make sure you picture is roated 90° counterclockwise
- Use your graphic design passion
- If you want to update the repo, make sure to include Credits, a link to the Repo, version number and all the other stuff you also see on my splash screens
- Export it as a .png
- Use some online converter to convert the .png to a .bmp
- We need to use a online converter because GIMP currently has some issues with it
- Call it bootlogo.bmp if you want to use it as the standard one
- You can also choose a specific bootlogo for each launch option by writting
logopath=/Link/To/Bootimage.bmp
into your hekate-ipl.ini (Example)
- You can also choose a specific bootlogo for each launch option by writting
- Put it on the root of your SD / root of "SDFilesSwitch/Hekate"