Building Atmosphère on Windows using MSYS2

Sometimes you need to build the binaries for Atmosphère, or you want to change something on the source code, for building your starting point should be: https://github.com/Atmosphere-NX/Atmosphere/blob/master/docs/building.md
On that document you can read:
Building Atmosphère is a very straightforward process that relies almost exclusively on tools provided by the devkitPro organization.​
Dependencies:
  • devkitA64
  • devkitARM
  • Python 2 (Python 3 may work as well, but this is not guaranteed)
  • LZ4
  • PyCryptodome (optional)
  • Hactool
Setup a DevKitPro environment: (https://devkitpro.org/wiki/Getting_Started)
Install the following packages via (dkp-)pacman:​
  • switch-dev
  • switch-glm
  • switch-libjpeg-turbo
  • devkitARM
  • devkitarm-rules
  • hactool
Install the following library via python's package manager pip, required by exosphere:​
  • lz4
Finally, clone the Atmosphère repository and run make under its root directory.​

That instructions are a little plain for we the noobs.

First you need Install a MSYS environment:
The latest instructions for install the MSYS environment are on https://gbatemp.net/threads/install-msys-environment.652234/ if you don't have one working, use them.

After you have the MSYS environment working you need to install DevKitPro
For that you can follow the instructions on the tutorial https://gbatemp.net/threads/setup-a-devkitpro-environment-on-windows.652238/

Now you can install DevKitPro packages:

You Need base DevKitPro packages:
Bash:
pacman -S --noconfirm switch-dev devkitA64 dkp-toolchain-vars libnx switch-tools switch-mesa switch-libdrm_nouveau switch-sdl2

And the Atmosphère prerequisites
Bash:
Pacman -Sy --noconfirm devkitA64 devkitARM devkitarm-rules hactool mingw-w64-x86_64-python mingw-w64-x86_64-python-lz4 mingw-w64-x86_64-python-pycryptodome switch-dev switch-glm switch-libjpeg-turbo mingw-w64-x86_64-python-pip

I had to add zip package because even if wasn't explicit indicated on the build page, the code needs it.

You also will need the packages git make lz4 for all to work, use the command:

Bash:
Pacman -Sy --noconfirm zip git make lz4


All packages on a combined command:​

Bash:
pacman -S --noconfirm switch-dev devkitA64 dkp-toolchain-vars libnx switch-tools switch-mesa switch-libdrm_nouveau switch-sdl2 devkitA64 devkitARM devkitarm-rules hactool mingw-w64-x86_64-python mingw-w64-x86_64-python-lz4 mingw-w64-x86_64-python-pycryptodome switch-dev switch-glm switch-libjpeg-turbo mingw-w64-x86_64-python-pip zip git make lz4


The package hactool need you to copy your own prod.keys file on $HOME/.switch folder. (c:\msys64\home\USERNAME\.switch if you use the default installation folder)


LibNX Dependency
Atmosphère depends heavily on LibNX, generally when a major version of firmware is released or great changes on the code are made, changes to LibNX are also made.
The Atmosphère team works on their own repo of LibNX (https://github.com/Atmosphere-NX/libnx) and forward Pull Request to official SwitchBrew LibNX repo (https://github.com/switchbrew/libnx).


So ONLY if there are changes on LibNX repository, no yet committed to DevKitPro release, you need to build it and install on your setup.
If you haven't done already, setup the environment variables
You can test it running the command
export
You should have this:
Bash:
export DEVKITPRO=/opt/devkitpro
export DEVKITARM=${DEVKITPRO}/devkitARM
export DEVKITPPC=${DEVKITPRO}/devkitPPC
export PATH=${DEVKITPRO}/tools/bin:$PATH


Then go to the Atmosphere-NX/LibNX repo and look what is the new branch for the current firmware, by example, for Firmware 16.0.0 the branch name is "1600_Support"

1677718224337.png

Then go to your MSYS MinGW64 window and clone the Atmosphere-NX/LibNX repo

Bash:
cd ~
git clone --recursive https://github.com/Atmosphere-NX/libnx.git
cd libnx

And checkout the needed branch:

Bash:
git checkout 1600_support

Then build and install the new LibNX libraries

Bash:
make install -j$(nproc)

Now you can build Atmosphère with latest LibNX code; remember if you update the pacman LibNX package the changes get reversed and you need to build LibNX again.

Now is time to build the binaries
Clone the repository:
Bash:
cd ~
git clone --recursive https://github.com/Atmosphere-NX/Atmosphere

Go to new created Atmosphère folder
Bash:
cd Atmosphere

Be sure you have defined the environment variables for DevKitPro
You can test it running the command
export
You should have this:
Bash:
export DEVKITPRO=/opt/devkitpro
export DEVKITARM=${DEVKITPRO}/devkitARM
export DEVKITPPC=${DEVKITPRO}/devkitPPC
export PATH=${DEVKITPRO}/tools/bin:$PATH


COPY YOUR PROD.KEYS FILE TO THE .SWITCH FOLDER:

Copy prod.keys file on $HOME/.switch
Bash:
mkdir ~/.switch
cp "c:\YOUR\CURRENT\PATH\TO\KEYS\PROD.KEYS" ~/.switch/prod.keys

In the case of MSYS for using localhost paths you must use "" by example in my case I use the commands:
Bash:
mkdir ~/.switch
cp "z:\Emulation\NSwitch\keys\switch\prod.keys" ~/.switch/prod.keys

Obviously you also can copy the file manually on windows to the equivalent path to ~/.switch/ which by default is c:\msys\home\USERNAME\.switch Where c:\msys is the installation folder and USERNAME is the current name for the user.


Atmosphère is a Python 2 project, even when python 2 has been deprecated by almost 5 years now. some * insist on never update it so as far as that is going, you need to change some files in order to work on python 3, on the files:
  • Atmosphere\fusee\program\update_mtc_tables.py
  • Atmosphere\fusee\program\update_sdram_params.py
The function XRANGE must to be changed to RANGE, edit the files and change xrange( to range( save the files and continue.

And now you are ready to start the building process:
Bash:
make -j$(nproc)

I do use the "-j$(nproc)" parameter to "bleed" all the available CPU to run the compiler, without that the whole process could take up to 1 hour.

Also Note:, if you use make -j is possible a Error 2 can be generated, run make again without parameters. The process will continue where failed, since the two latest versions of DevKitPro using the -j parameters is not synced and the make process can fail by timeouts.


I want to thank a lot to @binkinator and @godreborn for all the help and inspiration to make this guide, and want to ask you for help improving this guide.

Also special thanks to @godreborn for been a support of the users replies and suggestions to the OP.

Remember, as you are getting a new set of binaries, you need new set of sigpatches if you use it. So the great tool from @mrdude comes in hand, the latest release can be downloaded from: https://github.com/mrdude2478/IPS_Patch_Creator/releases/; you use the program to generate a new set of patches for your recently build package3 file.


Latest IPS Patch Creator:
https://gbatemp.net/download/ips-patch-creator-1-5-9.38850/




-Edited: add sigpatches step and clean up a little-
-Edit 2, add LibNX build-
 

Attachments

  • 1695782853186.png
    1695782853186.png
    62.7 KB · Views: 217
  • 1695782902542.png
    1695782902542.png
    6.4 KB · Views: 206
  • Sigpatch-IPS-Creator_1.5.7_Yandex.png
    Sigpatch-IPS-Creator_1.5.7_Yandex.png
    3.3 KB · Views: 136
Last edited by impeeza,
yeah, I'm on windows 11 as well. I tested building it. after installing the libnx, I had no issues with the latest atmosphere. btw, do not run the commands on the first page again unless you reinstall libnx from github, because it will overwrite the github libnx and error again during either stratosphere or mesosphere building iirc.
Noted, I gave it a go just out of curiosity more than anything, but it would be fun one day to give it a full days attention to tweak every part just so i could get the switch too boot quicker, but think that would be like trying to run before you can walk haha
 
For building Atmosphère on UBUNTU, I had to run this commands:

DevKitPro Installation
Bash:
sudo apt install wget
wget https://apt.devkitpro.org/install-devkitpro-pacman
chmod +x ./install-devkitpro-pacman
sudo ./install-devkitpro-pacman


Base packages
Bash:
sudo apt install lz4 zip git make gcc python3 python-is-python3 python3-pip
sudo pip install pycryptodome lz4
sudo dkp-pacman -Sy --noconfirm --needed libnx devkitA64 devkitARM devkitarm-rules hactool switch-dev dkp-toolchain-vars switch-tools switch-mesa switch-libdrm_nouveau switch-sdl2 switch-libjpeg-turbo switch-glm
sudo dkp-pacman -Syuu --noconfirm

You need to copy prod.keys file on $HOME/.switch

Building
Bash:
export DEVKITPRO=/opt/devkitpro
export DEVKITARM=${DEVKITPRO}/devkitARM
export DEVKITPPC=${DEVKITPRO}/devkitPPC
export PATH=${DEVKITPRO}/tools/bin:$PATH
git clone --recursive https://github.com/Atmosphere-NX/Atmosphere
cd Atmosphere
make -j$(nproc)
 
For building Atmosphère on UBUNTU, I had to run this commands:

DevKitPro Installation
Bash:
sudo apt install wget
wget https://apt.devkitpro.org/install-devkitpro-pacman
chmod +x ./install-devkitpro-pacman
sudo ./install-devkitpro-pacman


Base packages
Bash:
sudo apt install lz4 zip git make gcc python3 python-is-python3 python3-pip
sudo pip install pycryptodome lz4
sudo dkp-pacman -Sy --noconfirm --needed libnx devkitA64 devkitARM devkitarm-rules hactool switch-dev dkp-toolchain-vars switch-tools switch-mesa switch-libdrm_nouveau switch-sdl2 switch-libjpeg-turbo switch-glm
sudo dkp-pacman -Syuu --noconfirm

You need to copy prod.keys file on $HOME/.switch

Building
Bash:
export DEVKITPRO=/opt/devkitpro
export DEVKITARM=${DEVKITPRO}/devkitARM
export DEVKITPPC=${DEVKITPRO}/devkitPPC
export PATH=${DEVKITPRO}/tools/bin:$PATH
git clone --recursive https://github.com/Atmosphere-NX/Atmosphere
cd Atmosphere
make -j$(nproc)
I would put the export portion in the .bashrc, so you don't have to do it each time you open the terminal.
 
problem. I could no longer get this to build in msys. I could do so in cmd prompt and linux but not msys. I figured out the problem. I needed to do pip install lz4 too.
 
you need to compile and install the official master branch:

Bash:
git clone --recursive https://github.com/switchbrew/libnx.git
cd libnx
make all -j$(nproc)
make install -j$(nproc)

has been updated with all commits up to 2 days ago.
Post automatically merged:

@impeeza The 16_Support branch is no longer available.
Yes was commited on the main branch, I am trying to build the latest commit of Atmosphère, will let you to know.
Post automatically merged:

Just finished to build the latest Atmosphère commit (476d658) just build and install the latest LIBNX commit (c09a21d) before start the process.
 
Last edited by impeeza,
friends I'm new to this
When I am installing the dependencies at this point I get these errors, how would I solve it?


Pacman -Sy --noconfirm devkitA64 devkitARM devkitarm-rules hactool mingw-w64-x86_64-python mingw-w64-x86_64-python-lz4 mingw-w64-x86_64-python-pycryptodome switch-dev switch-glm switch-libjpeg-turbo mingw-w64-x86_64-python-pip

For me I had to add zip package because even if wasn't explicit indicated on the build page, the code needs it.
 

Attachments

  • IMG_20230926_212711.jpg
    IMG_20230926_212711.jpg
    2.7 MB · Views: 56
I just want to leave a quick thank you here... since last night, deep into the night and since the morning I tried to compile Atmosphere to be able to change the boot splash (boot_splash_screen_notex.inc) and despaired !!!! Then I found this wonderful tutorial and suddenly everything went so fast 🤍
 
  • Love
Reactions: impeeza
I just want to leave a quick thank you here... since last night, deep into the night and since the morning I tried to compile Atmosphere to be able to change the boot splash (boot_splash_screen_notex.inc) and despaired !!!! Then I found this wonderful tutorial and suddenly everything went so fast 🤍
I am very glad this tutorial helped you, thanks for the kind message.
 
  • Like
Reactions: s1m0n
All your posts here on gbatemp regarding boot-/splashscreen helped me a lot.
But the correct installation of devkitPro I am desperate 😂... tried Windows 11. Windows + WSL, Parrot (Debian based), installed Python, Pip and lz4 in Msys...all exactly according to GitHub instructions and still every time an error occurred when linking the kernel.... each time waiting an hour 😂. Then once followed your instructions here and suddenly the compilation process was finished after 10min 👍

Thanks also to the creators of "nintendomo" and "nintendont".... i can't remember where exactly i found them, but they fit perfectly. Maybe later I will change Nintendo Switch and Nintendont Switch. A GIF would also be a great thing💭
Too bad it wasn't my Switch (it's for a family friend) and I have to give it back to him. 😁
 

Attachments

  • lv_0_20231009162958.mp4
    21 MB
  • Love
Reactions: impeeza
All your posts here on gbatemp regarding boot-/splashscreen helped me a lot.
But the correct installation of devkitPro I am desperate 😂... tried Windows 11. Windows + WSL, Parrot (Debian based), installed Python, Pip and lz4 in Msys...all exactly according to GitHub instructions and still every time an error occurred when linking the kernel.... each time waiting an hour 😂. Then once followed your instructions here and suddenly the compilation process was finished after 10min 👍

Thanks also to the creators of "nintendomo" and "nintendont".... i can't remember where exactly i found them, but they fit perfectly. Maybe later I will change Nintendo Switch and Nintendont Switch. A GIF would also be a great thing💭
Too bad it wasn't my Switch (it's for a family friend) and I have to give it back to him. 😁
Yeah, the DevKitPro instructions are somehow no noob proof, but I am glad this instructions worked for you.
Post automatically merged:

All your posts here on gbatemp regarding boot-/splashscreen helped me a lot.
But the correct installation of devkitPro I am desperate 😂... tried Windows 11. Windows + WSL, Parrot (Debian based), installed Python, Pip and lz4 in Msys...all exactly according to GitHub instructions and still every time an error occurred when linking the kernel.... each time waiting an hour 😂. Then once followed your instructions here and suddenly the compilation process was finished after 10min 👍

Thanks also to the creators of "nintendomo" and "nintendont".... i can't remember where exactly i found them, but they fit perfectly. Maybe later I will change Nintendo Switch and Nintendont Switch. A GIF would also be a great thing💭
Too bad it wasn't my Switch (it's for a family friend) and I have to give it back to him. 😁
I don't have NintendoMO splash but I do have the NintendoNT bootlogo.:

there are a lot of bootlogos on the thread https://gbatemp.net/threads/custom-boot-logo-for-switch.569031/
 

Attachments

Last edited by impeeza,
  • Love
Reactions: s1m0n
So far, compiling Atmosphere via Msys2 has worked wonderfully. However, since today (I have read the prod.keys from FW 17.0.0 and replaced them in the msys64/home/ml/.switch/ folder) I have been getting these error messages regarding the keys when compiling (see attachment). Now the question to the professionals here: What is the reason for this? Thank you for any feedback.
 

Attachments

Keys are ok.


You need the 1700_support libnx from atmosphere's repo

Code:
git clone --recursive https://github.com/Atmosphere-NX/libnx/

cd libnx

git checkout 1700_support
make install
 
  • Love
  • Like
Reactions: Muxi and impeeza
I haven't try to build latest Atmosphère commit but as far I see you need to update LIBNX manually.


Bash:
git clone --recursive https://github.com/Atmosphere-NX/libnx
cd ~/libnx
git checkout 1700_support
make all -j$(nproc)
make install -j$(nproc)

sorry for the typo, corrected.
 
Last edited by impeeza,
  • Like
Reactions: Muxi and josete2k

Site & Scene News

Popular threads in this forum