ControllerInterface: DirectInput: Added support for Ramp and various Periodic force...
[dolphin.git] / Readme.txt
blobd7f1343a2f603a436635f5194f8e54f8fdf821b1
1 Dolphin-emu - The Gamecube / Wii Emulator
2 ==========================================
3 Homesite: http://dolphin-emu.com/
4 Project Site: http://code.google.com/p/dolphin-emu
6 About: Dolphin-emu is a emulator for Gamecube, Wii, Triforce that lets you run Wii/GCN/Tri games on your Windows/Linux/MacOSX PC system
8 Open Source Release under GPL 2
10 Project Leaders: F|RES, ector
12 Team members: http://code.google.com/p/dolphin-emu/people/
15 Please read the FAQ before use: http://code.google.com/p/dolphin-emu/wiki/Facts_And_Questions
17 System Requirements:
18 * OS: Microsoft Windows (2000/XP/Vista or higher) or Linux or Apple Mac OS X.
19 * Processor: Fast CPU with SSE2 supported (recommended at least 2Ghz). Dual Core for speed boost.
20 * Graphics: Any graphics card that supports Direct3D 9 or OpenGL 2.1.
22 [Command line usage]
23 Usage: Dolphin [-h] [-d] [-l] [-e <str>] [-V <str>] [-A <str>] [-P <str>] [-W <str>]
24   -h, --help                    Show this help message
25   -d, --debugger                Opens the debugger
26   -l, --logger                  Opens the logger
27   -e, --exec=<str>              Loads the specified file (DOL, ELF, WAD, GCM, ISO)
28   -V, --video_plugin=<str>      Specify a video plugin
29   -A, --audio_plugin=<str>      Specify an audio plugin
30   -W, --wiimote_plugin=<str>    Specify a wiimote plugin
32 [Libraries]
33 Cg: Cg Shading API (http://developer.nvidia.com/object/cg_toolkit.html)
34 WiiUse: Wiimote Bluetooth API (http://www.wiiuse.net/)
35 SDL: Simple DirectMedia Layer API (http://www.libsdl.org/)
36 *.pdb = Program Debug Database (use these symbols with a program debugger)
38 [DSP Plugins]
39 Plugin_DSP_HLE: High Level DSP Emulation
40 Plugin_DSP_LLE: Low Level DSP Emulation
42 [Video Plugins]
43 Plugin_VideoDX9: Render with Direct3D 9
44 Plugin_VideoDX11: Render with Direct3D 11
45 Plugin_VideoOGL: Render with OpenGL + Cg Shader Language
47 [Wiimote Plugins]
48 Plugin_Wiimote: Use native wiimote or keyboard (legacy)
49 Plugin_WiimoteNew: Use native wiimote or keyboard (incomplete)
51 [Sys Files]
52 totaldb.dsy: Database of symbols (for devs only)
53 font_ansi.bin/font_sjis.bin: font dumps
54 setting-usa/jpn/usa.txt: config files for Wii
56 [Support Folders]
57 Cache: used to cache the ISO list
58 Config: emulator configuration files
59 Dump: anything dumped from dolphin will go here
60 GC: Gamecube memory cards
61 GameConfig: holds the INI game config files
62 Load: high resolution textures
63 Logs: logs go here
64 Maps: symbol tables go here (dev only)
65 OpenCL: OpenCL code
66 ScreenShots: screenshots are saved here
67 Shaders: post-processing shaders
68 StateSaves: save states are stored here
69 Wii: Wii saves and config is stored here