Discord: https://discord.gg/tRTRXXbyjp (my god why don't we just use IRC like good people?)
A GPLv3 static ARM64 to x86 recompiler with a Switch, GBA and GNU/Linux ABI translation layer for Solaris, Linux, Windows, FreeBSD and Android.
A game from your own dump is recompiled ahead of time into a native module for the machine it plays on, and runs on a runtime that answers the console's system calls and services and draws with Vulkan. Experimental drivers run 3DS games, DS games and PS Vita homebrew the same way, and Game Boy Advance ROMs on an emulated AGB board still under construction.
The newest build of main for Linux (AppImage), Windows and Android is in
scarletnx/nightly; Install lists each
download. Games need a Vulkan 1.3 driver, and keys and games must be dumped from your own console.
Started with no arguments, ScarletNX opens its launcher: Install Keys installs your prod.keys for
Switch and your aes_keys.txt for the encrypted 3DS games, to ~/.switch and ~/.3ds (%USERPROFILE% on Windows),
and your DS's ARM7 BIOS for the DS images whose secure area is still encrypted, to the data folder,
and Load Switch NSP/XCI/NRO picks a dump, recompiles it and starts the game. The command line does the same with
scarletnx "Game.xci" (Usage). To build it yourself, see Build.
- Install: the downloads for each system, keys, and the first start
- GUI launcher: the menu, its settings, themes and languages
- Usage: extract, recompile and play from the command line, with updates, mods, cheats, folders and users
- Settings: every key of a game's
.iniand of the launcher, with its default - Testing and reporting: how to test a build, and the form a report takes
- Build: prerequisites and builds on Linux, FreeBSD, macOS and Windows
- Development: checks, diagnostics and profiling; Contributing
- Architecture and the recompiler as a library
- Hosts: the Android app, macOS and iOS, PowerPC64, RISC-V and LoongArch, MIPS64, s390x, NetBSD
- Other systems: 3DS, PS Vita, Game Boy Advance, DS, Linux AArch64 programs, Android apps (Load Android APK/XAPK)
- Every document, by audience, platform and layer
ScarletNX is GPL-3.0-or-later. Code ported from other projects keeps its own license and copyright lines: Licenses and credits lists each, and the projects ScarletNX thanks.