Dolphin - dragoonDorise/EmuDeck GitHub Wiki

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

Dolphin is a Gamecube and Wii emulator.

Website: https://dolphin-emu.org/

Github: https://github.com/dolphin-emu/dolphin

Compatibility List: https://dolphin-emu.org/compat/

Updating this Emulator:

  • Use Discover (Shopping Bag icon) to update Dolphin

Dolphin Table of Contents

  1. Getting Started with Dolphin

  2. Dolphin Tips and Tricks

Getting Started with Dolphin

Back to the Top

Dolphin is a fairly straight-forward emulator to set up. Place your Wii ROMs in Emulation/roms/wii and your Gamecube ROMs in either Emulation/roms/gc or Emulation/roms/gamecube. No additional setup is required. Read the Configuration section to learn more about Dolphin 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 Gamecube or Wii ROMs:

  • EmulationStation-DE
  • Nintendo GameCube - Dolphin or Nintendo Wii - Dolphin
  • Emulators

Dolphin Configuration

Back to the Top

  • Type of Emulator: Flatpak
  • Config Location: /home/deck/.var/app/org.DolphinEmu.dolphin-emu
  • Gamecube Profiles: /home/deck/.var/app/org.DolphinEmu.dolphin-emu/config/dolphin-emu/Profiles/GCPad
  • Wii Profiles: /home/deck/.var/app/org.DolphinEmu.dolphin-emu/config/dolphin-emu/Profiles/Wiimote
  • ROM location (Gamecube): Emulation/roms/gc or Emulation/roms/gamecube
  • ROM location (Wii): Emulation/roms/wii
    • No BIOS are required to play Gamecube or Wii ROMs
  • Dolphin does not need any additional BIOS files to run
  • Saves (Wii):
    • Symlink: Emulation/saves/dolphin/Wii
    • Target: /home/deck/.var/app/org.DolphinEmu.dolphin-emu/data/dolphin-emu/Wii
  • Saves (Gamecube):
    • Symlink: Emulation/saves/dolphin/GC
    • Target: /home/deck/.var/app/org.DolphinEmu.dolphin-emu/data/dolphin-emu/GC
  • Savestates (Wii):
    • Symlink: Emulation/saves/dolphin/StateSaves
    • Target: /home/deck/.var/app/org.DolphinEmu.dolphin-emu/data/dolphin-emu/StateSaves
  • Savestates (Gamecube):
    • Symlink: Emulation/saves/dolphin/StateSaves
    • Target: /home/deck/.var/app/org.DolphinEmu.dolphin-emu/data/dolphin-emu/StateSaves
  • Gamecube BIOS (Optional): /home/deck/.var/app/org.DolphinEmu.dolphin-emu/data/dolphin-emu/GC/USA/IPL.bin
    • After placing the IPL.bin here, you will need to:
      1. Open the Dolphin emulator
      2. Open the Configuration settings
      3. Click the Gamecube tab
      4. uncheck Skip Main Menu
  • Wii Menu (Optional): Open the Dolphin emulator, click Tools at the top, click Perform System Update, select a Region

Note: ~/.var 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.

Works With

  • Steam ROM Manager
  • EmulationStation-DE

How to Update Dolphin

Back to the Top

How to Update Dolphin

  • Through the Update your Emulators & Tools section on the Manage Emulators page in the EmuDeck application
  • Run Update Emulators & Tools in EmuDeck

How to Launch Dolphin in Desktop Mode

Back to the Top

How to Launch Dolphin in Desktop Mode

  • Launch Dolphin Emulator (Blue Dolphin Icon) from the Applications Launcher (Steam Deck icon in the bottom left of the taskbar)
    • Icon:
  • Launch the script from Emulation/tools/launchers, dolphin-emu.sh
  • Launch the emulator from Steam after adding it via the Emulators parser in Steam ROM Manager

Dolphin File Formats

Back to the Top

  • .ciso
  • .dol
  • .elf
  • .gcm
  • .gcz
  • .iso
  • .nkit
  • .iso
  • .rvz
  • .wad
  • .wia
  • .wbfs

Dolphin Hotkeys

Back to the Top

Important Note: Dolphin does not have a way of opening the menu if you are launching the game directly. It is recommended that you change any settings in the Dolphin UI itself before launching a game.

Hotkey Dolphin
Menu N/A
Exit Select + Start
Pause/Unpause Select + A
Fast Forward (Hold) Select + R2
Save State Select + R1
Load State Select + L1
Next Save Slot Start + R1
Previous Save Slot Start + L1
Shake Nunchuk L2
Shake Wiimote L1
Tilt Wiimote L2 + Move Left Stick
Sideways Toggle Select + R3
Attach/Detach Nunchuk Select + Left Stick Down
Next Wii Profile Select Select + Left Stick Right
Previous Wii Profile Select Select + Left Stick Left
Next Game Profile Select Select + Left Stick Up
Previous Game Profile Select Select + Left Stick Down
Toggle Aspect Ratio Start + DPAD Right
Increase Internal Resolution Start + DPAD Up
Decrease Internal Resolution Start + DPAD Down
Reset A + B + X + Y + L1 + R1
Unlock FPS* Start + R2
Increase Emulator Speed* Select + R2
Decrease Emulator Speed* Select + L2

IMPORTANT

  • A * next to the hotkey means it is only mapped in the EmuDeck Beta

List of Wii Profiles Included with EmuDeck

  • Wiimote with Nunchuk
  • Wiimote with Nunchuk and Touchpad Support
  • Wiimote with No Attachment
  • Wiimote with No Attachment and Touchpad Support
  • Wii Classic Controller

Steam Deck Button Layout: https://github.com/dragoonDorise/EmuDeck/wiki/Hotkeys#steam-deck-button-layout

Dolphin Tips and Tricks

Back to the Top

How to Configure Gyro

Back to the Top

Gyro for Dolphin requires SteamDeckGyroDSU. SteamDeckGyroDSU can be installed via EmuDeck, or it can be installed manually.

IMPORTANT

Gyro for Dolphin is not mapped out of the box. You will need to open the Dolphin emulator and configure gyro controls after installing SteamDeckGyroDSU.

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 Optimize Storage (Compression Tool)

Back to the Top

To optimize storage, you can use the EmuDeck Compressor within EmuDeck.

The EmuDeck Compressor will compress your Gamecube and Wii ROMs from ISO to RVZ.

After running the EmuDeck Compression Tool, re-run Steam ROM Manager to update your ROM shortcuts to the newly compressed ROM.

Visual Reference:

How to Manage Multiple Discs

Back to the Top

M3U files can be used to manage multiple discs for Dolphin. With the Change Discs Automatically option toggled (turned on by default with EmuDeck), Dolphin will automatically switch discs in combination with an M3U file.

Learn how to create an M3U File: https://github.com/dragoonDorise/EmuDeck/wiki/file-management#how-to-manage-roms-with-multiple-discs.

How to Configure Multiplayer

Back to the Top

EmuDeck configures multiplayer out of the box. You do not need to configure the controls. However, to properly setup multiplayer, you will need to enable the additional ports.

Tutorial

  1. Open the Dolphin emulator
  2. Open the Controller settings
  3. For each controller you are using:
    1. Gamecube: To the right of each Port # under Gamecube Controllers, enable Standard Controller
    2. Wii: To the right of each Port # under Wii Remotes, enable Emulated Wii Remote

How To Install Custom Textures

Back to the Top

Here's how to install custom textures for Dolphin:

  1. Open the Dolphin emulator, right click the game you would like to install custom textures for, click Properties, click the Info tab, note down the GameID.
  2. In the Dolphin emulator, click Graphics in the top right (or Options > Graphic Settings), click Advanced, make sure Load Custom Textures and Prefetch Custom Textures are checked.
    • Visual Reference:
  3. Open /home/deck/.var/app/org.DolphinEmu.dolphin-emu/data/dolphin-emu/Load/Textures
    • ~/.var 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.
    • If the Load and Textures folder do not exist, create them.
  4. In the Textures folder from Step 2, create a folder matching the first 3 characters of the GameID from Step 1.
    • Example: Pokémon XD: Gale of Darkness
      • Original Game ID: GXXP01 (PAL Region)
      • Folder Name: GXX
  5. Put your texture files directly into this folder.
  6. Your texture pack should now be installed.
    • If the game crashes with custom textures, it is likely too demanding for the Steam Deck. You can turn off Prefetch Custom Textures as a workaround, but performance will still take a hit.

For a visual, watch the following GIF:

How to Create Dolphin Controller Profiles

Back to the Top

Preface

  1. This section goes over how to create a Dolphin controller profile and set it for a specific game. However, you can use this profile for any Gamecube/Wii game. While in game, you can use the following hotkeys to cycle through profiles:
    1. Wii: Select + tilt the Left Joystick Left or Right
    2. Gamecube: Select + tilt the Left Joystick Up or `Down
  2. EmuDeck currently comes with 6 profiles for Wii and 2 profiles for Gamecube. You can use these as a base to create a profile for your game of choice, using this section's tutorial.
    1. For a list of EmuDeck's profiles (you do not need to download any of these, use the links as a reference):
    2. Wii: https://github.com/dragoonDorise/EmuDeck/tree/main/configs/org.DolphinEmu.dolphin-emu/config/dolphin-emu/Profiles/Wiimote
    3. Gamecube: https://github.com/dragoonDorise/EmuDeck/tree/main/configs/org.DolphinEmu.dolphin-emu/config/dolphin-emu/Profiles/GCPad
  3. Warning: Creating too many controller configurations may make it difficult to cycle through and pick the one you would like to use.

Tutorial

  1. Open the Dolphin emulator, click Options at the top, click Controller Settings.
  2. Select a system:
    1. For Gamecube: Click Configure to the right of Port 1 Standard Controller
    2. For Wii: Click Configure to the right of Wii Remote 1 Emulated Wii Remote
  3. On this screen, configure your controllers however you like.
  4. After you have finished configuring your controls, in the top right under Profile, enter the profile name you would like to use.
  5. Click Save to the right.
    2. I named my profile EXAMPLE
  6. Close out of the Controller Settings menu.
  7. To use this profile, choose one of the following methods:
    1. Set it for a specific game: #how-to-set-dolphin-controller-profiles-on-a-per-game-basis
    2. Select the profile in game, by tilting the Left Joystick, Left or Right (For Wii) or Up or Down (For Gamecube), until your profile name appears in the top left.
      1. View the full list of Dolphin hotkeys here: Hotkeys

How to Share Your Dolphin Controller Profile

Back to the Top

Refer to https://github.com/dragoonDorise/EmuDeck/wiki/community-creations#sharing-dolphin-profiles, for instructions and a page to collect Dolphin profiles.

How to Set Dolphin Controller Profiles On a Per-Game Basis

Back to the Top

  1. Choose a controller profile (use one of the following methods):
    1. Download a controller profile with an .ini extension type
      1. View community layouts: https://github.com/dragoonDorise/EmuDeck/wiki/community-creations#dolphin
    2. Use one of EmuDeck's included layouts
      1. For a list of EmuDeck's profiles (you do not need to download any of these, use the links as a reference):
      2. Wii: https://github.com/dragoonDorise/EmuDeck/tree/main/configs/org.DolphinEmu.dolphin-emu/config/dolphin-emu/Profiles/Wiimote
      3. Gamecube: https://github.com/dragoonDorise/EmuDeck/tree/main/configs/org.DolphinEmu.dolphin-emu/config/dolphin-emu/Profiles/GCPad
    3. Create a controller profile in the Dolphin GUI
      1. Tutorial: How to Create Dolphin Controller Profiles
  2. (Optional) Place your controller profile in either the Gamecube or the Wii Profile folder
    1. Skip this step if you are using an EmuDeck included layout or a profile you created in the Dolphin GUI
    2. Gamecube Profiles: /home/deck/.var/app/org.DolphinEmu.dolphin-emu/config/dolphin-emu/Profiles/GCPad
    3. Wii Profiles: /home/deck/.var/app/org.DolphinEmu.dolphin-emu/config/dolphin-emu/Profiles/Wiimote
  3. Open the Dolphin emulator
  4. Right click the game you would like to use this controller profile for, and click Properties
  5. On the Game Config tab, press the Editor sub-tab
  6. Under User Config, enter a controller profile using the following template:
    • For SelectedProfileName, only type the name of the profile, not the file path to the profile

Wii:

[Controls] 
WiimoteProfile1 = SelectedProfileName

Gamecube:

[Controls] 
PadProfile1 = SelectedProfileName

Example (using EXAMPLE profile):

  1. Exit out, and your game should now be using the selected profile

For additional information, read Dolphin's GameINI (Controller Settings) Wiki Page: https://wiki.dolphin-emu.org/index.php?title=GameINI_(Controller_Settings)

How to Configure Wii Games To Use A Gamecube Controller

Back to the Top

  1. Right click a Wii game
  2. Click Properties
  3. Click the Game Config tab
  4. Click the Editor tab
  5. Under User Config, enter the following
[Controls]
PadType0 = 6
PadProfile1 = GC_base
WiimoteSource0 = 0
  1. Click OK and your Wii game should now be using a Gamecube controller profile

Multiplayer

Use the following template:

[Controls]
PadType0 = 6
PadType1 = 6
PadType2 = 6
PadType3 = 6
PadProfile1 = GC_base
WiimoteSource0 = 0
WiimoteSource1 = 0
WiimoteSource2 = 0
WiimoteSource3 = 0

For additional information, read Dolphin's GameINI (Controller Settings) Wiki Page: https://wiki.dolphin-emu.org/index.php?title=GameINI_(Controller_Settings)

How to Set Game Settings On a Per-Game Basis

Back to the Top

  1. In Desktop Mode, Open the Dolphin emulator
  2. Right click a game
  3. Click Properties
  4. Click the Editor tab
  5. Under User Config, add your configurations, use: https://wiki.dolphin-emu.org/index.php?title=GameINI for a full list
    1. You also need to include the headers. For example, any settings under the [Core] section need to include [Core] preceding the respective setting(s)

Example, to use OpenGL for only Super Paper Mario:

Example Use Cases for Custom Game Settings

  • Setting Aspect Ratio on a per game basis
  • Setting OpenGL on a per game basis
  • Setting Widescreen Hacks on a per game basis

Specific Use Cases for Custom Game Settings

  • Pokemon Colosseum: Aspect Ratio keeps changing
    • Copy and paste the below lines into the INI editor for Pokemon Colosseum
[Video_Settings]
wideScreenHack = False
AspectRatio = 2

How to Use Riivolution Patches

Back to the Top

Note: You will need the base game of the respective Riivolution patch to apply the patch. For example, the Riivolution patch Newer Super Mario Bros. Wii requires a copy of the New Super Mario Bros. Wii ROM in Emulation/roms/wii.

Riivolution Patch - Content

If your Riivolution patch includes additional content, follow the below steps. If not, skip to the next section.

  1. Place your Riivolution content folder in /home/deck/.var/app/org.DolphinEmu.dolphin-emu/data/dolphin-emu/Load
    • ~/.var 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

This may not apply to all Riivolution patches, read any attached instructions or the associated website for further help.

Riivolution Patch - XML File

  1. Place your Riivolution patch file in /home/deck/.var/app/org.DolphinEmu.dolphin-emu/data/dolphin-emu/Load/Riivolution/
    • ~/.var 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
    • A Riivolution patch file is generally a .xml file
  2. Open the Dolphin Emulator
  3. Right click the base game and select Start with Riivolution patches...
  4. Click Open Riivolution XML... and select a Riivolution patch
  5. Click Save as Preset...
  6. Name the preset with a .json file extension
    • The file name of the JSON file is up to you. However, it is recommended you match the JSON file as closely as possible to the Riivolution patch name so Steam ROM Manager and EmulationStation-DE can scrape the appropriate game art or game info
  7. Save your preset file with a .json file extension to Emulation/roms/wii
    • If the bottom left box to append .json does not exist, you can instead type the full name and add .json manually at the end of the full name. For example, Newer Super Mario Bros. Wii, type Newer Super Mario Bros. Wii.json into the box
  8. Your Riivolution patch will now be playable as a stand-alone game
    • Parse it through Steam ROM Manager or play it through EmulationStation-DE

Keep in Mind

  • Some Riivolution patches may require additional steps. Read any attached instructions or the associated website for further help.
  • If a Riivolution patch includes extra content, the root directory generally means: /home/deck/.var/app/org.DolphinEmu.dolphin-emu/data/dolphin-emu/Load/. Place any additional content from the patch here. This does not apply to all Riivolution patches, read any attached instructions or the associated website for further help.
  • Linux is case sensitive. If a patch includes extra content and Dolphin is not identifying it, you may want to read the included XML files and folders to look for any casing mismatches. This does not apply to all Riivolution patches, read any attached instructions or the associated website for further help.

Known Riivolution Patch Fixes

  • Mario Kart Midnight
    • Open the included Mario Kart Midnight.xml in a text editor and capitalize the L in loader{$__region}.bin
  • Mario Kart Wii Deluxe
    • Rename the included mkwdx folder to MKWDX

How to Configure Real Wiimotes

Back to the Top

How to Configure Real Wiimotes

  1. In Desktop Mode, open Dolphin
  2. Open the controller settings
  3. Under Wii Remotes, select Real Wii Remote under the drop-down list next to Wii Remote 1 and check Continuous Scanning at the bottom of the screen
  4. Return to Game Mode
  5. Open a Wii game, and press 1 and 2 on the Wiimote at the same time

IMPORTANT

  • Do not pair the Wiimote to the Steam Deck

For Further Reading: https://dolphin-emu.org/docs/guides/configuring-controllers/

How to Use a Mayflash DolphinBar in Game Mode

Back to the Top

Preface: To use the Mayflash DolphinBar, you need to blacklist it from Steam to properly allow it to work with Dolphin in Game Mode.

Note: This section is specifically for the Mayflash Dolphinbar. Read: How to Configure Real Wiimotes, for information on how to configure Real Wiimotes.

How to Use a Mayflash DolphinBar in Game Mode

  1. Back up /home/deck/.local/share/Steam/config/config.vdf
  2. Exit out of Steam
    • If Steam is not closed, any edits you make to config.vdf will be reverted
  3. Right click config.vdf, click Open with Kate
  4. Add the following to the end of the file, on a new line before the final } and save
"controller_blacklist"        "57e/0306,57e/0306,57e/0306,57e/0306"
  1. Make sure Wii Emulator Mode is toggled on the Mayflash DolphinBar by clicking the MODE button (LED 4)