# Virtual Jaguar: The Documentation

## Virtual Jaguar Quick Start

Welcome to Virtual Jaguar! If this is your first time using Virtual Jaguar, you can get a feel for what it is and does by doing the following:

- Select “Insert Cartridge” from the “Jaguar” menu, or press the “Insert Cartridge” toolbar button.
- In the dialogue that shows up, you will see the pack-in title of Downfall which is brought to you courtesy of Reboot (http://reboot.atari.org). Please note, the Rx version doesn't have games included.
- Click on the Insert button in the lower right-hand corner of the dialogue or simply press the Enter key on your keyboard.
- In a few moments, the Downfall title screen should show in the Virtual Jaguar main window.

To play, use the left and right keys (mapped to Z and C on your keyboard) and the B button (mapped to K on your keyboard). You can pause Virtual Jaguar by selecting “Pause” from the “Jaguar” menu, pressing the “Pause” toolbar button, or by pressing the Esc key on your keyboard. You can quit Virtual Jaguar by selecting “Exit” from the “Jaguar” menu, or by pressing Ctrl + Q on your keyboard.

## System Requirements

Virtual Jaguar should be able to run on most late model computers equipped with an OpenGL compliant video card. It requires a lot of raw oomph in its 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 Virtual Jaguar at full speed with all options on, we recommend using liquid nitrogen. At least until we get it properly optimized. ;-)

## Virtual Jaguar In Depth

This version of Virtual Jaguar 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.

## The Toolbar

The main Virtual Jaguar toolbar contains the following buttons:

- Power
- Pause
- Frame Advance
- Insert Cartridge
- Use CD Unit
- Screenshot
- Scale x1
- Scale x2
- Scale x3
- NTSC
- PAL
- Blur
- Full Screen

Here’s what they do.

### Power

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 can only be changed after the power has been turned off, such as the NTSC/PAL switches, or the “Use CD Unit” option. The “Use Jaguar BIOS” option in the Configuration dialogue will only take effect after the power has been cycled.

### Pause

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” dialogue. Pressing the Esc 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.

### Frame Advance

Pressing the button causes Virtual Jaguar 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 F7 key on your keyboard. This option only works when Virtual Jaguar is paused.

### Insert Cartridge

Pressing the Insert Cartridge button will bring up the Insert Cartridge dialogue; it can also be launched by pressing Ctrl + I on your keyboard. On the left side of the dialogue will be a list of software that Virtual Jaguar 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 dialogue if Virtual Jaguar knows about it. Pressing the icon in the lower right-hand side of the dialogue will then cause Virtual Jaguar to attempt to run the selected item. Virtual Jaguar cycles the power when it attempts to run the software you select.

There are also some keyboard shortcuts that come with the Insert Cartridge dialogue: 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 Esc key will dismiss the dialogue without attempting to load anything, and pressing the Enter key is the same as pressing the icon on the lower right-hand side of the dialogue.

### Use CD Unit

Pressing this toolbar button will virtually plug in a Jaguar CD unit into the emulated Jaguar. It can only be toggled with the virtual machine powered off.

As of the release date for this emulator, this option DOES NOT WORK 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.

Note that once this is working as it should, the DSP will be required to be enabled for it to work properly. It WILL NOT WORK properly without the DSP.

### Screenshot

Pressing the screenshot button will create a picture file based on the screen displayed in the main window. The file will be saved in the screenshot dedicated directory.

### Scale x1

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.

### Scale x2

This will cause the screen to be displayed with pixels that are sized 2 to 1 with your display.

### Scale x3

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.

### NTSC

Selecting this item will cause the emulated Jaguar to behave as if it were an NTSC type Jaguar, running at 60 Hz. This option can only be toggled when the virtual machine is powered off.

### PAL

Selecting this item will cause the emulated Jaguar to behave as if it were a 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 can only be toggled when the virtual machine is powered off.

### Blur

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.

### Full Screen

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 F9 key on your keyboard. Note that on monitors with a wide aspect ratio that Virtual Jaguar will still display its virtual screen in a 4:3 aspect ratio—this is normal and expected.

## Jaguar Menu

This menu has the following options:

- Power
- Pause
- Insert Cartridge...
- Use CD Unit
- Configure
- Status
- Exit

Power does the same as the toolbar button; see the “Power” toolbar button description for details.

Pause does the same as the toolbar button; see the “Pause” toolbar button description for details.

Insert Cartridge... does the same as the toolbar button; see the “Insert Cartridge” toolbar button description for details.

Use CD Unit does the same as the toolbar button; see the “Use CD Unit” toolbar button description for details.

Configure launches the Configure dialogue. A full description is given in the “Configure Dialog” section below.

Status launches a window with emulator internal information. It includes M68000 cycles counters.

Exit quits Virtual Jaguar immediately. You can also quit Virtual Jaguar by pressing Ctrl + Q on your keyboard.

## Help Menu

This menu has the following options:

- Contents
- About

The Contents 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 dialogue can be dismissed by clicking on the “X” in the upper corner of the dialogue, or by pressing the Esc key on your keyboard.

The About option shows a credits dialogue. It can be dismissed by clicking on the “X” in the upper corner of the dialogue, or by pressing the Esc key on your keyboard.

## The Configure Dialog

The Configure dialogue has the following tabs:

- General
- Models and BIOS
- Controllers
- Key Bindings

## General Tab

Under the General tab, there are the following options:

- EEPROMs
- Software
- Screenshots
- Enable GPU
- Enable DSP
- Start Virtual Jaguar in full screen
- Show all files in file chooser
- Use fast blitter

Here’s what they do.

### EEPROMs

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 Virtual Jaguar executable is located on your filesystem.

### Software

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 Virtual Jaguar executable is located on your filesystem.

### Screenshots

This field holds the location on your screenshots (see the “Screenshots” section below for details). The path can be either absolute or relative; if relative, it will be relative to where the Virtual Jaguar executable is located on your filesystem.

### Enable GPU

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.

### Enable DSP

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 no sound.

### Start Virtual Jaguar in full screen

Virtual Jaguar will display his video output in full screen.

### Show all files in file chooser

Normally the “Insert Cartridge...” dialogue 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 not cause Virtual Jaguar to be able to load such files.

### Use fast blitter

Checking this option will force Virtual Jaguar to use the older, less compatible yet faster blitter. Some games will not work properly with this option checked!

## Models and Bios Tab

Under the Models and Bios tab, there are the following options:

- Jaguar model
- Retail BIOS
- Developer BIOS

### Jaguar Model

Option to select the Jaguar model; set as "M" by default; there is no model specific usage except when selecting the retail BIOS.

### Retail BIOS

Selecting 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; also, it won't take effect until the virtual machine has been power cycled.

### Developer BIOS

Selecting this option will cause the emulated Jaguar to run with the built-in developer BIOS upon powering on. This option has been set mostly for testing purposes. Note that this option will only affect cartridge images; also, it won't take effect until the virtual machine has been power cycled.

## Controllers Tab

Under the Controller tab, there are the following options:

- A combobox labeled “Host Device”
- A combobox labeled “Map Name”
- Two buttons labelled “+” and “-”
- A combobox labeled “Maps to”
- A picture of a Jaguar controller showing which inputs are defined
- A button labeled “Define All Inputs”

Virtual Jaguar utilizes a profile system for controllers. What this means is that you can set up any device that Virtual Jaguar recognizes with any number of different configurations for it. Here’s how it works:

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.

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!

The “Maps to” combobox tells Virtual Jaguar which virtual controller slot you would like your device to be plugged into. Selecting None disables that key mapping for that device. Selecting Controller #1 will map the device to virtual controller slot #1. Selecting Controller #2 will map the device to virtual controller slot #2. Selecting Either one that’s free 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 not attempt to connect itself.

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 Esc key on your keyboard.

NOTE: For gamepads to be detected, they must be connected to the computer before starting Virtual Jaguar.

## Key Bindings Tab

This tab adapts based on the stock, alpine and debugger mode. User can change the emulator keyboards interactions but not all features have keybinding.

## EEPROMs

EEPROMs (Electrically Erasable Programmable Read Only Memory) were typically installed on Jaguar cartridges to save high scores and the like, and Virtual Jaguar 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.

## Software

Software can be either uncompressed or stored in a ZIP file. Virtual Jaguar looks for software in the location specified by the “Software” field in the Configuration dialog, under the “General” tab.

Virtual Jaguar 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, Virtual Jaguar will recognize and utilize it. If it’s a file meant to load into the emulated Jaguar’s RAM space, Virtual Jaguar 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 Virtual Jaguar 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 Virtual Jaguar, complain to the author and ask politely for a file with headers. :-)

## Screenshots

Screenshots use JPEG file, with 100% quality.

## Some Issues You May Encounter

Most of the time Virtual Jaguar 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 Virtual Jaguar got in the way and forced you to do the right thing, so, in those places where it’s possible to tell Virtual Jaguar to do bad things, it will willingly oblige.

Some cartridge based games will not work without either the DSP enabled, the BIOS enabled, or both. Virtual Jaguar will let you attempt to run those games with those options disabled, but the result probably won’t be what you want.

## Jaguar Programmer’s Zone

Virtual Jaguar has 2 modes available that makes it more convenient for developers to use. In order to use a mode, you must start Virtual Jaguar with the --alpine or --debugger option.

When started in Debugger mode, a specific tab is made available in the configuration dialogue which gives you the following options:

- Disassembly lines
- Source file search paths
- Display M68000 opcodes
- Display HW labels
- Display source filename
- ELF sections check

Disassembly lines represent the number of disassembly lines to display in the M68000 tracing window. This doesn't include the number of source lines displayed.

Source file search paths may be used in case of the debugger cannot find files path in the DWARF information.

Display M68000 opcode allows or not the opcode display. Can be useful in case of user prefers to see the disassembly only.

Display HW labels allows or not the name of the Jaguar hardware registers as reported in the official documentation.

Display source filename allows or not the source code filename display depend the disassembly in the M68000 tracing window.

ELF sections check allows or not potential unknown ELF section, it will stop, or not stop, the sections decoding.

When started in Alpine mode, or in Debugger mode, a specific tab is made available in the configuration dialogue which gives you the following options:

- ROM to load
- ABS to load
- Windows refresh
- Allow writes to cartdridge ROM
- Allow M68000 exception catch

ROM to load 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.

ABS to load 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 Virtual Jaguar 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 Virtual Jaguar is first run.

Windows refresh is the refresh rate for open windows. The smaller the rate, the faster the refresh window will occur. A 0 value will disable the refresh operations.

Allow writes to cartdridge ROM is the option allowing or not the cartdridge ROM writing. If allowed, emulator won't interfere but when turned off the emulator will display a dialog box with proper information, at this point user can allow to continue or stop the code.

Allow M68000 exception catch is the option allowing or not the exception catch from the M68000. If allowed, the emulator will display a dialog box with proper information and user will have the choice to continue or to stop the code.

Also, when in Debugger mode, extra toolbar buttons are defined (also found under the extra “Debug” menu) and also include the Alpine mode features:

- Restart
- Step Into
- Step Over
- Breakpoints
- New Function Breakpoint
- Delete All Breakpoints
- Disable All Breakpoints
- Exception Vector Table
- Output Video
- All Watch
- Locals
- Call Stack
- Heap Allocator
- Memory (1-4)
- Save Dump As...
- Cartridge directory and files list.

### Restart

Restart M68000 code (PC) and the stack (SP) pointer to the original ones provided in the ROM.

### Step Into

Trace into M68000 instruction, similar to a step by step tracing.

### Step Over

Trace over M68000 instruction such as jsr/bsr, otherwise this feature functions like a Step Into.

### Breakpoints

List the breakpoints and their status. The first breakpoint represents the breakpoint set via the CPU browser, also named as BPM.

### New Function Breakpoint

Add breakpoint to a function.

### Delete All Breakpoints

Delete all breakpoints, also reset the BPM.

### Disable All Breakpoints

Disable all breakpoints, and also disable BPM.

### Exception Vector Table

Display a partial table of the M68000 exception vectors as reported by Motorola.

### Output Video

Display the video output window.

### All Watch

Display all global variables used by the Jaguar code. It uses the available DWARF debug information. It has a search feature to look for a specific global variable.

### Locals

Display the local variables of the traced M68000 function. It uses the available DWARF debug information, and the A6 register to point on the stack.

### Call Stack

Display the M68000 call stack functions. It uses the available DWARF debug information, and the A6 register to point on the stack.

### Heap Allocator

Display the status of all memory allocations. It uses a specific structure memory allocation, if such structure is not found then nothing will be displayed.

### Memory (1-4)

This 4 independent windows lets you inspect Virtual Jaguar’s emulated memory space. The PgDn key will advance the top of the window’s memory location by 480 bytes, and PgUp will go back by the same amount. The Plus (+) key will advance the top of the window’s memory location by 16 bytes, and Minus (-) will go back by the same amount. Entering a memory location, in hexadecimal, label or decimal, in the edit field and pressing the Go 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 Esc key on your keyboard.

### Save Dump As...

Save a memory portion to a file.

### Cartridge directory and files list

List the cartridge's directory and files; available only if specific structure is used.

### Main window

In the debugger mode, the main window doesn't display anymore the video output; it is replaced by a source code files viewer and a disassembly window made of tabs to allow tracing / display of code.

Source code files

It is available for convenience reason; it display all the filenames found in the DWARF information. It is turned off by default but user can turn it on.

Sources tab

This tab is populated by C, or asm, source files following the M68000 program counter (PC). User can trace source code within the tab.

Disassembly tabs

There are 3 tabs, each of them is dedicated to a specific processor (M68000, GPU, and DSP). Currently, only the M68000 is tracable, others 2 display only the code pointed by their respective program counter (PC).

Also, when in Alpine mode, extra toolbar buttons are defined (also found under the extra “Debug” menu):

- Memory Browser
- Stack Browser
- CPU Browser
- OP Browser
- M68K Disassembly Browser
- RISC Disassembly Browser
- HW Registers Browser

### Memory Browser

This window lets you inspect Virtual Jaguar’s emulated memory space. The PgDn key will advance the top of the window’s memory location by 480 bytes, and PgUp will go back by the same amount. The Plus (+) key will advance the top of the window’s memory location by 16 bytes, and Minus (-) will go back by the same amount. Entering a memory location, in hexadecimal, in the edit field and pressing the Go 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 Esc key on your keyboard.

### Stack Browser

This window lets you inspect Virtual Jaguar’s emulated memory stack (SP) space. The PgDn key will advance the top of the window’s memory location by 480 bytes, and PgUp will go back by the same amount. The Plus (+) key will advance the top of the window’s memory location by 16 bytes, and Minus (-) will go back by the same amount. Entering a memory location, in hexadecimal, in the edit field and pressing the Go 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 Esc key on your keyboard.

### CPU Browser

This window shows the state of the various CPUs in the emulated Jaguar; a memory breakpoint (read Á write) can also be set via the BPM setting. The window can be dismissed by clicking on the “X” in the upper corner of the dialog, or by pressing the Esc key on your keyboard.

### OP Browser

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 Esc key on your keyboard.

### M68K Disassembly Browser

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 Esc key on your keyboard.

### RISC Disassembly Browser

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 Esc key on your keyboard.

### HW Registers Browser

This window provides a list of the hardware registers content; for the moment, only the blitter is displayed. It can be dismissed by clicking on the “X” in the upper corner of the dialog, or by pressing the Esc key on your keyboard.

The aforementioned options will only work when Virtual Jaguar is run in Alpine or Debugger mode, that is, when the --alpine or --debugger flag is passed in. If you do not pass such flag, Virtual Jaguar will run as it normally does, i.e., as a stock Jaguar, and nothing will be loaded by default.

## For The Curious

If you’re wondering why some cartridges have labels in the “Insert Cartridge...” dialogue and some don’t, read on...

Virtual Jaguar 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, Virtual Jaguar will use that image in the “Insert Cartridge...” dialogue — 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 Virtual Jaguar will scale it down to 365 x 168 anyway.

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 Virtual Jaguar will be able to utilize them.

## Legal Nigglings

Or, as it’s more commonly known, the disclaimer: “O liability, I do disclaim thee!”

Trademarks used in Virtual Jaguar and/or this documentation are the property of their respective owners. The user(s) of Virtual Jaguar 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.

Virtual Jaguar is Free (as in Libre) software and is licensed under the GPL version 3. You should have received a copy of the license with this software; if you did not, you may view a copy at http://www.gnu.org/licenses. A copy of the source code is available at http://icculus.org/virtualjaguar. A copy of the Rx version source code is available at https://github.com/djipi/Virtual-Jaguar-Rx.

Downfall is © 2011 Reboot, All Rights Reserved. Distribution of Downfall with Virtual Jaguar has been graciously authorized by Reboot, and may not be distributed as part of any other package. As previously stated, the Rx version doesn't have the game included.