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

   1 Virtual Jaguar v1.0.0 GCC/SDL release README
   2 --------------------------------------------
   3
   4 - DISCLAIMER -
   5
   6 Ported by SDLEMU (Niels Wagenaar & Caz) and is based upon the original work
   7 from Potato Emulation. For requirements please consult the INSTALL file for
   8 more information about supported OS' and software requirements.
   9
  10 The use of this software is entirely at your own risk. We can't be held
  11 responsible for damage done to you hard- and/or software. This software
  12 requires the use of the Atari Jaguar (CD) boot ROM and/or Commercial ROM
  13 images. You may only use the ROM images if you own the cartridges itself.
  14 The use of Commercial ROM's without owning the original cartridge is
  15 illegal in most countries and could result in fines and/or legal actions.
  16
  17 This software is released under the GPL license. For more information I
  18 should direct you to the GPL.TXT. You may hack/change the code anyway you
  19 like. You may not commercially sell this software.
  20
  21 If you make changes, release the sourcecode to the public and send us the
  22 changes you made to the original authors.
  23
  24 The products and brands used in these documents and/or sourcecode are owned
  25 but the desired company in question.
  26
  27 - What is Virtual Jaguar GCC/SDL?
  28
  29 Virtual Jaguar is software dedicated to emulate the Atari Jaguar hardware
  30 on you standard P.C. The software was originally developed by Potato Emulation
  31 (http://potato.emu-france.com) and was released under the GPL license on
  32 25 June 2003.
  33
  34 Virtual Jaguar GCC/SDL is a port of the MS Visual C++/SDL sourcecode so that
  35 we can enjoy Atari Jaguar emulation on every platform which uses the GCC
  36 compiler and what can make use of the Simple Directmedia Layer library (SDL).
  37
  38 Currently Virtual Jaguar GCC/SDL compiles on WIN32, using mingw, and several
  39 UN*X based systems (BeOS, Linux and FreeBSD). It may run on other systems
  40 as well but we can not garantee that.
  41
  42 The port was done by the SDLEMU crew (http://sdlemu.ngemu.com) and especially
  43 by Niels Wagenaar and Caz. You may contact us by e-mail (sdlemu@ngemu.com) or
  44 leave a message on the SDLEMU Official Forum (see the website).
  45
  46 More information about SDL can be found at http://www.libsdl.org.
  47
  48 - Using Virtual Jaguar GCC/SDL
  49
  50 After compiling the binary (see INSTALL) you can now run original Atari Jaguar
  51 games. These games are distributed on cartridges and can there for not be used
  52 on a P.C. To use these games on Virtual Jaguar GCC/SDL you need to get ROM
  53 images. Besides that ROM imgaes from Commercial games you must also obtain the
  54 Atari Jaguar (CD) boot ROM which you must copy to the BIOS directory.
  55 For legal issues concerning ROM images please consult the DISCLAIMER at the
  56 beginning of this file.
  57
  58 After obaining the Atari Jaguar (CD) boot ROM and several ROM's you can now
  59 use Virtual Jaguar using the following command :
  60
  61 ./vj romfile -switch
  62
  63 The context of ROMFILE is the filename of the an Atari Jaguar ROM dump (can be
  64 either compressed or uncompressed). You can also use switches. By just typing
  65 ./vj you get an overview of the options you can use. WIN32 users should look
  66 into the stdout.txt for that information.
  67
  68 If you succesfully start the emulator with the game you should see a window
  69 (or fullscreen) which shows the game. If the game doesn't comply to a CRC
  70 check the game will display a black screen, this means that the game is
  71 probably a hack or a new game which isn't supported. You may add the CRC
  72 check to the sources yourself (src/crc32.cpp).
  73
  74 This emulator also emulates the Atari Jaguar Analog gamepads. By using the
  75 following keyboard or joystick settings you can (possibly) play the game :
  76
  77 Atari Button C       : Z or joystick button 3
  78 Atari Button B       : X or joystick button 2
  79 Atari Button A       : C or joystick button 1
  80 Atari Buttons 1 - 10 : Keypad 0 - 9 (0 = 10)
  81 Atari Start/Pause    : ENTER
  82 Atari Select         : TAB
  83 Atari UP             : UP    or joystick UP
  84 Atari DOWN           : DOWN  or joystick DOWN
  85 Atari LEFT           : LEFT  or joystick LEFT
  86 Atari RIGHT          : RIGHT or joystick RIGHT
  87 Atari *, # are not mapped yet!
  88
  89 With ESC you can easily stop Virtual Jaguar GCC/SDL which will get you back
  90 to you command prompt. If you want to change the key layout, simply hack the
  91 src/joystick.cpp and change the keys :)
  92
  93 - Finally
  94
  95 If you find bugs, enhance the code or simply have questions. Drop us an e-mail
  96 at sdlemu AT ngemu DOT com or drop a message on the SDLEMU Official Forum.
  97
  98 More information about this projects (releases/WIP) can be found at the SDLEMU
  99 website : http://sdlemu.ngemu.com.
 100
 101 I hope you enjoy the emulator and will use it wisely!
 102
 103 Special thanks go to guys over at ngemu.com and #ngemu (EFNET). Also the author
 104 who originally developed this emulator is thanked for releasing the sources to
 105 the public.
 106
 107 SDLEMU