-Virtual Jaguar v1.0.6 GCC/SDL release INSTALL
+Virtual Jaguar v1.0.7 GCC/SDL release INSTALL
---------------------------------------------
REQUIREMENTS:
Also, I would recommend that you have at least 20MB of free space. The .o's
can be quite big and the binary is likely to be about a 1.5MB in size (with
-UPX or strip this could downsize to about 800K).
+UPX and/or strip this could downsize to about 400K).
COMPILING:
-If you sure you have the minimum software requirements, you can safely
-compile Virtual Jaguar v1.0.6 GCC/SDL release by doing the following:
+If you sure you have the minimum software requirements, you can safely compile
+Virtual Jaguar by doing the following:
1) Compile:
makefile that executes upx so that you'll end up with a somewhat smaller
binary.
-That's it! You're done! You can now start the emulator with ./vj.
-See the output for more details or consult the docs/README for more info.
+That's it! You're done! You can now start the emulator with ./vj. See the
+output for more details or consult the README file for more info.
-For even more info, go to http://sdlemu.ngemu.com or send use an e-mail to
-the following e-mail address: sdlemu AT ngemu DOT com.
+For even more info, go to http://sdlemu.ngemu.com or send use an e-mail to the
+following e-mail address: sdlemu AT ngemu DOT com.
SDLEMU
-Virtual Jaguar v1.0.6 GCC/SDL release README
+Virtual Jaguar v1.0.7 GCC/SDL release README
--------------------------------------------
- DISCLAIMER -
Or, "O liability, I do disclaim thee!"
-Ported by SDLEMU (Niels Wagenaar & Caz) and is based upon the original work
-from Potato Emulation. For requirements please consult the INSTALL file for
-more information about supported OS's and software requirements.
+Ported by SDLEMU (Niels Wagenaar & Carwin Jones) and is based upon the
+original work from Potato Emulation. For requirements please 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. 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 ROM's without owning the original cartridge is
-illegal in most countries and could result in fines and/or legal actions.
+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 license. For more information I
-should direct you to the GPL.TXT. You may hack/change the code anyway you
-like. You may not commercially sell this software.
+This software is released under the GPL license. 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 us the
changes you made to the original authors.
-The products and brands used in these documents and/or sourcecode are owned
-by the desired company in question.
+The products and brands used in these documents and/or sourcecode are owned by
+their respective companies.
- What is Virtual Jaguar GCC/SDL?
-Virtual Jaguar is software dedicated to emulate the Atari Jaguar hardware
-on a standard P.C. The software was originally developed by Potato Emulation
-(http://potato.emu-france.com) by Cal2 and was released under the GPL license
-on 25 June 2003.
+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
+license on 25 June 2003.
-Virtual Jaguar GCC/SDL is a port of the MS Visual C++/SDL sourcecode 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).
+Virtual Jaguar GCC/SDL is not only 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).
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.
The port was done by the SDLEMU crew (http://sdlemu.ngemu.com) and especially
-by Niels Wagenaar and Caz. You may contact us by e-mail (sdlemu@ngemu.com) or
-leave a message on the SDLEMU Official Forum (see the website).
+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
+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.
After compiling the binary (see INSTALL) you can now run original Atari Jaguar
games. These games are distributed on cartridges and can there for cannot be
-used on a P.C. To use these games on Virtual Jaguar GCC/SDL you need to get ROM
+used on a PC. 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
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 for that information. If you have a
-directory full of ROM files, you can type
+users should look into the stdout.txt for that information.
-./vj [directory with ROM files] [-switches]
-
-and Virtual Jaguar will pull up a simple file selector to allow you to choose
-which ROM file you want to use.
+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 # : Keypad /
Atari * : Keypad *
-With ESC you can easily stop Virtual Jaguar GCC/SDL which will get you back
-to you command prompt. If you want to change the key layout, simply edit the
-vj.cfg file and change the keys :)
+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!
- Finally
-If you find bugs, enhance the code or simply have questions. Drop us an e-mail
+If you find bugs, enhance the code or simply have questions, drop us an e-mail
at sdlemu AT ngemu DOT com or drop a message on the SDLEMU Official Forum.
-More information about this projects (releases/WIP) can be found at the SDLEMU
-website : http://sdlemu.ngemu.com.
+More information about this project (releases/WIP) can be found at the official
+Virtual Jaguar website [http://www.icculus.org/virtualjaguar] and on the SDLEMU
+website [http://sdlemu.ngemu.com].
I hope you enjoy the emulator and will use it wisely!
-Special thanks go to guys over at ngemu.com and #ngemu (EFNET). Also Cal2 of
-Potato Emulation who originally developed this emulator is thanked for
-releasing the sources to the public.
+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
+released the sources to the public. We couldn't have done it without you!
SDLEMU
projects / virtualjaguar / commitdiff