Skip to content

Update README.md - building instructions for Windows #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
averne merged 2 commits into from
May 17, 2026
Merged

Update README.md - building instructions for Windows #80

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5614b2d
Update README.md - building instructions for Windows
Thundereus May 17, 2026
f157a05
Clean up readme
averne May 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 21 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,27 @@ DISLAIMER: This reads data from your save. I am not responsible for any data los
<p align="center"><img src="https://i.imgur.com/MZjTKoj.jpg" </p>
<p align="center"><img src="https://i.imgur.com/J1Ef38k.jpg" </p>

# Compiling
Building needs a working devkitA64 environment, with packages `libnx`,`deko3d` and `switch-glm` installed (`sudo (dkp-)pacman -S switch-dev`).
```
$ git clone --recursive https://github.com/averne/Turnips.git
$ cd Turnips
$ make -j$(nproc)
```
Output will be located in out/.
# Compiling (Windows and Linux):

Important:
Building needs a working devkitA64 environment, with packages `libnx`, `deko3d` and `switch-glm` installed.

Windows:

1. Download devkitA64/devkitPro (https://github.com/devkitPro/installer). Without overcomplicating it, just install everything included and click through the installer.
2. Start msys2 via the start menu search. Alternatively you can start the .bat file (`C:\devkitPro\msys2\msys2_shell.bat`).
3. Install required libraries: run `pacman -S libnx deko3d switch-glm`, then type "Y" to confirm download/installation.
4. Still in msys2, run `git clone --recursive https://github.com/averne/Turnips.git`, then type `cd Turnips` to switch to the directory the project has been cloned into.
6. Type `make` to compile.
7. The executable should be found in `C:\Users\username\Turnips\out`.

Linux:

1. `sudo (dkp-)pacman -S switch-dev libnx deko3d switch-glm`
2. `git clone --recursive https://github.com/averne/Turnips.git`
3. `cd Turnips`
4. `make -j$(nproc)`
5. Output will be located in out/.

# Credits
- The [NHSE](https://github.com/kwsch/NHSE) project for save decrypting/parsing.
Expand Down