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

   1 -------------------------------------------
   2 Virtual Jaguar v2.0.2 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 may only use the ROM images if
  19 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 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 Simply double click on the Virtual Jaguar icon or type ./virtualjaguar from
 111 the command line. See the built in help (under Help|Contents) for more
 112 information on how to use it. :-)
 113
 114 -----------
 115 - Finally -
 116 -----------
 117
 118 If you find bugs, enhance the code or simply have questions, drop us an e-mail
 119 at sdlemu AT ngemu DOT com or drop a message on the SDLEMU Official Forum.
 120
 121 More information about this project (releases/WIP) can be found at the official
 122 Virtual Jaguar website [http://www.icculus.org/virtualjaguar] and on the SDLEMU
 123 website [http://sdlemu.ngemu.com].
 124
 125 We hope you enjoy the emulator and will use it wisely!
 126
 127 Thanks go to guys over at ngemu.com and #ngemu (EFNET). Thanks also to David
 128 Raingeard of Potato Emulation who originally developed this emulator and
 129 released the sources to the public. We couldn't have done it without you!
 130
 131 Special thanks go to everyone who submitted good, detailed bug reports,
 132 sometimes with demonstration code(!); your help has helped to make Virtual
 133 Jaguar better, more accurate, and more polished than it would be otherwise. We
 134 really appreciate your help!
 135
 136 SDLEMU