Shamusworld >> Repos - virtualjaguar/blob - docs/README

   1 Virtual Jaguar v1.0.7 GCC/SDL release README
   2 --------------------------------------------
   3
   4 - DISCLAIMER -
   5
   6 Or, "O liability, I do disclaim thee!"
   7
   8 Ported by SDLEMU (Niels Wagenaar & Carwin Jones) and is based upon the
   9 original work from Potato Emulation. For requirements please consult the
  10 INSTALL file for more information about supported OS's and software
  11 requirements.
  12
  13 The use of this software is entirely at your own risk. We can't be held
  14 responsible for damage done to you hardware and/or software. This software
  15 requires the use of the Atari Jaguar (CD) boot ROM and/or Commercial ROM
  16 images. You may only use the ROM images if you own the cartridges itself.
  17 The use of Commercial ROMs without owning the original cartridge is illegal
  18 in most countries and could result in fines and/or legal actions.
  19
  20 This software is released under the GPL license. For more information I direct
  21 you to the GPL.TXT. You may hack/change the code anyway you like. You may not
  22 commercially sell this software.
  23
  24 If you make changes, release the source code to the public and send us the
  25 changes you made to the original authors.
  26
  27 The products and brands used in these documents and/or sourcecode are owned by
  28 their respective companies.
  29
  30 - What is Virtual Jaguar GCC/SDL?
  31
  32 Virtual Jaguar is software dedicated to emulating the Atari Jaguar hardware on
  33 a standard PC. The software was originally developed by David Raingeard of
  34 Potato Emulation [http://potato.emu-france.com] and was released under the GPL
  35 license on 25 June 2003.
  36
  37 Virtual Jaguar GCC/SDL is not only a port of the MS Visual C++/SDL sourcecode
  38 but has also been extended and rewritten so that we can enjoy Atari Jaguar
  39 emulation on every platform which uses the GCC compiler and that can make use
  40 of the Simple Directmedia Layer library (SDL).
  41
  42 Currently Virtual Jaguar GCC/SDL compiles on WIN32 using mingw, and several
  43 UN*X based systems (BeOS, Linux and FreeBSD). It may run on other systems
  44 as well but we can not guarantee that.
  45
  46 The port was done by the SDLEMU crew (http://sdlemu.ngemu.com) and especially
  47 by Niels Wagenaar and Carwin Jones. A major portion of the rewrite was done by
  48 James L. Hammons. You may contact us by e-mail (sdlemu@ngemu.com) or leave a
  49 message on the SDLEMU Official Forum (see the website). Patches and bugfixes
  50 are particularly welcome! :)
  51
  52 More information about SDL can be found at http://www.libsdl.org.
  53
  54 - Using Virtual Jaguar GCC/SDL
  55
  56 After compiling the binary (see INSTALL) you can now run original Atari Jaguar
  57 games. These games are distributed on cartridges and can there for cannot be
  58 used on a PC. To use these games on Virtual Jaguar GCC/SDL you need to get ROM
  59 images. Besides the ROM images from commercial games you must also obtain the
  60 Atari Jaguar (CD) boot ROM which you must copy to the BIOS directory. For legal
  61 issues concerning ROM images please consult the DISCLAIMER at the beginning of
  62 this file.
  63
  64 After obtaining the Atari Jaguar (CD) boot ROM and several ROMs you can now
  65 use Virtual Jaguar using the following command:
  66
  67 ./vj [romfile] [-switches]
  68
  69 The context of ROMFILE is the filename of the an Atari Jaguar ROM dump (can be
  70 either compressed or uncompressed). You can also use switches. By just typing
  71 ./vj -? (or ./vj -help) you get an overview of the options you can use. WIN32
  72 users should look into the stdout.txt for that information.
  73
  74 If you prefer a nice GUI instead of typing in command lines, you can either
  75 type ./vj or double click on the Virtual Jaguar executable. If you have a
  76 directory full of ROM files, you can tell Virtual Jaguar where they are by
  77 editing the appropriate line in the vj.cfg file (it assumes a ROMs directory
  78 under the directory where VJ lives) so that they show up when you pick the
  79 "Load" option from the "File" menu.
  80
  81 This emulator also emulates the Atari Jaguar gamepads. By using the following
  82 keyboard or joystick settings you can (possibly) play a given game:
  83
  84 Atari Button C       : Z or joystick button 3
  85 Atari Button B       : X or joystick button 2
  86 Atari Button A       : C or joystick button 1
  87 Atari Buttons 1 - 10 : Keypad 0 - 9 (0 = 10)
  88 Atari Start/Pause    : ENTER
  89 Atari Select         : '
  90 Atari UP             : UP    or joystick UP
  91 Atari DOWN           : DOWN  or joystick DOWN
  92 Atari LEFT           : LEFT  or joystick LEFT
  93 Atari RIGHT          : RIGHT or joystick RIGHT
  94 Atari #              : Keypad /
  95 Atari *              : Keypad *
  96
  97 With ESC you can easily stop Virtual Jaguar GCC/SDL which will get you back to
  98 the GUI (pressing ESC again will take you back to the game). To exit VJ, you
  99 can either select File|Quit or press the "Q" key on your keyboard. If you want
 100 to change the key layout, simply edit the vj.cfg file and change the keys. :)
 101 NOTE: There are quite a few keys mapped to debugging functions at present. You
 102 have been warned!
 103
 104 - Finally
 105
 106 If you find bugs, enhance the code or simply have questions, drop us an e-mail
 107 at sdlemu AT ngemu DOT com or drop a message on the SDLEMU Official Forum.
 108
 109 More information about this project (releases/WIP) can be found at the official
 110 Virtual Jaguar website [http://www.icculus.org/virtualjaguar] and on the SDLEMU
 111 website [http://sdlemu.ngemu.com].
 112
 113 I hope you enjoy the emulator and will use it wisely!
 114
 115 Special thanks go to guys over at ngemu.com and #ngemu (EFNET). Thanks also to
 116 David Raingeard of Potato Emulation who originally developed this emulator and
 117 released the sources to the public. We couldn't have done it without you!
 118
 119 SDLEMU