<body>
<h1><i>Virtual Jaguar:</i> The Documentation</h1>
-<i>Coming Soon!</i>
+<h2><i>Virtual Jaguar</i> Quick Start</h2>
+
+<p>Welcome to <i>Virtual Jaguar!</i> If this is your first time using <i>Virtual Jaguar</i>, you can get a feel for what it is and does by doing the following:
+
+<ul>
+<li>Select “Insert Cartridge” from the “Jaguar” menu, or press the “Insert Cartridge” toolbar button.</li>
+<li>In the dialog that shows up, you will see the pack-in title of <i>Downfall</i> which is brought to you courtesy of <b>Reboot</b> (<a href="http://reboot.atari.org">http://reboot.atari.org</a>).</li>
+<li>Click on the <i>Insert</i> button in the lower right hand corner of the dialog or simply press the <b>Enter</b> key on your keyboard.</li>
+<li>In a few moments, the <i>Downfall</i> title screen should show in the <i>Virtual Jaguar</i> main window.</li>
+</ul>
+
+<p>To play, use the left and right keys (mapped to <b>Z</b> and <b>C</b> on your keyboard) and the the B button (mapped to <b>K</b> on your keyboard). You can pause <i>Virtual Jaguar</i> by selecting “Pause” from the “Jaguar” menu, pressing the “Pause” toolbar button, or by pressing the <b>Esc</b> key on your keyboard. You can quit <i>Virtual Jaguar</i> by selecting “Exit” from the “Jaguar” menu, or by pressing <b>Ctrl</b> + <b>Q</b> on your keyboard.</p>
+
+<h2>System Requirements</h2>
+
+<p><i>Virtual Jaguar</i> should be able to run on most late model computers equipped with an OpenGL compliant video card. It requires a lot of raw <i>oomph</i> in it’s present form to run well; do not be surprised if it doesn’t run at 100% speed with all the options, such as sound and DSP, turned on. Certain subsystems of the Jaguar are not optimized yet and as such take more time than they would if they were optimized. To run <i>Virtual Jaguar</i> at full speed with all options on, we recommend using liquid nitrogen. At least until we get it properly optimized. ;-)</p>
+
+<h2><i>Virtual Jaguar</i> In Depth</h2>
+
+<p>This version of <i>Virtual Jaguar</i> has been redesigned with a modern GUI and as such should be fairly easy to use and understand. However, some options may not do what you expect: What follows is an exhaustive look at what the various toolbar buttons and menu options do.</p>
+
+<h2>The Toolbar</h2>
+
+<p>The main <i>Virtual Jaguar</i> toolbar contains the following buttons:</p>
+
+<ul>
+<li>Power</li>
+<li>Pause</li>
+<li>Insert Cartridge</li>
+<li>Use CD Unit</li>
+<li>Scale x1</li>
+<li>Scale x2</li>
+<li>Scale x3</li>
+<li>NTSC</li>
+<li>PAL</li>
+<li>Blur</li>
+</ul>
+
+<p>Here’s what they do.</p>
+
+<h3>Power</h3>
+
+<p>This toolbar button acts just like the power switch on a real Jaguar, complete with untuned tank circuit noise showing on the screen when the emulated Jaguar is turned off. Some options only take effect after the power has been cycled, such as the NTSC/PAL switches, or the “Use Jaguar BIOS” option in the Configuration dialog.</p>
+
+<h3>Pause</h3>
+
+<p>Pressing the Pause toolbar button will pause execution of the emulated Jaguar. Note that most games have a pause feature that is built into the game; this feature is separate from and will override any built-in game pause feature. Also, the emulator will go into pause mode if the power is on when you activate the “Insert Cartridge” dialog. Pressing the <b>Esc</b> key will also activate this option. Selecting this option in any of the ways listed above, while in pause mode, will take it out of pause mode.</p>
+
+<h3>Insert Cartridge</h3>
+
+<p>Pressing the Insert Cartridge button will bring up the Insert Cartridge dialog; it can also be launched by pressing <b>Ctrl</b> + <b>I</b> on your keyboard. On the left side of the dialog will be a list of software that <i>Virtual Jaguar</i> recognizes from the directory you tell it to look into (see the “Configure” menu option and the “General” tab, “Software” item for more information). Selecting an item in the list will bring up some information about the software on the right side of the dialog, if <i>Virtual Jaguar</i> knows about it. Pressing the icon in the lower right hand side of the dialog will then cause <i>Virtual Jaguar</i> to attempt to run the selected item. <i>Virtual Jaguar</i> cycles the power when it attempts to run the software you select.</p>
+
+<p>There are also some keyboard shortcuts that come with the Insert Cartridge dialog: Pressing a letter key will highlight the nearest item in the list that starts with that letter. Pressing more than one letter key in quick succession will narrow in on the item that matches those letter keys pressed. Pressing the <b>Esc</b> key will dismiss the dialog without attempting to load anything, and pressing the <b>Enter</b> key is the same as pressing the icon in the lower right hand side of the dialog.</p>
+
+<h3>Use CD Unit</h3>
+
+<p>Pressing this toolbar button will virtually plug in a Jaguar CD unit into the emulated Jaguar. It will not take effect until the power has been cycled.</p>
+
+<p>As of the release date for this emulator, this option <b>DOES NOT WORK</b> 100% the way it’s intended to: When it’s working correctly, selecting this option will allow you to insert a Jaguar CD game into your computer’s CD/DVD drive and play it as if it were on a real Jaguar. For now, you can see the CD BIOS make pretty patterns on your screen if you use it.</p>
+
+<p>Note that once this is working as it should, the DSP will be required to be <b>enabled</b> for it to work properly. It <b>WILL NOT WORK</b> properly without the DSP.</p>
+
+<h3>Scale x1</h3>
+
+<p>Selecting this toolbar button will cause the screen to be displayed with pixels that are sized 1 to 1 with your display; this will give you a very small display.</p>
+
+<h3>Scale x2</h3>
+
+<p>This will cause the screen to be displayed with pixels that are sized 2 to 1 with your display.</p>
+
+<h3>Scale x3</h3>
+
+<p>This will cause the screen to be displayed with pixels that are sized 3 to 1 with your display; this should yield a fairly large display.</p>
+
+<h3>NTSC</h3>
+
+<p>Selecting this item will cause the emulated Jaguar to behave as if it were an NTSC type Jaguar, running at 60 Hz. This option will shrink the screen immediately but will not take effect until the emulated Jaguar has been power cycled.</p>
+
+<h3>PAL</h3>
+
+<p>Selecting this item will cause the emulated Jaguar to behave as if it were an PAL type Jaguar, running at 50 Hz. As an added bonus, you also get a few extra scan lines as compared with NTSC mode; some games will even utilize this extra screen real estate. This option will enlarge the screen immediately but will not take effect until the emulated Jaguar has been power cycled.</p>
+
+<h3>Blur</h3>
+
+<p>Normally, the emulated Jaguar’s display shows pixels that are razor sharp and is what you would likely see if the Jaguar was hooked up to a high quality monitor. Selecting this item will cause the emulated Jaguar’s display to be averaged, resulting in a screen that looks slightly blurry—more like what you would expect to see if the Jaguar was hooked up to a television. This is an aesthetic option that some people prefer; you may or may not like it.</p>
+
+
+<h2>Jaguar Menu</h2>
+
+<p>This menu has the following options:</p>
+
+<ul>
+<li>Power</li>
+<li>Pause</li>
+<li>Insert Cartridge...</li>
+<li>Use CD Unit</li>
+<li>Configure</li>
+<li>Exit</li>
+</ul>
+
+<p><b>Power</b> does the same as the toolbar button; see the “Power” toolbar button description for details.</p>
+
+<p><b>Pause</b> does the same as the toolbar button; see the “Pause” toolbar button description for details.</p>
+
+<p><b>Insert Cartridge...</b> does the same as the toolbar button; see the “Insert Cartridge” toolbar button description for details.</p>
+
+<p><b>Use CD Unit</b> does the same as the toolbar button; see the “Use CD Unit” toolbar button description for details.</p>
+
+<p><b>Configure</b> launches the Configure dialog. A full description is given in the “Configure Dialog” section below.</p>
+
+<p><b>Exit</b> quits <i>Virtual Jaguar</i> immediately. You can also quit <i>Virtual Jaguar</i> by pressing <b>Ctrl</b> + <b>Q</b> on your keyboard.</p>
+
+<h2>Help Menu</h2>
+
+<p>This menu has the following options:</p>
+
+<ul>
+<li>Contents</li>
+<li>About</li>
+</ul>
+
+<p>The <b>Contents</b> is what you’re reading right now. The voice you are hearing in your head is probably your own, though we can’t guarantee that. ;-) This dialog can be dismissed by clicking on the “X” in the upper corner of the dialog, or by pressing the <b>Esc</b> key on your keyboard.</p>
+
+<p>The <b>About</b> option shows a credits dialog. It can be dismissed by clicking on the “X” in the upper corner of the dialog, or by pressing the <b>Esc</b> key on your keyboard.</p>
+
+<h2>The Configure Dialog</h2>
+
+<p>The Configure dialog has the following tabs:</p>
+
+<ul>
+<li>General</li>
+<li>Controller #1</li>
+<li>Controller #2</li>
+</ul>
+
+<h2>General Tab</h2>
+
+<p>Under the General tab, there are the following options:</p>
+
+<ul>
+<li>EEPROMs</li>
+<li>Software</li>
+<li>Enable Jaguar BIOS</li>
+<li>Enable GPU</li>
+<li>Enable DSP</li>
+<li>Enable audio playback</li>
+<li>Show all files in file chooser</li>
+</ul>
+
+<p>Here’s what they do.</p>
+
+<h3>EEPROMs</h3>
+
+<p>This field holds the location on your filesystem where your EEPROM files will live (see the “EEPROMs” section below for details). The path can be either absolute or relative; if relative, it will be relative to where the <i>Virtual Jaguar</i> executable is located on your filesystem.</p>
+
+<h3>Software</h3>
+
+<p>This field holds the location on your filesystem where your Jaguar software files will live (see the “Software” section below for details). The path can be either absolute or relative; if relative, it will be relative to where the <i>Virtual Jaguar</i> executable is located on your filesystem.</p>
+
+<h3>Enable Jaguar BIOS</h3>
+
+<p>Checking this option will cause the emulated Jaguar to run with the built-in system BIOS upon powering on. This is usually not necessary, but some games will not run correctly without it. Note that this option will only affect cartridge images; it has no effect on Alpine ROMs or homebrew files.</p>
+
+<h3>Enable GPU</h3>
+
+<p>The GPU is one of the three main processors in the Jaguar, and checking this option enables it. Most software will not work without this.</p>
+
+<h3>Enable DSP</h3>
+
+<p>The DSP is one of the three main processors in the Jaguar, and checking this option enables it. Much software will work without it, however, there is some software that will not.</p>
+
+<h3>Enable audio playback</h3>
+
+<p>Checking this option will allow <i>Virtual Jaguar</i> to attempt to output sound to your sound card. It will <b>not</b> output <b>any</b> sound without the DSP being enabled.</p>
+
+<h3>Show all files in file chooser</h3>
+
+<p>Normally the “Insert Cartridge...” dialog will ignore any files it encounters that it doesn’t know how to deal with. You can override this behavior by checking this option. However, this will <b>not</b> cause <i>Virtual Jaguar</i> to be able to load such files.</p>
+
+<h2>Controller Tab</h2>
+
+<p>Under the Controller tab, there are the following options:</p>
+
+<ul>
+<li>A picture of a Jaguar controller showing which keys are defined</li>
+<li>A button labeled “Define All Keys”</li>
+</ul>
+
+<p>Hovering over a letter on the picture of the Jaguar controller will highlight it; clicking on the letter will let you redefine that key. If you prefer, you can define all the keys at once by clicking on the “Define All Keys” button. It will then step through each button on the controller, one at a time, and wait for you to press the key that you wish to set it to. You can exit the key redefinition process at any time by pressing the <b>Esc</b> key on your keyboard.</p>
+
+<h2>EEPROMs</h2>
+
+<p>EEPROMs (Electrically Erasable Programmable Read Only Memory) were typically installed on Jaguar cartridges to save high scores and the like, and <i>Virtual Jaguar</i> emulates this. The EEPROMs are keyed to specific games by making a CRC32 checksum of the game and using this as a filename. If an EEPROM file does not exist, it is created when the emulated Jaguar writes to it. The EEPROM files are stored in the location specified by the “EEPROMs” field of the Configuration dialog, under the “General” tab.</p>
+
+<h2>Software</h2>
+
+<p>Software can be either uncompressed or stored in a ZIP file. <i>Virtual Jaguar</i> looks for software in the location specified by the “Software” field in the Configuration dialog, under the “General” tab.</p>
+
+<p><i>Virtual Jaguar</i> is a bit picky about file formats, but tries its best to figure out what you’re trying to feed it. In general, if the file is a ROM image, or an Alpine image, <i>Virtual Jaguar</i> will recognize and utilize it. If it’s a file meant to load into the emulated Jaguar’s RAM space, <i>Virtual Jaguar</i> will load and run it as long as the file contains proper headers. A headerless file of this kind (as opposed to a cartridge or Alpine ROM image) is useless; it contains no information to help <i>Virtual Jaguar</i> know how to load and run it. There is no excuse for this kind of file to exist other than programmer laziness: So, if a file is not recognized by <i>Virtual Jaguar</i>, complain to the author and ask <i>politely</i> for a file with headers. :-)</p>
+
+<h2>Some Issues You May Encounter</h2>
+
+<p>Most of the time <i>Virtual Jaguar</i> tries to do the right thing with what you tell it to do. There are some options, however, that would be more annoying to use if <i>Virtual Jaguar</i> got in the way and forced you to do the right thing, so, in those places where it’s possible to tell <i>Virtual Jaguar</i> to do bad things, it will willingly oblige.</p>
+
+<p>One of these areas is the NTSC/PAL switch: If you toggle it while the Jaguar is running, most likely it will not do what you want. For the NTSC/PAL switch to have any real effect, you need to power cycle the Jaguar to see it.</p>
+
+<p>Also, some cartridge based games will not work without either the DSP enabled, the BIOS enabled, or both. <i>Virtual Jaguar</i> will let you attempt to run those games with those options disabled, but the result probably won’t be what you want.</p>
+
+<h2>Jaguar Programmer’s Zone</h2>
+
+<p><i>Virtual Jaguar</i> has a mode available that makes it more convenient for developers to use. In order to use this mode, you must start <i>Virtual Jaguar</i> with the --alpine option.</p>
+
+<p>When started in this mode, an Alpine tab is made available in the configuration dialog which gives you the following options:</p>
+
+<ul>
+<li>ROM to load</li>
+<li>ABS to load</li>
+</ul>
+
+<p><b>ROM to load</b> is the path to a Jaguar executable file that will be loaded into the Jaguar’s cartridge memory space at $800000 (Alpine ROM images will load at $802000). As a convenience to coders, this file can be of any length, as long as it fits into the cartridge memory space (a file of this type is treated as an Alpine ROM and is loaded at $802000). The file thus loaded into memory will not be executed.</p>
+
+<p><b>ABS to load</b> is the path to a Jaguar executable file that will be loaded in the Jaguar’s main RAM. This file must have valid headers, otherwise <i>Virtual Jaguar</i> won’t be able to load it. Assuming the file exists and has the correct headers in it, it will be loaded and run when <i>Virtual Jaguar</i> is first run.</p>
+
+<p>The aforementioned options will only work when <i>Virtual Jaguar</i> is run in Alpine mode, that is, when the --alpine flag is passed in. If you do not pass in the --alpine flag, <i>Virtual Jaguar</i> will run as it normally does, i.e., as a stock Jaguar, and nothing will be loaded by default.</p>
+
+<h2>For The Curious</h2>
+
+<p>If you’re wondering why some cartridges have labels in the “Insert Cartridge...” dialog and some don’t, read on...</p>
+
+<p><i>Virtual Jaguar</i> looks at your ZIP file as a container—if it finds what it expects in the ZIP, it will use it. For example, label images: If you put an image file of a cartridge label in the ZIP file with your ROM image, <i>Virtual Jaguar</i> will use that image in the “Insert Cartridge...” dialog—assuming it’s a valid image file. The image should be 365 x 168 for it to show up on the big cartridge image without any scaling; any bigger is just a waste of space and <i>Virtual Jaguar</i> will scale it down to 365 x 168 anyway.</p>
+
+<p>Using the ZIP file as a container this way opens up some exciting possibilities: Box art, overlays and documentation can be included and future versions of <i>Virtual Jaguar</i> will be able to utilize them.</p>
+
+<h2>Legal Nigglings</h2>
+
+<p>Or, as it’s more commonly known, the disclaimer: <i>“O liability, I do disclaim thee!”</i></p>
+
+<p>Trademarks used in <i>Virtual Jaguar</i> and/or this documentation are the property of their respective owners. The user(s) of <i>Virtual Jaguar</i> assumes all risk associated with using the software; the authors are not responsible for anything the user(s) does with said software or what happens to the user(s) as a result of using this software.</p>
+
+<p><i>Virtual Jaguar</i> is Free (as in Libre) software and is licensed under the GPL version 3. You should have recieved a copy of the license with this software; if you did not, you may view a copy at <a href="http://www.gnu.org/licenses">http://www.gnu.org/licenses</a>. A copy of the source code is available at <a href="http://icculus.org/virtualjaguar">http://icculus.org/virtualjaguar</a>.</p>
+
+<p><i>Downfall</i> is © 2011 <b>Reboot</b>, All Rights Reserved. Distribution of <i>Downfall</i> with <i>Virtual Jaguar</i> has been graciously authorized by <b>Reboot</b>, and may not be distributed as part of any other package.</p>
</body>
</html>
projects / virtualjaguar / blobdiff