Updated the Readme.txt file.

git-svn-id: https://dolphin-emu.googlecode.com/svn/trunk@1882 8ced0084-cf51-0410-be5f-012b33b47a6e
This commit is contained in:
omegadox 2009-01-16 21:58:56 +00:00
parent 93d12069cb
commit 074436c0eb
2 changed files with 66 additions and 58 deletions

66
Readme.txt Normal file
View File

@ -0,0 +1,66 @@
Dolphin-emu - The Gamecube / Wii Emulator
==========================================
Homesite: http://dolphin-emu.com/
Project Site: http://code.google.com/p/dolphin-emu
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
Open Source Release under GPL 2
Project Leaders: F|RES, ector
Team members: zerofrog, vincent.hamm, falc4ever, Sonicadvance1, tmator, shuffle2, gigaherz, mthuurne, drkIIRaziel, masken, daco, XTra.KrazzY, nakeee, memberTwo.mb2, donkopunchstania, jpeterson, omegadox, lpfaint99, bushing, magumagu9, mizvekov, cooliscool, facugaich
Please read the FAQ before use: http://code.google.com/p/dolphin-emu/wiki/Facts_And_Questions
System Requirements:
* OS: Mircrosoft Windows (2000/XP/Vista or higher) or Linux or Apple Mac OS X.
* Processor: Fast CPU with SSE2 supported (recommended at least 2Ghz). Dual Core for speed boost.
* Graphics: Any graphics card that supports Direct3D 9 or OpenGL 2.1.
[Windows Version]
DolphinWx.exe: The main program
Arguments:
-d Run Dolphin with the debugger tools
cg.dll/cgGL.dll: Cg Shading API (http://developer.nvidia.com/object/cg_toolkit.html)
wiiuse.dll: Wiimote Bluetooth API (http://www.wiiuse.net/)
SDL: Simple DirectMedia Layer API (http://www.libsdl.org/)
*.pdb = Program Debug Database (use these symbols with a program debugger)
[DSP Plugins]
Plugin_DSP_NULL.dll: No Audio
Plugin_DSP_LLE.dll: Low Level DSP Emulation
Plugin_DSP_HLE.dll: High Level DSP Emulation (only emulates AX UCodes)
[Video plugins]
Plugin_VideoDX9.dll: Render with Direct3D 9 (outdated video plugin)
Plugin_VideoOGL.dll: Render with OpenGL + Cg Shader Language
[Gamecube Controller Plugins]
Plugin_PadSimple.dll: Use keyboard or XBOX 360 Controller
Plugin_nJoy_SDL_Test.dll: Test nJoy DLL
Plugin_nJoy_SDL.dll: Use Joypads
[Wiimote plugins]
Plugin_Wiimote.dll: Use native wiimote or keyboard
[Linux Version]
(someone fill this out)
[Mac Version]
(someone fill this out)
[Sys Files]
totaldb.dsy: Database of symbols (for devs only)
font_ansi.bin/font_sjis.bin: font dumps
setting-usa/jpn/usa.txt: config files for Wii
[Config Folders]
Cache: used to cache the ISO list
Dump: Anything dumped from dolphin will go here
GameConfig: Holds the INI game config files
GC: Gamecube Memory Cards
Logs: logs go here
Maps: symbol tables go here (dev only)
ScreenShots: screenshots are saved here
SaveStates: save states are stored here
Wii: Wii saves and config is stored here

View File

@ -1,58 +0,0 @@
Dolphin
=======
Open Source Release under GPL 2
by F|RES & ector
Contributions by:
zerofrog, yaz0r, tmbinc
DX9 gfx plugin by ector
OpenGL gfx plugin by zerofrog
System Requirements:
* Windows 2000 or higher. The Linux build is at least 80% done, it starts,
but won't run games yet. There's a bug somewhere.
* Fast CPU. Dual core a plus.
* Any reasonable modern GPU, support for pixel shaders 2.0 required.
New Features
* Interprets Action Replay codes
* Buggy framerate limiter, deactivated
* Full Xbox 360 Controller support, with rumble
Dolphin is a Gamecube emulator. It also has preliminary support for Wii and
Triforce emulation.
Gamecube compatibility is about the same as previous releases.
Wii compatibility is very low. Some games show their intro movies, that's it.
There is preliminary Wiimote emulation but it does not work yet.
We haven't worked on Dolphin for a long time, except for a short burst adding
the basic Wii support, and we don't think we will finish it, so we hereby
release it, in its current unfinished state, to the world.
Usage Notes
-----------
The GUI should be pretty much self-explanatory.
To attempt to boot Wii ISOs, you need the disc master key. It should be
called "masterkey.bin". Put it in the Wii subdirectory.
To use Action Replay codes, follow the examples in the Patches subdirectory.
Use + in front of a cheat name to activate it. The cheats can be named
anything.
Code Notes
----------
Dolphin is written in C++. It's compiled with Visual Studio 2005. An
installation of the DirectX SDK is required.
To tweak settings for the JIT/Dynarec, see Core/PowerPC/Jit64/JitCache.cpp,
in InitCache().
We have a scons build system set up, but if anyone wants to create an
automake solution, go ahead, we'd appreciate it.
We are looking for new source code maintainers.