NetPlay: Fixed a problem with client game start code. Other minor fixes.
[dolphin.git] / Readme.txt
blob5ec71aae736c17ba3fff60db129a5ffb8aa2013c
1 Dolphin-emu - The Gamecube / Wii Emulator\r
2 ==========================================\r
3 Homesite: http://dolphin-emu.com/\r
4 Project Site: http://code.google.com/p/dolphin-emu\r
5 \r
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\r
7 \r
8 Open Source Release under GPL 2\r
9 \r
10 Project Leaders: F|RES, ector\r
12 Team members: zerofrog, vincent.hamm, falc4ever, Sonicadvance1, tmator, shuffle2, gigaherz, mthuurne, drkIIRaziel, masken, DacoTaco, XTra.KrazzY, nakeee, memberTwo.mb2, donkopunchstania, jpeterson, omegadox, lpfaint99, bushing, magumagu9, mizvekov, cooliscool, facugaich\r
15 Please read the FAQ before use: http://code.google.com/p/dolphin-emu/wiki/Facts_And_Questions\r
17 System Requirements:\r
18 * OS: Mircrosoft Windows (2000/XP/Vista or higher) or Linux or Apple Mac OS X.\r
19 * Processor: Fast CPU with SSE2 supported (recommended at least 2Ghz). Dual Core for speed boost.\r
20 * Graphics: Any graphics card that supports Direct3D 9 or OpenGL 2.1.\r
23 [Windows Version]\r
24 Dolphin.exe: The main program \r
25 Arguments:\r
26 -d              Run Dolphin with the debugger tools\r
27 -l              Run Dolphin with the logmanager enabled\r
28 -e=<path>       Open an elf file\r
30 cg.dll/cgGL.dll: Cg Shading API (http://developer.nvidia.com/object/cg_toolkit.html)\r
31 wiiuse.dll: Wiimote Bluetooth API (http://www.wiiuse.net/)\r
32 SDL: Simple DirectMedia Layer API (http://www.libsdl.org/)\r
33 *.pdb = Program Debug Database (use these symbols with a program debugger)\r
34 [DSP Plugins]\r
35 Plugin_DSP_LLE.dll: Low Level DSP Emulation\r
36 Plugin_DSP_HLE.dll: High Level DSP Emulation (only emulates AX UCodes)\r
37 [Video plugins]\r
38 Plugin_VideoDX9.dll: Render with Direct3D 9 (outdated video plugin)\r
39 Plugin_VideoOGL.dll: Render with OpenGL + Cg Shader Language\r
40 [Gamecube Controller Plugins]\r
41 Plugin_GCPad.dll: Use keyboard or joypads\r
42 [Wiimote plugins]\r
43 Plugin_Wiimote.dll: Use native wiimote or keyboard\r
45 [Linux Version]\r
46 Usage: Dolphin [-h] [-d] [-l] [-e <str>]\r
47   -h, --help            Prints usage message\r
48   -d, --debugger        Run Dolphin with the debugger tools\r
49   -l, --logger          Run Dolphin with the logmanager enabled\r
50   -e, --elf=<path>      Loads an elf file\r
52 [Mac Version]\r
53 (someone fill this out)\r
55 [Sys Files]\r
56 totaldb.dsy: Database of symbols (for devs only)\r
57 font_ansi.bin/font_sjis.bin: font dumps\r
58 setting-usa/jpn/usa.txt: config files for Wii\r
60 [Config Folders]\r
61 Cache: used to cache the ISO list\r
62 Dump: Anything dumped from dolphin will go here\r
63 GameConfig: Holds the INI game config files\r
64 GC: Gamecube Memory Cards\r
65 Logs: logs go here\r
66 Maps: symbol tables go here (dev only)\r
67 ScreenShots: screenshots are saved here\r
68 SaveStates: save states are stored here\r
69 Wii: Wii saves and config is stored here\r