Skip to content

About

A compatibility layer for porting Switch games to Android, one game at a time

Resources

Stars

0 stars

Watchers

0 watching

Forks

 
 

Repository files navigation

nx2android

Port your own Nintendo Switch games to Android, natively: the game's own arm64 code runs on the device, with the Switch's system services stood in for by a host and NVN graphics replayed on Vulkan. Pick the game's folder, click Port, and get an APK plus the game's data, installed on your device if you like. Bring your own game files and keys; nothing from any game is in this repository.

This is the Android port of nxnative, which does the same on iPhone and iPad. Supported games: Games.

Games

These games play on Android. Click a game for its page: its status, the game update and the nx2android version it was tested with, the frame rate, the devices it was tested on, the options to set and its known quirks. The device's GPU must read BC-compressed textures (Adreno, Xclipse; not Mali or PowerVR).

13 Sentinels: Aegis Rim
13 Sentinels: Aegis Rim
13 Sentinels: Aegis Rim (Asia)
13 Sentinels: Aegis Rim (Asia)
Advance Wars 1+2: Re-Boot Camp
Advance Wars 1+2: Re-Boot Camp
Animal Crossing: New Horizons
Animal Crossing: New Horizons
Blasphemous 2
Blasphemous 2
Captain Toad: Treasure Tracker
Captain Toad: Treasure Tracker
Cardfight!! Vanguard Dear Days 2
Cardfight!! Vanguard Dear Days 2
Castlevania: Belmont's Curse
Castlevania: Belmont's Curse
Celeste
Celeste
Dark Souls: Remastered
Dark Souls: Remastered
Disco Elysium - The Final Cut
Disco Elysium - The Final Cut
Divinity: Original Sin 2 - Definitive Edition
Divinity: Original Sin 2 - Definitive Edition
Donkey Kong Country Returns HD
Donkey Kong Country Returns HD
Final Fantasy Resonance
Final Fantasy Resonance
Fire Emblem Engage
Fire Emblem Engage
FM24 Touch
FM24 Touch
Football Manager 26 Touch
Football Manager 26 Touch
Graveyard Keeper 2
Graveyard Keeper 2
Hades II
Hades II
Hollow Knight: Silksong
Hollow Knight: Silksong
Kirby and the Forgotten Land
Kirby and the Forgotten Land
Kirby's Return to Dream Land Deluxe
Kirby's Return to Dream Land Deluxe
Lonely Mountains: Downhill
Lonely Mountains: Downhill
Mario vs. Donkey Kong
Mario vs. Donkey Kong
Mega Man Battle Network Legacy Collection Vol. 1
Mega Man Battle Network Legacy Collection Vol. 1
Mega Man Battle Network Legacy Collection Vol. 2
Mega Man Battle Network Legacy Collection Vol. 2
Metroid Dread
Metroid Dread
NEO: The World Ends with You
NEO: The World Ends with You
OCTOPATH TRAVELER 0
OCTOPATH TRAVELER 0
OCTOPATH TRAVELER 0 (Chinese release)
OCTOPATH TRAVELER 0 (Chinese release)
Paper Mario: The Origami King
Paper Mario: The Origami King
Paper Mario: The Thousand-Year Door
Paper Mario: The Thousand-Year Door
Picross S+
Picross S+
Pokémon Brilliant Diamond
Pokémon Brilliant Diamond
Pokémon Legends: Arceus
Pokémon Legends: Arceus
Pokémon Legends: Z-A
Pokémon Legends: Z-A
Pokémon Mystery Dungeon Rescue Team DX
Pokémon Mystery Dungeon Rescue Team DX
Pokémon Scarlet
Pokémon Scarlet
Pokémon Shield
Pokémon Shield
Pokémon Sword
Pokémon Sword
Rhythm Heaven Groove
Rhythm Heaven Groove
ROMANCE OF THE THREE KINGDOMS XIV
ROMANCE OF THE THREE KINGDOMS XIV
South Park: The Stick of Truth
South Park: The Stick of Truth
Super Mario 3D World + Bowser's Fury
Super Mario 3D World + Bowser's Fury
Super Mario Bros. Wonder
Super Mario Bros. Wonder
Super Mario Odyssey
Super Mario Odyssey
Tales of Eternia Remastered
Tales of Eternia Remastered
The Legend of Zelda: Breath of the Wild
The Legend of Zelda: Breath of the Wild
The Legend of Zelda: Echoes of Wisdom
The Legend of Zelda: Echoes of Wisdom
The Legend of Zelda: Link's Awakening
The Legend of Zelda: Link's Awakening
The Legend of Zelda: Tears of the Kingdom
The Legend of Zelda: Tears of the Kingdom
The World Ends with You -Final Remix-
The World Ends with You -Final Remix-
Tomodachi Life: Living the Dream
Tomodachi Life: Living the Dream
Ultra Kaiju Monster Rancher
Ultra Kaiju Monster Rancher
UNDER NIGHT IN-BIRTH Exe:Late[cl-r]
UNDER NIGHT IN-BIRTH Exe:Late[cl-r]
UNDER NIGHT IN-BIRTH II Sys:Celes
UNDER NIGHT IN-BIRTH II Sys:Celes
Unicorn Overlord
Unicorn Overlord
Unpacking
Unpacking
Untitled Goose Game
Untitled Goose Game
Viractal: Will You Trust Your Party?
Viractal: Will You Trust Your Party?
Xenoblade Chronicles 3
Xenoblade Chronicles 3
Xenoblade Chronicles: Definitive Edition
Xenoblade Chronicles: Definitive Edition

A game's page names the latest nx2android version the game was tested on (v0.1.3). Older games are not tested again for each release: if a later version breaks one, a patch release fixes it. A version newer than the latest release is the next release, and the game needs the development checkout until it ships.

A game that is not in this list is not supported yet. The games we look at next, and the ones done: docs/PORT_CHECKLIST.md.

For players: port a game without programming

  1. Download nx2android-<version>-windows-x64.zip (Windows), nx2android-<version>-macos-arm64.zip (Mac with Apple silicon), nx2android-<version>-linux-x64.zip (Linux on a PC) or nx2android-<version>-linux-arm64.zip (Linux on ARM) from Releases, unzip it and start nx2android (on a Mac, see packaging/INSTALL.md first). On Linux you can take the nx2android-<version>-linux-x64.AppImage or -linux-arm64.AppImage instead: make it executable and start it.
  2. Setup tab: click Download missing tools (the Android NDK, the .NET SDK and platform-tools, about 1 GB, from Google and Microsoft), then set your prod.keys. Every line turns green.
  3. Port tab: choose the folder with the game's NSP, XCI, NSZ or XCZ files (base game, update, DLC) and click Port.
  4. Tick Install on the device when done with the device plugged in and USB debugging on, or copy the APK and the data folder yourself.

Pokémon Legends: Arceus and Pokémon Legends: Z-A need the device during the port, even without Install on the device when done: their shaders are in Oodle-compressed archives, which the port decodes with the game's own decoder on the device. Have platform-tools (adb) from step 2, and plug in the device with USB debugging on before you click Port.

A game played by touch: tick Touch game on the Port tab (--touch). The on-screen gamepad then starts hidden and every touch but one on the menu button goes to the game; the pause menu shows the gamepad again.

Chinese or Korean text drawn as ???: choose a TrueType font with those characters as System font on the Port tab (--shared-font, a single .ttf, not a .ttc). It goes in the data pack; the tool ships none. The tool's own text entry panel shows those characters in its title and the game's initial text, but its keyboard types only ASCII.

A game that reads system data from the console's firmware (sysdata in its profile; Mario Kart 8 Deluxe builds its Mii heads from MiiModel, title 0100000000000802) needs your console's own system content files, which the tool cannot ship. Copy them (.nca, for example NAND SYSTEM Contents/registered in DBI's MTP mode) to a folder on the PC and give it with --firmware <folder> (or porter config firmware <folder> once). Without it the host's empty stand-in is used.

A game whose profile lists the shared font titles (0100000000000811 and 0100000000000810, and 0100000000000814 / 0100000000000813 / 0100000000000812 for simplified Chinese, traditional Chinese and Korean) needs the same --firmware folder for its text and button icons; without it the host uses Android's own font and generated icons, and a game that needs a glyph those lack can fail at start. --shared-font <ttf> still wins for every shared font but the button icons.

A game slowed by its draw calls in busy scenes: tick Multithread replay on the Port tab (--mt-replay). The game's Vulkan commands are then recorded on a thread of their own. It stays on until you port the game again without it.

When Show gamepad is enabled, using a controller hides the on-screen controls. Touch the screen to bring them back. The draggable menu button stays available even with Show gamepad off.

To play without the on-screen menu button, tick No menu button on the Port tab (--no-menu-button). The button is then not drawn and its corner of the screen goes to the game. Open the pause menu with the Back gesture or key, or with a controller's Home or Menu key. The layout editor shows the button darkened, and a second screen's gamepad keeps it. It stays hidden until you port the game again without the option.

To arrange the on-screen controls, open the pause menu's Gamepad tab and choose Edit layout: drag a control to move it, pinch or use − / + to resize it. Save keeps the layout for the next launch and Cancel discards your edits. Snap to grid (off at first, and remembered) shows a square grid and snaps each control's center to it as you drag.

A controller whose A is the bottom button (Xbox labels, most Android devices' built-in controls) can have its face buttons follow their labels: the Gamepad tab's Face buttons row switches between Position (the Switch's layout, the default) and Label. It applies at once, also to the pause menu's own A and B, and each device keeps its own choice.

For Android's Unicode keyboard, port with --native-keyboard. It supports composed text, non-Latin scripts and emoji through the system IME, preserves initial text, and applies the guest's UTF-16 length limits. This option requires javac and an Android SDK with platform and build-tools (ANDROID_HOME). The default APK keeps the existing controller keyboard and does not require Java build tools. Combine --external-display --native-keyboard to opt into the native keyboard on an external-screen port; external display alone keeps the controller keyboard. The combined mode still needs runtime qualification over the full-screen phone gamepad.

For the experimental external-screen controller, port from the command line with --external-display. The game moves to a connected display and the phone shows the gamepad. In the pause menu's Game → Audio output, choose the phone, a connected output, or the system default; the list updates as devices connect or disconnect. Bluetooth call-only routes are omitted; the system may not honor the requested device. This option requires javac and an Android SDK with a platform and build-tools (ANDROID_HOME). Android 12 or newer uses the saved native layout; Android 10–11 use the fallback controller. Support varies by device and game.

Already have the game on the device for an emulator? The app can read the game's files (its RomFS, most of its size) from that dump's folder instead of a second copy: type the dump's RomFS folder in the app's RomFS on the device field (or give it to --romfs-at) before you install, which must be the same game version as the port. packaging/INSTALL.md says how.

A game that crashes with "AllocateAddressRegion … refused (0x1803)" in its log needs more address space: port it again with a larger Extra address space on the Port tab (--alias-headroom on the command line). packaging/INSTALL.md says more.

The step-by-step guide is packaging/INSTALL.md. You need your own game files and prod.keys, dumped from your own Switch; the tool never ships or downloads either. NSZ and XCZ files are decompressed during the port (into the build folder's tmp/, deleted once extracted).

Saves

The game's pause menu (Game tab) has Export save and Import save: an export is a folder in Android/data/<package>/files/saves/ on the device, the save's files as a console's save tools copy them, so a save from a console imports the same way. The app's Saves tab moves them between the device and the PC.

An import replaces the save the game has; the app exports that one first on the device (a folder ending -before-import). Uninstalling the app deletes its saves and its exports: copy them to the PC first.

For developers

Running from the repository, the command line, the repository layout, building the bundle, tests and commit messages: docs/DEVELOPMENT_GUIDE.md. How it is put together: docs/ARCHITECTURE.md.

Keys and game files

nx2android decrypts your game files with your prod.keys while it ports them, as Switch emulators do. This repository and its releases contain no keys, no game files and nothing extracted from them, and the tool never downloads either. Dump both from your own Switch, and don't share them or the APKs and data packs built from them.

Nintendo's takedown notices so far have gone to whoever hosts a project (13 Switch emulator repositories on GitHub in February 2026), not to players. Whether decrypting your own games for your own use is allowed depends on where you live.

License

MIT, as nxnative (see nxnative/LICENSE). Third-party code keeps its own license.

About

A compatibility layer for porting Switch games to Android, one game at a time

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages