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