X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=docs%2FREADME;h=d223e2dbb45fcc60a8e946a5d2ad603952a232ce;hb=0238cd1a0aa8a4b161936c0c9fa1c2fdabe9eaa2;hp=163514b05115410f413eaa2cdbdf32637cfbbda5;hpb=fa566a2c8ec532eb5325b4d5a663fb2a7d72adc6;p=virtualjaguar diff --git a/docs/README b/docs/README index 163514b..d223e2d 100644 --- a/docs/README +++ b/docs/README @@ -1,14 +1,16 @@ -Virtual Jaguar v1.0.0 GCC/SDL release README +Virtual Jaguar v1.0.6 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' and software requirements. +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 hard- and/or software. This software +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 @@ -18,26 +20,26 @@ 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 +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 -but the desired company in question. +by 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. +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 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). +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 +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. +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 @@ -48,47 +50,48 @@ 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. +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 +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 obaining the Atari Jaguar (CD) boot ROM and several ROM's you can now -use Virtual Jaguar using the following command : +After obtaining the Atari Jaguar (CD) boot ROM and several ROMs you can now +use Virtual Jaguar using the following command: -./vj romfile -switch +./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 you get an overview of the options you can use. WIN32 users should look -into the stdout.txt for that information. +./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 + +./vj [directory with ROM files] [-switches] -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). +and Virtual Jaguar will pull up a simple file selector to allow you to choose +which ROM file you want to use. -This emulator also emulates the Atari Jaguar Analog gamepads. By using the -following keyboard or joystick settings you can (possibly) play the game : +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 : TAB +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 *, # are not mapped yet! +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 hack the -src/joystick.cpp and change the keys :) +to you command prompt. If you want to change the key layout, simply edit the +vj.cfg file and change the keys :) - Finally @@ -100,8 +103,8 @@ 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 the author -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). Also Cal2 of +Potato Emulation who originally developed this emulator is thanked for +releasing the sources to the public. SDLEMU