Dolphin is a GameCube / Wii emulator, allowing you to play games for these two platforms on PC with improvements.
Go to file
Stenzek efbb85da43 D3D12: Improve robustness of command allocator and fence tracking 2016-02-28 17:18:39 +10:00
CMakeTests Extend libav check to find versions without pkg-config 2016-02-11 15:34:34 -06:00
Data Merge pull request #3674 from RisingFog/weeaboo_ini 2016-02-26 21:41:55 +01:00
Externals D3D12: Add d3dx12.h helper library to Externals 2016-02-15 09:48:23 -08:00
Installer Merge pull request #3654 from jcowgill/desktop-remove-shebang 2016-02-20 16:53:01 +01:00
Languages Automatic translation template update 2016-02-24 19:49:19 +00:00
Source D3D12: Improve robustness of command allocator and fence tracking 2016-02-28 17:18:39 +10:00
Tools Add linter script which will replace the ad-hoc commands ran by the linter Buildbot. 2015-10-31 18:43:37 +01:00
docs Audio: new dsp_coef.bin with windowed sinc filter coefficients 2015-06-29 22:24:24 -04:00
.gitignore Ignore vim swapfiles 2015-05-02 23:34:23 -07:00
.gitmodules Add Qt submodule for windows. 2014-09-15 15:07:42 -07:00
.mailmap Add a .mailmap file 2014-12-23 09:34:56 +01:00
AndroidSetup.md Android: Add detailed instructions for setting up a build environment 2015-07-11 17:14:37 -04:00
CMakeLists.txt Replace the XPM desktop icon with an SVG 2016-02-20 15:32:52 +00:00
Contributing.md Add a sample snippet to illustrate indentation/alignment 2016-02-24 21:51:59 +01:00
Readme.md Correct Windows version requirement in Readme.md 2015-10-02 18:23:54 +02:00
license.txt Engrish. :) 2008-12-01 09:49:24 +00:00

Readme.md

Dolphin - A GameCube / Wii / Triforce Emulator

Homepage | Project Site | Forums | Wiki | Issue Tracker | Coding Style | Transifex Page

Dolphin is an emulator for running GameCube, Wii, and Triforce games on Windows, Linux, OS X, and recent Android devices. It's licensed under the terms of the GNU General Public License, version 2 or later (GPLv2+).

Please read the FAQ before using Dolphin.

System Requirements

Desktop

  • OS
    • Windows (7 SP1 or higher is officially supported, but Vista SP2 might also work).
    • Linux.
    • OS X (10.9 Mavericks or higher).
    • Unix-like systems other than Linux are not officially supported but might work.
  • Processor
    • A CPU with SSE2 support.
    • A modern CPU (3 GHz and Dual Core, not older than 2008) is highly recommended.
  • Graphics
    • A reasonably modern graphics card (Direct3D 10.0 / OpenGL 3.0).
    • A graphics card that supports Direct3D 11 / OpenGL 4.4 is recommended.

Android

  • OS
    • Android 5.0 (Lollipop) or higher.
  • Processor
    • An ARM processor with support for 64-bit applications. (An Intel x86 processor could also work in theory, but no known x86 devices support 64-bit applications.)
  • Graphics
    • A graphics processor that supports OpenGL ES 3.0 or higher. Performance varies heavily with driver quality.
    • A graphics processor that supports standard desktop OpenGL features is recommended for best performance.

Dolphin can only be installed on devices that satisfy the above requirements. Attempting to install on an unsupported device will fail and display an error message.

Building for Windows

Use the solution file Source/dolphin-emu.sln to build Dolphin on Windows. Visual Studio 2015 is a hard requirement. Other compilers might be able to build Dolphin on Windows but have not been tested and are not recommended to be used.

An installer can be created by using the Installer_win32.nsi and Installer_x64.nsi scripts in the Installer directory. This will require the Nullsoft Scriptable Install System (NSIS) to be installed. Creating an installer is not necessary to run Dolphin since the Build directory contains a working Dolphin distribution.

Building for Linux and OS X

Dolphin requires CMake for systems other than Windows. Many libraries are bundled with Dolphin and used if they're not installed on your system. CMake will inform you if a bundled library is used or if you need to install any missing packages yourself.

Build Steps:

  1. mkdir Build
  2. cd Build
  3. cmake ..
  4. make

On OS X, an application bundle will be created in ./Binaries.

On Linux, it's strongly recommended to perform a global installation via sudo make install.

Building for Android

These instructions assume familiarity with Android development. If you do not have an Android dev environment set up, see AndroidSetup.md.

If using Android Studio, import the Gradle project located in ./Source/Android.

Android apps are compiled using a build system called Gradle. Dolphin's native component, however, is compiled using CMake. The Gradle script will attempt to run a CMake build automatically while building the Java code, if you create the file Source/Android/build.properties, and place the following inside:

# Specifies arguments for the 'make' command. Can be blank.
makeArgs=

# The path to your machine's Git executable. Will autodetect if blank (on Linux only).
gitPath=

# The path to the CMake executable. Will autodetect if blank (on Linux only).
cmakePath=

# The path to the extracted NDK package. Will autodetect if blank (on Linux only).
ndkPath=

If you prefer, you can run the CMake step manually, and it will copy the resulting binary into the correct location for inclusion in the Android APK.

Execute the Gradle task assembleArm_64Debug to build, or installArm_64Debug to install the application onto a connected device. If other ABIs are eventually supported, execute the tasks corresponding to the desired ABI.

Uninstalling

When Dolphin has been installed with the NSIS installer, you can uninstall Dolphin like any other Windows application.

Linux users can run cat install_manifest.txt | xargs -d '\n' rm as root from the build directory to uninstall Dolphin from their system.

OS X users can simply delete Dolphin.app to uninstall it.

Additionally, you'll want to remove the global user directory (see below to see where it's stored) if you don't plan to reinstall Dolphin.

Command Line Usage

Usage: Dolphin [-h] [-d] [-l] [-e <str>] [-b] [-V <str>] [-A <str>]

  • -h, --help Show this help message
  • -d, --debugger Opens the debugger
  • -l, --logger Opens the logger
  • -e, --exec= Loads the specified file (DOL,ELF,WAD,GCM,ISO)
  • -b, --batch Exit Dolphin with emulator
  • -V, --video_backend= Specify a video backend
  • -A, --audio_emulation= Low level (LLE) or high level (HLE) audio

Available DSP emulation engines are HLE (High Level Emulation) and LLE (Low Level Emulation). HLE is fast but often less accurate while LLE is slow but close to perfect. Note that LLE has two submodes (Interpreter and Recompiler), which cannot be selected from the command line.

Available video backends are "D3D" (only available on Windows) and "OGL". There's also "Software Renderer", which uses the CPU for rendering and is intended for debugging purposes only.

Sys Files

  • totaldb.dsy: Database of symbols (for devs only)
  • GC/font_ansi.bin: font dumps
  • GC/font_sjis.bin: font dumps
  • GC/dsp_coef.bin: DSP dumps
  • GC/dsp_rom.bin: DSP dumps
  • Wii/clientca.pem: Wii network certificate
  • Wii/clientcacakey.pem: Wii network certificate
  • Wii/rootca.pem: Wii network certificate

The DSP dumps included with Dolphin have been written from scratch and do not contain any copyrighted material. They should work for most purposes, however some games implement copy protection by checksumming the dumps. You will need to dump the DSP files from a console and replace the default dumps if you want to fix those issues.

Wii network certificates must be extracted from a Wii IOS. A guide for that can be found here.

Folder Structure

These folders are installed read-only and should not be changed:

  • GameSettings: per-game default settings database
  • GC: DSP and font dumps
  • Maps: symbol tables (dev only)
  • Shaders: post-processing shaders
  • Themes: icon themes for GUI
  • Resources: icons that are theme-agnostic
  • Wii: default Wii NAND contents

User Folder Structure

A number of user writeable directories are created for caching purposes or for allowing the user to edit their contents. On OS X and Linux these folders are stored in ~/Library/Application Support/Dolphin/ and ~/.dolphin-emu respectively. On Windows the user directory is stored in the My Documents folder by default, but there are various way to override this behavior:

  • Creating a file called portable.txt next to the Dolphin executable will store the user directory in a local directory called "User" next to the Dolphin executable.
  • If the registry string value LocalUserConfig exists in HKEY_CURRENT_USER/Software/Dolphin Emulator and has the value 1, Dolphin will always start in portable mode.
  • If the registry string value UserConfigPath exists in HKEY_CURRENT_USER/Software/Dolphin Emulator, the user folders will be stored in the directory given by that string. The other two methods will be prioritized over this setting.

List of user folders:

  • Cache: used to cache the ISO list
  • Config: configuration files
  • Dump: anything dumped from Dolphin
  • GameConfig: additional settings to be applied per-game
  • GC: memory cards and system BIOS
  • Load: custom textures
  • Logs: logs, if enabled
  • ScreenShots: screenshots taken via Dolphin
  • StateSaves: save states
  • Wii: Wii NAND contents

Custom Textures

Custom textures have to be placed in the user directory under Load/Textures/[GameID]/. You can find the Game ID by right-clicking a game in the ISO list and selecting "ISO Properties".