home *** CD-ROM | disk | FTP | other *** search
/ Collection of Hack-Phreak Scene Programs / cleanhpvac.zip / cleanhpvac / VGBEMU.ZIP / VGB.DOC < prev    next >
Text File  |  1995-10-05  |  12KB  |  259 lines
  1.  
  2.  
  3.                    ******* Virtual GameBoy *******
  4.                 The Portable Nintendo GameBoy Emulator
  5.                              version 0.3
  6.  
  7.                          by Marat Fayzullin
  8.                       
  9.                        email: fms@wam.umd.edu
  10.                             IRC:  RST38h
  11.                WWW:  http://www.cs.umd.edu/users/fms/
  12.  
  13.          (*) GameBoy is a registered trademark of Nintendo.
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.                           * INTRODUCTION *
  21.  
  22.   Virtual GameBoy [VGB] is a portable emulator of the Nintendo GameBoy 
  23. portable videogame console written in C. Although it is an initial 
  24. release of the emulator in which many things do not quite work yet, it 
  25. was able to run about 85% of 80 games checked with it. You can always
  26. get the latest VGB source code and support files from
  27.  
  28.     http://www.cs.umd.edu/users/fms/GameBoy/VGB.html
  29.  
  30.   There are two different VGB distributions which are both covered by 
  31. this manual:
  32.  
  33. 1. *** Source Code Distribution ***
  34.   This distribution contains C sources of the emulator, and the 
  35. screen/keyboard drivers for Unix/X. Virtual GameBoy has been tested on 
  36. the following Unix systems:
  37.  
  38.   SunOS   Solaris   OSF/1   FreeBSD   HP/UX   Linux   AIX 3.2.5
  39.  
  40.   It was also successfully run on a Mac, Amiga, and Atari Falcon, 
  41. although no decent ports are available for these platforms yet.
  42.   If you would like to write new drivers, or port VGB to another platform, 
  43. *please*, contact me by email or some other means. Feel free to look at 
  44. existing drivers as well as at the other code.
  45.  
  46. 2. *** VGB-Windows Distribution ***
  47.   Due to the flood of requests from the people who use DOS/Windows 
  48. running PCs and are unable to compile the emulator on their own, I have 
  49. ported VGB under Microsoft Windows. This distribution contains an
  50. executable of a limited version of VGB-Windows which doesn't allow you to 
  51. reload a new game from a menu when emulation is already running, and has 
  52. an annoying "Virtual GameBoy DEMO" message across its window. The 
  53. uncrippled version of VGB-Windows is available for $35US from
  54.  
  55.   Marat Fayzullin
  56.   6304 Hampton Place
  57.   Elkridge, MD 21227
  58.   USA
  59.  
  60.   VGB-Windows is a 32-bit application which runs under Windows 3.11, 
  61. Windows 95, and Windows NT. It is compiled with Borland C++ and needs 
  62. Microsoft WinG library which can be obtained from
  63.  
  64.   ftp://ftp.microsoft.com/Softlib/MSFILES/WING10.EXE
  65.  
  66.  
  67.  
  68.  
  69.                       * NEW IN THIS VERSION *
  70.  
  71. o Windows version is made.
  72. o Some heavy magic is done on the interrupts.
  73. o Palette registers are writable now.
  74. o Sprite display routine is changed.
  75. o Sprites are now clipped properly at the top and bottom boundaries.
  76. o -delay/-nodelay option is added.
  77. o etc.
  78.  
  79.  
  80.  
  81.                * SHORT MANUAL FOR THE WINDOWS USERS *
  82.  
  83.   In order to use VGB-Windows, you will first have to install WinG
  84. graphical library which can be obtained from Microsoft [see address
  85. above]. Also, the VGB-WIndows distribution contains a file called
  86. BWCC32.DLL which should be either kept in a directory from which
  87. VGB runs, or copied into \WINDOWS\SYSTEM directory.
  88.   VGB-Windows runs in a resizable window with the following menus:
  89.  
  90. o File
  91.   o New
  92.     This opton allows to run a new game. If you only have an unregistered
  93.     version of VGB-Windows, it will be disabled so that you will only be
  94.     able to choose a game when emulator starts.
  95.   o Setup
  96.     This option pops up a setup dialog allowing to change all 4 GameBoy's
  97.     colors and some emulation parameters:
  98.     o Palette
  99.       Use this group of controls to select a color and change its RGB
  100.       components. The palette controls may not work very well if you
  101.       run Windows in 256-color mode. Use 16-bit or 24-bit graphical
  102.       mode for best effect. 
  103.     o VBlank Period
  104.       This parameter determines how many CPU commands will be executed
  105.       between vertical blanking interrupts. Setting it lower may speed
  106.       up the emulation, but setting it too low will hang it.
  107.     o Update Period
  108.       This parameter determines how many vertical blanking interrupts
  109.       will pass between window refreshes. It is usually set to 2, but
  110.       you can increase it to make VGB work faster. The sprite
  111.       movements become jerky at high update periods though, and some
  112.       sprites may simply disappear.
  113.     o Delay Line Interrupts
  114.       If you see "dirty" horizontal lines in some games, you may turn
  115.       this option on or off to remove them. There is no some universal
  116.       state of this option which will work for all games though.  
  117.   o Quit
  118. o Size
  119.   o 1:1  These options change the window size to be the same as in real
  120.   o 2:1  GameBoy, or 2/3/4 times bigger. Please, note that you can change
  121.   o 3:1  window size by simple dragging the bottom-right corner of a
  122.   o 4:1  window with the mouse.
  123. o Help
  124.   o About
  125.     This option will display a dialog box with copyright information
  126.     and other legal stuff.
  127.  
  128.  
  129.  
  130.                    * FREQUENTLY ASKED QUESTIONS *
  131.  
  132. 1. What is GameBoy?
  133.   GameBoy is a handheld videogame machine produced by Nintendo. It is 
  134. built around a custom CPU similar to Z80, but with some changes. GameBoy 
  135. is frequently laughed at because of its reflective green-on-yellow LCD 
  136. screen which in fact is its virtue. Due to the low power consumption of 
  137. its LCD, GameBoy can work for 35 hours off 4 AA batteries. There is a lot 
  138. of good games produced for GameBoy, both classics [Tetris, Pacman, 
  139. Asteroids, etc.] and specific ones [Final Fantasy series for GB]. It 
  140. excells in RPGs and classic games where gameplay is more important than 
  141. graphics. More information about GameBoy is available from
  142.  
  143.                 http://www.cs.umd.edu/users/fms/GameBoy/
  144.  
  145. 2. Where do I get GameBoy games?
  146.   You buy the cartridges. GameBoy software is copyrighted and still sold. 
  147. Therefore, its distribution is an act of piracy. Nothing prohibits you 
  148. from backing up a cartridge you own and playing it on the emulator though.
  149. To back up a GameBoy cartridge, you can use either SmartCard copier [about
  150. $100 for a standalone version], or a self-built copier, description of
  151. which will hopefully be available at the WWW page soon.
  152.  
  153. 3. Is it legal to spread GameBoy cartridge snapshots?
  154.   NO. Be aware of the fact that by using commercial software you haven't 
  155. bought, you are commencing an act of piracy. Not that I care, anyway...
  156.  
  157. 4. What are the keys used in VGB?
  158.   VGB Unix/X keys:
  159.  
  160.   [SPACE] - A button
  161.   [LALT]  - B button                        ([CONTROL] in Windows)
  162.   [TAB]   - SELECT button
  163.   [ENTER] - START button
  164.   [ESC]   - Quit emulation
  165.   [F1]    - Turn tracing on/off             (Not implemented in Windows)
  166.   [F2]    - Show LCD controller registers   (Not implemented in Windows)
  167.  
  168. 5. Where is the complete list of command line options of VGB?
  169.   Use -help option. It will tell VGB to display all options available in 
  170. your version. Following are the options available in VGB-Unix/X:
  171.  
  172.   -verbose <level>    - Select debugging messages [5]
  173.                         0 - Silent           1 - Startup messages
  174.                         2 - Illegal writes   4 - Illegal CPU ops
  175.                         8 - Bank switching
  176.   -vperiod <period>   - Set VBlank interrupts period [10000ops]
  177.   -uperiod <period>   - Number of interrupts per screen update [2]
  178.   -help               - Print this help page
  179.   -cheat <GG code>    - Activate a GameGenie cheat [not supported yet]
  180.   -shm/-noshm         - Use/don't use MIT SHM extensions for X [-shm]
  181.   -trap <address>     - Trap execution when PC reaches address [FFFFh]
  182.   -delay/nodelay      - Delay/don't delay coincidence int-s [-nodelay]
  183.   -saver/-nosaver     - Save/don't save CPU when inactive [-saver]
  184.   -color0 <name>      - Change color#0 [black]
  185.   -color1 <name>      - Change color#1 [#585858]
  186.   -color2 <name>      - Change color#2 [#989898]
  187.   -color3 <name>      - Change color#3 [white]
  188.  
  189. 6. Why some games do not run with VGB?
  190.   As it was said before, VGB emulation is not completely accurate yet.
  191. Also, some games will probably never run on VGB.
  192.  
  193. o If a game refuses to work, try changing -vperiod value from 2000 to
  194.   15000, or moving a "VBlank Period" knob in the VGB-Windows setup
  195.   window.
  196. o If you see a group of "dirty" lines on VGB screen, or a game behaves
  197.   strangely, try -delay/-nodelay options, or check/clear the "Delay
  198.   Line Interrupts" checkbox in the VGB-Windows setup window. 
  199. o If some sprites blink or do not appear at all, try changing -uperiod
  200.   value from 1 to 10 [1 will give you the best picture, but the slowest
  201.   emulation], or moving an "Update Period" knob in the VGB-Windows
  202.   setup window.
  203.  
  204. 7. Palette controls in VGB-Windows do not work.
  205.   This probably means that you are running Windows in the 256-color
  206. mode. In this mode, not all of 256 possible colors are available, and
  207. you will be able to choose only from the available colors. Switch
  208. Windows into 16-bit or 24-bit graphics and palette will start working.
  209.  
  210. 8. I start VGB-WIndows, but it tells me that WING.DLL is not found.
  211.   This means that you haven't installed WinG library necessary to run
  212. VGB. Check the information in the beginning of this manual on how to
  213. obtain WinG.
  214.  
  215. 9. I start VGB-WIndows, but it tells me that BWCC32.DLL is not found.
  216.   VGB-Windows comes with a file called BWCC32.DLL. This file should
  217. be either kept in the directory from which VGB runs, or put into
  218. \WINDOWS\SYSTEM directory.
  219.  
  220. 10. Why is VGB so slow on my computer?
  221.   Because your computer is too slow to run VGB. VGB is written entirely in
  222. C language and therefore is quite slow. Although it works on 486/33 and even 
  223. 386/33 PCs, it runs best on a Pentium/90 or a DEC Alpha/150. You can try to 
  224. speed it up by increasing -uperiod value controlling the number of vertical
  225. blanking impulses between screen updates to 3-6, and by decreasing -vperiod
  226. value controlling the number of CPU cycles between vertical blanking
  227. impulses to 3000-6000. Please, DO NOT SEND ME MAIL about VGB speed.
  228.  
  229. 11. Can I compile VGB with my Borland/Turbo C compiler?
  230.   You can, given that your compiler creates executables using flat 32bit 
  231. memory model. Two PC compilers which do that are WATCOM [using DOS4GW DOS 
  232. extender] and GCC [using DJPP extender]. The only Borland/Turbo C 32-bit 
  233. compiler that I'm aware of is for Windows.
  234.  
  235. 12. When compiling VGB under Unix, I get "undefined name" errors.
  236.   This means that your linker can not find the libraries necessary
  237. for VGB [namely, libX11.a and libXext.a]. Find these libraries in
  238. your system and modify the Makefile so that the final invocation
  239. of the C compiler has "-L<path_to_libs>" options. If the errors
  240. persist, try #undefining MITSHM option.
  241.  
  242. 13. When starting VGB-Unix/X, I get X_ShmAttach error.
  243.   You are probably trying to run VGB on a remote Xterminal while it 
  244. attempts to use shared memory for interfacing with X. Use -noshm option 
  245. to tell VGB not to use shared memory.
  246.  
  247. 14. VGB starts under Unix, but then I get X_PutImage error.
  248.   Unix/X version of VGB currently needs 256-color X. Neither 2-color 
  249. nor TrueColor Xterminals will work with the drivers included into 
  250. "official" VGB distribution.
  251.  
  252. 15. I start VGB-Unix/X but the window stays black.
  253.   Some other X application took over all available colors so that VGB 
  254. could not allocate any for itself. Check if you run XV, Netscape, or 
  255. something similar.
  256.  
  257. ---------------
  258. Marat Fayzullin
  259.