Readme.md 8.98 KB
Newer Older
Pringo's avatar
Pringo committed
1
# Dolphin - A GameCube and Wii Emulator
2

Jules Blok's avatar
Jules Blok committed
3
[Homepage](https://dolphin-emu.org/) | [Project Site](https://github.com/dolphin-emu/dolphin) | [Forums](https://forums.dolphin-emu.org/) | [Wiki](https://wiki.dolphin-emu.org/) | [Issue Tracker](https://bugs.dolphin-emu.org/projects/emulator/issues) | [Coding Style](https://github.com/dolphin-emu/dolphin/blob/master/Contributing.md) | [Transifex Page](https://www.transifex.com/projects/p/dolphin-emu/)
Soren Jorvang's avatar
Meta:    
Soren Jorvang committed
4

JosJuice's avatar
JosJuice committed
5
Dolphin is an emulator for running GameCube and Wii games on Windows,
Pringo's avatar
Pringo committed
6
Linux, macOS, and recent Android devices. It's licensed under the terms
JosJuice's avatar
JosJuice committed
7
of the GNU General Public License, version 2 or later (GPLv2+).
Soren Jorvang's avatar
Meta:    
Soren Jorvang committed
8

Buddybenj's avatar
Buddybenj committed
9
Please read the [FAQ](https://dolphin-emu.org/docs/faq/) before using Dolphin.
Soren Jorvang's avatar
Meta:    
Soren Jorvang committed
10

11
## System Requirements
Roger's avatar
Roger committed
12

13
### Desktop
Roger's avatar
Roger committed
14

15
* OS
16
    * Windows (7 SP1 or higher).
17
    * Linux.
18
    * macOS (10.12 Sierra or higher).
19
    * Unix-like systems other than Linux are not officially supported but might work.
20
* Processor
21
22
    * A CPU with SSE2 support.
    * A modern CPU (3 GHz and Dual Core, not older than 2008) is highly recommended.
23
* Graphics
24
25
    * A reasonably modern graphics card (Direct3D 11.1 / OpenGL 3.3).
    * A graphics card that supports Direct3D 11.1 / OpenGL 4.4 is recommended.
26

27
### Android
Roger's avatar
Roger committed
28

29
* OS
Pringo's avatar
Pringo committed
30
    * Android (5.0 Lollipop or higher).
31
* Processor
32
    * A processor with support for 64-bit applications (either ARMv8 or x86-64).
33
34
35
36
37
38
* Graphics
    * A graphics processor that supports OpenGL ES 3.0 or higher. Performance varies heavily with [driver quality](https://dolphin-emu.org/blog/2013/09/26/dolphin-emulator-and-opengl-drivers-hall-fameshame/).
    * 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.

39
## Building for Windows
Roger's avatar
Roger committed
40

41
Use the solution file `Source/dolphin-emu.sln` to build Dolphin on Windows.
shuffle2's avatar
shuffle2 committed
42
Visual Studio 2019 16.3 or later is a hard requirement. Other compilers might be
JosJuice's avatar
JosJuice committed
43
able to build Dolphin on Windows but have not been tested and are not
44
recommended to be used. Git and Windows 10 SDK must be installed when building.
Soren Jorvang's avatar
Meta:    
Soren Jorvang committed
45

shuffle2's avatar
shuffle2 committed
46
Make sure to pull submodules before building:
47
48
49
50
```sh
git submodule update --init
```

51
52
53
The "Release" solution configuration includes performance optimizations for the best user experience but complicates debugging Dolphin.
The "Debug" solution configuration is significantly slower, more verbose and less permissive but makes debugging Dolphin easier.

54
An installer can be created by using the `Installer.nsi` script in the
55
56
57
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 Binary directory contains a working Dolphin distribution.
Soren Jorvang's avatar
Meta:    
Soren Jorvang committed
58

Pringo's avatar
Pringo committed
59
## Building for Linux and macOS
Roger's avatar
Roger committed
60

61
Dolphin requires [CMake](https://cmake.org/) for systems other than Windows. Many libraries are
Tony Wasserka's avatar
Tony Wasserka committed
62
63
64
65
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.

Pringo's avatar
Pringo committed
66
### macOS Build Steps:
Roger's avatar
Roger committed
67

68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
1. `mkdir build`
2. `cd build`
3. `cmake ..`
4. `make`

An application bundle will be created in `./Binaries`.

### Linux Global Build Steps:

To install to your system.

1. `mkdir build`
2. `cd build`
3. `cmake ..`
4. `make`
5. `sudo make install`

### Linux Local Build Steps:

Useful for development as root access is not required.

89
90
1. `mkdir Build`
2. `cd Build`
91
3. `cmake .. -DLINUX_LOCAL_DEV=true`
92
4. `make`
93
5. `ln -s ../../Data/Sys Binaries/`
Tony Wasserka's avatar
Tony Wasserka committed
94

95
### Linux Portable Build Steps:
Tony Wasserka's avatar
Tony Wasserka committed
96

97
98
99
100
101
102
103
104
105
Can be stored on external storage and used on different Linux systems.
Or useful for having multiple distinct Dolphin setups for testing/development/TAS.

1. `mkdir Build`
2. `cd Build`
3. `cmake .. -DLINUX_LOCAL_DEV=true`
4. `make`
5. `cp -r ../Data/Sys/ Binaries/`
6. `touch Binaries/portable.txt`
Tony Wasserka's avatar
Tony Wasserka committed
106

107
## Building for Android
108

109
110
111
These instructions assume familiarity with Android development. If you do not have an
Android dev environment set up, see [AndroidSetup.md](AndroidSetup.md).

Roger's avatar
Roger committed
112
If using Android Studio, import the Gradle project located in `./Source/Android`.
113
114
115

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
116
automatically while building the Java code.
117

118
## Uninstalling
Roger's avatar
Roger committed
119

Tony Wasserka's avatar
Tony Wasserka committed
120
121
122
When Dolphin has been installed with the NSIS installer, you can uninstall
Dolphin like any other Windows application.

123
Linux users can run `cat install_manifest.txt | xargs -d '\n' rm` as root from the build directory
Tony Wasserka's avatar
Tony Wasserka committed
124
125
to uninstall Dolphin from their system.

Pringo's avatar
Pringo committed
126
macOS users can simply delete Dolphin.app to uninstall it.
Tony Wasserka's avatar
Tony Wasserka committed
127
128
129

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.
Soren Jorvang's avatar
Meta:    
Soren Jorvang committed
130

131
## Command Line Usage
132

Roger's avatar
Roger committed
133
134
135
`Usage: Dolphin [-h] [-d] [-l] [-e <str>] [-b] [-V <str>] [-A <str>]`

* -h, --help Show this help message
136
137
138
* -d, --debugger Show the debugger pane and additional View menu options
* -l, --logger Open the logger
* -e, --exec=<str> Load the specified file (DOL,ELF,WAD,GCM,ISO)
Roger's avatar
Roger committed
139
140
141
* -b, --batch Exit Dolphin with emulator
* -V, --video_backend=<str> Specify a video backend
* -A, --audio_emulation=<str> Low level (LLE) or high level (HLE) audio
Tony Wasserka's avatar
Tony Wasserka committed
142
143

Available DSP emulation engines are HLE (High Level Emulation) and
Craftyawesome's avatar
Craftyawesome committed
144
145
146
LLE (Low Level Emulation). HLE is faster but less accurate whereas
LLE is slower but close to perfect. Note that LLE has two submodes (Interpreter and Recompiler) 
but they cannot be selected from the command line.
Tony Wasserka's avatar
Tony Wasserka committed
147

Craftyawesome's avatar
Craftyawesome committed
148
149
150
Available video backends are "D3D" and "D3D12" (they are only available on Windows), "OGL", and "Vulkan".
There's also "Null", which will not render anything, and
"Software Renderer", which uses the CPU for rendering and
151
is intended for debugging purposes only.
Soren Jorvang's avatar
Meta:    
Soren Jorvang committed
152

153
## Sys Files
Roger's avatar
Roger committed
154

155
* `wiitdb.txt`: Wii title database from [GameTDB](https://www.gametdb.com/)
156
* `totaldb.dsy`: Database of symbols (for devs only)
157
158
* `GC/font_western.bin`: font dumps
* `GC/font_japanese.bin`: font dumps
159
160
* `GC/dsp_coef.bin`: DSP dumps
* `GC/dsp_rom.bin`: DSP dumps
161
162
163
* `Wii/clientca.pem`: Wii network certificate
* `Wii/clientcacakey.pem`: Wii network certificate
* `Wii/rootca.pem`: Wii network certificate
Soren Jorvang's avatar
Meta:    
Soren Jorvang committed
164

Tony Wasserka's avatar
Tony Wasserka committed
165
166
167
168
169
170
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.

171
172
Wii network certificates must be extracted from a Wii IOS. A guide for that can be found [here](https://wiki.dolphin-emu.org/index.php?title=Wii_Network_Guide).

173
## Folder Structure
Roger's avatar
Roger committed
174

175
These folders are installed read-only and should not be changed:
Tony Wasserka's avatar
Tony Wasserka committed
176

177
178
179
180
181
* `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
182
* `Resources`: icons that are theme-agnostic
183
* `Wii`: default Wii NAND contents
Tony Wasserka's avatar
Tony Wasserka committed
184

185
## Packaging and udev
Roger's avatar
Roger committed
186

187
188
The Data folder contains a udev rule file for the official GameCube controller
adapter and the Mayflash DolphinBar. Package maintainers can use that file in their packages for Dolphin.
Roger's avatar
Roger committed
189
Users compiling Dolphin on Linux can also just copy the file to their udev
190
191
rules folder.

192
## User Folder Structure
Roger's avatar
Roger committed
193

Tony Wasserka's avatar
Tony Wasserka committed
194
A number of user writeable directories are created for caching purposes or for
Pringo's avatar
Pringo committed
195
allowing the user to edit their contents. On macOS and Linux these folders are
196
stored in `~/Library/Application Support/Dolphin/` and `~/.dolphin-emu`
197
198
respectively, but can be overwritten by setting the environment variable
`DOLPHIN_EMU_USERPATH`. On Windows the user directory is stored in the `My Documents`
Tony Wasserka's avatar
Tony Wasserka committed
199
folder by default, but there are various way to override this behavior:
200

201
* Creating a file called `portable.txt` next to the Dolphin executable will
Tony Wasserka's avatar
Tony Wasserka committed
202
203
  store the user directory in a local directory called "User" next to the
  Dolphin executable.
204
* If the registry string value `LocalUserConfig` exists in
205
206
  `HKEY_CURRENT_USER/Software/Dolphin Emulator` and has the value **1**,
  Dolphin will always start in portable mode.
207
* If the registry string value `UserConfigPath` exists in
208
209
210
  `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.
Tony Wasserka's avatar
Tony Wasserka committed
211
212

List of user folders:
213

214
215
* `Cache`: used to cache the ISO list
* `Config`: configuration files
Stevoisiak's avatar
Stevoisiak committed
216
* `Dump`: anything dumped from Dolphin
217
* `GameConfig`: additional settings to be applied per-game
Stevoisiak's avatar
Stevoisiak committed
218
* `GC`: memory cards and system BIOS
219
220
221
222
223
* `Load`: custom textures
* `Logs`: logs, if enabled
* `ScreenShots`: screenshots taken via Dolphin
* `StateSaves`: save states
* `Wii`: Wii NAND contents
224

225
## Custom Textures
Roger's avatar
Roger committed
226

Tony Wasserka's avatar
Tony Wasserka committed
227
Custom textures have to be placed in the user directory under
228
`Load/Textures/[GameID]/`. You can find the Game ID by right-clicking a game
Tony Wasserka's avatar
Tony Wasserka committed
229
in the ISO list and selecting "ISO Properties".