home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 7 Games / 07-Games.zip / snes9_r3.zip / ReadMe.OS2 < prev    next >
Text File  |  2000-08-20  |  10KB  |  211 lines
  1. SNES9x for OS/2 - MGL version ported by Marty Amodeo [Release 3]
  2. ================================================================
  3.  
  4. This is a port of an emulator for a game system that plays two of my
  5. five favorite all-time games (Zelda 3 and Super Metroid for those who
  6. are curious).  I have wanted to port this for a LONG time, but with all
  7. the work on MAME and Retrocade, I never got around to it.  Well, I
  8. finally bit the bullet and did it.
  9.  
  10. Things to be aware of:
  11. 1] This emulator *requires* use of the TIMER0 device driver.
  12.    Most people already have a working version of this on their systems
  13.    but you should be aware that it can disrupt operations in concurrent
  14.    DOS and Windows applications.
  15.  
  16. 2] DART is *required*.  Your sound card must support DART otherwise
  17.    this version of SNES9x will not have sound.
  18.  
  19. 3] This version requires the installation of SDDHELP.SYS from beta 32 or
  20.    later of Scitech Display Doctor.  The appropriate file is included for
  21.    those who do not use SDD as their video drivers.  Those who do have
  22.    beta 32 or later installed should use their own versions of SDDHELP.SYS.
  23.    This version of SNES9x will not work with older versions of SDDHELP.SYS.
  24.  
  25. 4] OS/2 believes that it is in a full screen text mode while SNES9x is
  26.    running.  If a fatal error is encountered, such as a SYS3175, a full
  27.    screen popup error will appear.  Note however, that OS/2 is not aware
  28.    that you are in a graphics mode and may not be able to display such
  29.    popup messages correctly.  If SNES9x blanks out and you are left with
  30.    a stagnant black screen with no sound playing, press ENTER a few times
  31.    and then type "MODE CO80" to restore text mode.
  32.  
  33. 5] If you wind up back at your desktop while SNES9x is running (by
  34.    accidentally hitting CTRL-ESC or something), SNES9x will pause
  35.    itself until you go back to it.  If this happens, it will unpause when
  36.    you select the session again and will attempt to re-initialize the
  37.    video mode.
  38.  
  39. 6] Any printed-out messages on the screen that can't be seen because
  40.    you are in graphics mode or went by too fast for you to read can
  41.    be read in a file named Debug.Log.
  42.  
  43. 7] This version will produce core files when a problem is encountered.
  44.  
  45.    IF YOU ENCOUNTER A PROBLEM:  First check the list of known deficiencies 
  46.    below.  If your problem is listed, then there's obviously no need to tell
  47.    me about it.  If your problem is not listed, e-mail me a *text message*
  48.    describing the actions leading up to your problem and whatever was reported
  49.    in the Debug.Log file.  SAVE YOUR CORE FILES!  If you find a problem and 
  50.    write to me about it, I may ask you to zip up the core file and e-mail it
  51.    to me.  This will be extremely helpful in solving the problem.
  52.  
  53. 8] The enhanced joystick device driver (by Vesa Jääskeläinen) is included
  54.    with this archive.  To enable joystick support, install and configure this
  55.    driver as per the instructions in the driver's archive.
  56.  
  57. 9] Known deficiencies:
  58.    * None at this time.
  59.  
  60.  
  61. Getting Started
  62. ===============
  63.  
  64. ** YOU NEED EMX TO RUN SNES9x **  Download it (EMXRT.ZIP) from Hobbes or 
  65. your favorite OS/2 software archive.
  66.  
  67. Just unzip the main Zip file (which you've undoubtedly already done).  Next,
  68. run the CONFIG program to set up your keyboard, joystick, video, and audio
  69. options.
  70.  
  71. If you have a registered version of Scitech Display Doctor, you may press the
  72. "Scitech Display Doctor Setup" button.  When prompted, enter the directory into
  73. which the SDD utility programs were installed (specifically, GAMode).  CONFIG
  74. will then check which video modes are available and add the modes used by SNES9x
  75. if they are not present.  If the modes are added to your system, you can then
  76. run GACtrl to set their refresh rates and center them properly on your monitor
  77. if you wish.
  78.  
  79. To "tune in" the Super Nintendo video modes manually, if you don't want to use
  80. CONFIG to do it for you, run the following commands at a full screen OS/2
  81. command prompt from your SDD installed directory:
  82.  
  83. gamode add 256 239 8
  84. gamode add 256 239 16
  85.  
  86. If you do not have a registered version of Scitech Display Doctor installed on
  87. your system, or if you are using an IBM-licensed version (SDD SE), you will not
  88. be able to use the custom video modes.  SNES9x will default to using 640x480.
  89. You can tell it to stretch the image to occupy the full screen if you wish.
  90. (See the extra command line arguments documented below.)
  91.  
  92. Make sure you have installed and booted up with the correct versions of the
  93. SDDHELP.SYS device driver from Scitech.  An appropriate version is included
  94. in this archive, however, you should *NOT* install it if you already have an
  95. up-to-date version of SDD installed on your system.
  96.  
  97. Now you should be all ready to run SNES9x!
  98.  
  99.  
  100. Command Line Parameters
  101. =======================
  102.  
  103. If you wish to get a list of many common SNES9x command line parameters,
  104. just run the executable with no parameters and it will list them.  I'll
  105. only document the OS/2-specific ones here.  The CONFIG front-end utility
  106. will allow you to configure all of the major parameters easily and save
  107. the settings to an INI file.  This INI file is used by SNES9x to fill in
  108. the default options.  Command line parameters can override these defaults.
  109. For the most part, the only command line option you'll need to use after
  110. running CONFIG is the name of the ROM to run, but this information is
  111. provided for the sake of completeness.
  112.  
  113. -maxskip:  This is the maximum number of frames to skip in a row before
  114.            displaying another frame.  If this is set to zero, it will
  115.            keep skipping frames until it is caught up.  The default is 3.
  116.            If this is set too low for slower computers, it can slow down
  117.            the emulation speed and music.  If it is set too high on slow
  118.            computers, you won't be able to see what's happening!
  119.  
  120. -transparency:  Not an OS/2-specific option, but useful to highlight.  This
  121.                 option enables transparency effects in the emulation.  It 
  122.                 requires a 16 bit color video mode and enabling this option
  123.                 will automatically enable 16 bit color video.  It can slow
  124.                 the emulation down a bit, but makes the emulation as
  125.                 accurate and visually appealing as possible.  This is
  126.                 disabled by default.
  127.  
  128. -soundbuffer:  Sets the sound buffer size used by DART.  Don't set it too low
  129.                or your sound drivers may have problems.  It defaults to 2048
  130.                bytes.
  131.  
  132. -stretchblit:  If you're stuck using one of the 640x480 graphics modes
  133.                because you can't "tune in" 256x239, then this option will
  134.                tell SNES9x to stretch the video image to occupy the full
  135.                640x480 instead of centering it on the screen.
  136.  
  137.  
  138. Controls
  139. ========
  140.  
  141. Controls can be configured via the CONFIG program.  Click on the function you
  142. wish to set in the list box and press the "Change Key Assignment" button.  Then
  143. press the key or joystick button you wish to assign to that function.  Note that
  144. the X and Y axis of the joystick (if present) are automatically assigned to the
  145. directional controls of the first SNES controller.
  146.  
  147. SNES Player 1 Start        = Enter
  148. SNES Player 1 Select        = TAB
  149. SNES Player 1 Top Left Button    = Q
  150. SNES Player 1 Top Right Button    = W
  151. SNES Player 1 X Button        = S
  152. SNES Player 1 Y Button        = A
  153. SNES Player 1 A Button        = X
  154. SNES Player 1 B Button        = Z
  155. SNES Player 1 Pad Up        = Up arrow key
  156. SNES Player 1 Pad Down        = Down arrow key
  157. SNES Player 1 Pad Left        = Left arrow key
  158. SNES Player 1 Pad Right        = Right arrow key
  159.  
  160. SNES Player 2 Start        = Keypad Enter
  161. SNES Player 2 Select        = Keypad +
  162. SNES Player 2 Top Left Button    = Keypad /
  163. SNES Player 2 Top Right Button    = Keypad *
  164. SNES Player 2 X Button        = PageUp
  165. SNES Player 2 Y Button        = Home
  166. SNES Player 2 A Button        = PageDown
  167. SNES Player 2 B Button        = End
  168. SNES Player 2 Pad Up        = Keypad Up arrow key
  169. SNES Player 2 Pad Down        = Keypad Down arrow key
  170. SNES Player 2 Pad Left        = Keypad Left arrow key
  171. SNES Player 2 Pad Right        = Keypad Right arrow key
  172.  
  173. SNES Power Off (exit)        = Escape
  174. SNES Halt (pause/resume)    = F12
  175. Save system state snapshot    = F1
  176. Load system state snapshot    = F2
  177. Video mode refresh        = F11
  178. Screen capture to a PNG file    = F3
  179.  
  180. SNES mouse support is not currently implemented.
  181.  
  182.  
  183. Misc.
  184. =====
  185.  
  186. Snapshots and screen shots will be saved into a directory named "snapshots"
  187. under the directory in which the SNES9x executable lies.  If it does not
  188. exist, it will be created.  These files will be saved with the name of
  189. the game and an appropriate extension.  For example, a machine snapshot
  190. of Zelda will be saved to snapshots\zelda.s9x, and a screen capture from
  191. Metroid3 will be saved to snapshots\metroid3.png.
  192.  
  193. You will be able to view the resulting PNG files in Netscape or your
  194. favorite image manipulation software, such as PMView.
  195.  
  196. You should be able to load the .s9x files into versions of SNES9x for
  197. other platforms, and their saved states can be loaded into the OS/2 version
  198. if they are named properly.  The .s9x files should be compatible with the
  199. .s96 files made with older versions of SNES9x.  Also, .srm files from older
  200. versions of SNES9x should be compatible with this version.
  201.  
  202.  
  203. Please give me feedback if you are having graphics compatibility problems.
  204.  
  205. I hope you all enjoy this as much as I do!  :-)
  206.  
  207. Send your feedback and bug reports to mamedev@stny.rr.com.  Keep your eye on
  208. http://emuos2.vintagegaming.com for the latest in Retrocade, MAME, and
  209. SNES9x news!
  210.  
  211.