News
About
Status
Screen Shots
User's Manual
Windows
Linux
Downloads
Contact

Xe User's Manual

Last update: 4/01/09


Table of Contents

1: Introduction
1.1: About
1.2: Definitions
1.3: Machine Names

2: Installation
2.1: Requirements
2.2: Simple Install
2.3: Manual Install

3: File Information
3.1: Special Files
3.2: rc Files
3.3: gzip Compressed Files
3.4: zip Compressed Files
3.5: CD Image File Format
3.6: Neo Geo ROM Image File Format
3.7: CPS Changer ROM Image File Format

4: Command Line
4.1: Command Line Options

5: Changing Machines
5.1: Start Machine
5.2: Stop Machine

6: Changing Media
6.1: Load ROM
6.2: Insert Cartridge 1
6.3: Remove Cartridge 1
6.4: Insert Cartridge 2
6.5: Remove Cartridge 2
6.6: Insert Floppy Disk
6.7: Remove Floppy Disk
6.8: Insert Compact Disc
6.9: Remove Compact Disc
6.10: Open Tray
6.11: Close Tray
6.12: Insert Unknown Image

7: Screen Shot
7.1: Saving Screen Shots

8: Exit
8.1: Exiting

9: Configuring Video
9.1: Render
9.2: Aspect
9.3: Soft Zoom
9.4: Window Size
9.5: Full Screen Size
9.6: Auto Shrink
9.7: Auto Fill
9.8: Horizontal Overscan
9.9: Vertical Overscan
9.10: Rotate Screen
9.11: Full Screen

10: Configuring Audio
10.1: Sample Rate
10.2: Channels
10.3: Mute
10.4: Lock
10.5: Visualizer
10.6: Sound

11: Configuring Input
11.1: Enable Keyboard
11.2: Enable Joystick 1
11.3: Enable Joystick 2
11.4: Enable Joystick 3
11.5: Enable Joystick 4
11.6: Enable Joystick 5
11.7: Enable Joystick 6
11.8: Mouse Player Select
11.9: Enable Mouse

12: Menu Controls
12.1: Menu Bar
12.2: Control Bar
12.3: Status Bar

13: Settings
13.1: Settings
13.2: Keyboard
13.3: Joystick
13.4: Mouse
13.5: Options
13.6: Adding Extensions

14: Emulator Controls
14.1: Options
14.2: Reset
14.3: Restart
14.4: Pause
14.5: Speed Control
14.6: Playback
14.7: Load State
14.8: Save State

15: Help
15.1: Help
15.2: About

16: Machines
16.1: SG-1000
16.2: Famicom
16.3: Mark III
16.4: PC Engine
16.5: Mega Drive
16.6: Super Famicom
16.7: Neo Geo
16.8: Neo Geo CD
16.9: CPS Changer
16.10: FM-Towns Marty
16.11: PC-FX
16.12: Game Boy
16.13: Game Gear
16.14: Neo Geo Pocket
16.15: Wonder Swan
16.16: Game Boy Advance


1 Introduction

1.1 About

Xe is a multi system emulator that emulates many console and handheld video game systems of the are no longer on the market.


1.2 Definitions
  • Machine / Module: Also known as a plug-in. In Xe, it is the machine emulator. For example, the 'superfamicom' module is the machine emulator for 'Super Famicom'.
  • Cartridge / ROM image: Also known as ROM. A copy of ROM chip(s) stored in a file.
  • CD / Disc image: A copy of a CD-ROM disc stored in a file.
  • Floppy / Disk image: a copy of a floppy disk stored in a file.
  • RAM Cartridge / Memory Card: NVRAM (Battery SRAM, EEPROM, Flash ...) image stored in a file.
  • Data Disk: Same as Floppy images except original image will be overwritten.

1.3 Machine Names

Many machines have different names. Xe uses the original names which may not be the same in all parts of the world.

SG-1000
Mark IIIMaster System
FamicomNES
Famicom Disk System
PC EngineTurbo Grafx 16
PC Engine CD-ROM2Turbo Grafx CD
Mega DriveGenesis
Mega CDSega CD
Super FamicomSuper NES
Neo GeoNeo Geo
Neo Geo CDNeo Geo CD
CPS Changer
FM-Towns Marty
PC-FX
Game BoyGame Boy
Game GearGame Gear
Neo Geo PocketNeo Geo Pocket
Wonder Swan
Game Boy AdvanceGame Boy Advance


2 Installation

2.1 Requirements

GTK+2.10.11 or above is required. Since GTK+ could be configured differently on different systems, you will need to link Xe manually. The files are described in 3.1 Special Files.


2.2 Simple Install

Install to system directory:
  1. login as root
  2. 'make' to link the software
  3. 'make install' will install it to the system directory

2.3 Manual Install

Install to system directory:
  1. login as root
  2. 'make' to link the software
  3. 'mkdir /usr/local/lib/xe' to create system directory
  4. 'mv xe rc modules manual.html /usr/local/lib/xe' to move files to system directory
  5. 'ln -sf /usr/local/lib/xe/xe /usr/local/bin/xe' to link binary into system path
Install to user directory:
  1. 'make' to link the software
  2. 'mkdir ~/.xe' to create local directory
  3. 'mv xe rc modules manual.html ~/.xe' to move files to local directory
  4. link or move ~/.xe/xe' to your local bin directory


3 File Information

3.1 Special Files

biosstore BIOS in this directory
modulesstore the modules in this directory
rcstore the configuration files in this directory
manual.htmlthe user's manual
xe.bgwallpaper (Image File: jpg, png, etc)

biosstore BIOS in this directory
modulesstore the modules in this directory
savesXe automatically saves Backup RAM in this directory
rcstore the configuration files in this directory
manual.htmlthe user's manual
xe.bgwallpaper (Image File: JPG, PNG, etc)

Notes:
  • Special files other than Backup RAM files could be stored in either the system directory or the user directory.
  • If BIOS files of the same name are stored in both the system and user directory, the file stored in the user directory is used.
  • If the Wallpaper file (xe.bg) is stored in both the system and user directory, the file stored in the user directory is used.
  • The system configuration files is loaded before the user configuration file.
  • The Wallpaper will be displayed when no machines are loaded.

3.2 rc Files

Notes:
  • rc files contain configuration information.
  • rc files are stored in either the system directory or the user directory.
  • The system rc file is xerc. It is loaded when Xe is started and saved when Xe is stopped.
  • The machine rc files contain keyboard, joystick and mouse configurations of a individual machine. For example, the pcengine rc file is pcenginerc. It is loaded when a machine is started and saved when the machine is stopped.
  • The gtk theme file is gtkrc. It is loaded when Xe is started

3.3 gzip Compressed Files

Notes:
  • ROMs, BIOS, backup RAM, floppy and CD image files could be compressed using gzip.
  • Backup RAM files are saved in gzip compressed format.
  • If both the compressed (.gz) file and the uncompressed file exist, the uncompressed file is used.
  • If compressed, the file must end in .gz, including BIOS files.

3.4 zip Compressed Files

Notes:
  • Unlike gzip, Only zipped ROMs and floppy images are supported.
  • BIOS, Backup RAM & CD images are not supported if zipped.
  • Only the first entry in the zip file is used.

3.5 CD Image File Format

header: 0x200 bytes
data: 2448 byte sectors (2352 Main, 96 Sub), 00:00:00->Lead Out

0x00000
0x00100
0x002First Track
0x003Last Track
0x004Track 1 (ADR << 4) | CTRL
0x005Track 1 Start Minutes
0x006Track 1 Start Seconds
0x007Track 1 Start Frames
......
n+0Last Track Start Minutes
n+1Last Track Start Seconds
n+2Last Track Start Frames
n+3Last Track (ADR << 4) | CTRL
n+4Lead-Out Track Start Minutes
n+5Lead-Out Track Start Seconds
n+6Lead-Out Track Start Frames
n+7Lead-Out Track (ADR << 4) | CTRL
...00
0x1FF00
                                                                                                                                                                               


3.6 Neo Geo ROM Image File Format

header: 0x10 bytes
SMA Banking control (optional): 0x10 bytes
SMA Banking data (optional): 0x80 bytes
68K ROM data
Z80 ROM data
CHR ROM data (optional)
SPR ROM data
ADPCM-A ROM data
ADPCM-B ROM data (optional)

0x00'N'
0x01'E'
0x02'O'
0x0300
0x0468K ROM size >> 17
0x05Z80 ROM size >> 16
0x06CHR ROM size >> 15
0x07SPR ROM size >> 20
0x08ADPCM-A ROM size >> 19
0x09ADPCM-B ROM size >> 19
0x0A Flags:
bit0-bit1: CHR ROM type (0) Normal (1) 128K in SPR ROMs (2) 512K type 1, (3) 512K type 2
bit2-bit4: Extra Devices
0x0B00
0x0C00
0x0D00
0x0E00
0x0F00
                                                                                                                                                                               
Notes:
  • 68K ROM is stored in big-endian format
  • SPR ROM is stored as Plane1, Plane 0, Plane 3, Plane 2. (Same format used by Neo CD)

3.7 CPS Changer ROM Image File Format

header: 0x10 bytes
68K ROM data
Z80 ROM data
GFX ROM data
PCM ROM data (optional)

0x00'C'
0x01'P'
0x02'S'
0x0300
0x0468K ROM size >> 17
0x05Z80 ROM size >> 15
0x06GFX ROM size >> 20
0x07PCM ROM size >> 17
0x0800
0x09 Flags:
bit2 - 0: 68K 10 MHz, 1: 68K 12 MHz
bit3 - 0: MSM6295 SS pin Low, 1: MSM6295 SS pin high
0x0A 68K I/O type:
bit0 - bit4: 68K I/O type
0x0BVDP type
0x0C Tile Banks:
bit0 - bit1: 32x32 Tile Bank
bit2 - bit3: 16x16 Tile Bank
bit4 - bit5: 8x8 Tile Bank
bit6 - bit7: Sprite Tile Bank
0x0DDefault DIP Switch 1
0x0EDefault DIP Switch 2
0x0FDefault DIP Switch 3
                                                                                                                                                                               
Notes:
  • 68K ROM is stored in big-endian format


4 Command Line

4.1 Command Line Options

Usage:xe [options] [rom image] [floppy image] [cd image]

-h, --helpDisplay help message
--liteStart without menu bar, control bar or status bar
--[no]autoshrinkEnable / disable auto shrink
--[no]autofillEnable / disable auto fill
--[no]hoverscanEnable / disable horizontal overscan
--[no]voverscanEnable / disable vertical overscan
--[no]rotateEnable / disable rotated screen
--[no]fullscreenEnable / disable fullscreen mode
--[no]muteEnable / disable mute
--[no]lockEnable / disable mixer lock
--[no]visualizerEnable / disable audio visualizer
--[no]soundEnable / disable sound
--[no]keyboardEnable / disable keyboard input
--[no]joystick1Enable / disable joystick 1 input
--[no]joystick2Enable / disable joystick 2 input
--[no]joystick3Enable / disable joystick 3 input
--[no]joystick4Enable / disable joystick 4 input
--[no]joystick5Enable / disable joystick 5 input
--[no]joystick6Enable / disable joystick 6 input
--[no]controlbarEnable / disable control bar
--[no]statusbarEnable / disable status bar
--[no]speedcontrolEnable / disable speed control
--[no]playbackEnable / disable playback
--region <int>Select region (0: Japan, 1: USA, 2: Europe)
--aspect <int>Select aspect (0: None, 1: Pixel, 2: 4x3, 3: 16x9, 4: Auto)
--zoom <int>Select soft zoom type (0: 1x1, 1: 2x1, 2: 1x2, 3: 2x2, 4: Auto)
--render <int>Select render (0: Software, 1: Hardware RGB, 2: Hardware YUV)
--winmode <int>Select window mode (0: Minimum, 1: Custom)
--scrmode <int>Select full screen mode (0: Minimum, 1: Custom, 2: Full, 3: Maximum)
--srmode <int>Select sample rate mode (0: Auto, 1: Custom)
--channels <int>Select number of audio channels (1: Mono, 2: Stereo)
--cwwidth <int>Set custom window Width
--cwheight <int>Set custom window Height
--cswidth <int>Set custom fullscreen Width
--csheight <int>Set custom fullscreen Height
--voll <int>Set left volume
--volr <int>Set right volume
--csrate <int>Set custom sample rate
--pbrate <int>Set playback rate
--pbmemory <int>Set maximum plaback memory
--mouse <int>Select the player to use the mouse
--cddevice <string>Select CD-ROM device file
--auddevice <string>Select sound card device file
--joy1device <string>Select Joystick 1 device file
--joy2device <string>Select Joystick 2 device file
--joy3device <string>Select Joystick 3 device file
--joy4device <string>Select Joystick 4 device file
--joy5device <string>Select Joystick 5 device file
--joy6device <string>Select Joystick 6 device file
-m, --machine <string>Select machine
--cart1 <string>Select ROM cartridge 1 image
--cart2 <string>Select ROM cartridge 2 image
--disk <string>Select Floppy Disk image
--disc <string>Select Compact Disc image
--memcard1 <string>Select RAM cartridge / memory card 1
--memcard2 <string>Select RAM cartridge / memory card 2
--datadisk <string>Select data disk
--nomemcard1 <string>Disable previous RAM cartridge / memory card 1
--nomemcard2 <string>Disable previous RAM cartridge / memory card 2
--nodatadisk <string>Disable previous data disk
--cdromSelect CD-ROM drive (and not disc image)
--cdcacheEnable caching for disc image & CD-ROM
                                                                                                                                                                               


5 Changing Machines

5.1 Start Machine [Ctrl+N]
  1. Select 'File' from the menu bar
  2. Select 'Start Machine'
  3. Select the machine to load
Notes:
  • The inserted cart, floppy or disc will not be affected.
  • RAM Cartridges / Memory Cards that was last used will be auto inserted if the cartridge slot is empty.
  • This option is usually used to start a machine without any cart, floppy or disc inserted. It is much easier to use the Load ROM, Insert Cartridge 1, Insert Cartridge 2, Insert Floppy Disk or Insert Compact Disc option to start a machine with a game.


5.2 Stop Machine [Alt+N]
  1. Select 'File' from the menu bar
  2. Select 'Stop Machine'
Notes:
  • The inserted Cart, Floppy and Discs will be removed.
  • RAM Cartridges / Memory Cards will be auto removed and auto inserted when the same machine is started again.


6 Changing Media

6.1 Load ROM [Ctrl+L]
  1. Select 'File' from the menu bar
  2. Select 'Load ROM'
  3. Select ROM, Floppy or CD Image
Notes:
6.2 Insert Cartridge 1 [Ctrl+C]
  1. Select 'File' from the menu bar
  2. Select 'Insert Cartridge 1'
  3. Select the ROM image to load
Options:
  • Image: Input image file or click on the ... button to select a image file. If inserting RAM Cartridge / Memory Card, non-existent files will be created.
  • Machine: Select the machine to use for the image. Use '[Auto Select]' to automatically select a machine. Use '[Current]' to select the current machine.
  • Media: Select ROM or RAM Cartridge / Memory Card.
  • Save extension: The file extension will be used to select this machine in the future.
  • Write Protect: Writes to RAM Cartridge / Memory Card will be disabled.
Notes:
  • RAM Cartridges are same as Memory Cards. /: Permission denied.
  • ROM images could also be inserted using 6.1 Load ROM
  • If inserting a ROM Cartridge and a machine is currently running, it will be stopped and the selected machine will be started.

6.3 Remove Cartridge 1 [Alt+C]
  1. Select 'File' from the menu bar
  2. Select 'Remove Cartridge 1'
Notes:
  • If removing a ROM Cartridge and a machine is currently running, it will be stopped.

6.4 Insert Cartridge 2 [Ctrl+M]
  1. Select 'File' from the menu bar
  2. Select 'Insert Cartridge 2'
  3. Select the ROM image to load
Notes:

6.5 Remove Cartridge 2 [Alt+M]
  1. Select 'File' from the menu bar
  2. Select 'Remove Cartridge 2'
Notes:
6.6 Insert Floppy Disk [Ctrl+P]
  1. Select 'File' from the menu bar
  2. Select 'Insert Floppy disk'
  3. Select the Floppy image to load
Options:
  • Image: Input Floppy image file, or click on the ... button to select a Floppy image file. If inserting a Data Disk, non-existent files will be created.
  • Machine: Select the machine to use for the Floppy image. Use '[Auto Select]' to automatically select a machine. Use '[Current]' to select the current machine.
  • Media: Select System or Data Disk.
  • Side: Select Side A or Side B.
  • Save extension: The file extension will be used to select this machine in the future.
  • Write Protect: Writes to the floppy disk will be disabled.
Notes:
  • Data Disks will be overwritten, System disks will store changes in a save file and the original image will not be modified.
  • Data Disks can not be used to auto select machines. The option [Auto Select] will always select the current machine.
  • Floppy images could also be inserted using 6.1 Load ROM
  • If a machine is currently running and a floppy image is inserted, it will be stopped and the selected machine will be started.

6.7 Remove Floppy Disk [Alt+P]
  1. Select 'File' from the menu bar
  2. Select 'Remove Floppy Disk'

6.8 Insert Compact Disc [Ctrl+D]
  1. Select 'File' from the menu bar
  2. Select 'Insert Compact Disc'
  3. Select the CD image to load
Options:
  • Image: Input Disc image file, or click on the ... button to select a CD image file.
  • Machine: Select the machine to use for the Disc image. Use '[Auto Select]' to automatically select a machine. Use '[Current]' to select the current machine.
  • Media: Select Image or CD-ROM drive.
  • Save extension: The file extension will be used to select this machine in the future.
  • Enable cache: Sectors are cached to memory as they are accessed.
Notes:
6.9 Remove Compact Disc [Alt+D]
  1. Select 'File' from the menu bar
  2. Select 'Remove Cartridge'
Notes:
6.10 Open Tray [Ctrl+T]
  1. Select 'File' from the menu bar
  2. Select 'Open Tray'
  • This option only affects the emulated machine. It has no effect with the physical disc drive.

6.11 Close Tray [Alt+T]
  1. Select 'File' from the menu bar
  2. Select 'Close Tray'
Notes:
  • This option only affects the emulated machine. It has no effect with the physical disc drive.

6.12 Insert Unknown Image
  1. Type 'xe unknown.ext' from the command line. Where file unknown.ext is the file name.
  2. Select options in the new window.
Options:
  • Image: The image name.
  • Machine: The machine to use for the image. Use '[Current]' to select current machine.
  • Media: Select the image type, Cart, Floppy or CD image.
  • Save extension: The file extension will be used to select this machine in the future.
Unknown Image could also be inserted using 6.1 Load ROM.


7 Screen Shot

7.1 Saving Screen Shots [Ctrl+F2]
  1. Select 'File' from the menu bar
  2. Select 'Save Screen Shot'
Notes:
  • The image will be save in PNG format.


8 Exit

8.1 Exiting [Ctrl+X]
  1. Select 'File' from the menu bar
  2. Select 'Exit'
Notes:
  • The system configuration file (xerc) is updated when Xe exits.


9 Configuring Video

9.1 Render
  1. Select 'Edit' from the menu bar
  2. Select 'Video'
  3. Select 'Render'
Options:
  • Software [Shift+X]: The default render using software to display video.
  • Hardware RGB [Shift+V]: This render uses the video card to display video. It is much faster than the standard software render. Not all systems support Hardware RGB.
  • Hardware YUV [Shift+Y]: This render uses the video card to display video. It is much faster than the standard software render. Not all systems support Hardware YUV.

9.2 Aspect
  1. Select 'Edit' from the menu bar
  2. Select 'Video'
  3. Select 'Aspect'
Options:
  • None [Shift+N]: Video is displayed using the size of the video window.
  • Pixel [Shift+P]: Video is displayed using the aspect of the image.
  • Normal [Shift+R]: Video is displayed like on television, using the aspect of 4x3.
  • Wide [Shift+W]: Video is displayed like on television, using the aspect of 16x9.
  • Zoom [Shift+Z]: Video is displayed like on television, using the aspect of 16x9 with image aspect 4:3.
  • Auto [Shift+A]: Aspect is automatically selected depending on machine. Machines that use television will use 4x3 aspect and machines that use LCD screens will use pixel aspect. If no machine is loaded, then aspect none will be used.

9.3 Soft Zoom
  1. Select 'Edit' from the menu bar
  2. Select 'Video'
  3. Select 'Soft Zoom'
Options:
  • 1x1 [Shift+F1]: No Change to video image.
  • 2x1 [Shift+F2]: 2x horizontal zoom of video image.
  • 1x2 [Shift+F3]: 2x vertical zoom of video image.
  • 2x2 [Shift+F4]: 2x zoom of video image.
  • Auto [Shift+F5]: Automatically determine zoom type from image size and window size.
Notes:
  • This option will improve picture quality of low resolution images. This option is only useful while using the Hardware RGB or Hardware YUV render.

9.4 Window Size
  1. Select 'Edit' from the menu bar
  2. Select 'Video'
  3. Select 'Window Size'
Options:
  • Minimum [Shift+F7]: Minimum window size is the size of the video image.
  • Custom [Shift+F8]: Minimum window size determined by custom settings .
Notes:
9.5 Full Screen Size
  1. Select 'Edit' from the menu bar
  2. Select 'Video'
  3. Select 'Full Screen Size'
Options:
  • Minimum [Shift+F9]: Full Screen uses smallest resolution able to fit the video image.
  • Full [Shift+F10]: Full Screen uses Current resolution.
  • Maximum [Shift+F11]: Full Screen uses all screens.
  • Custom [Shift+F12]: Full Screen uses custom settings.
Notes:
  • Enabling Menu Bar, Control Bar or any dialogs while in Minimum or Custom Full Screen mode will also change the current display to Window mode.
  • Minimum, Custom and Maximum modes may not be available on all systems.
  • To set Custom Full Screen size, see 13.5 Options.

9.6 Auto Shrink [Shift+S]
  1. Select 'Edit' from the menu bar
  2. Select 'Video'
  3. Select 'Auto Shrink'
Options:
  • enabled: Empty spaces will be removed when the screen is resized.
  • disabled: Empty spaces will not be affected when the screen is resized.

9.7 Auto Fill [Shift+F]
  1. Select 'Edit' from the menu bar
  2. Select 'Video'
  3. Select 'Auto Fill'
Options:
  • enabled: Screen will be expanded to fill the window.
  • disabled: Screen will not be expanded to fill the window.

9.8 Horizontal Overscan [F5]
  1. Select 'Edit' from the menu bar
  2. Select 'Video'
  3. Select 'Horizontal Overscan'
Options:
  • enabled: The screen will display the entire horizontal active scan area.
  • disabled: The screen will display only the horizontal vertical display area.
Notes:
  • The overscan area contains either black, a solid color, garbage or graphics.
  • Vertical Overscan could only be used if the machine uses a non-LCD type display.

9.9 Vertical Overscan [F6]
  1. Select 'Edit' from the menu bar
  2. Select 'Video'
  3. Select 'Vertical Overscan'
Options:
  • enabled: The screen will display the entire vertical active scan area.
  • disabled: The screen will display only the visible vertical display area.
Notes:
  • The overscan area contains either black, a solid color, garbage or graphics.
  • Vertical Overscan could only be used if the machine uses a non-LCD type display.

9.10 Rotate Screen [F7]
  1. Select 'Edit' from the menu bar
  2. Select 'Video'
  3. Select 'Rotate Screen'
Options:
  • enabled: The screen will be rotated 90 degrees counter clockwise.
  • disabled: The screen will be displayed normally.

9.11 Full Screen [F8]
  1. Select 'Edit' from the menu bar
  2. Select 'Video'
  3. Select 'Full Screen'
Options:
  • enabled: Display video using the whole screen.
  • disabled: Display video in a window.


10 Configuring Audio

10.1 Sample Rate
  1. Select 'Edit' from the menu bar
  2. Select 'Audio'
  3. Select 'Sample Rate'
Options:
  • Auto [Ctrl+F7]: Sample rate is automatically selected.
  • Custom [Ctrl+F8]: Custom sample rate will be used. This option will not affect internal sample rate and should not be used unless the sound card is not not working properly with automatically selected sample rate.
Notes:
  • This option is only available if Sound is enabled.
  • To set Custom Sample Rate, see 13.5 Options.

10.2 Channels
  1. Select 'Edit' from the menu bar
  2. Select 'Audio'
  3. Select 'Channels'
Options:
  • Mono [Ctrl+F9]: Mono sound will be output to both the left and right channels.
  • Stereo [Ctrl+F10]: Stereo sound output to the left and right channels.
Notes:
  • This option is only available if Sound is enabled.

10.3 Mute [F4]
  1. Select 'Edit' from the menu bar
  2. Select 'Audio'
  3. Select 'Mute'
Options:
  • enabled: No sound is output.
  • disabled: Sound is output normally.
Notes:
  • This option is only available if Sound is enabled.

10.4 Lock [Alt+L]
  1. Select 'Edit' from the menu bar
  2. Select 'Audio'
  3. Select 'Lock'
Options:
  • enabled: Lock left and right mixer controls together.
  • disabled: Do not lock left and right mixer controls.
Notes:
  • See the Control Bar section for Mixer controls.
  • This option is only available if Sound is enabled.

10.5 Visualizer [Alt+V]
  1. Select 'Edit' from the menu bar
  2. Select 'Audio'
  3. Select 'Visualizer'
Options:
  • enabled: The Visualizer will be displayed over the screen.
  • disabled: The Visualizer will be disabled.
Notes:
  • The red line is the Left Channel.
  • The green line is the Right Channel.
  • The white line is when the Left and Right Channel are at the same level (Mono).
  • This option is only available if Sound is enabled.

10.6 Sound [Alt+S]
  1. Select 'Edit' from the menu bar
  2. Select 'Audio'
  3. Select 'Sound'
Options:
  • enabled: Sound Card is used.
  • disabled: Sound Card is not used.


11 Configuring Input

11.1 Enable Keyboard [Ctrl+K]
  1. Select 'Edit' from the menu bar
  2. Select 'Input'
  3. Select 'Keyboard'
  4. Select 'Enable Keyboard'
Options:
  • enabled: Accept keyboard input.
  • disabled: Keyboard input is ignored.
Notes:
11.2 Enable Joystick 1 [Ctrl+1]
  1. Select 'Edit' from the menu bar
  2. Select 'Input'
  3. Select 'Joystick'
  4. Select 'Enable Joystick 1'
Options:
  • enabled: Accept joystick input.
  • disabled: Joystick input is ignored.
Notes:
11.3 Enable Joystick 2 [Ctrl+2]

See 11.2 Enable Joystick 1.

11.4 Enable Joystick 3 [Ctrl+3]

See 11.2 Enable Joystick 1.

11.5 Enable Joystick 4 [Ctrl+4]

See 11.2 Enable Joystick 1.

11.6 Enable Joystick 5 [Ctrl+5]

See 11.2 Enable Joystick 1.

11.7 Enable Joystick 6 [Ctrl+6]

See 11.2 Enable Joystick 1.

11.8 Mouse Player Select
  1. Select 'Edit' from the menu bar
  2. Select 'Input'
  3. Select 'Mouse'
Options:
  • Player 1 [Alt+1]: Map mouse to Player 1.
  • Player 2 [Alt+2]: Map mouse to Player 2.
  • Player 3 [Alt+3]: Map mouse to Player 3.
  • Player 4 [Alt+4]: Map mouse to Player 4.
  • Player 5 [Alt+5]: Map mouse to Player 5.
  • Player 6 [Alt+6]: Map mouse to Player 6.
Notes:
  • Only one player can use the mouse at any given time.
  • The Mouse must be enabled before it could be used.
  • To configure joystick buttons, see 13.4 Mouse.

11.9 Enable Mouse [F9]
  1. Select 'Edit' from the menu bar
  2. Select 'Input'
  3. Select 'Mouse'
  4. Select 'Enable Mouse'
Options:
  • enabled: Accept mouse input.
  • disabled: Mouse input is ignored.
Notes:
  • When Mouse is enabled, the mouse could not be used for the UI or the OS.
  • To configure mouse buttons, see 13.4 Mouse.


12 Menu Controls

12.1 Menu Bar [Escape]
  1. Select 'Edit' from the menu bar
  2. Select 'Menu Bar'
Options:
  • enabled: The menu bar will be displayed. Enabling this option while in Minimum or Custom Full Screen mode will also change the current display to Window mode.
  • disabled: The menu bar will not be displayed. Disabling this option has no effect on the current Display mode.

12.2 Control Bar [Ctrl+F5]
  1. Select 'Edit' from the menu bar
  2. Select 'Control Bar'
Options:
  • enabled: The control bar will be displayed. Enabling this option while in Minimum or Custom Full Screen mode will also change the current display to Window mode.
  • disabled: The control bar will not be displayed. Disabling this option has no effect on the current Display mode.
Playback Controls:
  • Rewind (or key '<'): Rewind gameplay up to the point of recorded Playback start. If machine is paused, step back one saved frame.
  • Play: Resume play if the machine is paused.
  • Pause: Pause the machine if machine is running and resume play if the machine is paused.
  • Stop: The machine will be reset and paused.
  • Forward (or key '>'): Fast Forward the gameplay up to the point of recorded Playback end. If machine is paused, step forward one saved frame.
Mixer Controls:
  • Left and Right volume could be adjusted independently if the Lock option is disabled.
Notes:
12.3 Status Bar [Ctrl+F6]
  1. Select 'Edit' from the menu bar
  2. Select 'Status Bar'
Options:
  • enabled: The status bar will be displayed.
  • disabled: The status bar will not be displayed.
The status bar displays the current state of the emulator.
  • Box 1: The currently running machine
  • Box 2: The currently inserted Cartridge / RAM Cartridge / Memory Card in slot 1
  • Box 3: The currently inserted Cartridge / RAM Cartridge / Memory Card in slot 2
  • Box 4: The currently inserted Floppy Disk
  • Box 5: The currently inserted Compact Disc
  • Box 6: Frame Rate


13 Settings

13.1 Settings [Ctrl+S]
  1. Select 'Edit' from the menu bar
  2. Select 'Settings'
Keyboard and Joystick input are mapped out using the following layout.

Up 1 5 6 7 8
Left 1 Right 1 1 2 3 4
Down 1 Select Start
Up 2 Up 3
Left 2 9 Right 2 Left 3 10 Right 3
Down 2 Down 3



13.2 Keyboard Changing Keys:
  1. Select 'Edit' from the menu bar
  2. Select 'Settings'
  3. Select 'Keyboard' tab
  4. Select 'Player 1/2/3/4/5/6' tab
Notes:
  • Configuring input when no machines are loaded will configure the default input.
  • Configuring input when a machine is loaded will configure input for that machine.
  • To change a key, simply click on the box of the button.
  • To unbind a key, click on the box of the button and press 'Escape'.

13.3 Joystick Changing Axis & Buttons:
  1. Select 'Edit' from the menu bar
  2. Select 'Settings'
  3. Select 'Joystick' tab
  4. Select 'Player 1/2/3/4/5/6' tab
Notes:
  • Configuring input when no machines are loaded will configure the default input.
  • Configuring input when a machine is loaded will configure input for that machine.
  • To change an axis or buttons, simply click on the box of the button and press desired joystick button or axis. Joystick must be enabled.
  • To unbind a axis or button, click on the box of the button and press 'Escape'.
  • A + or - indicates an axis.

13.4 Mouse Changing Buttons:
  1. Select 'Edit' from the menu bar
  2. Select 'Settings'
  3. Select 'Mouse' tab
Notes:
  • Configuring input when no machines are loaded will configure the default input.
  • Configuring input when a machine is loaded will configure input for that machine.
  • To change buttons, simply click on the box of the button and press the desired mouse button.
  • To unbind a button, click on the box of the button and press 'Escape'.

13.5 Options
  1. Select 'Edit' from the menu bar
  2. Select 'Settings'
  3. Select 'Options' tab
Options:
  • Custom Window Size: Select the size of the Custom Window. See 9.4 Window Mode.
  • Custom Screen Size: Select the size of the Custom Screen. See 9.5 Full Screen Mode.
  • Custom Sample Rate: Select the size of the Custom Sample Rate. See 10.1 Sample Rate.
  • Playback Rate: Select the Playback Rate. See 14.6 Playback.
  • Playback Memory: Select the maximum Playback memory usage. See 14.6 Playback.
  • Playback Time: The maximum playback time for the current machine (Time will vary depending on settings and machine). See 14.6 Playback.
  • Custom Sample Rate: Select the size of the Custom Sample Rate. See 10.1 Sample Rate.
  • CD-ROM: Select the CD-ROM drive device file or 'default' to use '/dev/cdrom'.
  • Sound Card: Select the sound card device file or 'default' to use 'ALSA default'.
  • Joystick 1: Select the joystick 1 device file or 'default' to use '/dev/input/js0'.
  • Joystick 2: Select the joystick 2 device file or 'default' to use '/dev/input/js1'.
  • Joystick 3: Select the joystick 2 device file or 'default' to use '/dev/input/js2'.
  • Joystick 4: Select the joystick 2 device file or 'default' to use '/dev/input/js3'.
  • Joystick 5: Select the joystick 2 device file or 'default' to use '/dev/input/js4'.
  • Joystick 6: Select the joystick 2 device file or 'default' to use '/dev/input/js5'.

13.6 Adding Extensions
  1. Select 'Edit' from the menu bar
  2. Select 'Settings'
  3. Select 'Machines' tab
Options:
  • Extension: File type extension to be added.
  • Media: File type is Cartridge, Floppy Disk or Compact Disk.
  • Machine: The machine to use for this extension.


14 Emulator Controls

14.1 Options
  1. Select 'Machine' from the menu bar
  2. Select 'Options'
Options:
  • Japan [Ctrl+J]: Machine will use region Japan.
  • USA [Ctrl+U]: Machine will use region USA.
  • Europe [Ctrl+E]: Machine will use region Europe.
  • Mode (machine specific): Select machine mode.
  • Cartridge Port 1 (machine specific): Select expansion device connected to cartridge port 1.
  • Cartridge Port 2 (machine specific): Select expansion device connected to cartridge port 1.
  • Expansion Port 1 (machine specific): Select expansion device connected to expansion port 1.
  • Expansion Port 2 (machine specific): Select expansion device connected to expansion port 2.
  • Input Port 1 (machine specific): Select device connected to input port 1.
  • Input Port 2 (machine specific): Select device connected to input port 2.
  • Input Port 3 (machine specific): Select device connected to input port 3.
  • Input Port 4 (machine specific): Select device connected to input port 4.
Notes:
  • Changes will not take effect until the machine is restarted.
  • See the Machines section for machine specific options

14.2 Reset [F1]
  1. Select 'Machine' from the menu bar
  2. Select 'Reset'
Notes:
  • This options will reset the current machine.

14.3 Restart [Ctrl+F1]
  1. Select 'Machine' from the menu bar
  2. Select 'Restart'
Notes:
  • This option restarts the current machine. Any changes to machine options will take effect after the restart.

14.4 Pause [F2]
  1. Select 'Machine' from the menu bar
  2. Select 'Pause'
Notes:
  • This option suspends the current machine. When paused, no CPU time will be used.

14.5 Speed Control [F3]
  1. Select 'Machine' from the menu bar
  2. Select 'Speed Control'
Options:
  • enabled: Machine will run at the correct frame rate.
  • disabled: Machine will run at maximum speed.
Notes:
  • This option is only available if Sound is enabled.

14.6 Playback [Ctrl+B]
  1. Select 'Machine' from the menu bar
  2. Select 'Playback'
Options:
  • enabled: Playback will be enabled. Enabling this option while not in Minimum or Custom Full Screen mode will also enable the Control Bar.
  • disabled: Playback will be disabled. Disabling this option has no effect on the Control Bar.
Notes:
  • To configure Playback, see 13.5 Options.
  • See the Control Bar section for Playback controls.
  • Playback will be reset if any Media are changed or the current Machine is stopped.

14.7 Load State [F11]
  1. Select 'Machine' from the menu bar
  2. Select 'Load State'
Notes:
  • Load States will be lost if any Media are changed or the current Machine is stopped.

14.8 Save State [F12]
  1. Select 'Machine' from the menu bar
  2. Select 'Save State'
Notes:
  • Save Sates will not be written to disk. If any Media are changed or the current Machine is stopped the state will be lost.


15 Help

15.1 Help [Ctrl+H]
  1. Select 'Help' from the menu bar
  2. Select 'Help'
Notes:
  • This option will load this document using the default web browser

15.2 About [Ctrl+A]
  1. Select 'Help' from the menu bar
  2. Select 'About'
Notes:
  • This option will display the about box.


16 Machines

16.1 SG-1000

Up        
Left Right 1 2    
Down   Pause
   
           
   

Card Catcher

Standard Pad

Cartridge Port 1 Cartridge Port
Cartridge Port 2 Cart Catcher Card Port
Floppy Disk Drive  
Compact Disc Drive  
                                                                                                                                                                               
Notes:
  • Card Catcher option is ignored if cartridge is inserted.

16.2 Famicom

Up        
Left Right B A    
Down Select Start
   
           
   

Famicom Disk System famicomds.rom famicomds.rom famicomds.rom

Standard Pad
Multi-Tap

Cartridge Port 1 Cartridge Port
Cartridge Port 2  
Floppy Disk Drive Famicom Disk System Floppy Drive
Compact Disc Drive  

Player 1 Input Port 1 Multi-Tap 1 Port 1 Input Port 1 Multi-Tap 1 Port 1
Player 2 Input Port 2 Input Port 2 Multi-Tap 2 Port 1 Multi-Tap 2 Port 1
Player 3 Multi-Tap 1 Port 2 Multi-Tap 1 Port 2
Player 4 Multi-Tap 2 Port 2 Multi-Tap 2 Port 2
Player 5
Player 6
                                                                                                                                                                               
Notes:
  • Famicom Disk System option is ignored if cartridge is inserted.
  • Japanese multiplayer games may only be compatible with the Multi-Tap with the Region Japan setting.
  • US or Europe multiplayer games may only be compatible with the Multi-Tap with the Region US or Europe setting.

16.3 Mark III

Up        
Left Right 1 2    
Down   Pause
   
           
   

Mark III
Master System mastersystem-j.rom mastersystem-u.rom mastersystem-e.rom

FM Sound Unit

Standard Pad

Cartridge Port 1 Cartridge Port
Cartridge Port 2 Card Port
Floppy Disk Drive  
Compact Disc Drive  

                                                                                                                                                                               

16.4 PC Engine

Up        
Left Right II I    
Down Select Run
   
           
   

Up        
Left Right III II I  
Down Select Run
   
           
   

Up IV V VI  
Left Right III II I  
Down Select Run
   
           
   

         
    L R    
  Select Run
   
           
   

PC Engine
Super Grafx

CD-ROM2
Super CD-ROM2 supercdrom2.rom supercdrom2.rom supercdrom2.rom

Standard Pad
3 Button Pad
6 Button Pad
Mouse
Multi-Tap

Cartridge Port 1 Card Port
Cartridge Port 2  
Floppy Disk Drive  
Compact Disc Drive CD-ROM2 Drive

Player 1 Input Port 1 Multi-Tap 1 Port 1
Player 2 Multi-Tap 1 Port 2
Player 3 Multi-Tap 1 Port 3
Player 4 Multi-Tap 1 Port 4
Player 5 Multi-Tap 1 Port 5
Player 6
                                                                                                                                                                               
Notes:
  • Super Grafx is not 100% compatible with the PC Engine.
  • PC Engine CDs requires both a System Card or the Super CD-ROM2 option and a CD or CD Image.
  • 3-Button Pad button "III" is mapped to "Run".
  • 6-Button Pad may not be compatible with older games.
  • Mouse is not compatible with all games.

16.5 Mega Drive

Up        
Left Right A B C  
Down   Start
   
           
   

Up X Y Z  
Left Right A B C Mode
Down   Start
   
           
   

         
    L M R  
    Start
   
           
   

Mega CD megacd-u.rom megacd-j.rom megacd-e.rom
Mega CD 2 megacd2-u.rom megacd2-j.rom megacd2-e.rom

Standard Pad
6 Button Pad
Mouse
Multi-Tap

Cartridge Port 1 Cartridge Port
Cartridge Port 2  
Floppy Disk Drive  
Compact Disc Drive Mega CD Drive

Player 1 Input Port 1 Multi-Tap 1 Port 1 Input Port 1 Multi-Tap 1 Port 1
Player 2 Input Port 2 Multi-Tap 1 Port 2 Multi-Tap 2 Port 1 Multi-Tap 1 Port 2
Player 3 Multi-Tap 1 Port 3 Multi-Tap 2 Port 2 Multi-Tap 1 Port 3
Player 4 Multi-Tap 1 Port 4 Multi-Tap 2 Port 3 Multi-Tap 1 Port 4
Player 5 Input Port 2 Multi-Tap 2 Port 4 Multi-Tap 2 Port 1
Player 6 Multi-Tap 2 Port 2
                                                                                                                                                                               
Notes:
  • 6-Button Pad may not be compatible with older games.
  • Mouse is not compatible with all games.

16.6 Super Famicom

Up Y X L  
Left Right B A R  
Down Select Start
   
           
   

         
    L R    
     
   
           
   

Standard Pad
Mouse
Multi-Tap

Cartridge Port 1 Cartridge Port
Cartridge Port 2  
Floppy Disk Drive  
Compact Disc Drive  

Player 1 Input Port 1 Multi-Tap 1 Port 1 Input Port 1 Multi-Tap 1 Port 1
Player 2 Input Port 2 Multi-Tap 1 Port 2 Multi-Tap 2 Port 1 Multi-Tap 1 Port 2
Player 3 Multi-Tap 1 Port 3 Multi-Tap 2 Port 2 Multi-Tap 1 Port 3
Player 4 Multi-Tap 1 Port 4 Multi-Tap 2 Port 3 Multi-Tap 1 Port 4
Player 5 Input Port 2 Multi-Tap 2 Port 4 Multi-Tap 2 Port 1
Player 6 Multi-Tap 2 Port 2
                                                                                                                                                                               
Notes:
  • Mouse is not compatible with all games.

16.7 Neo Geo

Up        
Left Right A B C D
Down Select Start
   
           
   

Neo Geo neogeo-j.rom neogeo-u.rom neogeo-e.rom

Standard Stick

Cartridge Port 1 Cartridge Port
Cartridge Port 2 Memory Card Port
Floppy Disk Drive  
Compact Disc Drive  

                                                                                                                                                                               
Notes:
  • Neo Geo BIOS must be in big-endian format.
  • Only the home system (AES) BIOSs are supported, the arcade system (MVS) BIOSs are not supported.
  • ROM image format is described in 3.5 Neo Geo ROM Image File Format.
  • To swap the BIOS into big-endian format, use the swab or dd utility. 'swab aes-bios.bin neogeo.rom'.

16.8 Neo Geo CD

Up C D    
Left Right A B    
Down Select Start
   
           
   

Neo Geo CD neocd.rom neocd.rom neocd.rom
Neo Geo CDZ neocdz.rom neocdz.rom neocdz.rom

Standard Pad

Cartridge Port 1  
Cartridge Port 2  
Floppy Disk Drive  
Compact Disc Drive CD Drive

                                                                                                                                                                               
Notes:
  • Neo Geo CD BIOS must be in big-endian format.
  • To swap the BIOS into big-endian format, use the swab utility. 'swab neocd.bin neocd.rom'.
  • The Neo CD and CDZ BIOS are not compatible and therefore not interchangeable.

16.9 CPS Changer

Up L X R  
Left Right Y B A  
Down Select Start
   
           
   

Standard Stick

Cartridge Port 1 Cartridge Port
Cartridge Port 2  
Floppy Disk Drive  
Compact Disc Drive  

                                                                                                                                                                               

16.10 FM-Towns Marty

Up        
Left Right B A Zoom  
Down Select Run
   
           
   

Up        
Left Right B A    
Down Select Run
   
           
   

Up X Y Z  
Left Right A B C  
Down Select Run
   
           
   

         
    L R    
     
   
           
   

FM-Towns Marty marty.rom marty.rom marty.rom

Standard Pad
2 Button Pad
6 Button Pad
Mouse

Cartridge Port 1 PCMCIA Port
Cartridge Port 2  
Floppy Disk Drive Floppy Drive
Compact Disc Drive CD Drive

                                                                                                                                                                               
Notes:
  • Only the home console FM-Towns Marty BIOSs are supported, the computer (FM-Towns) BIOSs are not supported.
  • FM Town Computer is not 100% compatible with the FM-Towns Marty.
  • Some Marty CDs require both a Floppy Disk Image and an CD Image.
  • Standard Pad is not compatible with all games (some games only work with the mouse).
  • 6-Button Pad is not be compatible with all games.
  • Mouse is not compatible with all games.

16.11 PC-FX

Up IV V VI Mode 1
Left Right III II I Mode 2
Down Select Run
   
           
   

         
    L R    
     
   
           
   

PC-FX pcfx.rom pcfx.rom pcfx.rom

Standard Pad
Mouse

Cartridge Port 1 Memory Card Port
Cartridge Port 2  
Floppy Disk Drive  
Compact Disc Drive CD Drive

                                                                                                                                                                               
Notes:
  • Mouse is not compatible with all games.

16.12 Game Boy

Up        
Left Right B A    
Down Select Start
   
           
   

Game Boy gameboy.rom gameboy.rom gameboy.rom
Game Boy Color gbcolor.rom gbcolor.rom gbcolor.rom

Cartridge Port 1 Cartridge Port
Cartridge Port 2  
Floppy Disk Drive  
Compact Disc Drive  

                                                                                                                                                                               

16.13 Game Gear

Up        
Left Right 1 2    
Down   Start
   
           
   

Cartridge Port 1 Cartridge Port
Cartridge Port 2  
Floppy Disk Drive  
Compact Disc Drive  

                                                                                                                                                                               

16.14 Neo Geo Pocket

Up        
Left Right A B    
Down   Option
   
           
   

Neo Geo Pocket neopocket.rom neopocket.rom neopocket.rom
Neo Geo Pocket Color ngpcolor-j.rom ngpcolor-u.rom ngpcolor-e.rom

Cartridge Port 1 Cartridge Port
Cartridge Port 2  
Floppy Disk Drive  
Compact Disc Drive  

                                                                                                                                                                               

16.15 Wonder Swan

X1     Y1 Y2
X4 X2 B A Y4 Y3
X3   Start
   
           
   

Y2 X1 X2    
Y1 Y3 X4 X3 B A
Y4   Start
   
           
   

Wonder Swan wonderswan.rom wonderswan.rom wonderswan.rom
Wonder Swan Color wscolor-j.rom wscolor-u.rom wscolor-e.rom

Cartridge Port 1 Cartridge Port
Cartridge Port 2  
Floppy Disk Drive  
Compact Disc Drive  

                                                                                                                                                                               
Notes:
  • Vertical Layout is used when the screen is rotated.

16.16 Game Boy Advance

Up L R    
Left Right B A    
Down Select Start
   
           
   

Game Boy Advance gbadvance.rom gbadvance.rom gbadvance.rom

Cartridge Port 1 Cartridge Port
Cartridge Port 2  
Floppy Disk Drive  
Compact Disc Drive