Website: https://ryujinx.org/
GitHub: https://github.com/Ryujinx/Ryujinx
GitHub Releases: https://github.com/Ryujinx/release-channel-master/releases
Compatibility List: https://github.com/Ryujinx/Ryujinx-Games-List/issues
Quickstart guide: https://github.com/Ryujinx/Ryujinx/wiki/Ryujinx-Setup-&-Configuration-Guide
Ryujinx Table of Contents
Getting Started with Ryujinx
- Configuration
- Ryujinx Folder Locations
- How to Update Ryujinx
- How to Launch Ryujinx in Desktop Mode
- File Formats
- How To Manage DLC and Updates
- Hotkeys
Ryujinx Tips and Tricks
- How to Configure Gyro
- How to Configure Gyro With External Controllers
- How to Optimize Performance (Power Tools)
- How to Configure Multiplayer
- How to Install Mods
- Special Characters
- How to Roll Back Ryujinx to an Older Version
- How to Select Between Yuzu and Ryujinx in Game Mode
- How to Configure Language Settings
Getting Started with Ryujinx
Back to the Top
In order to play Nintendo Switch games on Ryujinx, you need a prod.keys
file to decrypt your ROMs. You will need to continue to keep your prod.keys
up to date as new Nintendo Switch firmware releases.
Firmware is required to play Nintendo Switch games through Ryujinx. To install firmware, open Ryujinx, click Tools
, click Install Firmware
and select the appropriate option depending on how your firmware is packaged.
Read Ryujinx's Quick Start guide to learn how to dump Nintendo Switch keys, firmware, and ROMs: https://github.com/Ryujinx/Ryujinx/wiki/Ryujinx-Setup-%26-Configuration-Guide.
Place your ROMs in Emulation/roms/switch
. Place your prod.keys
file in Emulation/bios/ryujinx/keys
. Install your firmware through Ryujinx's GUI. Install your DLC and Updates through Ryujinx's GUI, see How To Manage DLC and Updates to learn how.
Read the Configuration section to learn more about Ryujinx and its folder locations.
To launch your ROMs in game mode, use Steam ROM Manager and use one of the following parsers to play your Nintendo Switch ROMs:
ES-DE
Nintendo Switch Ryujinx
Emulators
Ryujinx Configuration:
Back to the Top
- Type of Emulator: Binary Package
- Executable Location:
/home/deck/Applications/publish/Ryujinx
or/home/deck/Applications/publish/Ryujinx.sh
- Config Location:
/home/deck/.config/Ryujinx/
- Storage Location:
Emulation/storage/Ryujinx
- DLC and Updates:
Emulation/storage/Ryujinx/patchesAndDlc
- It's recommended that you place your DLC and Updates directly in this folder. However, you can create any folder for Ryujinx DLC and Updates as long as it is not
Emulation/roms/switch
- For more detail, read: How To Manage DLC and Updates
- It's recommended that you place your DLC and Updates directly in this folder. However, you can create any folder for Ryujinx DLC and Updates as long as it is not
- ROMs:
Emulation/roms/switch/
- Keys (required):
Emulation/bios/ryujinx/keys/
- Firmware (required): Install through Ryujinx GUI
- Firmware is installed to
$HOME/.config/Ryujinx/bis/system/Contents/registered
- Saves:
- Symlink:
Emulation/saves/ryujinx/saves
- Target:
/home/deck/.config/Ryujinx/bis/user/save
- Symlink:
- saveMeta:
- Symlink:
Emulation/saves/Ryujinx/saveMeta
- Target:
/home/deck/.config/Ryujinx/bis/user/saveMeta
- Symlink:
Note: ~/.config
is an invisible folder by default. In Dolphin (file manager), click the hamburger menu in the top right, click Show Hidden Files
to see these folders.
Works With
- Steam ROM Manager
- ES-DE
Ryujinx Folder Locations
Back to the Top
These file locations apply regardless of where you chose to install EmuDeck (to your internal SSD, to your SD Card, or elsewhere). Some emulator configuration files will be located on the internal SSD as listed below.
$HOME
refers to your home folder. If you are on a Steam Deck, this folder will be named /home/deck
(you will likely not see deck
in the file path when navigating using the file manager).
Paths beginning with Emulation/..
correspond to your EmuDeck install location. If you installed on an SD Card, your path may be /run/media/mmcblk0p1/Emulation/roms/..
. If you installed on your internal SSD, your path may be /home/deck/Emulation/roms/..
Note: Folders with a .
(.var
, .local
, .config
, etc.) at the beginning are hidden by default. In Dolphin (file manager), click the hamburger menu in the top right, click Show Hidden Files
to see these folders.
$HOME/.config/Ryujinx
Ryujinx/├── bis│ ├── system│ │ ├── Contents│ │ └── save│ └── user│ ├── Contents│ ├── save│ ├── saveMeta│ └── temp├── Config.json├── Config.json.bak├── games -> Emulation/storage/ryujinx/games/├── mods│ ├── contents│ ├── exefs_patches│ └── nro_patches├── profiles│ └── controller│ ├── Deck.json│ └── Deck.json.bak├── sdcard│ ├── atmosphere│ │ ├── contents│ │ ├── exefs_patches│ │ └── nro_patches│ ├── Nintendo│ │ ├── Contents│ │ └── save│ └── ocw-config.json└── system ├── prod.keys └── Profiles.json
Emulation/bios/Ryujinx
ryujinx/└── keys -> /home/deck/.config/Ryujinx/system
How to Update Ryujinx
Back to the Top
How to Update Ryujinx
- Through the
Update your Emulators & Tools
section on theManage Emulators
page in theEmuDeck
application - Manual file replacement of
Ryujinx
- Refer to How to Swap Out AppImages and Binaries for instructions
- Through the application's automatic updater
- When you open Ryujinx, you may be prompted for an update, accept the prompt to update the application
- Through Ryujinx's built-in updater
- Desktop Mode:
- Search for Ryujinx in the
Applications Launcher
(Steam Deck icon in the bottom left of the taskbar) and open it, Ryujinx will prompt for an update if one is available
- Search for Ryujinx in the
- Game Mode:
- Add Ryujinx to Steam by using the
Emulators
parser in Steam ROM Manager. After adding it to Steam, you may open it in Game Mode, Ryujinx will prompt for an update if one is available
- Add Ryujinx to Steam by using the
- Desktop Mode:
- Through
binupdate.sh
inEmulation/tools/binupdate
, double click to launch
How to Launch Ryujinx in Desktop Mode
Back to the Top
How to Launch Ryujinx in Desktop Mode
- Launch
Ryujinx Binary
from theApplications Launcher
(Steam Deck icon in the bottom left of the taskbar) - Launch the script from
Emulation/tools/launchers
,ryujinx.sh
- Launch the binary in
/home/deck/Applications/publish/Ryujinx
- Launch the emulator from
Steam
after adding it via theEmulators
parser inSteam ROM Manager
Ryujinx File Formats
Back to the Top
- .kp
- .nca
- .nro
- .nso
- .nsp
- .xci
How to Manage DLC and Updates
Back to the Top
IMPORTANT: Do not keep your DLC and Update Files in the Emulation/roms/switch
folder. Steam ROM Manager will try to parse them and the Steam shortcuts created will not work.
- Place updates and DLC files in
Emulation/storage/ryujinx/patchesAndDlc
- It's recommended that you place your DLC and Updates directly in this folder. However, you can create any folder for Ryujinx DLC and Updates as long as it is not
Emulation/roms/switch
- It's recommended that you place your DLC and Updates directly in this folder. However, you can create any folder for Ryujinx DLC and Updates as long as it is not
- Open Ryujinx, right click the ROM, and click
Manage Title Updates
orManage DLC
- Select
Add
, and navigate toEmulation/storage/ryujinx/patchesAndDlc
, and select your Update or DLC- You can select more than one at a time if you are adding a batch of DLCs
- Optionally, you can right click the
patchesAndDlc
folder and clickAdd to Bookmarks
- After selecting the Update or DLC, select it in the Ryujinx menu, and click save
- Updates will be reflected under the ROM name in the game list, DLC will automatically be applied in-game
Ryujinx Hotkeys
Back to the Top
Ryujinx | Hotkeys | Keyboard Keys |
---|---|---|
Stop Emulation | Steam or ... + DPad Left | Esc |
Ryujinx Tips and Tricks
Back to the Top
How to Configure Gyro
Back to the Top
Gyro for Ryujinx requires SteamDeckGyroDSU. SteamDeckGyroDSU can be installed via EmuDeck, or it can be installed manually.
Visit SteamDeckGyroDSU to learn how to install and utilize SteamDeckGyroDSU.
How to Configure Gyro With External Controllers
Back to the Top
- Switch to Desktop Mode
- Exit out of Steam
- You may exit out of Steam a couple of different ways:
- Right click the
Steam
icon in your taskbar and clickExit Steam
- Open Steam, click the
Steam
button in the top left, clickExit
- Open a terminal (Konsole) and enter
killall -9 steam
- Do note that clicking the the
X
button in the top right of the Steam window will not exit out of Steam
- Right click the
- Your controls will switch to
Lizard Mode
. UseL2
to right click,R2
to left click, and theRight Trackpad
to move the mouse - You may also connect an external keyboard and mouse
- You may exit out of Steam a couple of different ways:
- Click the bluetooth icon in the bottom right of your taskbar and connect your controller
- Open Ryujinx
- Click
Options
at the top, clickSettings
- Click the
Input
tab on the top - Click
Configure
underPlayer 1
- Under
Input Device
, select your external controller - Select your
Controller Type
- Select either
Joycon Pair
orPro Controller
depending on the game you are playing
- Select either
- Click
Load
to the right ofController Type
- Under
Motion
, checkEnable Motion Controls
and uncheckUse CemuHook compatible motion
- Exit out of Ryujinx
- Switch to
Game Mode
- In Game Mode, connect your controller
- Select your Nintendo Switch game
- On the
Play
screen, select theController
icon to the right of the screen - Select your controller tab at the top
- Click the
Gear
icon to the right, and clickDisable Steam Input
- Your controller's gyro will now work for this selected game, repeat as needed for your other games
If your controller gyro does not work after the above steps, reset Ryujinx's configuration in the EmuDeck application on the Manage Emulators page and try again.
Post-Configuration
To restore the default Steam Deck controls:
- Open Ryujinx
- Click
Options
at the top, clickSettings
- Click the
Input
tab on the top - Click
Configure
underPlayer 1
- Select
Steam Virtual Gamepad
underInput Device
- Click
Load
on the right side of the screen - Click
Save
and exit out of Ryujinx
(Optional) To restore Steam Input:
- Select your Nintendo Switch game
- On the
Play
screen, select theController
icon to the right of the screen - Select your controller tab at the top
- Click the
Gear
icon to the right, and clickEnable Steam Input
- You may need to restart first for this setting to properly apply
- The controls will be reverted to Steam Input and the Steam Deck controls will be restored
How to Optimize Performance (Power Tools)
Back to the Top
Visit Power Tools to learn how to optimize performance using Power Tools.
How to Configure Multiplayer
Back to the Top
Ryujinx comes with a nifty auto-map feature that makes setting up multiplayer a breeze. To set up multiplayer, you simply need to enable the additional ports.
- In Game Mode, open Ryujinx
- You may add Ryujinx to Steam by using the
Emulators
parser in Steam ROM Manager
- You may add Ryujinx to Steam by using the
- Open the
Input
settings in theSettings
menu - For each controller you are using for Player 2, 3, 4, etc, click the respective
Configure
button- You do not need to adjust any settings for Player 1
- Under
Input Device
- Player 2:
Steam Virtual Gamepad 1
- Player 3:
Steam Virtual Gamepad 2
- Player 4:
Steam Virtual Gamepad 3
- Player 5:
Steam Virtual Gamepad 4
- Player 6:
Steam Virtual Gamepad 5
- Player 7:
Steam Virtual Gamepad 6
- Player 8:
Steam Virtual Gamepad 7
- Player 2:
- Using
Player 2
as an example:- On the
Player 2
configuration screen, after you have selected the appropriateInput Device
, select your preferredController Type
and clickLoad
to the right ofProfile
- On the
- After you are finished enabling any additional players, click
Save
and you may open your game either directly as a shortcut in Steam or through ES-DE - (Optional) You may need to re-arrange the controller order in Game Mode for your controllers to function as expected. See How to Re-Arrange the Controller Order to learn how
How to Install Mods
Back to the Top
Mod Resources
This list is not comprehensive
- Ryujinx's Discord
- GameBanana Mods: https://gamebanana.com/
- Search by game name
- Nexus Mods: https://www.nexusmods.com/
- Search by game name
- GBAtemp: https://gbatemp.net/forums/nintendo-switch.283/?prefix_id=56
- Use https://gbatemp.net/search/?type=post to search
- Sort by
ROM Hack
in the prefixes list andNintendo Switch
in theSearch in forums
list
- Sort by
- To narrow search results, use the
Search titles only
toggle
- Use https://gbatemp.net/search/?type=post to search
- SweetFX: http://sfx.thelazy.net/games/
- Search by game name
- theboy181
- 1: Github Collection: https://github.com/theboy181/switch-ptchtxt-mods
- 2: Github Collection: https://github.com/theboy181/switch-cheat-mods
- 3: theboy181's Discord: https://linktr.ee/theboy181
Preface
Read Ryujinx's instructions on how to install mods here: How to Install Ryujinx Mods
The folder structure of a mod is important. It should generally look like the following:
mod_directory - exefs - romfs - romfs_ext
Tutorial
- In Desktop Mode, open Ryujinx
- Right click a game you intend on modding
- Click
Open Mod Data Location
- Place your mod folder in the opened folder
- Your mod is now installed
Special Characters
Back to the Top
Files with special characters in the ROM name will not launch from steam. Rename your ROMs and remove the special character.
Known Cases:
é
inPokémon
'
inThe Legend of Zelda: Link's Awakening
+
and'
inSuper Mario 3D World + Bowser’s Fury
If you used Steam ROM Manager previously, re-run Steam ROM Manager after renaming your ROMs.
How to Remove Special Characters
How to Roll Back Ryujinx to an Older Version
Back to the Top
Preface
Your ROMs launch using a script created by EmuDeck, ryujinx.sh
in Emulation/tools/launchers
.
The script launches the corresponding emulator in /home/deck/Applications/publish
and specifically looks for two traits:
- The most recently downloaded version of the emulator in
/home/deck/Applications/publish
, based on the file/release date. - The emulator name at the beginning of the file. Anything after the emulator name is ignored.
- For example, if the latest version of the emulator is
1351
and you would like to downgrade to1349
. When you download version1349
, you could rename it toEMULATORNAME-1349.AppImage
, and EmuDeck's script will ignore the-1349
in the file name, allowing you to record which versions of the emulator you are using through the file name.
- For example, if the latest version of the emulator is
How to Roll Back Ryujinx
- Download the version of the emulator you would like to use from Ryujinx's GitHub: https://github.com/Ryujinx/release-channel-master/releases
- Move the downloaded emulator from Step 1 to
/home/deck/Applications/publish
- (Optional) Rename or delete the original emulator file
- One at a time, right click
Ryujinx
andRyujinx.sh
, clickProperties
, clickPermissions
, checkIs executable
- Your games will now launch using the version of the emulator you downloaded
How to Select Between Yuzu and Ryujinx in Game Mode
Back to the Top
If you are using Steam ROM Manager and would like to run some games through Yuzu and others through Ryujinx, you may use Steam ROM Manager's exception manager to selectively run your games in your preferred emulator.
For further instructions, see Steam ROM Manager: How to Hide ROMs on a Per Parser Basis.
If you are using ES-DE, you may use ES-DE's alternative emulators feature to select on a per-game basis which to run through Yuzu and which to run through Ryujinx.
For further instructions, see ES-DE: How to Select a Different Emulator on a Per-Game Basis.
How to Configure Language Settings
Back to the Top
UI
- In Desktop Mode, open Ryujinx
- At the top, click
Options
, clickChange Language
- Select your preferred language in the menu
In-Game
- In Desktop Mode, open Ryujinx
- At the top, click
Options
, clickSettings
- Click the
System
tab - To the right of
System Language
, select your preferred language in the drop-down menu