removing now unneeded dir from package
[drnoksnes] / readme.txt
1 DrPocketSnes
2 Super Nintendo (SNES) Emulator
3 by Reesy
4
5 DrPocketSnes is a Super Nintendo (SNES) emulator for the GP2X and Gizmondo. I've taken bits from PocketSnes and SquidgeSnes and merged them into another new emulator.  I then stuck my menu system on it and called it my own :) you've got to love porting stuff.
6
7 So credits for this emulator should really go to.
8
9 Snes9x Team for creating the original Snes9x emulator
10 http://www.snes9x.com/
11
12 Scott Ramsby for PocketSnes port based on Snes9x sources
13 http://paqpark.nuclearfallout.net/projects/pocketsnes.php
14
15 Yoyofr for OpenSnes9x port based on Snes9x sources
16 http://yoyofr.fr.st/
17
18 Squidge for the SquidgeSnes port based on OpenSnes9x
19 http://squidge2x.com/
20
21 Notaz for his fixes and improvements to SquidgeSnes.
22 http://notaz.atspace.com/
23
24 Rlyeh for his work on the gp2x (not so)minimal sdk
25 http://www.retrodev.info/
26
27 HeadOverHeels for lots of fixes and added functionality
28 (No known website)
29
30 Reesy for merging everything and sticking a menu on it...the really complicated stuff ;).
31 http://reesy.gp32x.de/
32
33 ====================
34 IMPORTANT
35 When upgrading from v4 to v5 you will need to manually move the savestate files (*.sv*) from the options directory into the savestate directory and the SRAM files (*.srm) from the root installation directory into the sram directory.  See change history for more details.
36 ====================
37
38 ==============
39 Change History
40 ==============
41 ___________________________________
42 Version 6.4.4   Release Date 01/06/2008
43 ___________________________________
44 Changes by Reesy
45         1. version includes fixes by HeadOverHeels ( 6.4.3 ). 
46         2. KGSDK.DLL no longer required ( all now built into executable )
47         3. Zipped save states
48         4. Non-Gizmondo related menu options now hidden.
49         5. Snes Select button now mapped :) 
50         6. Rom Browser code tidied, you can now set the default directory
51                 from inside the rom browser.  The rom browser now also tells
52                 you the current directory.
53 ___________________________________
54 Version 6.4.3   Release Date 23/02/2008
55 ___________________________________
56 Changes by HeadOverHeels
57         1. USB pads support (GP2x only)
58         2. Fixed sky colour for Super Mario World when transparencies are not active.
59         3. Fixed framerate for PAL games (50 fps) and added an option to configure region (AUTO, NTSC, PAL)
60         4. Fixed sound problems with some games (Ilussion of Gaia for exmaple)
61         5. Sound frequencies have been changed (8250,16500) to make GP2X F200 compatible
62         6. 256x240 games resolution problem have been fixed
63         7. C4 chip support (Megaman X2, X3)
64         8. High resolution text support (Seiken Densetsu 3 - Secret of Mana2)
65         9. Added DSP optimizations from snes9xTYL of Yoyofr.
66         10. F200 sound level now is lower
67         11. SDD1 support (Star Ocean & Street Fighter Alpha 2)
68                 SDD1 decompressed packs are supported. SDD1GFX.DAT & SDD1GFX.IDX must be copied to a subdirectory named socnsdd1 (for Star Ocean) and sfa2sdd1 (for Street Fighter 2 alpha). Create these subdirectories in the roms directory.
69                 If no packs are found, the emulator uses realtime decompression (slower)
70         12. Other minor fixes and optimizations.
71         13. Added stereo sound.
72         14. New advanced hacks options:
73                 Audio performance hack
74                 Ignore palette writes
75                 Ignore Fixed Colour
76                 Ignore Windows clipping
77                 Ignore Add/Sub modes
78                 Layer desactivation___
79 ________________________________
80 Version 6       Release Date 04/02/2007
81 ___________________________________
82 Changes by Reesy
83         1. Fixed a bug on the rom browsing code.  Strings were not being terminated correctly.  
84 ___________________________________
85 Version 5       Release Date 03/02/2007
86 ___________________________________
87         1. Changed the way SRAM works.  The old versions of PocketSnes used a timer to check if SRAM had changed while the SNES emulator was running.  If a change was detected the SRAM was saved straight away.  This used to cause glitches in the framerate.  SRAM is now saved when you enter the menu as long as you have SRAM saving set to automatic in the options menu.
88         2. Added options to allow you to switch MMU hack on or off
89         3. Added options to allow you to switch Craigx's RAM settings on or off.
90         4. Fixed problems where data was not being saved to SD card correctly, I was missing a few calls to sync()
91         5. I've tidied up the installation directory abit.  Most things used to be stored in the options sub directory and somethings were saved to the root installation directory, which was a bit of a mess.  So I've now created the following 3 directories in order to make things more logical.
92         
93         options (*.opt)         - used to hold global and individual game settings
94         savestate (*.sv*)       - used to hold save states for all games
95         sram (*.srm)            - used to hold SRAM saves for all games
96         
97         This means that we you upgrade from Version 4 to Version 5 you will need to manually copy the savestates out of the options directory and into the savestate directory in order for PocketSnes to recognise them.  You will also have to move the SRAM files out of the root
98 installation directory and into the sram directory.     
99 ___________________________________     
100 Version 4       Release Date 30/01/2007
101 ___________________________________
102         1. Fixed timer code which was causing the emulator to crash
103 ___________________________________     
104 Version 3       Release Date 24/01/2007
105 ___________________________________
106         1. Scaled display mode added.
107         2. 44K sound mode added.
108         3. Super FX support added - very very buggy and slow
109 ___________________________________
110 Version 2       Release Date 24/01/2007
111 ___________________________________
112         1. Fixed Diagnals.
113         2. Fixed Volume controls.
114         3. Fixed Reset game function.
115         4. Snes Select button now working.
116 ___________________________________     
117 Version 1       Release Date 24/01/2007
118 ___________________________________
119         Initial release
120
121 =========================
122 Installation Instructions - Gizmondo
123 =========================
124
125 When you extracted the release zip file it would have created a DrPocketSnes folder.  Simply copy this folder onto your SD card.
126
127 NOTE: If you are using zektor's menu system, then the DrPocketSnes.exe will need to be renamed to autorun.exe in order to be seen.
128
129 Now you need to copy some SNES roms to you SD card.  Again you can put your roms anywhere you like on your SD card, just remember where you put them as you'll need to know this later. 
130
131 ============
132 Menu Options
133 ============
134 _______________________________________________ 
135 Return To Game
136         If you have a rom loaded this will allow to exit the menu and return to the game.
137 _______________________________________________ 
138 Select Rom
139         Takes you to the Rom Selection screen which allows you load a new game.
140 _______________________________________________         
141 Manage Save States
142         Takes you to the save state management screen.  Save states allow you to save your current position in the currently loaded game.  This means that you can reload a particular position in the game as many times as you want.
143 _______________________________________________ 
144 Save Sram
145         Allows you save the current contents of SRAM to a file.  SRAM is the battery backup ram which used to be on the Snes cartridges.  This allowed high scores or game progress, so that the next time you loaded the snes game you could continue where you left off.  If you plan to use save states then you don't need to worry about SRAM saves as the save state holds all of this information as well.
146 _______________________________________________ 
147 SNES Options
148         Takes you into the options screen which allows you to customise how the emulator runs. See "SNES Options - In Detail" for more information on each of the settings.
149 _______________________________________________
150 Reset Game
151         Allows you to reset the current rom, its the same as reloading the rom apart from you don't have to read the rom file from the SD card again.
152 _______________________________________________ 
153 Exit Application
154         Exits PocketSnes and reloaded the GP2X menu.
155 _______________________________________________
156
157 ========================        
158 SNES Options - In Detail
159 ========================
160 _______________________________________________
161 Sound
162         Allows you to turn the sound on or off
163 _______________________________________________ 
164 Sound Rate
165         Allows you to configure the sample rate of the sound emulation.  The high the rate the clearer and more accurate the sound.
166 _______________________________________________
167 Volumne
168         Allows you setup default volume levels.  Volume can also be controlled using the volume controls on the GP2X.
169 _______________________________________________ 
170 Cpu Speed (GP2x only)
171         Allows you select the GP2X cpu speed to be used when emulating the Snes.  The higher the cpu speed the smoother the emulation is ( plus it drains you battery more)
172 _______________________________________________ 
173 FrameSkip
174         Allows you to control how many frames are not rendered, this can allow you to keep full speed emulation when at low cpu speeds. AUTO will skip as many frames as needed in order to maintain full speed emulation.
175 _______________________________________________ 
176 Action Buttons (GP2x only)
177         The GP2X has the same button as the snes but the buttons are in the wrong order.  This option allows you to have the same button names as the snes, or to have the same button positions as snes.
178         NORMAL = same button names as Snes
179         SWAPPED = same button positions as Snes
180 _______________________________________________ 
181 Show FPS
182         This allows you to see how man frames are being rendered per second.  This can allow you to see how the emulator is performing.
183 _______________________________________________ 
184 Brightness (GP2x only)
185         This allows you to control the current brightness of the screen.  You can make it darker or brighter.
186 _______________________________________________ 
187 Transparencies
188         The SNES has very complicated graphics hardware which can be quite slow to emulate.  Switching off transparencies can improve performce but makes some games unplayable because you can not see all of the information that you need.
189 _______________________________________________ 
190 Render Mode (GP2x only)
191         Allows you to scale the emulated SNES graphics.  The normal SNES screen resolution is less than the GP2X's, so when in unscaled mode the graphics appear in a window.  If you select the scaled mode then the graphics are stretched to fill the screen.
192 _______________________________________________ 
193 RAM Timing (GP2x only)
194         This allows you select faster ram timings.  This can improve performance.  If you change this option you need to restart PocketSnes because these settings are only applied as the emulator is first started.
195 _______________________________________________ 
196 MMU Hack (GP2x only)
197         This option allows you to enable the MMU hack developed by Squidge.  This option massively improves performance and is recommended.  Again if you change this option you need to restart PocketSnes because these settings are only applied as the emulator is first started.
198 _______________________________________________ 
199 Saving SRAM
200         This option allows you to control how the SRAM is saved to you SD card.  If you select automatic then SRAM will be saved automatically everytime you return to the menu if it has been modified during the last run of emulation.  If you select the manual option then SRAM will only be saved when you select the Save SRAM menu option from the main menu.
201 _______________________________________________ 
202 Load Global Settings
203         This option will reload the global settings.  Global Settings affect all games as long as the games does not have a setting file of its own ( See Load Settings for current game). 
204 _______________________________________________ 
205 Save Global Settings
206         This option allows you to save the current settings to the SD card.  Everytime you load a new rom these settings will be reloaded, so basically they become you default settings.  This can be overwritten using the "Save Settings For Current Game" option which allows you to save a config file for a particular rom. So each time you load the rom these settings will automatically be loaded.
207 _______________________________________________ 
208 Delete Global Settings
209         Deletes any global setting file that has been created.  If you have no global setting file then PocketSnes will use its own internal default settings when loading a new rom.
210 _______________________________________________ 
211 Load Settings For Current Game
212         This option will load any setting file associated with the currently loaded rom.
213 _______________________________________________ 
214 Save Settings For Current Game
215         This option allows you to save a config file for the currently loaded rom. So each time you load this rom these settings will automatically be loaded instead of the global settings.
216 _______________________________________________ 
217 Delete Settings For Current Game
218         Deletes any config file for the currently loaded rom.
219 _______________________________________________ 
220 Save Current Rom Directory
221         This option allows you to save the current rom directory as you default rom directory.
222 _______________________________________________
223 Reset Default Rom Directory
224         This option clears any previous default rom directory.  The Rom directory is reset to the current working directory instead.
225 _______________________________________________
226         
227         
228         
229
230
231
232
233
234
235
236
237