diff --git a/Readme.md b/Readme.md index a5143078fd..7f7563edbb 100644 --- a/Readme.md +++ b/Readme.md @@ -1,6 +1,6 @@ # Dolphin - A Gamecube / Triforce / Wii Emulator -[Homepage](http://dolphin-emu.org/) | [Project Site](https://github.com/dolphin-emu/dolphin) | [Forums](http://forums.dolphin-emu.org/) | [Wiki](http://wiki.dolphin-emu.org/) +[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/) Dolphin is an emulator for running Gamecube, Triforce and Wii games on Windows/Linux/OS X systems and recent Android devices. It's licensed under @@ -21,13 +21,13 @@ Please read the [FAQ](http://dolphin-emu.org/docs/faq/) before use. * A graphics card that supports Direct3D 11 / OpenGL 4.4 is recommended. ## Installation on Windows -Use the solution file Source/dolphin-emu.sln to build Dolphin on Windows. +Use the solution file `Source/dolphin-emu.sln` to build Dolphin on Windows. Visual Studio 2013 is a hard requirement since previous versions don't support many C++ features that we use. 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 +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. @@ -39,21 +39,20 @@ 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 +1. `mkdir Build` +2. `cd Build` +3. `cmake ..` +4. `make` -On OS X, an application bundle will be created in ./Binaries. +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". +On Linux, it's strongly recommended to perform a global installation via `sudo make install`. ## 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 | xargs -d '\n' rm" from the build directory +Linux users can run `cat install_manifest | xargs -d '\n' rm` from the build directory to uninstall Dolphin from their system. OS X users can simply delete Dolphin.app to uninstall it. @@ -62,7 +61,7 @@ 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 ] [-b] [-V ] [-A ] +`Usage: Dolphin [-h] [-d] [-l] [-e ] [-b] [-V ] [-A ]` * -h, --help Show this help message * -d, --debugger Opens the debugger @@ -82,11 +81,11 @@ Available video backends are "D3D" (only available on Windows Vista or higher), 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 +* `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 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 @@ -97,46 +96,46 @@ to fix those issues. ## 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 -* Wii: default Wii NAND contents +* `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 +* `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" +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 +* 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/Dolphin Emulator" and has the value "1", Dolphin will +* If the registry string value `LocalUserConfig` exists in + `HKEY_CURRENT_USER/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/Dolphin Emulator", the user folders will be stored in the +* If the registry string value `UserConfigPath` exists in + `HKEY_CURRENT_USER/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 -* Load: custom textures -* Logs: logs, if enabled -* ScreenShots: screenshots taken via Dolphin -* StateSaves: save states -* Wii: Wii NAND contents +* `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 +* `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 +`Load/Textures/[GameID]/`. You can find the Game ID by right-clicking a game in the ISO list and selecting "ISO Properties".