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

   1 -------------------------------------------
   2 Virtual Jaguar v2.0.0 GCC/Qt 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. While it won't rape
  17 your dog, it might do other nasty things. We can't be held responsible for
  18 damage done to you hardware and/or software. You have been warned! You may only
  19 use the ROM images if you own the cartridges itself. The use of Commercial ROMs
  20 without owning the original cartridge is illegal in most countries and could
  21 result in fines and/or legal actions.
  22
  23 This software is released under the GPL v3 or later. For more information I
  24 direct you to the GPLv3 file. You may hack/change the code anyway you like. You
  25 may not commercially sell this software. If you make changes, release the
  26 source code to the public and send the changes you made to the original
  27 authors.
  28
  29 The products, trademarks and/or brands used in these documents and/or
  30 sourcecode are owned by their respective companies and/or successors in
  31 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/Qt? -
  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/Qt is not just 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 that has a GCC compiler and a port of Qt.
  92
  93 Currently Virtual Jaguar GCC/Qt compiles on WIN32 using mingw, and several
  94 UN*X based systems (BeOS, Linux, FreeBSD and MacOS). It may run on other
  95 systems as well but we can not guarantee that.
  96
  97 The port was done by the SDLEMU crew (http://sdlemu.ngemu.com) and especially
  98 by Niels Wagenaar and Carwin Jones. A major portion of the rewrite was done by
  99 James L. Hammons. You may contact us by e-mail (sdlemu@ngemu.com) or leave a
 100 message on the SDLEMU Official Forum (see the website). Patches and bugfixes
 101 are particularly welcome! :)
 102
 103 More information about the incredible SDL libraries can be found at
 104 http://www.libsdl.org. Thanks Sam--you rock! :)
 105
 106 -------------------------------
 107 - Using Virtual Jaguar GCC/Qt -
 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 and controller connectors
 114 ;-). To use these games on Virtual Jaguar GCC/Qt you need to get ROM images.
 115 For legal issues concerning ROM images please consult the DISCLAIMER at the
 116 beginning of this file.
 117
 118 After obtaining several game ROMs you can now use Virtual Jaguar using the
 119 following command:
 120
 121 ./virtualjaguar [romfile] [-switches]
 122
 123 The context of ROMFILE is the filename of the an Atari Jaguar ROM dump (can be
 124 either compressed or uncompressed). You can also use switches. By just typing
 125 ./virtualjaguar -? (or ./virtualjaguar -help) you get an overview of the
 126 options you can use. WIN32 users should look into the stdout.txt in the
 127 directory they ran Virtual Jaguar for that information. Also, WIN32 users
 128 should be aware that if their ROM filenames contain any spaces, you will have
 129 to enclose the ROMFILE in double quotes for Virtual Jaguar to function
 130 properly.
 131
 132 Note that running Virtual Jaguar this way will cause the emulator to exit
 133 completely upon pressing the ESC key. If this is not what you want, then omit
 134 the ROMFILE and it will bring up a nice GUI instead.
 135
 136 If you prefer a nice GUI instead of typing in command lines, you can either
 137 type ./virtualjaguar or double click on the Virtual Jaguar executable. If you
 138 have a directory full of ROM files, you can tell Virtual Jaguar where they are
 139 by editing the appropriate line in the vj.cfg file (it assumes a ROMs directory
 140 under the directory where VJ lives) so that they show up when you pick the
 141 "Load" option from the "File" menu.
 142
 143 This emulator also emulates the Atari Jaguar gamepads. By using the following
 144 keyboard or joystick settings you can (possibly) play a given game:
 145
 146 Atari Button C       : Z or joystick button 3
 147 Atari Button B       : X or joystick button 2
 148 Atari Button A       : C or joystick button 1
 149 Atari Buttons 1 - 10 : Keypad 0 - 9 (0 = 10)
 150 Atari Start/Pause    : ENTER
 151 Atari Select         : '
 152 Atari UP             : UP    or joystick UP
 153 Atari DOWN           : DOWN  or joystick DOWN
 154 Atari LEFT           : LEFT  or joystick LEFT
 155 Atari RIGHT          : RIGHT or joystick RIGHT
 156 Atari #              : Keypad /
 157 Atari *              : Keypad *
 158
 159 With ESC you can easily stop Virtual Jaguar GCC/Qt which will get you back to
 160 the GUI (pressing ESC again will take you back to the game). To exit VJ, you
 161 can either select File|Quit or press the "Q" key on your keyboard. If you want
 162 to change the key layout, simply edit the vj.cfg file and change the keys. :)
 163 NOTE: There are quite a few keys mapped to debugging functions at present. You
 164 have been warned!
 165
 166 -------------------
 167 - A note on sound -
 168 -------------------
 169
 170 By default, the Virtual Jaguar's DSP is turned off, since it doesn't work very
 171 well at present (it requires a lot of horsepower to sound decent at this
 172 point!). In order to hear any sound at all, you have to either edit the vj.cfg
 173 file and change the appropriate line or set the DSP on in the GUI (found under
 174 Settings|Misc). One word of caution: Use the old DSP core instead of the new
 175 pipelined version for now--the new pipelined DSP core has not yet been
 176 optimized and runs quite slow at present! Once the DSP issues have been ironed
 177 out, it will be turned on by default and you won't have to deal with it
 178 anymore. ;)
 179
 180 -----------
 181 - Finally -
 182 -----------
 183
 184 If you find bugs, enhance the code or simply have questions, drop us an e-mail
 185 at sdlemu AT ngemu DOT com or drop a message on the SDLEMU Official Forum.
 186
 187 More information about this project (releases/WIP) can be found at the official
 188 Virtual Jaguar website [http://www.icculus.org/virtualjaguar] and on the SDLEMU
 189 website [http://sdlemu.ngemu.com].
 190
 191 We hope you enjoy the emulator and will use it wisely!
 192
 193 Special thanks go to guys over at ngemu.com and #ngemu (EFNET). Thanks also to
 194 David Raingeard of Potato Emulation who originally developed this emulator and
 195 released the sources to the public. We couldn't have done it without you!
 196
 197 SDLEMU
 198
 199
 200 *** Stuff to add in:
 201
 202  o  Documentation needs a rewrite, more or less, as the GUI is now front and
 203     center. Need to update the docs to reflect this change.
 204  o  Document the new "solid" zip file archive mechanism which allows putting
 205     artwork into a "ROM".