X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=docs%2FREADME;h=63e1f191c764dfd53e81860ba81f8cd3ced9c455;hb=e68c334af31779da826f7876a3af487c2e96c3f6;hp=163514b05115410f413eaa2cdbdf32637cfbbda5;hpb=fa566a2c8ec532eb5325b4d5a663fb2a7d72adc6;p=virtualjaguar diff --git a/docs/README b/docs/README index 163514b..63e1f19 100644 --- a/docs/README +++ b/docs/README @@ -1,107 +1,137 @@ -Virtual Jaguar v1.0.0 GCC/SDL release README --------------------------------------------- +------------------------------------------- +Virtual Jaguar v2.1.1 GCC/Qt release README +------------------------------------------- +-------------- - DISCLAIMER - - -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' 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 hard- 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. - -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. - -If you make changes, release the sourcecode 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 -but the desired company in question. - -- What is Virtual Jaguar GCC/SDL? - -Virtual Jaguar is software dedicated to emulate the Atari Jaguar hardware -on you standard P.C. The software was originally developed by 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 what 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 garantee that. +-------------- + +Or, "O liability, I do disclaim thee!" + +Ported by SDLEMU (Niels Wagenaar & Carwin Jones) and is based upon the +original work by David Raingeard of 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. 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. + +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. + + +---------------------------------------------------------------- +- IMPORTANT NOTE ABOUT JAGUAR FILE FORMATS--READ THIS OR ELSE! - +---------------------------------------------------------------- + +There seems to be a lot of confusion surrounding the various file formats that +Jaguar programs come in, and a lot of this confusion seem to come from +Cowering's GoodJag renaming tool. Note that it simply gets some files wrong, +and it also incorrectly renames cartridge images with an extension that +belongs to an already established extension (.jag is a Jaguar Server +executable--read on). To clarify, there are basically four major types of +Jaguar binary images that are NOT cartridge images: + + .abs + .jag + .rom + .bin + +The first type, the .abs file, is a DRI/Alcyon format absolute location +executable. These come in two different flavors and contain load and run +addresses in their headers. Note that some files which have an .abs extension +are really incorrectly labelled .bin files with no header information +whatsoever. + +The second type, the .jag file, is a Jaguar Server executable. These files +contain header information that tells you where to load and run the file's +executable code. Note that as of this writing (8/5/2005) that the GoodJag ROM +renaming tool by Cowering incorrectly renames Jaguar cartridge ROM dumps to +have a .jag extension (a better choice, and the one supported by Virtual +Jaguar, is .j64)--if you're trying to run a ROM image with a .jag extension on +VJ, it will misinterpret it as a Jaguar Server executable and likely fail to +run. + +The third type, the .rom file, is an Alpine Board/ROM Image file. These files +have no header, but are known to load and run at $802000 in the Jaguar memory +space. Again, these are *different* from cartridge dumps since they load at a +higher address than a Jaguar cartridge. + +The fourth type, the .bin file, is simply a Jaguar executable with no header. +Since these files contain no information about where they load and execute, +Virtual Jaguar does not support this file type. Go bug the author to release +either a file with proper headers or a file in Alpine ROM format. Virtual +Jaguar is not omniscient (yet)! ;) + +There is a fifth type of file that is supported by Virtual Jaguar, the .j64 +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/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/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 that has a GCC compiler and a port of Qt. + +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 Caz. You may contact us by e-mail (sdlemu@ngemu.com) or -leave a message on the SDLEMU Official Forum (see the website). - -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 there for not be used -on a P.C. To use these games on Virtual Jaguar GCC/SDL you need to get ROM -images. Besides that ROM imgaes 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 obaining the Atari Jaguar (CD) boot ROM and several ROM's you can now -use Virtual Jaguar using the following command : +by Niels Wagenaar and Carwin Jones. A major portion of the rewrite was done by +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! :) -./vj romfile -switch +More information about the incredible SDL libraries can be found at +http://www.libsdl.org. Thanks Sam--you rock! :) -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 you get an overview of the options you can use. WIN32 users should look -into the stdout.txt for that information. -If you succesfully start the emulator with the game you should see a window -(or fullscreen) which shows the game. If the game doesn't comply to a CRC -check the game will display a black screen, this means that the game is -probably a hack or a new game which isn't supported. You may add the CRC -check to the sources yourself (src/crc32.cpp). +------------------------------- +- Using Virtual Jaguar GCC/Qt - +------------------------------- -This emulator also emulates the Atari Jaguar Analog gamepads. By using the -following keyboard or joystick settings you can (possibly) play the game : +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. :-) -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 : TAB -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 *, # are not mapped yet! -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 hack the -src/joystick.cpp and change the keys :) +----------- +- Finally - +----------- -- Finally +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. -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 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]. -More information about this projects (releases/WIP) can be found at the SDLEMU -website : http://sdlemu.ngemu.com. +We hope you enjoy the emulator and will use it wisely! -I hope you enjoy the emulator and will use it wisely! +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 guys over at ngemu.com and #ngemu (EFNET). Also the author -who originally developed this emulator is thanked for releasing the sources to -the public. +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