ShuriZma
/
dolphin
mirror of https://github.com/dolphin-emu/dolphin.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #6 from lioncash/readme-markdown 

Change the plain-text Readme.txt to a markdown-using Readme.md.
This commit is contained in:
neobrain 2014-01-29 06:45:10 -08:00
parent ac2ebd264d d7268dd176
commit 48cde2685c
1 changed files with 70 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

135
Readme.txt → Readme.md
View File

@ -1,25 +1,26 @@
Dolphin - A Gamecube / Triforce / Wii Emulator # Dolphin - A Gamecube / Triforce / Wii Emulator
==========================================
Homesite: http://dolphin-emu.org/ [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/)
Project Site: http://code.google.com/p/dolphin-emu
Dolphin is an emulator for running Gamecube, Triforce and Wii games on 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 Windows/Linux/OS X systems and recent Android devices. It's licensed under
the terms of the GNU General Public License, version 2 (GPLv2). the terms of the GNU General Public License, version 2 (GPLv2).
Team members: http://code.google.com/p/dolphin-emu/people/ Please read the [FAQ](http://dolphin-emu.org/docs/faq/) before use.
Please read the FAQ before use: http://dolphin-emu.org/docs/faq/ ## System Requirements
* OS
* Microsoft Windows (Vista or higher).
* Linux or Apple Mac OS X (10.7 or higher).
* Unix-like systems other than Linux might work but are not officially supported.
* 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.
[System Requirements] ## Installation on Windows
* OS: Microsoft Windows (Vista or higher) or Linux or Apple Mac OS X (10.7 or higher).
Unix like systems other than Linux might work but are not officially supported.
* 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).
Direct3D 11 / OpenGL 4.4 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 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 many C++ features that we use. Other compilers might be able to build Dolphin
@ -31,25 +32,24 @@ Nullsoft Scriptable Install System (NSIS) to be installed. Creating an
installer is not necessary to run Dolphin since the Build directory contains installer is not necessary to run Dolphin since the Build directory contains
a working Dolphin distribution. a working Dolphin distribution.
[Installation on Linux/OS X] ## Installation on Linux/OS X
Dolphin requires [CMake](http://www.cmake.org/) for systems other than Windows. Many libraries are
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 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 will inform you if a bundled library is used or if you need to install any
missing packages yourself. missing packages yourself.
Build steps: ### Build steps:
mkdir Build 1. mkdir Build
cd Build 2. cd Build
cmake .. 3. cmake ..
make 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 On Linux, it's strongly recommended to perform a global installation via
"sudo make install". "sudo make install".
[Uninstalling] ## Uninstalling
When Dolphin has been installed with the NSIS installer, you can uninstall When Dolphin has been installed with the NSIS installer, you can uninstall
Dolphin like any other Windows application. Dolphin like any other Windows application.
@ -61,15 +61,16 @@ OS X users can simply delete Dolphin.app to uninstall it.
Additionally, you'll want to remove the global user directory (see below to 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. see where it's stored) if you don't plan to reinstall Dolphin.
[Command line usage] ## Command line usage
Usage: Dolphin [-h] [-d] [-l] [-e <str>] [-b] [-V <str>] [-A <str>] Usage: Dolphin [-h] [-d] [-l] [-e <str>] [-b] [-V <str>] [-A <str>]
-h, --help Show this help message
-d, --debugger Opens the debugger * -h, --help Show this help message
-l, --logger Opens the logger * -d, --debugger Opens the debugger
-e, --exec=<str> Loads the specified file (DOL,ELF,WAD,GCM,ISO) * -l, --logger Opens the logger
-b, --batch Exit Dolphin with emulator * -e, --exec=<str> Loads the specified file (DOL,ELF,WAD,GCM,ISO)
-V, --video_backend=<str> Specify a video backend * -b, --batch Exit Dolphin with emulator
-A, --audio_emulation=<str> Low level (LLE) or high level (HLE) audio * -V, --video_backend=<str> Specify a video backend
* -A, --audio_emulation=<str> Low level (LLE) or high level (HLE) audio
Available DSP emulation engines are HLE (High Level Emulation) and Available DSP emulation engines are HLE (High Level Emulation) and
LLE (Low Level Emulation). HLE is fast but often less accurate while LLE is LLE (Low Level Emulation). HLE is fast but often less accurate while LLE is
@ -80,12 +81,12 @@ Available video backends are "D3D" (only available on Windows Vista or higher),
"OGL". There's also "Software Renderer", which uses the CPU for rendering and "OGL". There's also "Software Renderer", which uses the CPU for rendering and
is intended for debugging purposes, only. is intended for debugging purposes, only.
[Sys Files] ## Sys Files
totaldb.dsy: Database of symbols (for devs only) * totaldb.dsy: Database of symbols (for devs only)
GC/font_ansi.bin: font dumps * GC/font_ansi.bin: font dumps
GC/font_sjis.bin: font dumps * GC/font_sjis.bin: font dumps
GC/dsp_coef.bin: DSP dumps * GC/dsp_coef.bin: DSP dumps
GC/dsp_rom.bin: DSP dumps * GC/dsp_rom.bin: DSP dumps
The DSP dumps included with Dolphin have been written from scratch and do not 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 contain any copyrighted material. They should work for most purposes, however
@ -93,47 +94,49 @@ 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 dump the DSP files from a console and replace the default dumps if you want
to fix those issues. to fix those issues.
[Folder structure] ## Folder structure
These folders are installed read-only and should not be changed. These folders are installed read-only and should not be changed:
GameSettings: per-game default settings database * GameSettings: per-game default settings database
GC: DSP and font dumps * GC: DSP and font dumps
Maps: symbol tables (dev only) * Maps: symbol tables (dev only)
OpenCL: OpenCL code * Shaders: post-processing shaders
Shaders: post-processing shaders * Themes: icon themes for GUI
Themes: icon themes for GUI * Wii: default Wii NAND contents
Wii: default Wii NAND contents
[User folder structure] ## User folder structure
A number of user writeable directories are created for caching purposes or for 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 allowing the user to edit their contents. On OS X and Linux these folders are
stored in ~/Library/Application Support/Dolphin/ and ~/.dolphin-emu stored in ~/Library/Application Support/Dolphin/ and ~/.dolphin-emu
respectively. On Windows the user directory is stored in the "My Documents" respectively. On Windows the user directory is stored in the "My Documents"
folder by default, but there are various way to override this behavior: 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 store the user directory in a local directory called "User" next to the
Dolphin executable. Dolphin executable.
- If the registry string value "LocalUserConfig" exists in * If the registry string value "LocalUserConfig" exists in
"HKEY_CURRENT_USER/Dolphin Emulator" and has the value "1", Dolphin will "HKEY\_CURRENT\_USER/Dolphin Emulator" and has the value "1", Dolphin will
always start in portable mode. always start in portable mode.
- If the registry string value "UserConfigPath" exists in * If the registry string value "UserConfigPath" exists in
"HKEY_CURRENT_USER/Dolphin Emulator", the user folders will be stored in the "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 directory given by that string. The other two methods will be prioritized
over this setting. 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
[Custom textures] 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
## Custom textures
Custom textures have to be placed in the user directory under 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". in the ISO list and selecting "ISO Properties".