Compile fix.
[dolphin.git] / Readme.txt
blob75307666080f44c3edfbf2ec5cbe17d58be0ed25
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, --elf=<str>               Loads an elf file
28   -V, --video_plugin=<str>      Specify a video plugin
29   -A, --audio_plugin=<str>      Specify an audio plugin
30   -P, --pad_plugin=<str>        Specify a pad plugin
31   -W, --wiimote_plugin=<str>    Specify a wiimote plugin
33 [Libraries]
34 Cg: Cg Shading API (http://developer.nvidia.com/object/cg_toolkit.html)
35 WiiUse: Wiimote Bluetooth API (http://www.wiiuse.net/)
36 SDL: Simple DirectMedia Layer API (http://www.libsdl.org/)
37 *.pdb = Program Debug Database (use these symbols with a program debugger)
39 [DSP Plugins]
40 Plugin_DSP_HLE: High Level DSP Emulation
41 Plugin_DSP_LLE: Low Level DSP Emulation
43 [Video Plugins]
44 Plugin_VideoDX9: Render with Direct3D 9
45 Plugin_VideoOGL: Render with OpenGL + Cg Shader Language
47 [Gamecube Controller Plugins]
48 Plugin_GCPad: Use keyboard or joypads
50 [Wiimote Plugins]
51 Plugin_Wiimote: Use native wiimote or keyboard
53 [Sys Files]
54 totaldb.dsy: Database of symbols (for devs only)
55 font_ansi.bin/font_sjis.bin: font dumps
56 setting-usa/jpn/usa.txt: config files for Wii
58 [Support Folders]
59 Cache: used to cache the ISO list
60 Config: emulator configuration files
61 Dump: anything dumped from dolphin will go here
62 GC: Gamecube memory cards
63 GameConfig: holds the INI game config files
64 Load: high resolution textures
65 Logs: logs go here
66 Maps: symbol tables go here (dev only)
67 OpenCL: OpenCL code
68 ScreenShots: screenshots are saved here
69 Shaders: post-processing shaders
70 StateSaves: save states are stored here
71 Wii: Wii saves and config is stored here