# Dolphin - General Guide Dolphin logo Dolphin feature rich a GameCube and Wii Emulator. --- ## Links ### Dolphin | Resource | Link | |----------|------| | Dolphin - Webpage | [Link](https://dolphin-emu.org/) | | Dolphin - Wiki | [Link](https://wiki.dolphin-emu.org/index.php?title=Main_Page) | | Dolphin - Game Compatibility | [Link](https://dolphin-emu.org/compat/) | | Dolphin - Performance Guide | [Link](https://dolphin-emu.org/docs/guides/performance-guide/) | | Dolphin - Github | [Link](https://github.com/dolphin-emu/dolphin) | --- ## Where to put the games? **Gamecube:** Should be put under the `retrodeck/roms/gc/` directory. **Wii:** Should be put under the `retrodeck/roms/wii/` directory. ## What file formats are supported? | File Format | Description | |-------------|-------------| | .ciso | Compressed ISO image file | | .dff | Digital Forensics File | | .dol | GameCube executable file | | .elf | Executable and Linkable Format | | .gcm | GameCube disc image file | | .gcz | Compressed GameCube disc image | | .iso | Standard ISO disc image | | .json | JavaScript Object Notation file | | .m3u | Playlist file | | .rvz | Compressed GameCube/Wii disc image **(Recommended)** | | .tgc | GameCube disc image format | | .wad | WiiWare and Virtual Console game file | | .wbfs | Wii Backup File System image | | .wia | Compressed Wii disc image | | .7z | Compressed archive file | | .zip | Compressed archive file | **NOTE:** `.wbfs` and `.wad` are the original format supported by the Wii console. ## Does Dolphin require BIOS, Game Data or Firmware files? | File Name | Description | |-----------|-------------| | `IPL.bin` | GameCube boot animation (optional) | | `segaboot.gcm` | Triforce BIOS. | ### Where to put the GameCube BIOS? Dolphin looks for the `IPL.bin` in the save folders. Put each region's `IPL.bin` in the corresponding saves folder. | File Name | Directory | Comment | |:------------------:|:-------------------------------------|:-------------------| | `IPL.bin` EU | `retrodeck/saves/gc/dolphin/EU/` | dolphin-emu/GC/EUR/ | | `IPL.bin` JP | `retrodeck/saves/gc/dolphin/JP/` | dolphin-emu/GC/JAP/ | | `IPL.bin` US | `retrodeck/saves/gc/dolphin/US/` | dolphin-emu/GC/USA/ | ### Where to put the Triforce BIOS? | File Name | Directory | Comment | |:------------------:|:-------------------------------------|:-------------------| | `segaboot.gcm` | `retrodeck/bios/Triforce/` | dolphin-emu/Trifoce/ | --- ## Directory structure --- ### Dolphin This shows what folder corresponds to each folder in the standard Dolphin structure | Type | Directory | Comment | |:------------------:|:-------------------------------------|:-------------------------------| | Dump | `retrodeck/storage/Dolphin/Dump/` | dolphin-emu/Dump | | GameCube Saves EU | `retrodeck/saves/gc/dolphin/EU/` | dolphin-emu/GC/EUR/ | | GameCube Saves JP | `retrodeck/saves/gc/dolphin/JP/` | dolphin-emu/GC/JAP/ | | GameCube Saves US | `retrodeck/saves/gc/dolphin/US/` | dolphin-emu/GC/USA/ | | Triforce BIOS | `retrodeck/bios/Triforce/` | dolphin-emu/Trifoce/ | | Mods | `retrodeck/mods/Dolphin/` | dolphin-emu/Load/GraphicMods/ | | ROMs Gamecube | `retrodeck/roms/gc/` | | | ROMs Wii | `retrodeck/roms/wii/` | | | Screenshots | `retrodeck/screenshots/Dolphin/` | dolphin-emu/ScreenShots/ | | Shaders | `retrodeck/shaders/Dolphin/` | dolphin-emu/Shaders | | States | `retrodeck/states/dolphin/` | dolphin-emu/StateSaves/ | | Texture Packs | `retrodeck/texture_packs/Dolphin/Textures` | dolphin-emu/Load/Textures/ | | Wii Saves | `retrodeck/saves/wii/dolphin/` | dolphin-emu/Wii/ | --- ## How-to: Change the language of Dolphin 1. In the `Configurator` open either `Dolphin`. 2. Navigate to `Options` → `Configuration` → `Interface` . 3. Select preferred language in the drop-down menu. 4. Close the Emulator, Configurator and return to RetroDECK. --- ## How-to: Enable GameCube Boot Main Menu **Prerequisite:** Place the GameCube `IPL.bin` BIOS in the save folders (see above). 1. Open Dolphin in `RetroDECK Configurator` by selecting `Open Emulator` → `Dolphin`. 2. Go to `Options` → `Configuration` → `GameCube` and uncheck `Skip Main Menu`. --- ## How-to: Enable Wii System Menu - Online Update 1. **RetroDECK Configurator** → Open Components. 2. Launch **Dolphin** 3. Go to `Tools` → `Perform Online System Update` → Select the Region you want for the System Menu and install it. 4. You can open the System Menu by going to: `Tools` → `Load Wii System Menu`. --- ## How-to: Enable Wii System Menu - BootMii NAND Backup 1. **RetroDECK Configurator** → Open Components. 2. Launch **Dolphin** 3. Go to: `Tools` → `Manage NAND` → `Import BootMii NAND Backup` then select your backup file. 4. You can open the System Menu by going to: `Tools` → `Load Wii System Menu`. --- ## Hot-to: Enable WiiLink Channels WiiLink is an open source replacement for Nintendo's servers for both WiiConnect24 and Nintendo Wi-Fi Connection, allowing online connectivity for all, even after the original servers were discontinued. - [Website: WiiLink](https://wiilink.ca/) - [GitHub: WiiLink Patcher Releases](https://github.com/WiiLink24/WiiLink-Patcher-GUI/releases) ### Prerequisites: Wii System Menu / NAND Backup - You must have either the Wii System Menu installed **or** a full BootMii NAND backup. - The `Check Mii Out` and `Everybody Votes` channels **require** a genuine BootMii NAND dump. - Make sure `Enable WiiConnect24` is checked in Dolphin: **RetroDECK Configurator** → Open Components → Launch **Dolphin** → `Options` → `Configuration` → `Wii` → `Enable WiiConnect24`. ### How-to: Install the Channels 1. Download the latest [WiiLink Patcher Releases](https://github.com/WiiLink24/WiiLink-Patcher-GUI/releases) for Linux from the GitHub releases page and extract it. 2. Make the `WiiLinkPatcherGUI` executable and launch it. 3. Choose **Custom Setup** in the installer. 4. Select the desired channels and their regions. 5. Set **Platform** to **Dolphin Emulator**. 6. Choose your system region. 7. The patcher downloads the selected files to `~/Downloads/WiiLink`. 8. **RetroDECK Configurator** → Open Components. 9. Launch **Dolphin** 10. Go to `Tools` → `Install WAD` 11. Install `WiiLink Address Settings.wad` first, then install the remaining WAD files you downloaded in `~/Downloads/WiiLink`. 12. Go to `Tools` → `Load Wii System Menu` and launch it. 13. Inside the systems menu go to: `Wii Options` → `Wii Settings` → `WiiConnect24` and accept the EULA. --- ## Adding Mods The `~/retrodeck/mods/dolphin/` that represents the `/load/GraphicMods` folder. **Note:** Some texture packs could made for a specific version or region of a game. Make sure you have the right game and textures for it. `GAME_ID` is different for every game. ### Enable Mods 1. Open up Dolphin inside `RetroDECK Configurator` by pressing `Open Emulator` - `Dolphin`. 2. Press `Options` → `Graphic Settings`. 3. `Enable Graphics Mods` and set it to `On`. ### Adding the mods 1. Extract any mod files from compressed `.zip` or any other format into folders. 2. Go into mods folders, they contain folders that are all named by `GAME_ID`. 3. Move the mods into the right folder: **Dolphin:** `~/retrodeck/mods/dolphin/` If all is correct the mods should be loaded on next game launch. --- ## Adding Texture Packs The `~/retrodeck/texture_packs/dolphin/Textures` represents the `/load/Textures` folder. Some texture packs could made for a specific version or region of a game. Make sure you have the right game and textures for it. `GAME_ID` is different for every game. ### Enable Custom Textures 1. Open up Dolphin inside `RetroDECK Configurator` by pressing `Open Emulator` - `Dolphin`. 2. Press `Options` → `Graphic Settings` 3. `Load Custom Textures` & `Prefetch Custom Textures` and set them to `On`. ### Adding the textures 1. Extract any texture pack files from compressed `.zip` or any other format into folders. 2. Go into texture pack folders, they contain folders that are all named by `GAME_ID`. 3. Move the textures into the right folder: **Dolphin:** `~/retrodeck/texture_packs/dolphin/Textures/` If all is correct the textures should be loaded on next game launch. --- ## Gamecube / Triforce Controls The controls here are described as an Xbox Layout style controller. | Action | Button | Comment | |:---------------:|:------------:|:-------:| | A | `A` | | | B | `B` | | | X | `X` | | | Y | `Y` | | | Z | `R2 or L2` | | | START | `START` | | | Control Stick | `Left Stick` | | | C Stick | `Right Stick`| | | D-Pad Up | `D-Pad Up` | | | D-Pad Down | `D-Pad Down` | | | D-Pad Left | `D-Pad Left` | | | D-Pad Right | `D-Pad Right`| | | Triforce Test Mode | `L3` | | | Triforce Service Mode | `R3` | | | Triforce Insert Credit | `SELECT`| | --- ## Wii Controls for Controllers The controls here are described as an Xbox Layout style controller. There are hotkeys in the Radial Menus to change the Wii Mote from Upright / Sidways. | Action | Button | Comment | |:-----------------:|:---------------------:|:-------:| | 1 | `Y` | | | 2 | `X` | | | A | `A` or `Left Mouse Click` | | | B | `B` | | | C | `R1` | | | D-Pad Down | `D-Pad Down` | | | D-Pad Left | `D-Pad Left` | | | D-Pad Right | `D-Pad Right` | | | D-Pad Up | `D-Pad Up` | | | Home | `R3` | | | + | `Start` | | | - | `Select` | | | Shake Nunchuck | `L1 + L2` | | | Shake Wii Mote | `L1` | | | Z | `L2` | | ### Wii Motion - Pointer Emulation - Mouse movement is the general way to to get the pointer emulation. - `Left Mouse Click` that correspons to a press of the `A` button (as that one is the one mostly used for Wii games that are based around pointing as the primary button). - [RetroDECK Hotkeys](../../wiki_rd_controls/hotkeys-retrodeck.md) features several ways to enable `Joystick as Mouse` Emulation. - You could also use a mouse / touchpad. ### Wii Motion - Tilt Emulation Tilt emulation is made possible by holding the `L2` button and moving the `Right Joystick`. | Action | Button | Comment | |:---------------:|:-------------------------:|:-------:| | Tilt Down | `L2 + Right Joystick Down`| | | Tilt Left | `L2 + Right Joystick Left`| | | Tilt Right | `L2 + Right Joystick Right`| | | Tilt Up | `L2 + Right Joystick Up` | | --- ## Using Real Wii Remotes How-to use Real Wii Remotes and Nunchuck hardware? **Read more here:** - [Using Real Wii Remotes](dolphin-wii-remote.md) --- ## Troubleshooting | Topic | Issue | Solution | |---|---|---| | **Wayland Windowing System** | Input mapping and GUI issues occur under Wayland. | Disable **Wayland Windowing System** via **Flatseal** for RetroDECK. | | **.m3u Files** | `.m3u` files do not launch. | Make sure the `.m3u` file is saved with **UNIX line endings** rather than Windows line endings. | | **Steam Deck OLED Flickering** | Some games may flicker on the Steam Deck OLED. | Lower the display refresh rate from **90Hz** to **60Hz**. | ---