-
-
Notifications
You must be signed in to change notification settings - Fork 220
Yuzu
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/
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
. 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:
EmulationStation-DE
Nintendo Switch - Yuzu
Emulators
- Type of Emulator: AppImage
- Executable Location:
/home/deck/Applications/yuzu.AppImage
- Config Location:
/home/deck/.config/yuzu/
- Default storage Location:
/home/deck/.share/local/yuzu/
- Persistent Storage:
Emulation/storage/yuzu
- Contains:
dump
,load
,nand
,screenshots
,sdmc
, andtas
- Contains:
- 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) - Keys:
Emulation/bios/yuzu/keys/
(symlink folder to the proper place. DO NOT OVERWRITE THE FOLDER or it won't work) - Saves:
- Symlink:
Emulation/saves/yuzu/
- Target:
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 "view hidden files" to see these folders.
- Steam ROM Manager
- EmulationStation-DE
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 https://github.com/dragoonDorise/EmuDeck/wiki/File-Management#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
- 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
- .kp
- .nca
- .nro
- .nso
- .nsp
- .xci
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: https://github.com/dragoonDorise/EmuDeck/wiki/ryujinx#how-to-manage-dlc-and-updates.
DLC and Updates are installed directly through the Yuzu menu.
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
Combo hotkeys have been mapped for this emulator.
Hotkey | Yuzu |
---|---|
Menu / Full Screen |
Select + R3
|
Docked Mode |
Start + DPAD Up
|
GPU Accuracy |
Start + DPAD Down
|
Filter |
Start + DPAD Left
|
Pause |
Select + A
|
Fast Forward |
Select + R2
|
Exit |
Select + Start
|
Steam Deck Button Layout: https://github.com/dragoonDorise/EmuDeck/wiki/Hotkeys#steam-deck-button-layout
- Files with special characters in the name will not launch from shortcuts created by Steam ROM Manager in Steam or EmulationStation-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:
- Date added to this page: Jun 16, 2022
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
If you used Steam ROM Manager previously, re-run Steam ROM Manager after renaming your ROMs.
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 EmulationStation-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 EmulationStation-DE.
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.
Reference Image:
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 placed it in the correct folder, you will be able to proceed through the Mii selection menu.
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.
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 placed it in the correct folder, the game will proceed and you will be able to play.
Gyro for Cemu requires SteamDeckGyroDSU. SteamDeckGyroDSU can be installed via EmuDeck, or it can be installed manually.
Visual Reference:
How to Install SteamDeckGyroDSU: https://github.com/dragoonDorise/EmuDeck/wiki/frequently-asked-questions#how-do-i-install-steamdeckgyrodsu
Prerequisites
- Decky Loader and Power Tools
- Power Tools can be installed via EmuDeck, or it can be installed manually
- Visual Reference:
- Although this screen does not explicitly state Decky Loader, Decky Loader is included in this installation
- Step by Step Instructions on How to Install Power Tools: https://github.com/dragoonDorise/EmuDeck/wiki/frequently-asked-questions#how-do-i-install-power-tools-and-deckyloader
- Power Tools can be installed via EmuDeck, or it can be installed manually
Recommended Settings
- Power Tools: Turn SMT off
- Open the
QAM
("..." button), select theSocket
icon, selectPOWERTOOLS
, turn offSMT
- Visual Reference:
- (Optional) Use the
Persistent
toggle to set these settings on a per-game basis- Visual Reference:
- Open the
- Steam Deck Performance Menu: Set Manual GPU Clock Control to 1200 frequency
- Open the
QAM
("..." button), select theBattery
icon, enableAdvance View
, scroll down, enableManual GPU Clock Control
, and set it to1200
- Visual Reference:
- Toggle per game profiles
- Visual Reference:
- Open the
-
IMPORTANT: Some Nintendo Switch games will not perform well regardless and will require the Yuzu team to improve compatibility
- In some cases, these games may have workarounds through modifying settings or applying patches or mods. Search on Google for your respective game, and see if these workarounds exist
- Check the Yuzu Compatibility List: https://yuzu-emu.org/game/
Multiplayer for Yuzu is configured out of the box, no additional configuration is needed.
You may need to set the Controller Order
in the Steam QAM (...
button).
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 - To narrow search results, use the
Search titles only
toggle
- Sort by
- 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 Yuzu's instructions on how to install mods here: https://yuzu-emu.org/help/feature/game-modding/
The folder structure of a mod is important. It should generally look like the following:
mod_directory
- exefs
- romfs
- romfs_ext
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
# 60 FPS Mod for The Legend of Zelda: Link's Awakening
Stable-60fps-v2
- exefs
- 1.0.0.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
- Visual Reference:
- Place your mod folder in the opened folder
- You may need to extract the mod first
- Visual Reference:
- In Yuzu, right click the same game, open
Properties
, click theAdd-Ons
tab - Check the box to the left of your mod(s)
- Visual Reference:
- Your mod is now installed
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.
You can submit or view special game configurations here: https://github.com/dragoonDorise/EmuDeck/wiki/community-creations#yuzu-nintendo-switch
Current List of Special Game Configurations
- The Legend of Zelda: Link's Awakening
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