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

   1 --------------------------------------------
   2 Virtual Jaguar v1.1.0 GCC/SDL release README
   3 --------------------------------------------
   4
   5 --------------
   6 - DISCLAIMER -
   7 --------------
   8
   9 Or, "O liability, I do disclaim thee!"
  10
  11 Ported by SDLEMU (Niels Wagenaar & Carwin Jones) and is based upon the
  12 original work by David Raingeard of Potato Emulation. For requirements please
  13 consult the INSTALL file for more information about supported OS's and
  14 software requirements.
  15
  16 The use of this software is entirely at your own risk. We can't be held
  17 responsible for damage done to you hardware and/or software. While it won't
  18 rape your dog, it might do other nasty things. You have been warned. This
  19 software requires the use of the Atari Jaguar (CD) boot ROM and/or Commercial
  20 ROM images. You may only use the ROM images if you own the cartridges itself.
  21 The use of Commercial ROMs without owning the original cartridge is illegal in
  22 most countries and could result in fines and/or legal actions.
  23
  24 This software is released under the GPL v2 or later. For more information I
  25 direct you to the GPL.TXT. You may hack/change the code anyway you like. You
  26 may not commercially sell this software. If you make changes, release the
  27 source code to the public and send the changes you made to the original
  28 authors.
  29
  30 The products and brands used in these documents and/or sourcecode are owned by
  31 their respective companies and/or successors in interest.
  32
  33 ----------------------------------------------------------------
  34 - IMPORTANT NOTE ABOUT JAGUAR FILE FORMATS--READ THIS OR ELSE! -
  35 ----------------------------------------------------------------
  36
  37 There seems to be a lot of confusion surrounding the various file formats that
  38 Jaguar programs come in, and a lot of this confusion seem to come from
  39 Cowering's GoodJag renaming tool. Note that it simply gets some files wrong,
  40 and it also incorrectly renames cartridge images with an extension that
  41 belongs to an already established extension (.jag is a Jaguar Server
  42 executable--read on). To clarify, there are basically four major types of
  43 Jaguar binary images that are NOT cartridge images:
  44
  45     .abs
  46     .jag
  47     .rom
  48     .bin
  49
  50 The first type, the .abs file, is a DRI/Alcyon format absolute location
  51 executable. These come in two different flavors and contain load and run
  52 addresses in their headers. Note that some files which have an .abs extension
  53 are really incorrectly labelled .bin files with no header information
  54 whatsoever.
  55
  56 The second type, the .jag file, is a Jaguar Server executable. These files
  57 contain header information that tells you where to load and run the file's
  58 executable code. Note that as of this writing (8/5/2005) that the GoodJag ROM
  59 renaming tool by Cowering incorrectly renames Jaguar cartridge ROM dumps to
  60 have a .jag extension (a better choice, and the one supported by Virtual
  61 Jaguar, is .j64)--if you're trying to run a ROM image with a .jag extension on
  62 VJ, it will misinterpret it as a Jaguar Server executable and likely fail to
  63 run.
  64
  65 The third type, the .rom file, is an Alpine Board/ROM Image file. These files
  66 have no header, but are known to load and run at $802000 in the Jaguar memory
  67 space. Again, these are *different* from cartridge dumps since they load at a
  68 higher address than a Jaguar cartridge.
  69
  70 The fourth type, the .bin file, is simply a Jaguar executable with no header.
  71 Since these files contain no information about where they load and execute,
  72 Virtual Jaguar does not support this file type. Go bug the author to release
  73 either a file with proper headers or a file in Alpine ROM format. Virtual
  74 Jaguar is not omniscient (yet)! ;)
  75
  76 There is a fifth type of file that is supported by Virtual Jaguar, the .j64
  77 file, which is simply a 1, 2, or 4 Meg dump of a Jaguar cartridge ROM which
  78 loads at $800000 in the Jaguar memory space.
  79
  80 -----------------------------------
  81 - What is Virtual Jaguar GCC/SDL? -
  82 -----------------------------------
  83
  84 Virtual Jaguar is software dedicated to emulating the Atari Jaguar hardware on
  85 a standard PC. The software was originally developed by David Raingeard of
  86 Potato Emulation [http://potato.emu-france.com] and was released under the GPL
  87 on 25 June 2003.
  88
  89 Virtual Jaguar GCC/SDL is not only a port of the MS Visual C++/SDL sourcecode
  90 but has also been extended and rewritten so that we can enjoy Atari Jaguar
  91 emulation on every platform which uses the GCC compiler and that can make use
  92 of the Simple Directmedia Layer library (SDL).
  93
  94 Currently Virtual Jaguar GCC/SDL compiles on WIN32 using mingw, and several
  95 UN*X based systems (BeOS, Linux and FreeBSD). It may run on other systems
  96 as well but we can not guarantee that.
  97
  98 The port was done by the SDLEMU crew (http://sdlemu.ngemu.com) and especially
  99 by Niels Wagenaar and Carwin Jones. A major portion of the rewrite was done by
 100 James L. Hammons. You may contact us by e-mail (sdlemu@ngemu.com) or leave a
 101 message on the SDLEMU Official Forum (see the website). Patches and bugfixes
 102 are particularly welcome! :)
 103
 104 More information about SDL can be found at http://www.libsdl.org.
 105
 106 --------------------------------
 107 - Using Virtual Jaguar GCC/SDL -
 108 --------------------------------
 109
 110 After compiling the binary (see INSTALL) you can now run original Atari Jaguar
 111 games. These games are distributed on cartridges and can therefore cannot be
 112 used on a PC (we're still waiting for that Jaguar-on-a-PCI-card that you plug
 113 into your late model PC, complete with cartridge slot ;-). To use these games
 114 on Virtual Jaguar GCC/SDL you need to get ROM images. Besides the ROM images
 115 from commercial games you must also obtain the Atari Jaguar (CD) boot ROM
 116 which you must copy to the BIOS directory. For legal issues concerning ROM
 117 images please consult the DISCLAIMER at the beginning of this file.
 118
 119 After obtaining the Atari Jaguar (CD) boot ROM and several ROMs you can now
 120 use Virtual Jaguar using the following command:
 121
 122 ./vj [romfile] [-switches]
 123
 124 The context of ROMFILE is the filename of the an Atari Jaguar ROM dump (can be
 125 either compressed or uncompressed). You can also use switches. By just typing
 126 ./vj -? (or ./vj -help) you get an overview of the options you can use. WIN32
 127 users should look into the stdout.txt in the directory they ran Virtual Jaguar
 128 for that information.
 129
 130 If you prefer a nice GUI instead of typing in command lines, you can either
 131 type ./vj or double click on the Virtual Jaguar executable. If you have a
 132 directory full of ROM files, you can tell Virtual Jaguar where they are by
 133 editing the appropriate line in the vj.cfg file (it assumes a ROMs directory
 134 under the directory where VJ lives) so that they show up when you pick the
 135 "Load" option from the "File" menu.
 136
 137 This emulator also emulates the Atari Jaguar gamepads. By using the following
 138 keyboard or joystick settings you can (possibly) play a given game:
 139
 140 Atari Button C       : Z or joystick button 3
 141 Atari Button B       : X or joystick button 2
 142 Atari Button A       : C or joystick button 1
 143 Atari Buttons 1 - 10 : Keypad 0 - 9 (0 = 10)
 144 Atari Start/Pause    : ENTER
 145 Atari Select         : '
 146 Atari UP             : UP    or joystick UP
 147 Atari DOWN           : DOWN  or joystick DOWN
 148 Atari LEFT           : LEFT  or joystick LEFT
 149 Atari RIGHT          : RIGHT or joystick RIGHT
 150 Atari #              : Keypad /
 151 Atari *              : Keypad *
 152
 153 With ESC you can easily stop Virtual Jaguar GCC/SDL which will get you back to
 154 the GUI (pressing ESC again will take you back to the game). To exit VJ, you
 155 can either select File|Quit or press the "Q" key on your keyboard. If you want
 156 to change the key layout, simply edit the vj.cfg file and change the keys. :)
 157 NOTE: There are quite a few keys mapped to debugging functions at present. You
 158 have been warned!
 159
 160 -------------------
 161 - A note on sound -
 162 -------------------
 163
 164 By default, the Virtual Jaguar's DSP is turned off, since it doesn't work very
 165 well at present (it requires a lot of horsepower to sound decent at this
 166 point!). In order to hear any sound at all, you have to either edit the vj.cfg
 167 file and change the appropriate line or set the DSP on in the GUI (found under
 168 Settings|Misc). One word of caution: Use the old DSP core instead of the new
 169 pipelined version for now--the new pipelined DSP core has not yet been
 170 optimized and runs quite slow at present! Once the DSP issues have been ironed
 171 out, it will be turned on by default and you won't have to deal with it
 172 anymore. ;)
 173
 174 -----------
 175 - Finally -
 176 -----------
 177
 178 If you find bugs, enhance the code or simply have questions, drop us an e-mail
 179 at sdlemu AT ngemu DOT com or drop a message on the SDLEMU Official Forum.
 180
 181 More information about this project (releases/WIP) can be found at the official
 182 Virtual Jaguar website [http://www.icculus.org/virtualjaguar] and on the SDLEMU
 183 website [http://sdlemu.ngemu.com].
 184
 185 We hope you enjoy the emulator and will use it wisely!
 186
 187 Special thanks go to guys over at ngemu.com and #ngemu (EFNET). Thanks also to
 188 David Raingeard of Potato Emulation who originally developed this emulator and
 189 released the sources to the public. We couldn't have done it without you!
 190
 191 SDLEMU