Ryujinx - dragoonDorise/EmuDeck GitHub Wiki

THIS WIKI IS NO LONGER MAINTAINED. VISIT https://emudeck.github.io/ FOR THE NEW EMUDECK WIKI.

Ryujinx is a Nintendo Switch Emulator.

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

  1. Getting Started with Ryujinx

  2. Ryujinx Tips and Tricks

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.

If you play a Nintendo Switch game with Miis (example - Mario Kart 8 Deluxe), you will need firmware files.

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. 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:

  • EmulationStation-DE
  • Nintendo Switch Ryujinx
  • Emulators

Ryujinx Configuration:

Back to the Top

  • Type of Emulator: Binary Package
  • Executable Location: /home/deck/Applications/publish/Ryujinx
  • Emulator Configuration Location:
    • /home/deck/.config/Ryujinx/
      • Contains the following folders and files:
        • bis
        • games
        • mods
        • profiles
        • sdcard
        • system
        • Config.json
  • Storage: Emulation/storage/Ryujinx
    • Contains the following folders:
      • games
      • patchesAndDlc
  • 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
  • ROMs: Emulation/roms/switch/
  • Keys: Emulation/bios/ryujinx/keys/
  • Firmware: Install through Ryujinx GUI
  • Saves:
    • Symlink: Emulation/saves/ryujinx/saves
    • Target: /home/deck/.config/Ryujinx/bis/user/save
  • saveMeta:
    • Symlink: Emulation/saves/Ryujinx/saveMeta
    • Target: /home/deck/.config/Ryujinx/bis/user/saveMeta

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
  • EmulationStation-DE

How to Update Ryujinx

Back to the Top

How to Update Ryujinx

How to Launch Ryujinx in Desktop Mode

Back to the Top

How to Launch Ryujinx in Desktop Mode

  • Launch Ryujinx Binary from the Applications 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 the Emulators parser in Steam 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 ROM folder. Steam ROM Manager will try to parse them and the Steam shortcuts created will not work.

  1. Place updates and DLC files in Emulation/storage/ryujinx/patchesAndDlc
  2. Open Ryujinx, right click the ROM, and click Manage Title Updates or Manage DLC
  3. Select Add, and navigate to Emulation/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 click Add to Bookmarks
  4. After selecting the Update or DLC, select it in the Ryujinx menu, and click save
    • Updates:
    • DLC:
  5. 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
Exit Steam + DPad Left

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 https://github.com/dragoonDorise/EmuDeck/wiki/EmuDeck-Application-101#steamdeckgyrodsu to learn how to install and utilize SteamDeckGyroDSU.

How to Optimize Performance (Power Tools)

Back to the Top

Visit https://github.com/dragoonDorise/EmuDeck/wiki/EmuDeck-Application-101#power-tools to learn how to optimize performance using Power Tools.

How to Install Mods

Back to the Top

Mod Resources

This list is not comprehensive

Preface

Read Ryujinx's instructions on how to install mods here: https://github.com/Ryujinx/Ryujinx/wiki/Ryujinx-Setup-&-Configuration-Guide/87dc34d49facc69bb1b4fde45e1f10b520171671#managing-mods

The folder structure of a mod is important. It should generally look like the following:

mod_directory
  - exefs
  - romfs
  - romfs_ext

Tutorial

  1. In Desktop Mode, open Ryujinx
  2. Right click a game you intend on modding
  3. Click Open Mod Data Location
  4. Place your mod folder in the opened folder
    1. You may need to extract the mod first
  5. 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:

  • é in Pokémon
  • ' in The Legend of Zelda: Link's Awakening

If you used Steam ROM Manager previously, re-run Steam ROM Manager after renaming your ROMs.