Yuzu is a Nintendo Switch emulator.
Website: https://yuzu-emu.org/
GitHub: https://github.com/yuzu-emu/yuzu-mainline
GitHub Releases: https://github.com/yuzu-emu/yuzu-mainline/releases
Compatibility List: https://yuzu-emu.org/game/
Quickstart guide: https://yuzu-emu.org/help/quickstart/
Yuzu Table of Contents
-
- 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 Game Configurations
- How to Set Up Early Access
- How to Roll Back Yuzu to an Older Version
- How to Select Between Yuzu and Ryujinx in Game Mode
- How to Configure Language Settings
Getting Started with Yuzu
In order to play Nintendo Switch games on Yuzu, you will need a prod.keys
file and title.keys
to decrypt your ROMs. You will need to continue to keep your prod.keys
and title.keys
up to date as new Nintendo Switch firmware releases.
If you play a Nintendo Switch game with Miis (for example - Mario Kart 8 Deluxe), you will need firmware files.
Read Yuzu's Quick Start guide to learn how to dump Nintendo Switch keys, firmware, and ROMs: https://yuzu-emu.org/help/quickstart/.
Place your ROMs in Emulation/roms/switch
. Place your prod.keys
file in Emulation/bios/yuzu/keys
. Place your firmware files in Emulation/bios/yuzu/firmware
.
Read the Configuration section to learn more about Yuzu 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 - Yuzu
Emulators
Yuzu Configuration
- Type of Emulator: AppImage
- Executable Location:
/home/deck/Applications/yuzu.AppImage
- Config Location:
$HOME/.config/yuzu/
- Contains the following folders and files:
custom
input
qt-config.ini
- Contains the following folders and files:
$HOME/.local/share/yuzu
- Contains the following folders:
amiibo
keys
Emulation/bios/yuzu/keys
is a symlink to the above location
log
shader
- Contains the following folders:
- Storage Location:
Emulation/storage/yuzu
- Contains the following folders:
dump
load
nand
- Firmware:
Emulation/storage/yuzu/nand/system/Contents/registered
Emulation/bios/yuzu/firmware
is a symlink to the above location
- Firmware:
screenshots
sdmc
tas
- Contains the following folders:
- ROMs:
Emulation/roms/switch/
- Firmware:
Emulation/bios/yuzu/firmware/
- Symlink folder to the proper place. DO NOT OVERWRITE THE FOLDER or it won't work
- Target Location:
Emulation/storage/yuzu/nand/system/Contents/registered
- Keys:
Emulation/bios/yuzu/keys/
- Symlink folder to the proper place. DO NOT OVERWRITE THE FOLDER or it won't work
- Target Location:
/home/deck/.local/share/yuzu/keys
- Saves:
- Symlink:
Emulation/saves/yuzu/
- Target Location:
Emulation/storage/yuzu/nand/user/save/
- Symlink:
Note: ~/.local
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
Yuzu Folder Locations
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/..
DLC and Updates are installed to the NAND. The NAND is localized to your EmuDeck install. If you installed EmuDeck to your internal SSD, your NAND is on your internal SSD. If you installed EmuDeck to an SD Card or an External Hard Drive, your NAND is on the removable storage device.
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/yuzu
yuzu/
├── custom
├── input
│ ├── emudeck.ini
│ └── emudeck.ini.bak
├── qt-config.ini
├── qt-config.ini.bak
└── telemetry_id
$HOME/.local/share/yuzu
Emulation/storage/yuzu
yuzu/
├── dump
├── load
├── nand
│ └── user
│ ├── Contents
│ │ ├── placehld
│ │ └── registered
│ ├── save
│ │ ├── 0000000000000000
│ │ └── cache
│ └── temp
├── screenshots
├── sdmc
└── tas
Emulation/bios/yuzu
yuzu/
├── firmware -> Emulation/storage/yuzu/nand/system/Contents/registered/
└── keys -> /home/deck/.local/share/yuzu/keys/
How to Update Yuzu
How to Update Yuzu
- Through the
Update your Emulators & Tools
section on theManage Emulators
page in theEmuDeck
application - Manual file replacement of
Yuzu
- Refer to How to Swap Out AppImages and Binaries for instructions
- Through the application's automatic updater
- When you open Yuzu you may be prompted for an update, accept the prompt to update the application
How to Launch Yuzu in Desktop Mode
How to Launch Yuzu in Desktop Mode
- Launch
yuzu AppImage
from theApplications Launcher
(Steam Deck icon in the bottom left of the taskbar) - Launch the script from
Emulation/tools/launchers
,yuzu.sh
- Launch the AppImage in
/home/deck/Applications/Yuzu.AppImage
- Launch the emulator from
Steam
after adding it via theEmulators
parser inSteam ROM Manager
Yuzu File Formats
- .kp
- .nca
- .nro
- .nso
- .nsp
- .xci
How to Manage DLC and Updates
Preface: Do not keep your DLC or update files in the Emulation/roms/switch
folder. Steam ROM Manager will parse your updates and DLC and create broken shortcuts. After installing your DLC or updates, you can discard them or save them for Ryujinx.
Ryujinx expects your DLC and update files to stay permanently in a folder, either in a folder of your choice, or in Emulation/storage/ryujinx/patchesAndDlc
. For further detail, read: Ryujinx: How to Manage DLC and Updates.
DLC and Updates are installed directly through the Yuzu menu.
DLC and Updates are installed to the NAND. The NAND is localized to your EmuDeck install. If you installed EmuDeck to your internal SSD, your NAND is on your internal SSD. If you installed EmuDeck to an SD Card or an External Hard Drive, your NAND is on the removable storage device. For specific folder locations, see Yuzu Folder Locations.
Quick Tutorial
- In Desktop Mode, open Yuzu
- Click
File
- Click
Install Files to NAND..
- (Optional) If your DLC or update files are on your SD Card, your path is:
/run/media/...
. To navigate here, clickComputer
on the left, open the/
folder, open therun
folder, then themedia
folder, and follow the path to the files on your SD Card. - Locate your DLC or update files in your directory
- Your DLC or update files are now installed
Yuzu Hotkeys
Combo hotkeys have been mapped for this emulator.
Hotkey | Yuzu |
---|---|
Quick Menu | Select + R3 |
Toggle Full Screen | Start + L3 |
Pause/Play | Select + A |
Fast Forward | Select + R2 |
Stop Emulation | Select + Start |
Full Screen Toggle | Select + R3 |
Docked Mode Toggle | Start + DPAD Up |
GPU Accuracy | Start + DPAD Down |
Filter | Start + DPAD Left |
Note:
Known Issues
- Files with special characters in the name will not launch from shortcuts created by Steam ROM Manager in Steam or ES-DE. Rename your ROMs if they contain any of the following characters.
- Known Cases:
é
in Pokémon'
in Link's Awakening
- Known Cases:
- The 3.4.6 SteamOS Stable Update on March 13th updated Mesa to 23.1. Some games may be affected.
- Known Issues:
- Super Mario 3D World has flicking textures in snow levels.
- Recommended Workarounds:
- Use the Yuzu Flatpak
- Test older Yuzu versions
- Date added to this page: March 14th, 2023
- Known Issues:
- Yuzu Mainline 1296 merged YFC 1.5. Recent versions of Yuzu may have some stability issues or regressions.
- Recommended Versions:
- Date added to this page: January 19th, 2023
- Shin Megami Tensei V may have some performance regressions in recent versions of Yuzu.
- Recommended Versions:
- Date added to this page: January 19th, 2023
- Pokemon Legends Arceus may have some crashes in recent versions of Yuzu.
- Recommended Versions:
- Mainline 984: https://github.com/yuzu-emu/yuzu-mainline/releases/download/mainline-0-984/yuzu-20220414-0d81d4395.AppImage
Yuzu Common Issues
Game suddenly stopped working?
If your game ever crashes or you exit the game by pressing the STEAM
button and clicking Exit Game
instead of using the hotkey (Select
+ Start
), you may end up corrupting the shader cache.
To clear the shader cache:
- Open Yuzu
- Right click the game in specific
- Click
Remove
- Click
Remove All Pipeline Caches
Note: Use Select
+ Start
to exit your game instead of using the STEAM
button.
Special Characters
Files with special characters in the ROM name will not launch from Steam.
Rename your ROMs by editing the file name directly in the respective ROM folder and remove the special character.
Known Cases
é
inPokémon
'
inThe Legend of Zelda: Link's Awakening
If you used Steam ROM Manager previously, re-run Steam ROM Manager after renaming your ROMs.
Combined XCI Files
Combined Nintendo Switch games can be unreliable. These combined games will still work if you open them through Yuzu directly.
However, using combined games may cause issues if you are using a shortcut created by Steam ROM Manager or running the game through ES-DE.
It is recommended you do not use combined games if you want to use shortcuts created by Steam ROM Manager or run your games through ES-DE.
Why is Mario Kart 8 stuck on the Mii selection screen?
Dump and use your firmware and keys from your console following Yuzu's Quickstart Guide.
The firmware must contain Mii data. Without it, the game will get stuck on the Mii selection screen.
If the game is stuck on a Mii selection screen, that means your firmware does not contain Mii data. You will need to re-dump your firmware.
After you dump your firmware with Mii data, place it in Emulation/bios/yuzu/firmware
.
Once you have dumped your firmware with the proper Mii data and place it in the correct folder, you will be able to proceed through the Mii selection menu.
Why is New Super Mario Bros U Deluxe stuck on a black screen?
Dump and use your firmware and keys from your console following Yuzu's Quickstart Guide.
The firmware must contain Mii data. Without it, the game will launch into a black screen.
If the game is stuck on a black screen, that means your firmware does not contain Mii data. You will need to re-dump your firmware.
After you dump your firmware with Mii data, place it in Emulation/bios/yuzu/firmware
.
Once you have dumped your firmware with the proper Mii data and place it in the correct folder, the game will proceed and you will be able to play.
Save Data Disappeared
If your save data disappeared, it's likely because the profile IDs were reset. Fortunately, the data is still present.
- In Desktop Mode, open the
Emulation/storage/yuzu/nand/user/save/0000000000000000
folder- In this folder, you will find more than one folder with alphanumerical names. These are the profile IDs for your save files
- In Desktop Mode, open Yuzu, right click on a game, click on
Open Save Data Location
- If you look at the path, you will see you are in one of the alphanumerical folders from Step 1. This folder is the ID of your current profile, and where you should be placing your recovered saves
Now that you know which save folder corresponds to the new save file, the other folders are for any old profiles you had.
If you only had one profile, there should be one other folder, and you can just transfer the saves over.
If you had two or more profiles, the best way to find out which was which was transfer a save from one game to the new folder and see which save it happens to be.
Inside each profile's folder are one or several game-specific folders, each named after their game-id, which you can find under the game's name in the Yuzu application (for example, Tears of the Kingdom ID is 0100F2C0115B6000
). These correspond to the respective game's save data, and moving them over to the new profile folder will make the save work in the new conditions.
If you had more than one profile, you will need to also create new profiles for each old one you had, and place the save files from each folder accordingly.
Yuzu Tips and Tricks
How to Configure Gyro
Gyro for Yuzu 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 Diagnose Gyro
Gyro with Yuzu on the Steam Deck can be a little finnicky. Prior to following the steps below, make sure you have already tried resetting Yuzu's configurations to EmuDeck's defaults in the EmuDeck application. If that still does not resolve the issue, you can take a look in the Yuzu settings and try to to set the gyro controls yourself.
Here's How
- Add Yuzu to Steam so you may open it in Game Mode
- You may add Yuzu to Steam by using the
Emulators
parser in Steam ROM Manager
- You may add Yuzu to Steam by using the
- Install and configure gyro for the Yuzu shortcut in Game Mode
- Read the instructions on the SteamDeckGyroDSU page to learn how to install and utilize SteamDeckGyroDSU in Game Mode
- In Game Mode, on the Yuzu shortcut, click the
Gear
icon - Select
Properties
- Scroll down to
Game Resolution
- Change it to
3840x2160
- Enable
Set resolution for internal and external display
- In Game Mode, open Yuzu
- Click
Emulation
at the top, clickConfigure
- Click
Controls
on the left - Make sure the
emudeck
profile is selected in theProfile
drop-down menu in the top right - Under
Motion 1
at the bottom, click[Not Set]
orsdl
and shake your Steam Deck - Click
OK
in the bottom right - Exit out of Yuzu
- In Game Mode, on the Yuzu shortcut, click the
Gear
icon - Select
Properties
- Scroll down to
Game Resolution
- Change it to
Default
- Disable
Set resolution for internal and external display
- Test gyro on a Nintendo Switch game using Yuzu in Game Mode
- You may do so by opening the game through Yuzu directly, adding the game as a shortcut through Steam ROM Manager, or opening the game through ES-DE
How to Configure Gyro With External Controllers
Desktop Mode
- 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
- Right click anywhere on the blank space on your desktop and click
Configure Display Settings
- You may also find this menu by opening
System Settings
and clickingDisplay and Monitor
- You may also find this menu by opening
- Click the
Upside Down
configuration underOrientation
- This setting will switch your Steam Deck to "Portrait Mode", hold your Steam Deck sideways for this section to navigate the various settings
- Open Yuzu
- Click
Emulation
at the top, clickConfigure
- Click
Controls
on the left - Under
Input Device
, select your external controller - Under
Motion 1
at the bottom, click[Not Set]
orsdl
and shake your controller - (Optional), you may also choose to save your layout as a unique profile. With this profile, you can choose to apply it on a per-game basis
- Click
OK
in the bottom right - Exit out of Yuzu
- Right click anywhere on the blank space on your desktop and click
Configure Display Settings
- You may also find this menu by opening
System Settings
and clickingDisplay and Monitor
- You may also find this menu by opening
- Click the
90 Counterclockwise
configuration underOrientation
- Switch to
Game Mode
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 Yuzu's configuration in the EmuDeck application on the Manage Emulators page and try again.
Post-Configuration
To restore the default Steam Deck controls:
- Open Yuzu
- Click
Emulation
at the top, clickConfigure
- Click
Controls
on the left - Under the
Profile
drop-down menu in the top right, selectemudeck
- The EmuDeck configured controls should now auto-populate
- Select
Steam Virtual Gamepad 0
underInput Device
- Click
OK
in the bottom right - Exit out of Yuzu
(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)
Visit Power Tools to learn how to optimize performance using Power Tools.
How to Configure Multiplayer
Multiplayer for Yuzu is configured out of the box, no additional configuration is needed.
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 for more information.
How to Install Mods
Mod Resources
This list is not comprehensive
- Yuzu Mods: https://yuzu-emu.org/wiki/switch-mods/
- This is not an exhaustive list of mods available for Yuzu
- Alternate link: https://github.com/yuzu-emu/yuzu/wiki/Switch-Mods
- Yuzu Mod Instructions: https://yuzu-emu.org/help/feature/game-modding/
- 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
For Yuzu's instructions on how to install mods, see: https://yuzu-emu.org/help/feature/game-modding/
The folder structure of a mod is important. It should generally look like the following:
A few examples:
# Blur Removal Mod for The Legend of Zelda: Link's Awakening
Blur Removal
- exefs
- Zelda-Links Awakening v1.0.1 - DOF.pchtxt
# Faster Battles Mod for Pokemon Brilliant Diamond
Faster Battles
- romfs
- Data
- StreamingAssets
- AssetAssistant
- Battle
- battle_masterdatas
Tutorial
- In Desktop Mode, open Yuzu
- Right click a game you intend on modding
- Click
Open Mod Data Location
- Place your mod folder in the opened folder
- In Yuzu, right click the same game, open
Properties
, click theAdd-Ons
tab - Check the box to the left of your mod(s)
- Your mod is now installed
Special Game Configurations
Some games will take additional setup, requiring mods or an extensive alteration of settings. The EmuDeck Community Creations page collects these configurations in one centralized location.
To submit or view special game configurations, see Special Game Configurations.
Current List of Special Game Configurations
- The Legend of Zelda: Link's Awakening
How to Set Up Early Access
EmuDeck 2.1 added an option to enable Yuzu (Early Access).
Here's how to set it up
- Open EmuDeck
- Click the
Manage Emulators
button - Click
Yuzu
- Click
Setup Early Access
- Enter your token
- Whenever you launch Yuzu, it will now use the
Early Access
version
How to Roll Back Yuzu to an Older Version
Preface
Your ROMs launch using a script created by EmuDeck, yuzu.sh
in Emulation/tools/launchers
.
The script launches the corresponding emulator in /home/deck/Applications
and specifically looks for two traits:
- The most recently downloaded version of the emulator in
/home/deck/Applications
, 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 Yuzu
- Download the version of the emulator you would like to use from Yuzu's GitHub: https://github.com/yuzu-emu/yuzu-mainline/releases
- Move the downloaded emulator from Step 1 to
/home/deck/Applications
- (Optional) Rename or delete the original emulator file
- Right click the newly downloaded emulator, click
Properties
, 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
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
UI
- In Desktop Mode, open Yuzu
- At the top, click
Emulation
, clickConfigure
- On the left, click the
General
tab - Click the
UI
tab - To the right of
Interface Language
, select your preferred language in the drop-down menu
In-Game
- In Desktop Mode, open Yuzu
- At the top, click
Emulation
, clickConfigure
- On the left, click the
System
tab - Click the
System
tab - To the right of
Language
, select your preferred language in the drop-down menu