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

   1 -------------------------------------------
   2 Virtual Jaguar v2.1.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 your hardware and/or software. You may only use the ROM images
  19 if you own the cartridges itself. The use of commercial ROMs without owning the
  20 original cartridge is illegal in most countries and could result in fines
  21 and/or legal actions.
  22
  23 The products, trademarks and/or brands used in these documents and/or
  24 sourcecode are owned by their respective companies and/or successors in
  25 interest.
  26
  27 This software is released under the GPL v3 or later. For more information, read
  28 the GPLv3 file.
  29
  30 ----------------------------------------------------------------
  31 - IMPORTANT NOTE ABOUT JAGUAR FILE FORMATS--READ THIS OR ELSE! -
  32 ----------------------------------------------------------------
  33
  34 There seems to be a lot of confusion surrounding the various file formats that
  35 Jaguar programs come in, and a lot of this confusion seem to come from
  36 Cowering's GoodJag renaming tool. Note that it simply gets some files wrong,
  37 and it also incorrectly renames cartridge images with an extension that
  38 belongs to an already established extension (.jag is a Jaguar Server
  39 executable--read on). To clarify, there are basically four major types of
  40 Jaguar binary images that are NOT cartridge images:
  41
  42     .abs
  43     .jag
  44     .rom
  45     .bin
  46
  47 The first type, the .abs file, is a DRI/Alcyon format absolute location
  48 executable. These come in two different flavors and contain load and run
  49 addresses in their headers. Note that some files which have an .abs extension
  50 are really incorrectly labelled .bin files with no header information
  51 whatsoever.
  52
  53 The second type, the .jag file, is a Jaguar Server executable. These files
  54 contain header information that tells you where to load and run the file's
  55 executable code. Note that as of this writing (8/5/2005) that the GoodJag ROM
  56 renaming tool by Cowering incorrectly renames Jaguar cartridge ROM dumps to
  57 have a .jag extension (a better choice, and the one supported by Virtual
  58 Jaguar, is .j64)--if you're trying to run a ROM image with a .jag extension on
  59 VJ, it will misinterpret it as a Jaguar Server executable and likely fail to
  60 run.
  61
  62 The third type, the .rom file, is an Alpine Board/ROM Image file. These files
  63 have no header, but are known to load and run at $802000 in the Jaguar memory
  64 space. Again, these are *different* from cartridge dumps since they load at a
  65 higher address than a Jaguar cartridge.
  66
  67 The fourth type, the .bin file, is simply a Jaguar executable with no header.
  68 Since these files contain no information about where they load and execute,
  69 Virtual Jaguar does not support this file type. Go bug the author to release
  70 either a file with proper headers or a file in Alpine ROM format. Virtual
  71 Jaguar is not omniscient (yet)! ;)
  72
  73 There is a fifth type of file that is supported by Virtual Jaguar, the .j64
  74 file, which is simply a 1, 2, or 4 Meg dump of a Jaguar cartridge ROM which
  75 loads at $800000 in the Jaguar memory space.
  76
  77 ----------------------------------
  78 - What is Virtual Jaguar GCC/Qt? -
  79 ----------------------------------
  80
  81 Virtual Jaguar is software dedicated to emulating the Atari Jaguar hardware on
  82 a standard PC. The software was originally developed by David Raingeard of
  83 Potato Emulation [http://potato.emu-france.com] and was released under the GPL
  84 on 25 June 2003.
  85
  86 Virtual Jaguar GCC/Qt is not just a port of the MS Visual C++/SDL sourcecode
  87 but has also been extended and rewritten so that we can enjoy Atari Jaguar
  88 emulation on every platform that has a GCC compiler and a port of Qt.
  89
  90 Currently Virtual Jaguar GCC/Qt compiles on WIN32 using mingw, and several
  91 UN*X based systems (BeOS, Linux, FreeBSD and MacOS). It may run on other
  92 systems as well but we can not guarantee that.
  93
  94 The port was done by the SDLEMU crew (http://sdlemu.ngemu.com) and especially
  95 by Niels Wagenaar and Carwin Jones. A major portion of the rewrite was done by
  96 James Hammons. You may contact us by e-mail (sdlemu@ngemu.com) or leave a
  97 message on the SDLEMU Official Forum (see the website). Patches and bugfixes
  98 are particularly welcome! :)
  99
 100 More information about the incredible SDL libraries can be found at
 101 http://www.libsdl.org. Thanks Sam--you rock! :)
 102
 103 -------------------------------
 104 - Using Virtual Jaguar GCC/Qt -
 105 -------------------------------
 106
 107 Simply double click on the Virtual Jaguar icon or type ./virtualjaguar from
 108 the command line. See the built in help (under Help|Contents) for more
 109 information on how to use it. :-)
 110
 111 -----------
 112 - Finally -
 113 -----------
 114
 115 If you find bugs, enhance the code or simply have questions, drop us an e-mail
 116 at sdlemu AT ngemu DOT com or drop a message on the SDLEMU Official Forum.
 117
 118 More information about this project (releases/WIP) can be found at the official
 119 Virtual Jaguar website [http://www.icculus.org/virtualjaguar] and on the SDLEMU
 120 website [http://sdlemu.ngemu.com].
 121
 122 We hope you enjoy the emulator and will use it wisely!
 123
 124 Thanks go to guys over at ngemu.com and #ngemu (EFNET). Thanks also to David
 125 Raingeard of Potato Emulation who originally developed this emulator and
 126 released the sources to the public. We couldn't have done it without you!
 127
 128 Special thanks go to everyone who submitted good, detailed bug reports,
 129 sometimes with demonstration code(!); your help has helped to make Virtual
 130 Jaguar better, more accurate, and more polished than it would be otherwise. We
 131 really appreciate your help!
 132
 133 SDLEMU