Added a date creation stamp in the application command line information
[clinton/Virtual-Jaguar-Rx.git] / docs / README
CommitLineData
024bfc46
JPM
1----------------------------------------------\r
2Virtual Jaguar v2.1.3 Rx GCC/Qt release README\r
3----------------------------------------------\r
4\r
5--------------\r
6- DISCLAIMER -\r
7--------------\r
8\r
9Or, "O liability, I do disclaim thee!"\r
10\r
11Ported by SDLEMU (Niels Wagenaar & Carwin Jones) and is based upon the\r
12original work by David Raingeard of Potato Emulation. For requirements please\r
13consult the INSTALL file for more information about supported OS's and\r
14software requirements.\r
15\r
16The use of this software is entirely at your own risk. While it won't rape\r
17your dog, it might do other nasty things. We can't be held responsible for\r
18damage done to your hardware and/or software. You may only use the ROM images\r
19if you own the cartridges itself. The use of commercial ROMs without owning the\r
20original cartridge is illegal in most countries and could result in fines\r
21and/or legal actions.\r
22\r
23The products, trademarks and/or brands used in these documents and/or\r
24sourcecode are owned by their respective companies and/or successors in\r
25interest.\r
26\r
27This software is released under the GPL v3 or later. For more information, read\r
28the LICENSE file.\r
29\r
30\r
31----------------------------------------------------------------\r
32- IMPORTANT NOTE ABOUT JAGUAR FILE FORMATS--READ THIS OR ELSE! -\r
33----------------------------------------------------------------\r
34\r
35There seems to be a lot of confusion surrounding the various file formats that\r
36Jaguar programs come in, and a lot of this confusion seem to come from\r
37Cowering's GoodJag renaming tool. Note that it simply gets some files wrong,\r
38and it also incorrectly renames cartridge images with an extension that\r
39belongs to an already established extension (.jag is a Jaguar Server\r
40executable--read on). To clarify, there are basically fith major types of\r
41Jaguar binary images that are NOT cartridge images:\r
42\r
43 .abs\r
44 .jag\r
45 .rom\r
46 .bin\r
47 .elf\r
48\r
49The first type, the .abs file, is a DRI/Alcyon format absolute location\r
50executable. These come in two different flavors and contain load and run\r
51addresses in their headers. Note that some files which have an .abs extension\r
52are really incorrectly labelled .bin files with no header information\r
53whatsoever.\r
54\r
55The second type, the .jag file, is a Jaguar Server executable. These files\r
56contain header information that tells you where to load and run the file's\r
57executable code. Note that as of this writing (8/5/2005) that the GoodJag ROM\r
58renaming tool by Cowering incorrectly renames Jaguar cartridge ROM dumps to\r
59have a .jag extension (a better choice, and the one supported by Virtual\r
60Jaguar, is .j64)--if you're trying to run a ROM image with a .jag extension on\r
61VJ, it will misinterpret it as a Jaguar Server executable and likely fail to\r
62run.\r
63\r
64The third type, the .rom file, is an Alpine Board/ROM Image file. These files\r
65have no header, but are known to load and run at $802000 in the Jaguar memory\r
66space. Again, these are *different* from cartridge dumps since they load at a\r
67higher address than a Jaguar cartridge.\r
68\r
69The fourth type, the .bin file, is simply a Jaguar executable with no header.\r
70Since these files contain no information about where they load and execute,\r
71Virtual Jaguar does not support this file type. Go bug the author to release\r
72either a file with proper headers or a file in Alpine ROM format. Virtual\r
73Jaguar is not omniscient (yet)! ;)\r
74\r
75The fifth type, the .elf file, is a Jaguar executable with ELF headers, with\r
76or without DWARF information.\r
77\r
78There is a sith type of file that is supported by Virtual Jaguar, the .j64\r
79file, which is simply a 1, 2, or 4 Meg dump of a Jaguar cartridge ROM which\r
80loads at $800000 in the Jaguar memory space.\r
81\r
82\r
83----------------------------------\r
84- What is Virtual Jaguar GCC/Qt? -\r
85----------------------------------\r
86\r
87Virtual Jaguar is software dedicated to emulating the Atari Jaguar hardware on\r
88a standard PC. The software was originally developed by David Raingeard of\r
89Potato Emulation [http://potato.emu-france.com] and was released under the GPL\r
90on 25 June 2003.\r
91\r
92Virtual Jaguar GCC/Qt is not just a port of the MS Visual C++/SDL sourcecode\r
93but has also been extended and rewritten so that we can enjoy Atari Jaguar\r
94emulation on every platform that has a GCC compiler and a port of Qt.\r
95\r
96Currently Virtual Jaguar GCC/Qt Rx compiles on WIN64 using msys2/MinGW64,\r
b1b673a3 97and Visual Studio 2015/2017. Compiles also on cygwin64 but no tests have been done.\r
024bfc46
JPM
98It has previously compiled on WIN32 using mingw, and several UN*X based systems\r
99(BeOS, Linux, FreeBSD and MacOS). It may run on other\r
100systems as well but we can not guarantee that.\r
101\r
102The Rx version has been made specically to add a debugger support, but some\r
103modifications have been done as well. The official contact email and name(s) are\r
104not related in any way with this work.\r
105\r
106The port was done by the SDLEMU crew (http://sdlemu.ngemu.com) and especially\r
107by Niels Wagenaar and Carwin Jones. A major portion of the rewrite was done by\r
108James Hammons. You may contact us by e-mail (sdlemu@ngemu.com) or leave a\r
109message on the SDLEMU Official Forum (see the website). Patches and bugfixes\r
110are particularly welcome! :)\r
111\r
112More information about the incredible SDL libraries can be found at\r
113http://www.libsdl.org. Thanks Sam--you rock! :)\r
114\r
115\r
116-------------------------------\r
117- Using Virtual Jaguar GCC/Qt -\r
118-------------------------------\r
119\r
120Simply double click on the Virtual Jaguar icon or type ./virtualjaguar -h from\r
121the command line. See the built in help (under Help|Contents) for more\r
122information on how to use it. :-)\r
123\r
124\r
125-----------\r
126- Finally -\r
127-----------\r
128\r
129If you find bugs, enhance the code or simply have questions, drop us an e-mail\r
130at sdlemu AT ngemu DOT com or drop a message on the SDLEMU Official Forum.\r
131\r
132More information about this project (releases/WIP) can be found at the official\r
133Virtual Jaguar website [http://www.icculus.org/virtualjaguar] and on the SDLEMU\r
134website [http://sdlemu.ngemu.com].\r
135\r
136We hope you enjoy the emulator and will use it wisely!\r
137\r
138Thanks go to guys over at ngemu.com and #ngemu (EFNET). Thanks also to David\r
139Raingeard of Potato Emulation who originally developed this emulator and\r
140released the sources to the public. We couldn't have done it without you!\r
141\r
142Special thanks go to everyone who submitted good, detailed bug reports,\r
143sometimes with demonstration code(!); your help has helped to make Virtual\r
144Jaguar better, more accurate, and more polished than it would be otherwise. We\r
145really appreciate your help!\r
146\r
147SDLEMU\r