---------------------------------------------
-Virtual Jaguar v1.1.0 GCC/SDL release README
---------------------------------------------
+-------------------------------------------
+Virtual Jaguar v2.1.2 GCC/Qt release README
+-------------------------------------------
--------------
- DISCLAIMER -
consult the INSTALL file for more information about supported OS's and
software requirements.
-The use of this software is entirely at your own risk. We can't be held
-responsible for damage done to you hardware and/or software. While it won't
-rape your dog, it might do other nasty things. You have been warned. This
-software requires the use of the Atari Jaguar (CD) boot ROM and/or Commercial
-ROM images. You may only use the ROM images if you own the cartridges itself.
-The use of Commercial ROMs without owning the original cartridge is illegal in
-most countries and could result in fines and/or legal actions.
+The use of this software is entirely at your own risk. While it won't rape
+your dog, it might do other nasty things. We can't be held responsible for
+damage done to your hardware and/or software. You may only use the ROM images
+if you own the cartridges itself. The use of commercial ROMs without owning the
+original cartridge is illegal in most countries and could result in fines
+and/or legal actions.
-This software is released under the GPL v2 or later. For more information I
-direct you to the GPL.TXT. You may hack/change the code anyway you like. You
-may not commercially sell this software. If you make changes, release the
-source code to the public and send the changes you made to the original
-authors.
+The products, trademarks and/or brands used in these documents and/or
+sourcecode are owned by their respective companies and/or successors in
+interest.
+
+This software is released under the GPL v3 or later. For more information, read
+the GPLv3 file.
-The products and brands used in these documents and/or sourcecode are owned by
-their respective companies and/or successors in interest.
----------------------------------------------------------------
- IMPORTANT NOTE ABOUT JAGUAR FILE FORMATS--READ THIS OR ELSE! -
file, which is simply a 1, 2, or 4 Meg dump of a Jaguar cartridge ROM which
loads at $800000 in the Jaguar memory space.
------------------------------------
-- What is Virtual Jaguar GCC/SDL? -
------------------------------------
+
+----------------------------------
+- What is Virtual Jaguar GCC/Qt? -
+----------------------------------
Virtual Jaguar is software dedicated to emulating the Atari Jaguar hardware on
a standard PC. The software was originally developed by David Raingeard of
Potato Emulation [http://potato.emu-france.com] and was released under the GPL
on 25 June 2003.
-Virtual Jaguar GCC/SDL is not only a port of the MS Visual C++/SDL sourcecode
+Virtual Jaguar GCC/Qt is not just a port of the MS Visual C++/SDL sourcecode
but has also been extended and rewritten so that we can enjoy Atari Jaguar
-emulation on every platform which uses the GCC compiler and that can make use
-of the Simple Directmedia Layer library (SDL).
+emulation on every platform that has a GCC compiler and a port of Qt.
-Currently Virtual Jaguar GCC/SDL compiles on WIN32 using mingw, and several
-UN*X based systems (BeOS, Linux and FreeBSD). It may run on other systems
-as well but we can not guarantee that.
+Currently Virtual Jaguar GCC/Qt compiles on WIN32 using mingw, and several
+UN*X based systems (BeOS, Linux, FreeBSD and MacOS). It may run on other
+systems as well but we can not guarantee that.
The port was done by the SDLEMU crew (http://sdlemu.ngemu.com) and especially
by Niels Wagenaar and Carwin Jones. A major portion of the rewrite was done by
-James L. Hammons. You may contact us by e-mail (sdlemu@ngemu.com) or leave a
+James Hammons. You may contact us by e-mail (sdlemu@ngemu.com) or leave a
message on the SDLEMU Official Forum (see the website). Patches and bugfixes
are particularly welcome! :)
-More information about SDL can be found at http://www.libsdl.org.
-
---------------------------------
-- Using Virtual Jaguar GCC/SDL -
---------------------------------
-
-After compiling the binary (see INSTALL) you can now run original Atari Jaguar
-games. These games are distributed on cartridges and can therefore cannot be
-used on a PC (we're still waiting for that Jaguar-on-a-PCI-card that you plug
-into your late model PC, complete with cartridge slot ;-). To use these games
-on Virtual Jaguar GCC/SDL you need to get ROM images. Besides the ROM images
-from commercial games you must also obtain the Atari Jaguar (CD) boot ROM
-which you must copy to the BIOS directory. For legal issues concerning ROM
-images please consult the DISCLAIMER at the beginning of this file.
-
-After obtaining the Atari Jaguar (CD) boot ROM and several ROMs you can now
-use Virtual Jaguar using the following command:
-
-./vj [romfile] [-switches]
-
-The context of ROMFILE is the filename of the an Atari Jaguar ROM dump (can be
-either compressed or uncompressed). You can also use switches. By just typing
-./vj -? (or ./vj -help) you get an overview of the options you can use. WIN32
-users should look into the stdout.txt in the directory they ran Virtual Jaguar
-for that information.
-
-If you prefer a nice GUI instead of typing in command lines, you can either
-type ./vj or double click on the Virtual Jaguar executable. If you have a
-directory full of ROM files, you can tell Virtual Jaguar where they are by
-editing the appropriate line in the vj.cfg file (it assumes a ROMs directory
-under the directory where VJ lives) so that they show up when you pick the
-"Load" option from the "File" menu.
-
-This emulator also emulates the Atari Jaguar gamepads. By using the following
-keyboard or joystick settings you can (possibly) play a given game:
-
-Atari Button C : Z or joystick button 3
-Atari Button B : X or joystick button 2
-Atari Button A : C or joystick button 1
-Atari Buttons 1 - 10 : Keypad 0 - 9 (0 = 10)
-Atari Start/Pause : ENTER
-Atari Select : '
-Atari UP : UP or joystick UP
-Atari DOWN : DOWN or joystick DOWN
-Atari LEFT : LEFT or joystick LEFT
-Atari RIGHT : RIGHT or joystick RIGHT
-Atari # : Keypad /
-Atari * : Keypad *
-
-With ESC you can easily stop Virtual Jaguar GCC/SDL which will get you back to
-the GUI (pressing ESC again will take you back to the game). To exit VJ, you
-can either select File|Quit or press the "Q" key on your keyboard. If you want
-to change the key layout, simply edit the vj.cfg file and change the keys. :)
-NOTE: There are quite a few keys mapped to debugging functions at present. You
-have been warned!
-
--------------------
-- A note on sound -
--------------------
-
-By default, the Virtual Jaguar's DSP is turned off, since it doesn't work very
-well at present (it requires a lot of horsepower to sound decent at this
-point!). In order to hear any sound at all, you have to either edit the vj.cfg
-file and change the appropriate line or set the DSP on in the GUI (found under
-Settings|Misc). One word of caution: Use the old DSP core instead of the new
-pipelined version for now--the new pipelined DSP core has not yet been
-optimized and runs quite slow at present! Once the DSP issues have been ironed
-out, it will be turned on by default and you won't have to deal with it
-anymore. ;)
+More information about the incredible SDL libraries can be found at
+http://www.libsdl.org. Thanks Sam--you rock! :)
+
+
+-------------------------------
+- Using Virtual Jaguar GCC/Qt -
+-------------------------------
+
+Simply double click on the Virtual Jaguar icon or type ./virtualjaguar -h from
+the command line. See the built in help (under Help|Contents) for more
+information on how to use it. :-)
+
-----------
- Finally -
We hope you enjoy the emulator and will use it wisely!
-Special thanks go to guys over at ngemu.com and #ngemu (EFNET). Thanks also to
-David Raingeard of Potato Emulation who originally developed this emulator and
+Thanks go to guys over at ngemu.com and #ngemu (EFNET). Thanks also to David
+Raingeard of Potato Emulation who originally developed this emulator and
released the sources to the public. We couldn't have done it without you!
+Special thanks go to everyone who submitted good, detailed bug reports,
+sometimes with demonstration code(!); your help has helped to make Virtual
+Jaguar better, more accurate, and more polished than it would be otherwise. We
+really appreciate your help!
+
SDLEMU
projects / virtualjaguar / blobdiff