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

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