<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>
+<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 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>
<li>NTSC</li>
<li>PAL</li>
<li>Blur</li>
+<li>Full Screen</li>
</ul>
<p>Here’s what they do.</p>
<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>
+<h3>Full Screen</h3>
+
+<p>Selecting this toolbar button will switch the display into full screen mode; selecting it again will switch it back to windowed mode. This option can also be activated by pressing the <b>F9</b> key on your keyboard. Note that on monitors with a wide aspect ratio that <i>Virtual Jaguar</i> will still display its virtual screen in a 4:3 aspect ratio—this is normal and expected.</p>
+
<h2>Jaguar Menu</h2>
<ul>
<li>Power</li>
<li>Pause</li>
+<li>Frame Advance</li>
<li>Insert Cartridge...</li>
<li>Use CD Unit</li>
<li>Configure</li>
<p><b>Pause</b> does the same as the toolbar button; see the “Pause” toolbar button description for details.</p>
+<p><b>Frame Advance</b> causes <i>Virtual Jaguar</i> to run for one frame (1/60th of a second for NTSC, 1/50th for PAL), and update the screen. This function can also be activated by pressing the <b>F7</b> key on your keyboard. This option only works when <i>Virtual Jaguar</i> is paused.</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>
<ul>
<li>General</li>
-<li>Controller #1</li>
-<li>Controller #2</li>
+<li>Controller</li>
</ul>
<h2>General Tab</h2>
<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>
+<li>Use fast blitter</li>
</ul>
<p>Here’s what they do.</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>
+<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. Note that if the DSP is disabled, there will be <b>no</b> sound.</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>
+<h3>Use fast blitter</h3>
+
+<p>Checking this option will force <i>Virtual Jaguar</i> to use the older, less compatible yet faster blitter. Some games will <b>not</b> work properly with this option checked!</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>
+<li>A combobox labeled “Host Device”</li>
+<li>A combobox labeled “Map Name”</li>
+<li>Two buttons labelled “+” and “-”</li>
+<li>A combobox labeled “Maps to”</li>
+<li>A picture of a Jaguar controller showing which inputs are defined</li>
+<li>A button labeled “Define All Inputs”</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>
+<p><i>Virtual Jaguar</i> utilizes a profile system for controllers. What this means is that you can set up any device that <i>Virtual Jaguar</i> recognizes with any number of different configurations for it. Here’s how it works:</p>
+
+<p>The “Host Device” combobox lets you select whichever gamepad device you have connected to your computer. This, plus the unique “Map Name” will show the keymapping set up for that particular host device/key map combination.</p>
+
+<p>The “Map Name” combobox lets you set up multiple key maps for your detected device. To add a new key map to the current device, press the “+” button next to the combobox. It will then ask your for a human readable name for the new map. If you want to remove any maps that you don't want anymore, you can delete the currently selected map by pressing the “-” button; it will ask for confirmation. Keep in mind that this action cannot be undone!</p>
+
+<p>The “Maps to” combobox tells <i>Virtual Jaguar</i> which virtual controller slot you would like your device to be plugged into. Selecting <i>None</i> disables that key mapping for that device. Selecting <i>Controller #1</i> will map the device to virtual controller slot #1. Selecting <i>Controller #2</i> will map the device to virtual controller slot #2. Selecting <i>Either one that’s free</i> will attempt to connect the device to a free virtual controller slot if one is still available after all other connected devices have had a chance to plug into a definite slot. If other devices have filled up the virtual slots, this option will cause the device to <b>not</b> attempt to connect itself.</p>
+
+<p>Hovering over a letter on the picture of the Jaguar controller will highlight it; clicking on the letter will let you redefine that input by pressing a key on the keyboard or button on a connected gamepad. If you prefer, you can define all inputs at once by clicking on the “Define All Inputs” button. It will then step through each input on the controller, one at a time, and wait for you to press the key/button 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>
+
+<p>NOTE: For gamepads to be detected, they must be connected to the computer before starting <i>Virtual Jaguar</i>.</p>
<h2>EEPROMs</h2>
<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>Also, when in Alpine mode, extra toolbar buttons are defined (also found under the extra “Debug” menu):</p>
+
+<ul>
+<li>Memory Browser</li>
+<li>CPU Browser</li>
+<li>OP Browser</li>
+<li>M68K Disassembly Browser</li>
+<li>RISC Disassembly Browser</li>
+</ul>
+
+<h3>Memory Browser</h3>
+
+<p>This window lets you inspect <i>Virtual Jaguar</i>’s emulated memory space. The <b>PgDn</b> key will advance the top of the window’s memory location by 480 bytes, and <b>PgUp</b> will go back by the same amount. The <b>Plus (+)</b> key will advance the top of the window’s memory location by 16 bytes, and <b>Minus (-)</b> will go back by the same amount. Entering a memory location, in hexadecimal, in the edit field and pressing the <b>Go</b> button will display memory from that location. 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>
+
+<h3>CPU Browser</h3>
+
+<p>This window shows the state of the various CPUs in the emulated Jaguar. 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>
+
+<h3>OP Browser</h3>
+
+<p>This window shows the current state of object list that the Object Processor is pointing to. Note that most of the time, this will likely show an object list that has had its objects processed. 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>
+
+<h3>M68K Disassembly Browser</h3>
+
+<p>This window provides a disassembly of 68000 opcodes. 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>
+
+<h3>RISC Disassembly Browser</h3>
+
+<p>This window provides a disassembly of RISC opcodes. 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>
+
<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>
projects / virtualjaguar / blobdiff