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! This
  19 software may require the use of the Atari Jaguar boot ROMs 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 v3 or later. For more information I
  25 direct you to the GPLv3 file. 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, trademarks and/or brands used in these documents and/or
  31 sourcecode are owned by their respective companies and/or successors in
  32 interest.
  33
  34 ----------------------------------------------------------------
  35 - IMPORTANT NOTE ABOUT JAGUAR FILE FORMATS--READ THIS OR ELSE! -
  36 ----------------------------------------------------------------
  37
  38 There seems to be a lot of confusion surrounding the various file formats that
  39 Jaguar programs come in, and a lot of this confusion seem to come from
  40 Cowering's GoodJag renaming tool. Note that it simply gets some files wrong,
  41 and it also incorrectly renames cartridge images with an extension that
  42 belongs to an already established extension (.jag is a Jaguar Server
  43 executable--read on). To clarify, there are basically four major types of
  44 Jaguar binary images that are NOT cartridge images:
  45
  46     .abs
  47     .jag
  48     .rom
  49     .bin
  50
  51 The first type, the .abs file, is a DRI/Alcyon format absolute location
  52 executable. These come in two different flavors and contain load and run
  53 addresses in their headers. Note that some files which have an .abs extension
  54 are really incorrectly labelled .bin files with no header information
  55 whatsoever.
  56
  57 The second type, the .jag file, is a Jaguar Server executable. These files
  58 contain header information that tells you where to load and run the file's
  59 executable code. Note that as of this writing (8/5/2005) that the GoodJag ROM
  60 renaming tool by Cowering incorrectly renames Jaguar cartridge ROM dumps to
  61 have a .jag extension (a better choice, and the one supported by Virtual
  62 Jaguar, is .j64)--if you're trying to run a ROM image with a .jag extension on
  63 VJ, it will misinterpret it as a Jaguar Server executable and likely fail to
  64 run.
  65
  66 The third type, the .rom file, is an Alpine Board/ROM Image file. These files
  67 have no header, but are known to load and run at $802000 in the Jaguar memory
  68 space. Again, these are *different* from cartridge dumps since they load at a
  69 higher address than a Jaguar cartridge.
  70
  71 The fourth type, the .bin file, is simply a Jaguar executable with no header.
  72 Since these files contain no information about where they load and execute,
  73 Virtual Jaguar does not support this file type. Go bug the author to release
  74 either a file with proper headers or a file in Alpine ROM format. Virtual
  75 Jaguar is not omniscient (yet)! ;)
  76
  77 There is a fifth type of file that is supported by Virtual Jaguar, the .j64
  78 file, which is simply a 1, 2, or 4 Meg dump of a Jaguar cartridge ROM which
  79 loads at $800000 in the Jaguar memory space.
  80
  81 ----------------------------------
  82 - What is Virtual Jaguar GCC/Qt? -
  83 ----------------------------------
  84
  85 Virtual Jaguar is software dedicated to emulating the Atari Jaguar hardware on
  86 a standard PC. The software was originally developed by David Raingeard of
  87 Potato Emulation [http://potato.emu-france.com] and was released under the GPL
  88 on 25 June 2003.
  89
  90 Virtual Jaguar GCC/Qt is not just a port of the MS Visual C++/SDL sourcecode
  91 but has also been extended and rewritten so that we can enjoy Atari Jaguar
  92 emulation on every platform that has a GCC compiler and a port of Qt.
  93
  94 Currently Virtual Jaguar GCC/Qt compiles on WIN32 using mingw, and several
  95 UN*X based systems (BeOS, Linux, FreeBSD and MacOS). It may run on other
  96 systems 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 the incredible SDL libraries can be found at
 105 http://www.libsdl.org. Thanks Sam--you rock! :)
 106
 107 -------------------------------
 108 - Using Virtual Jaguar GCC/Qt -
 109 -------------------------------
 110
 111 After compiling the binary (see INSTALL) you can now run original Atari Jaguar
 112 games. These games are distributed on cartridges and can therefore cannot be
 113 used on a PC (we're still waiting for that Jaguar-on-a-PCI-card that you plug
 114 into your late model PC, complete with cartridge slot and controller connectors
 115 ;-). To use these games on Virtual Jaguar GCC/Qt you need to get ROM images.
 116 Besides the ROM images from commercial games, you may also need to obtain the
 117 Atari Jaguar boot ROM (and/or CD boot ROM) which you must copy to the BIOS
 118 directory. For legal issues concerning ROM images please consult the DISCLAIMER
 119 at the beginning of this file.
 120
 121 After obtaining the Atari Jaguar boot ROM (and/or CD boot ROM) and several game
 122 ROMs you can now use Virtual Jaguar using the following command:
 123
 124 ./virtualjaguar [romfile] [-switches]
 125
 126 The context of ROMFILE is the filename of the an Atari Jaguar ROM dump (can be
 127 either compressed or uncompressed). You can also use switches. By just typing
 128 ./virtualjaguar -? (or ./virtualjaguar -help) you get an overview of the
 129 options you can use. WIN32 users should look into the stdout.txt in the
 130 directory they ran Virtual Jaguar for that information. Also, WIN32 users
 131 should be aware that if their ROM filenames contain any spaces, you will have
 132 to enclose the ROMFILE in double quotes for Virtual Jaguar to function
 133 properly.
 134
 135 Note that running Virtual Jaguar this way will cause the emulator to exit
 136 completely upon pressing the ESC key. If this is not what you want, then omit
 137 the ROMFILE and it will bring up a nice GUI instead.
 138
 139 If you prefer a nice GUI instead of typing in command lines, you can either
 140 type ./virtualjaguar or double click on the Virtual Jaguar executable. If you
 141 have a directory full of ROM files, you can tell Virtual Jaguar where they are
 142 by editing the appropriate line in the vj.cfg file (it assumes a ROMs directory
 143 under the directory where VJ lives) so that they show up when you pick the
 144 "Load" option from the "File" menu.
 145
 146 This emulator also emulates the Atari Jaguar gamepads. By using the following
 147 keyboard or joystick settings you can (possibly) play a given game:
 148
 149 Atari Button C       : Z or joystick button 3
 150 Atari Button B       : X or joystick button 2
 151 Atari Button A       : C or joystick button 1
 152 Atari Buttons 1 - 10 : Keypad 0 - 9 (0 = 10)
 153 Atari Start/Pause    : ENTER
 154 Atari Select         : '
 155 Atari UP             : UP    or joystick UP
 156 Atari DOWN           : DOWN  or joystick DOWN
 157 Atari LEFT           : LEFT  or joystick LEFT
 158 Atari RIGHT          : RIGHT or joystick RIGHT
 159 Atari #              : Keypad /
 160 Atari *              : Keypad *
 161
 162 With ESC you can easily stop Virtual Jaguar GCC/Qt which will get you back to
 163 the GUI (pressing ESC again will take you back to the game). To exit VJ, you
 164 can either select File|Quit or press the "Q" key on your keyboard. If you want
 165 to change the key layout, simply edit the vj.cfg file and change the keys. :)
 166 NOTE: There are quite a few keys mapped to debugging functions at present. You
 167 have been warned!
 168
 169 -------------------
 170 - A note on sound -
 171 -------------------
 172
 173 By default, the Virtual Jaguar's DSP is turned off, since it doesn't work very
 174 well at present (it requires a lot of horsepower to sound decent at this
 175 point!). In order to hear any sound at all, you have to either edit the vj.cfg
 176 file and change the appropriate line or set the DSP on in the GUI (found under
 177 Settings|Misc). One word of caution: Use the old DSP core instead of the new
 178 pipelined version for now--the new pipelined DSP core has not yet been
 179 optimized and runs quite slow at present! Once the DSP issues have been ironed
 180 out, it will be turned on by default and you won't have to deal with it
 181 anymore. ;)
 182
 183 -----------
 184 - Finally -
 185 -----------
 186
 187 If you find bugs, enhance the code or simply have questions, drop us an e-mail
 188 at sdlemu AT ngemu DOT com or drop a message on the SDLEMU Official Forum.
 189
 190 More information about this project (releases/WIP) can be found at the official
 191 Virtual Jaguar website [http://www.icculus.org/virtualjaguar] and on the SDLEMU
 192 website [http://sdlemu.ngemu.com].
 193
 194 We hope you enjoy the emulator and will use it wisely!
 195
 196 Special thanks go to guys over at ngemu.com and #ngemu (EFNET). Thanks also to
 197 David Raingeard of Potato Emulation who originally developed this emulator and
 198 released the sources to the public. We couldn't have done it without you!
 199
 200 SDLEMU
 201
 202
 203 *** Stuff to add in:
 204
 205  o  Documentation needs a rewrite, more or less, as the GUI is now front and
 206     center. Need to update the docs to reflect this change.
 207  o  Document the new "solid" zip file archive mechanism which allows putting
 208     artwork into a "ROM".