Universal Command-line Options¶
This section contains configuration options that are applicable to all MAME configurations (including both SDL and Windows native).
Commands and Verbs¶
Commands include mame itself as well as various tools included with the MAME distribution such as romcmp and srcclean.
Verbs are actions to take upon something with the command (e.g. mame -validate pacman has mame as a command and -validate as a verb)
Patterns¶
Many verbs support the use of patterns, which are either a system or device short name (e.g. a2600, zorba_kbd) or a glob pattern that matches either (e.g. zorba_*).
Depending on the command you're using the pattern with, pattern matching may match systems or systems and devices. It is advised to put quotes around your patterns to avoid having your shell try to expand them against filenames (e.g. mame -validate "pac*").
File Names and Directory Paths¶
A number of options for specifying directories support multiple paths (for
example to search for ROMs in multiple locations). MAME expects multiple
paths to be separated with semicolons ( ; ).
MAME expands environment variable expressions in paths. The syntax used depends
on your operating system. On Windows, % (percent) syntax is used. For
example %APPDATA%\mame\cfg will expand the application data path for the
current user's roaming profile. On UNIX-like system (including macOS and
Linux), Bourne shell syntax is used, and a leading ~ expands to the current
user's home directory. For example, ~/.mame/${HOSTNAME}/cfg expands to
a host-specific path inside the .mame directory in the current user's home
directory. Note that only simple variable substitutions are supported; more
complex expressions supported by Bash, ksh or zsh are not recognized by MAME.
Relative paths are resolved relative to the current working directory. If you
start MAME by double-clicking it in Windows Explorer, the working directory is
set to the folder containing the MAME executable. If you start MAME by
double-clicking it in the macOS Finder, it will open a Terminal window with the
working directory is set to your home directory (usually /Users/<username> )
and start MAME.
If you want behaviour similar to what Windows Explorer provides on macOS, create
a script file containing these lines in the directory containing the MAME
executable (for example you could call it mame-here ):
#!/bin/sh
cd "`dirname "$0"`"
exec ./mame
You should be able to use any text editor. If you have a choice of file format
or line ending style, choose UNIX. This assumes you're using a 64-bit release
build of MAME, but if you aren't you just need to change mame to the name
of your MAME executable (e.g. mamed, mamep, mamedp). Once you've created the
file, you need to mark it as executable. You can do this by opening a Terminal
window, typing chmod a+x followed by a space, dragging the file you created
onto the window (this causes Terminal to insert the full escaped path to the
file), and then ensuring the Terminal window is active and hitting Return
(or Enter) on your keyboard. You can close the Terminal window after doing
this. Now if you double-click the script in the Finder, it will open a
Terminal window, set the working directory to the location of the script
(i.e. the folder containing MAME), and then start MAME.
Core Verbs¶
Tip
Examples that have the output abbreviated for space reasons will show "..." in the output where needed. For instance: .. code-block:: bash
A B C ... Z
-help / -h / -?
Displays current MAME version and copyright notice.
- Example:
mame -help
-validate / -valid [<pattern>]
Performs internal validation on one or more drivers and devices in the system. Run this before submitting changes to ensure that you haven't violated any of the core system rules.
If a pattern is specified, it will validate systems matching the pattern, otherwise it will validate all systems and devices. Note that if a pattern is specified, it will be matched against systems only (not other devices), and no device type validation will be performed.
- Example:
Configuration Verbs¶
-createconfig / -cc
Creates the default
mame.inifile. All the configuration options (not verbs) described below can be permanently changed by editing this configuration file.
- Example:
mame -createconfig
-showconfig / -sc
Displays the current configuration settings. If you route this to a file, you can use it as an INI file.
- Example:
This example is equivalent to -createconfig.
-showusage / -su
Displays a summary of all the command line options. For options that are not mentioned here, the short summary given by "mame -showusage" is usually a sufficient description.
Frontend Verbs¶
Note: By default, all the '-list' verbs below write info to the standard output (usually the terminal/command window where you typed the command). If you wish to write the info to a text file instead, add this to the end of your command:
> filename
where filename is the name of the file to save the output in (e.g.
list.txt ). Note that if this file already exists, it will be completely
overwritten.
- Example:
This creates (or overwrites the existing file if already there)
list.txtand fills the file with the results of -listcrc puckman. In other words, the list of each ROM used in Puckman and the CRC for that ROM are written into that file.
-listxml / -lx [<pattern>...]
List comprehensive details for all of the supported systems and devices in XML format. The output is quite long, so it is usually better to redirect this into a file. By default all systems are listed; however, you can limit this list by specifying one or more patterns after the -listxml verb.
This XML output is typically imported into other tools (like graphical front-ends and ROM managers), or processed with scripts query detailed information.
- Example:
Tip
Output from this command is typically more useful if redirected to
an output file. For instance, doing
mame -listxml galaxian > galax.xml will make galax.xml or
overwrite any existing data in the file with the results of
-listxml; this will allow you to view it in a text editor or parse
it with external tools.
-listfull / -ll [<pattern>...]
- Example:
Displays a list of system driver names and descriptions. By default all systems and devices are listed; however, you can limit this list by specifying one or more patterns after the -listfull verb.
-listsource / -ls [<pattern>...]
Displays a list of system drivers/devices and the names of the source files where they are defined. Useful for finding which driver a system runs on in order to fix bugs. By default all systems and devices are listed; however, you can limit this list by specifying one or more pattern after the -listsource verb.
- Example:
-listclones / -lc [<pattern>]
Displays a list of clones. By default all clones are listed; however, you can limit this list by specifying a pattern after the -listsource verb. If a pattern is specified, MAME will list clones of systems that match the pattern, as well as clones that match the pattern themselves.
- Example 1:
- Example 2:
-listbrothers / -lb [<pattern>]
Displays a list of brothers, i.e. other systems that are defined in the same source file as a system that matches the specified pattern.
- Example:
-listcrc [<pattern>...]
Displays a full list of CRCs and names of all ROM images referenced by systems and devices matching the specified pattern(s). If no patterns are specified, ROMs referenced by all supported systems and devices will be included.
- Example:
-listroms / -lr [<pattern>...]
Displays a list of ROM images referenced by supported systems/devices that match the specified pattern(s). If no patterns are specified, the results will include all supported systems and devices.
- Example:
-listsamples [<pattern>]
Displays a list of samples referenced by the specified pattern of system or device names. If no pattern is specified, the results will be all systems and devices.
- Example:
-verifyroms [<pattern>]
Checks for invalid or missing ROM images. By default all drivers that have valid ZIP files or directories in the rompath are verified; however, you can limit this list by specifying a pattern after the -verifyroms command.
- Example:
-verifysamples [<pattern>]
Checks for invalid or missing samples. By default all drivers that have valid ZIP files or directories in the samplepath are verified; however, you can limit this list by specifying a pattern after the -verifyroms command.
- Example:
-romident [path/to/romstocheck.zip]
Attempts to identify ROM files, if they are known to MAME, in the specified .zip file or directory. This command can be used to try and identify ROM sets taken from unknown boards. On exit, the errorlevel is returned as one of the following:
0: means all files were identified
7: means all files were identified except for 1 or more "non-ROM" files
8: means some files were identified
9: means no files were identified
- Example:
-listdevices / -ld [<pattern>]
Displays a list of all devices known to be hooked up to a system. The ":" is considered the system itself with the devices list being attached to give the user a better understanding of what the emulation is using.
If slots are populated with devices, any additional slots those devices provide will be visible with -listdevices as well. For instance, installing a floppy controller into a PC will expose the disk drive slots.
- Example:
-listslots / -lslot [<pattern>]
Show available slots and options for each slot (if available). Primarily used for MAME to allow control over internal plug-in cards, much like PCs needing video, sound and other expansion cards.
If slots are populated with devices, any additional slots those devices provide will be visible with -listslots as well. For instance, installing a floppy controller into a PC will expose the disk drive slots.
The slot name (e.g. ctrl1) can be used from the command line (-ctrl1 in this case)
- Example:
-listbios [<pattern>]
Show available BIOS options for a system (if available). BIOS options may be available for the system or any devices selected as slot options.
If no pattern is specified, the results will include all supported systems.
- Example:
-listmedia / -lm [<pattern>]
List available media that the chosen system allows to be used. This includes media types (cartridge, cassette, diskette and more) as well as common file extensions which are supported.
- Example:
-listsoftware / -lsoft [<pattern>]
Displays the contents of all software lists that can be used by the system or systems represented by pattern.
- Example:
-verifysoftware / -vsoft [<pattern>]
Checks for invalid or missing ROM images in your software lists. By default all drivers that have valid ZIP files or directories in the rompath are verified; however, you can limit this list by specifying a specific driver name or pattern after the -verifysoftware command.
- Example:
-getsoftlist / -glist [<pattern>]
Displays the contents of a specific softlist with the filename represented by pattern.
- Example:
-verifysoftlist / -vlist [softwarelistname]
Checks a specified software list for missing ROM images if files exist for issued softwarelistname. By default, all drivers that have valid ZIP files or directories in the rompath are verified; however, you can limit this list by specifying a specific softwarelistname (without .XML) after the -verifysoftlist command.
- Example:
OSD Command-Line Verbs¶
-listmidi
List available MIDI I/O devices for use with emulation.
- Example:
-listnetwork
List available network adapters for use with emulation.
- Example 1:
- Example 2:
Tip
On Windows, you'll need the TAP driver from OpenVPN for MAME to see any network adapters.
OSD Output Options¶
-output
Chooses how MAME will handle processing of output notifiers. These are used to connect external outputs such as the LED lights for the Player 1/2 start buttons on certain arcade machines.
You can choose from:
auto,none,consoleornetworkNote that network port is fixed at 8000.
- Example:
Configuration Options¶
-[no]readconfig / -[no]rc
Enables or disables the reading of the config files. When enabled (which is the default), MAME reads the following config files in order:
mame.ini
debug.ini(if the debugger is enabled)
source/<driver>.ini(based on the source filename of the driver)
vertical.ini(for systems with vertical monitor orientation)
horizont.ini(for systems with horizontal monitor orientation)
arcade.ini(for systems in source added withGAME()macro)
console.ini(for systems in source added withCONS()macro)
computer.ini(for systems in source added withCOMP()macro)
othersys.ini(for systems in source added withSYST()macro)
vector.ini(for vector systems only)<parent>
.ini(for clones only, may be called recursively)<systemname>
.ini(See Order of Config Loading for further details)
The settings in the later INIs override those in the earlier INIs. So, for example, if you wanted to disable overlay effects in the vector systems, you can create a
vector.iniwith lineeffect nonein it, and it will override whatevereffectvalue you have in yourmame.ini.The default is ON (-readconfig).
- Example:
Core Search Path Options¶
-homepath <path>
Specifies a path for Lua plugins to store data.
The default is
.(that is, in the current working directory).
- Example:
-rompath / -rp <path>
Specifies one or more paths within which to find ROM or disk images. Multiple paths can be specified by separating them with semicolons.
The default is
roms(that is, a directoryromsin the current working directory).
- Example:
-hashpath / -hash_directory / -hash <path>
Specifies one or more paths within which to find software definition files. Multiple paths can be specified by separating them with semicolons.
The default is
hash(that is, a directoryhashin the current working directory).
- Example:
-samplepath / -sp <path>
Specifies one or more paths within which to find audio sample files. Multiple paths can be specified by separating them with semicolons.
The default is
samples(that is, a directorysamplesin the current working directory).
- Example:
-artpath <path>
Specifies one or more paths within which to find external layout and artwork files. Multiple paths can be specified by separating them with semicolons.
The default is
artwork(that is, a directoryartworkin the current working directory).
- Example:
-ctrlrpath <path>
Specifies one or more paths within which to find controller configuration files. Multiple paths can be specified by separating them with semicolons. Used in conjunction with the
-ctrlroption.The default is
ctrlr(that is, a directoryctrlrin the current working directory).
- Example:
-inipath <path>
Specifies one or more paths within which to find INI files. Multiple paths can be specified by separating them with semicolons.
On Windows, the default is
.;ini;ini/presets(that is, search in the current directory first, then in the directoryiniin the current working directory, and finally the directorypresetsinside that directory).On macOS, the default is
$HOME/Library/Application Support/mame;$HOME/.mame;.;ini(that is, search themamefolder inside the current user's Application Support folder, followed by the.mamefolder in the current user's home directory, then the current working directory, and finally the directoryiniin the current working directory).On other platforms (including Linux), the default is
$HOME/.mame;.;ini(that is search the.mamedirectory in the current user's home directory, followed by the current working directory, and finally the directoryiniin the current working directory).
- Example:
-fontpath <path>
Specifies one or more paths within which to find BDF (Adobe Glyph Bitmap Distribution Format) font files. Multiple paths can be specified by separating them with semicolons.
The default is
.(that is, search in the current working directory).
- Example:
-cheatpath <path>
Specifies one or more paths within which to find XML cheat files. Multiple paths can be specified by separating them with semicolons.
The default is
cheat(that is, a folder calledcheatlocated in the current working directory).
- Example:
-crosshairpath <path>
Specifies one or more paths within which to find crosshair image files. Multiple paths can be specified by separating them with semicolons.
The default is
crsshair(that is, a directorycrsshairin the current working directory).
- Example:
-pluginspath <path>
Specifies one or more paths within which to find Lua plugins for MAME.
The default is
plugins(that is, a directorypluginsin the current working directory).
- Example:
-languagepath <path>
Specifies one or more paths within which to find language files for localized UI text.
The default is
language(that is, a directorylanguagein the current working directory).
- Example:
-swpath <path>
Specifies the default path from which to load loose software image files.
The default is
sofware(that is, a directorysoftwarein the current working directory).
- Example:
Core Output Directory Options¶
-cfg_directory <path>
Specifies the directory where configuration files are stored. Configuration files are read when starting MAME or when starting an emulated machine, and written on exit. Configuration files preserve settings including input assignment, DIP switch settings, bookkeeping statistics, and debugger window arrangement.
The default is
cfg(that is, a directorycfgin the current working directory). If this directory does not exist, it will be created automatically.
- Example:
-nvram_directory <path>
Specifies the directory where NVRAM files are stored. NVRAM files store the contents of EEPROM, non-volatile RAM (NVRAM), and other programmable devices for systems that used this type of hardware. This data is read when starting an emulated machine and written on exit.
The default is
nvram(that is, a directorynvramin the current working directory)). If this directory does not exist, it will be created automatically.
- Example:
-input_directory <path>
Specifies the directory where input recording files are stored. Input recordings are created using the -record option and played back using the -playback option.
The default is
inp(that is, a directoryinpin the current working directory). If this directory does not exist, it will be created automatically.
- Example:
-state_directory <path>
Specifies the directory where save state files are stored. Save state files are read and written either upon user request, or when using the -autosave option.
The default is
sta(that is, a directorystain the current working directory). If this directory does not exist, it will be created automatically.
- Example:
-snapshot_directory <path>
Specifies the directory where screen snapshots and video recordings are stored when requested by the user.
The default is
snap(that is, a directorysnapin the current working directory). If this directory does not exist, it will be created automatically.
- Example:
-diff_directory <path>
Specifies the directory where hard drive difference files are stored. Hard drive difference files store data that is written back to an emulated hard disk, in order to preserve the original image file. The difference files are created when starting an emulated system with a compressed hard disk image.
The default is
diff(that is, a directorydiffin the current working directory). If this directory does not exist, it will be created automatically.
- Example:
-comment_directory <path>
Specifies a directory where debugger comment files are stored. Debugger comment files are written by the debugger when comments are added to the disassembly for a system.
The default is
comments(that is, a directorycommentsin the current working directory). If this directory does not exist, it will be created automatically.
- Example:
Core State/Playback Options¶
-[no]rewind
When enabled and emulation is paused, automatically creates a save state in memory every time a frame is advanced. Rewind save states can then be loaded consecutively by pressing the rewind single step shortcut key (Left Shift + Tilde by default).
The default rewind value is OFF (-norewind).
If debugger is in a 'break' state, a save state is instead created every time step in, step over, or step out occurs. In that mode, rewind save states can be loaded by executing the debugger rewind (or rw) command.
- Example:
mame -norewind
-rewind_capacity <value>
Sets the rewind capacity value, in megabytes. It is the total amount of memory rewind savestates can occupy. When capacity is hit, old savestates get erased as new ones are captured. Setting capacity lower than the current savestate size disables rewind. Values below 0 are automatically clamped to 0.
- Example:
-state <slot>
Immediately after starting the specified system, will cause the save state in the specified <slot> to be loaded.
- Example:
-[no]autosave
When enabled, automatically creates a save state file when exiting MAME and automatically attempts to reload it when later starting MAME with the same system. This only works for systems that have explicitly enabled save state support in their driver.
The default is OFF (-noautosave).
- Example:
mame -autosave
-playback / -pb <filename>
Specifies a file from which to play back a series of inputs. This feature does not work reliably for all systems, but can be used to watch a previously recorded game session from start to finish.
The default is
NULL(no playback).
- Example:
Tip
You may experience desync in playback if the configuration, NVRAM, and memory card files don't match the original; this is why it is suggested you should only record and playback with all configuration (.cfg), NVRAM (.nv), and memory card files deleted.
-[no]exit_after_playback
When used in conjunction with the -playback option, MAME will exit after playing back the input file. By default, MAME continues to run the emulated system after playback completes.
The default is OFF (-noexit_after_playback).
- Example:
-record / -rec <filename>
Specifies a file to record all input from a session. This can be used to record a session for later playback. This feature does not work reliably for all systems, but can be used to record a session from start to finish.
The default is
NULL(no recording).
- Example:
Tip
You may experience desync in playback if the configuration, NVRAM, and memory card files don't match the original; this is why it is suggested you should only record and playback with all configuration (.cfg), NVRAM (.nv), and memory card files deleted.
-mngwrite <filename>
Writes each video frame to the given <filename> in MNG format, producing an animation of the session. Note that -mngwrite only writes video frames; it does not save any audio data. Either use -wavwrite to record audio and combine the audio and video tracks using video editing software, or use -aviwrite to record audio and video to a single file.
The default is
NULL(no recording).
- Example:
-aviwrite <filename>
Stream video and sound data to the given <filename> in uncompressed AVI format, producing an animation of the session complete with sound. Note that the AVI format does not changes to resolution or frame rate, uncompressed video consumes a lot of disk space, and recording uncompressed video in realtime requires a fast disk. It may be more practical to record an emulation session using -record then make a video of it with -aviwrite in combination with -playback and -exit_after_playback options.
The default is
NULL(no recording).
- Example:
-wavwrite <filename>
Writes the final mixer output to the given <filename> in WAV format, producing an audio recording of the session.
The default is
NULL(no recording).
- Example:
-snapname <name>
Describes how MAME should name files for snapshots. <name> is a string that provides a template that is used to generate a filename.
Three simple substitutions are provided: the
/character represents the path separator on any target platform (even Windows); the string%grepresents the driver name of the current system; and the string%irepresents an incrementing index. If%iis omitted, then each snapshot taken will overwrite the previous one; otherwise, MAME will find the next empty value for%iand use that for a filename.The default is
%g/%i, which creates a separate folder for each system, and names the snapshots under it starting with 0000 and increasing from there.In addition to the above, for drivers using different media, like carts or floppy disks, you can also use the
%d_[media]indicator. Replace [media] with the media switch you want to use.
- Example 1:
Snapshots will be saved as
snaps\foo\robby0000.png,snaps\foo\robby0001.pngand so on.- Example 2:
Snapshots will be saved as
snaps\nes\robby.png.- Example 3:
Snapshots will be saved as
snaps\c64\robby\0000.png.
-snapsize <width>x<height>
Hard-codes the size for snapshots and movie recording. By default, MAME will create snapshots at the system's current resolution in raw pixels, and will create movies at the system's starting resolution in raw pixels. If you specify this option, then MAME will create both snapshots and movies at the size specified, and will bilinear filter the result.
The default is
auto.
- Example:
Tip
-snapsize does not automatically rotate if the system is vertically oriented, so for vertical systems you'll want to swap the width and height options.
-snapview <viewname>
Specifies the view to use when rendering snapshots and videos. The <viewname> does not need to be the full name of a view, MAME will choose the first view with a name that has the <viewname> as a prefix. For example -snapview "screen 0 pixel" will match the “Screen 0 Pixel Aspect (10:7)” view.
If the <viewname> is
autoor an empty string, MAME will select a view based on the number of emulated screens in the system, and the available external and internal artwork. MAME tries to select a view that shows all emulated screens by default.If the <viewname> is
native, MAME uses special internal view to save a separate snapshot for each visible emulated screen, or to record a video for the first visible screen only. The snapshot(s) or video will have the same resolution as the emulated screen(s) with no artwork elements drawn or effects applied.The default value is
auto.
- Example:
-[no]snapbilinear
Specify if the snapshot or movie should have bilinear filtering applied. Disabling this off can improve performance while recording video to a file.
The default is ON (-snapbilinear).
- Example:
-statename <name>
Describes how MAME should store save state files, relative to the state_directory path. <name> is a string that provides a template that is used to generate a relative path.
Two simple substitutions are provided: the
/character represents the path separator on any target platform (even Windows); the string%grepresents the driver name of the current system.The default is
%g, which creates a separate folder for each system.In addition to the above, for drivers using different media, like carts or floppy disks, you can also use the
%d_[media]indicator. Replace[media]with the media switch you want to use.
- Example 1:
- Example 2:
- Example 3:
Tip
Note that even on Microsoft Windows, you should use / as your
path seperator for -statename
-[no]burnin
Tracks brightness of the screen during play and at the end of emulation generates a PNG that can be used to simulate burn-in effects on other systems. The resulting PNG is created such that the least used-areas of the screen are fully white (since burned-in areas are darker, all other areas of the screen must be lightened a touch).
The intention is that this PNG can be loaded via an artwork file with a low alpha (e.g, 0.1-0.2 seems to work well) and blended over the entire screen.
The PNG files are saved in the snap directory under the
<systemname>/burnin-<screen.name>.png.The default is OFF (-noburnin).
- Example:
Core Performance Options¶
-[no]autoframeskip / -[no]afs
Dynamically adjust the frameskip level while you're running the system to maintain full speed. Turning this on overrides the -frameskip setting described below.
This is off by default (-noautoframeskip).
- Example:
-frameskip / -fs <level>
Specifies the frameskip value. This is the number of frames out of every 12 to drop when running. For example, if you specify -frameskip 2, MAME will render and display 10 out of every 12 emulated frames. By skipping some frames, you may be able to get full speed emulation for a system that would otherwise be too demanding for your computer.
The default value is -frameskip 0, which skips no frames.
- Example:
-seconds_to_run / -str <seconds>
This option tells MAME to automatically stop emulation after a fixed number of seconds of emulated time have elapsed. This may be useful for benchmarking and automated testing. By combining this with a fixed set of other command line options, you can set up a consistent environment for benchmarking MAME's emulation performance. In addition, upon exit, the -str option will write a screenshot to the system's snapshot directory with the file name determined by the -snapname option.
- Example:
-[no]throttle
Enable or disable throttling emulation speed. When throttling is enabled, MAME limits emulation speed to so the emulated system will not run faster than the original hardware. When throttling is disabled, MAME runs the emulation as fast as possible. Depending on your settings and the characteristics of the emulated system, performance may be limited by your CPU, graphics card, or even memory performance.
The default is to enable throttling (-throttle).
- Example:
-[no]sleep
When enabled along with -throttle, MAME will yield the CPU when limiting emulation speed. This allows other programs to use CPU time, assuming the main emulation thread isn't completely utilising a CPU core. This option can potentially cause hiccups in performance if other demanding programs are running.
The default is on (-sleep).
- Example:
-speed <factor>
Changes the way MAME throttles the emulation so that it runs at some multiple of the system's original speed. A <factor> of
1.0means to run the system at its normal speed, a <factor> of0.5means run at half speed, and a <factor> of 2.0 means run at double speed. Note that changing this value affects sound playback as well, which will scale in pitch accordingly. The internal precision of the fraction is two decimal places, so a <factor> of1.002is rounded to1.00.The default is
1.0(normal speed).
- Example:
-[no]refreshspeed / -[no]rs
Allows MAME to adjust the emulation speed so that the refresh rate of the first emulated screen does not exceed the slowest refresh rate for any targeted monitors in your system. Thus, if you have a 60Hz monitor and run a system that is designed to run at 60.6Hz, MAME will reduce the emulation speed to 99% in order to prevent sound hiccups or other undesirable side effects of running at a slower refresh rate.
The default is off (-norefreshspeed).
- Example:
-numprocessors / -np auto|<value>
Specify the number of threads to use for work queues. Specifying
autowill use the value reported by the system or environment variableOSDPROCESSORS. This value is internally limited to four times the number of processors reported by the system.The default is
auto.
- Example:
-bench <n>
Benchmark for <n> emulated seconds. This is equivalent to the following options:
-str <n> -video none -sound none -nothrottle
- Example:
-[no]lowlatency
This tells MAME to draw a new frame before throttling to reduce input latency. This is particularly effective with VRR (Variable Refresh Rate) displays.
This may cause frame pacing issues in the form of jitter with some systems (especially newer 3D-based systems or systems that run software akin to an operating system), so the default is off (-nolowlatency).
- Example:
Core Rotation Options¶
-[no]rotate
Rotate the system to match its normal state (horizontal/vertical). This ensures that both vertically and horizontally oriented systems show up correctly without the need to rotate your monitor. If you want to keep the system displaying 'raw' on the screen the way it would have in the arcade, turn this option OFF.
The default is ON (-rotate).
- Example:
-[no]ror
-[no]rol
Rotate the system screen to the right (clockwise) or left (counter-clockwise) relative to either its normal state (if -rotate is specified) or its native state (if -norotate is specified).
The default for both of these options is OFF (-noror -norol).
- Example 1:
- Example 2:
-[no]autoror
-[no]autorol
These options are designed for use with pivoting screens that only pivot in a single direction. If your screen only pivots clockwise, use -autorol to ensure that the system will fill the screen either horizontally or vertically in one of the directions you can handle. If your screen only pivots counter-clockwise, use -autoror.
- Example 1:
- Example 2:
Tip
If you have a display that can be rotated, -autorol or -autoror will allow you to get a larger display for both horizontal and vertical systems.
-[no]flipx
-[no]flipy
Flip (mirror) the system screen either horizontally (-flipx) or vertically (-flipy). The flips are applied after the -rotate and -ror/-rol options are applied.
The default for both of these options is OFF (-noflipx -noflipy).
- Example 1:
- Example 2:
Core Video Options¶
-video <bgfx|gdi|d3d|opengl|soft|accel|none>
Specifies which video subsystem to use for drawing. Options here depend on the operating system and whether this is an SDL-compiled version of MAME.
Generally Available:
Using
bgfxspecifies the new hardware accelerated renderer.Using
opengltells MAME to render video using OpenGL acceleration.Using
nonedisplays no windows and does no drawing. This is primarily intended for benchmarking emulation without the overhead of the video system.On Windows:
Using
gditells MAME to render video using older standard Windows graphics drawing calls. This is the slowest but most compatible option on older versions of Windows or buggy graphics hardware drivers.Using
d3dtells MAME to use Direct3D 9 for rendering. This produces better quality output thangdiand enables additional rendering options. It is recommended if you have a 3D-capable video card or onboard Intel video of the HD3000 line or better.On other platforms (including SDL on Windows):
Using
acceltells MAME to render video using SDL’s 2D acceleration if possible.Using
softuses software rendering for video output. This isn’t as fast or as nice as OpenGL, but it will work on any platform.Defaults:
The default on Windows is
d3d.The default for macOS is
openglbecause OS X is guaranteed to have a compliant OpenGL stack.The default on all other systems is
soft.
- Example:
-numscreens <count>
Tells MAME how many output windows or screens to create. For most systems, a single output window is all you need, but some systems originally used multiple screens (e.g. Darius and PlayChoice-10 arcade machines). Some systems with front panel controls and/or status lights also may let you put these in different windows/screens. Each screen (up to 4) has its own independent settings for physical monitor, aspect ratio, resolution, and view, which can be set using the options below.
The default is
1.
- Example 1:
- Example 2:
-[no]window / -[no]w
Run MAME in either a window or full screen.
The default is OFF (-nowindow).
- Example:
-[no]maximize / -[no]max
Controls initial window size in windowed mode. If it is set on, the window will initially be set to the maximum supported size when you start MAME. If it is turned off, the window will start out at the closest possible size to the original size of the display; it will scale on only one axis where non-square pixels are used. This option only has an effect when the -window option is used.
The default is ON (-maximize).
- Example:
-[no]keepaspect / -[no]ka
When enabled, MAME preserves the correct aspect ratio for the emulated system's screen(s). This is most often 4:3 or 3:4 for CRT monitors (depending on the orientation), though many other aspect ratios have been used, such as 3:2 (Nintendo Game Boy), 5:4 (some workstations), and various other ratios. If the emulated screen and/or artwork does not fill MAME's screen or Window, the image will be centred and black bars will be added as necessary to fill unused space (either above/below or to the left and right).
When this option is disabled, the emulated screen and/or artwork will be stretched to fill MAME's screen or window. The image will be distorted by non-proportional scaling if the aspect ratio does not match. This is very pronounced when the emulated system uses a vertically-oriented screen and MAME stretches the image to fill a horizontally-oriented screen.
On Windows, when this option is enabled and MAME is running in a window (not full screen), the aspect ratio will be maintained when you resize the window unless you hold the Control (or Ctrl) key on your keyboard. The window size will not be restricted when this option is disabled.
The default is ON (-keepaspect).
The MAME team strongly recommends leaving this option enabled. Stretching systems beyond their original aspect ratio will mangle the appearance of the system in ways that no filtering or shaders can repair.
- Example:
-[no]waitvsync
Waits for the refresh period on your computer's monitor to finish before starting to draw video to your screen. If this option is off, MAME will just draw to the screen as a frame is ready, even if in the middle of a refresh cycle. This can cause "tearing" artifacts, where the top portion of the screen is out of sync with the bottom portion.
The effect of turning -waitvsync on differs a bit between combinations of different operating systems and video drivers.
On Windows, -waitvsync will block until video blanking before allowing MAME to draw the next frame, limiting the emulated machine's framerate to that of the host display. Note that this option does not work with -video gdi mode in Windows.
On macOS, -waitvsync does not block; instead the most recent completely drawn frame will be displayed at vblank. This means that if an emulated system has a higher framerate than your host display, emulated frames will be dropped periodically resulting in motion judder.
On Windows, you should only need to turn this on in windowed mode. In full screen mode, it is only needed if -triplebuffer does not remove the tearing, in which case you should use -notriplebuffer -waitvsync.
Note that SDL-based MAME support for this option depends entirely on your operating system and video drivers; in general it will not work in windowed mode so -video opengl and fullscreen give the greatest chance of success with SDL builds of MAME.
The default is OFF (-nowaitvsync).
- Example:
-[no]syncrefresh
Enables speed throttling only to the refresh of your monitor. This means that the system's actual refresh rate is ignored; however, the sound code still attempts to keep up with the system's original refresh rate, so you may encounter sound problems.
This option is intended mainly for those who have tweaked their video card's settings to provide carefully matched refresh rate options. Note that this option does not work with -video gdi mode.
The default is OFF (-nosyncrefresh).
- Example:
-prescale <amount>
Controls the size of the screen images when they are passed off to the graphics system for scaling. At the minimum setting of 1, the screen is rendered at its original resolution before being scaled. At higher settings, the screen is expanded in both axes by a factor of <amount> using nearest-neighbor sampling before applying filters or shaders. With -video d3d, this produces a less blurry image at the expense of speed.
The default is
1.This is supported with all video output types (
bgfx,d3d, etc.) on Windows and is supported with BGFX and OpenGL on other platforms.
- Example:
-[no]filter / -[no]d3dfilter / -[no]flt
Enable bilinear filtering on the system screen graphics. When disabled, point filtering is applied, which is crisper but leads to scaling artifacts. If you don't like the filtered look, you are probably better off increasing the -prescale value rather than turning off filtering altogether.
The default is ON (-filter).
This is supported with OpenGL and D3D video on Windows and is ONLY supported with OpenGL on other platforms.
Use
bgfx_screen_chainsin your INI file(s) to adjust filtering with the BGFX video system.
- Example:
-[no]unevenstretch
Allow non-integer scaling factors allowing for great window sizing flexibility.
The default is ON. (-unevenstretch)
- Example:
Core Full Screen Options¶
-[no]switchres
Enables resolution switching. This option is required for the -resolution* options to switch resolutions in full screen mode.
On modern video cards, there is little reason to switch resolutions unless you are trying to achieve the "exact" pixel resolutions of the original systems, which requires significant tweaking. This is also true on LCD displays, since they run with a fixed resolution and switching resolutions on them is just silly. This option does not work with -video gdi and -video bgfx.
The default is OFF (-noswitchres).
- Example:
Core Per-Window Options¶
-screen <display>
-screen0 <display>
-screen1 <display>
-screen2 <display>
-screen3 <display>
Specifies which physical monitor on your system you wish to have each window use by default. In order to use multiple windows, you must have increased the value of the -numscreens option. The name of each display in your system can be determined by running MAME with the -verbose option. The display names are typically in the format of:
\\\\.\\DISPLAYn, where 'n' is a number from 1 to the number of connected monitors.The default value for these options is
auto, which means that the first window is placed on the first display, the second window on the second display, etc.The -screen0, -screen1, -screen2, -screen3 parameters apply to the specific window. The -screen parameter applies to all windows. The window-specific options override values from the all window option.
- Example 1:
- Example 2:
Tip
Using -verbose will tell you which displays you have on your system, where they are connected, and what their current resolutions are.
Tip
Multiple Screens may fail to work correctly on some Mac machines as of right now.
-aspect <width:height> / -screen_aspect <num:den>
-aspect0 <width:height>
-aspect1 <width:height>
-aspect2 <width:height>
-aspect3 <width:height>
Specifies the physical aspect ratio of the physical monitor for each window. In order to use multiple windows, you must have increased the value of the -numscreens option. The physical aspect ratio can be determined by measuring the width and height of the visible screen image and specifying them separated by a colon.
The default value for these options is
auto, which means that MAME assumes the aspect ratio is proportional to the number of pixels in the desktop video mode for each monitor.The -aspect0, -aspect1, -aspect2, -aspect3 parameters apply to the specific window. The -aspect parameter applies to all windows. The window-specific options override values from the all window option.
- Example 1:
- Example 2:
-resolution <widthxheight[@refresh]> / -r <widthxheight[@refresh]>
-resolution0 <widthxheight[@refresh]> / -r0 <widthxheight[@refresh]>
-resolution1 <widthxheight[@refresh]> / -r1 <widthxheight[@refresh]>
-resolution2 <widthxheight[@refresh]> / -r2 <widthxheight[@refresh]>
-resolution3 <widthxheight[@refresh]> / -r3 <widthxheight[@refresh]>
Specifies an exact resolution to run in. In full screen mode, MAME will try to use the specific resolution you request. The width and height are required; the refresh rate is optional. If omitted or set to 0, MAME will determine the mode automatically. For example, -resolution 640x480 will force 640x480 resolution, but MAME is free to choose the refresh rate. Similarly, -resolution 0x0@60 will force a 60Hz refresh rate, but allows MAME to choose the resolution. The string
autois also supported, and is equivalent to0x0@0.In window mode, this resolution is used as a maximum size for the window. This option requires the -switchres option as well in order to actually enable resolution switching with -video d3d.
The default value for these options is
auto.The -resolution0, -resolution1, -resolution2, -resolution3 parameters apply to the specific window. The -resolution parameter applies to all windows. The window-specific options override values from the all window option.
- Example:
-view <viewname>
-view0 <viewname>
-view1 <viewname>
-view2 <viewname>
-view3 <viewname>
Specifies the initial view setting for each window/screen. The <viewname> does not need to be the full name of a view, MAME will choose the first view with a name that has the <viewname> as a prefix. For example -view "screen 0 pixel" will match the “Screen 0 Pixel Aspect (10:7)” view.
If the <viewname> is
autoor an empty string, MAME will select views based on the number of emulated screens in the system, the number of windows/screens MAME is using, and the available external and internal artwork. MAME tries to select views so that all emulated screens are visible by default.The default value for these options is
auto.The -view0, -view1, -view2, -view3 parameters apply to the specific window. The -view parameter applies to all windows. The window-specific options override values from the all windows option.
Note that view settings saved in the configuration file for the machine take precedence over the initial view settings. If you change the selected views in the Video Options menu, this will be saved in the configuration file for the machine and take precedence over any initial views specified in INI files or on the command line.
- Example:
Core Artwork Options¶
-[no]artwork_crop / -[no]artcrop
Enable cropping of artwork to the system screen area only. This means that vertically oriented systems running full screen can display their artwork to the left and right sides of the screen. This option can also be controlled via the Video Options menu in the user interface.
The default is OFF -noartwork_crop.
- Example:
Tip
-artwork_crop is great for widescreen displays. You will get a full-sized system display and the artwork will fill the empty space on the sides as much as possible.
-fallback_artwork
Specifies fallback artwork if no external artwork or internal driver layout is defined. If external artwork for the system is present or a layout is included in the driver for the system, then that will take precedence.
- Example:
Tip
You can use fallback_artwork <artwork name> in
horizontal.ini and vertical.ini to specify different
fallback artwork choices for horizontal and vertical systems.
-override_artwork
Specifies override artwork for external artwork and internal driver layout.
- Example:
Core Screen Options¶
-brightness <value>
Controls the default brightness, or black level, of the system screens. This option does not affect the artwork or other parts of the display. Using the MAME UI, you can individually set the brightness for each system screen; this option controls the initial value for all visible system screens. The standard and default value is
1.0. Selecting lower values (down to 0.1) will produce a darkened display, while selecting higher values (up to 2.0) will give a brighter display.
- Example:
-contrast <value>
Controls the contrast, or white level, of the system screens. This option does not affect the artwork or other parts of the display. Using the MAME UI, you can individually set the contrast for each system screen; this option controls the initial value for all visible system screens. The standard and default value is
1.0. Selecting lower values (down to 0.1) will produce a dimmer display, while selecting higher values (up to 2.0) will give a more saturated display.
- Example:
-gamma <value>
Controls the gamma, which produces a potentially nonlinear black to white ramp, for the system screens. This option does not affect the artwork or other parts of the display. Using the MAME UI, you can individually set the gamma for each system screen; this option controls the initial value for all visible system screens. The standard and default value is
1.0, which gives a linear ramp from black to white. Selecting lower values (down to 0.1) will increase the nonlinearity toward black, while selecting higher values (up to 3.0) will push the nonlinearity toward white.The default is
1.0.
- Example:
-pause_brightness <value>
This controls the brightness level when MAME is paused.
The default value is
0.65.
- Example:
-effect <filename>
Specifies a single PNG file that is used as an overlay over any system screens in the video display. This PNG file is assumed to live in the root of one of the artpath directories. The pattern in the PNG file is repeated both horizontally and vertically to cover the entire system screen areas (but not any external artwork), and is rendered at the target resolution of the system image.
For -video gdi and -video d3d modes, this means that one pixel in the PNG will map to one pixel on your output display. The RGB values of each pixel in the PNG are multiplied against the RGB values of the target screen.
The default is
none, meaning no effect.
- Example:
Core Vector Options¶
-beam_width_min <width>
Sets the vector beam minimum width. The beam width varies between the minimum and maximum beam widths as the intensity of the vector drawn changes. To disable vector width changes based on intensity, set the maximum equal to the minimum.
- Example:
-beam_width_max <width>
Sets the vector beam maximum width. The beam width varies between the minimum and maximum beam widths as the intensity of the vector drawn changes. To disable vector width changes based on intensity, set the maximum equal to the minimum.
- Example:
-beam_intensity_weight <weight>
Sets the vector beam intensity weight. This value determines how the intensity of the vector drawn affects the width. A value of 0 creates a linear mapping from intensity to width. Negative values mean that lower intensities will increase the width toward maximum faster, while positive values will increase the width toward maximum more slowly.
- Example:
-beam_dot_size <scale>
Scale factor to apply to the size of single-point dots in vector games. Normally these are rendered according to the computed beam width; however, it is common for this to produce dots that are difficult to see. The beam_dot_size option applies a scale factor on top of the beam width to help them show up better.
The default is
1.
- Example:
-flicker <value>
Simulates a vector "flicker" effect, similar to a vector monitor that needs adjustment. This option requires a float argument in the range of 0.00 - 100.00 (0=none, 100=maximum).
The default is
0.
- Example:
Core Video OpenGL Feature Options¶
These options are for compatibility in -video opengl. If you report rendering artifacts you may be asked to try messing with them by the developers, but normally they should be left at their defaults which results in the best possible video performance.
Tip
Examples are not provided for these options as MAMEdev will provide suitable test options in the case of needing them for debugging.
-[no]gl_forcepow2texture
Always use only power-of-2 sized textures.
The default is OFF. (-nogl_forcepow2texture)
-[no]gl_notexturerect
Don't use OpenGL GL_ARB_texture_rectangle.
The default is ON. (-gl_notexturerect)
-[no]gl_vbo
Enable OpenGL VBO (Vertex Buffer Objects), if available.
The default is ON. (-gl_vbo)
-[no]gl_pbo
Enable OpenGL PBO (Pixel Buffer Objects), if available (default
on)The default is ON. (-gl_pbo)
Core Video OpenGL GLSL Options¶
-[no]gl_glsl
Enable OpenGL GLSL, if available.
The default is OFF (-nogl_glsl).
- Example:
-gl_glsl_filter
Use OpenGL GLSL shader-based filtering instead of fixed function pipeline-based filtering.
0-plain, 1-bilinear, 2-bicubic
The default is 1. (-gl_glsl_filter 1)
- Example:
-glsl_shader_mame0
-glsl_shader_mame1
...
-glsl_shader_mame9
Set a custom OpenGL GLSL shader effect to the internal system screen in the given slot. MAME does not include a vast selection of shaders by default; more can be found online.
- Example:
-glsl_shader_screen0
-glsl_shader_screen1
...
-glsl_shader_screen9
Set a custom OpenGL GLSL shader effect to the whole scaled-up output screen that will be rendered by your graphics card. MAME does not include a vast selection of shaders by default; more can be found online.
- Example:
Core Sound Options¶
-samplerate <value> / -sr <value>
Sets the audio sample rate. Smaller values (e.g. 11025) cause lower audio quality but faster emulation speed. Higher values (e.g. 48000) cause higher audio quality but slower emulation speed.
The default is
48000.
- Example:
-[no]samples
Use samples if available.
The default is ON (-samples).
- Example:
-[no]compressor
Enable audio compressor. It temporarily reduces the overall volume when the audio output is overdriven.
The default is ON (-compressor).
- Example:
-volume / -vol <value>
Sets the initial sound volume. It can be changed later with the user interface (see Keys section). The volume is an attenuation in decibels: e.g. "-volume -12" will start with -12 dB attenuation. Note that if the volume is changed in the user interface it will be saved to the configuration file for the system. The value from the configuration file for the system has priority over
volumesettings in general INI files.The default is
0(no attenuation, or full volume).
- Example:
-sound <dsound | coreaudio | sdl | xaudio2 | portaudio | none>
Specifies which sound subsystem to use. Selecting
nonedisables sound output altogether (sound hardware is still emulated).On Windows and Linux, portaudio is likely to give the lowest possible latency, while Mac users will find coreaudio provides the best results.
When using the
sdlsound subsystem, the audio API to use may be selected by setting the SDL_AUDIODRIVER environment variable. Available audio APIs depend on the operating system. On Windows, it may be necessary to setSDL_AUDIODRIVER=directsoundif no sound output is produced by default.The default is
dsoundon Windows. On Mac,coreaudiois the default. On all other platforms,sdlis the default.
- Example:
Microsoft Windows |
dsound |
xaudio2 |
portaudio |
sdl [13]. |
none |
|
macOS |
portaudio |
coreaudio |
sdl |
none |
||
Linux and others |
portaudio |
sdl |
none |
Footnotes
-audio_latency <value>
The exact behavior depends on the selected audio output module. Smaller values provide less audio delay while requiring better system performance. Higher values increase audio delay but may help avoid buffer under-runs and audio interruptions.
The default is
1.
For PortAudio, see the section on -pa_latency.
XAudio2 calculates audio_latency as 10ms steps.
DSound calculates audio_latency as 10ms steps.
CoreAudio calculates audio_latency as 25ms steps.
SDL calculates audio_latency as Xms steps.
- Example:
Core Input Options¶
-[no]coin_lockout / -[no]coinlock
Enables simulation of the "coin lockout" feature that is implemented on a number of arcade game PCBs. It was up to the operator whether or not the coin lockout outputs were actually connected to the coin mechanisms. If this feature is enabled, then attempts to enter a coin while the lockout is active will fail and will display a popup message in the user interface (in debug mode). If this feature is disabled, the coin lockout signal will be ignored.
The default is ON (-coin_lockout).
- Example:
-ctrlr <controller>
Specifies a controller configuration file, typically used to set more suitable default input assignments for special controllers. Directories specified using the
ctrlrpathoption are searched. Controller configuration files use a similar format to.cfgused to save system settings. See Controller Configuration Files for more details.The default is
NULL(no controller configuration file).
- Example:
-[no]mouse
Controls whether or not MAME makes use of mouse controllers. When this is enabled, you will likely be unable to use your mouse for other purposes until you exit or pause the system. Supported mouse controllers depend on your mouseprovider setting.
Note that if this setting is off (-nomouse), mouse input may still be enabled depending on the inputs present on the emulated system and your automatic input enable settings. In particular, the default is to enable mouse input when the emulated system has mouse inputs (-mouse_device mouse), so MAME will capture your mouse pointer when you run a system with mouse inputs unless you also change the mouse_device setting.
The default is OFF (-nomouse).
- Example:
-[no]joystick / -[no]joy
Controls whether or not MAME makes use of game controllers (e.g. joysticks, gamepads and simulation controls). Supported game controllers depend on your joystickprovider setting.
When this is enabled, MAME will ask the system about which controllers are connected.
Note that if this setting is off (-nojoystick), joystick input may still be enabled depending on the inputs present on the emulated system and your automatic input enable settings.
The default is OFF (-nojoystick).
- Example:
-[no]lightgun / -[no]gun
Controls whether or not MAME makes use of lightgun controllers. Note that most lightguns also produce mouse input, so enabling mouse and lightgun controllers simultaneously (using -lightgun and -mouse together) may produce strange behaviour. Supported lightgun controllers depend on your lightgunprovider setting.
Note that if this setting is off (-nolightgun), lightgun input may still be enabled depending on the inputs present on the emulated system and your automatic input enable settings.
The default is OFF (-nolightgun).
- Example:
-[no]multikeyboard / -[no]multikey
Determines whether MAME differentiates between multiple keyboards. Some systems may report more than one keyboard; by default, the data from all of these keyboards is combined so that it looks like a single keyboard.
Turning this option on will enable MAME to report keypresses on different keyboards independently.
The default is OFF (-nomultikeyboard).
- Example:
-[no]multimouse
Determines whether MAME differentiates between multiple mice. Some systems may report more than one mouse device; by default, the data from all of these mice is combined so that it looks like a single mouse. Turning this option on will enable MAME to report mouse movement and button presses on different mice independently.
The default is OFF (-nomultimouse).
- Example:
-[no]steadykey / -[no]steady
Some systems require two or more buttons to be pressed at exactly the same time to make special moves. Due to limitations in the keyboard hardware, it can be difficult or even impossible to accomplish that using the standard keyboard handling. This option selects a different handling that makes it easier to register simultaneous button presses, but has the disadvantage of making controls less responsive.
The default is OFF (-nosteadykey)
- Example:
-[no]ui_active
Enable user interface on top of emulated keyboard (if present).
The default is OFF (-noui_active)
- Example:
-[no]offscreen_reload / -[no]reload
Controls whether or not MAME treats a second button input from a lightgun as a reload signal. In this case, MAME will report the gun's position as (0,MAX) with the trigger held, which is equivalent to an offscreen reload.
This is only needed for games that required you to shoot offscreen to reload, and then only if your gun does not support off screen reloads.
The default is OFF (-nooffscreen_reload).
- Example:
-joystick_map <map> / -joymap <map>
Controls how analog joystick values map to digital joystick controls.
Systems such as Pac-Man use a 4-way digital joystick and will exhibit undesired behavior when a diagonal is triggered; in the case of Pac-Man, movement will stop completely at intersections when diagonals are triggered and the game will be considerably harder to play correctly. Many other arcade cabinets used 4-way or 8-way joysticks (as opposed to full analog joysticks), so for true analog joysticks such as flight sticks and analog thumb sticks, this then needs to be mapped down to the expected 4-way or 8-way digital joystick values.
To do this, MAME divides the analog range into a 9x9 grid that looks like this:
insert 9x9 grid picture here
MAME then takes the joystick axis position (for X and Y axes only), maps it to this grid, and then looks up a translation from a joystick map. This parameter allows you to specify the map.
For instance, an 8-way joystick map traditionally looks like this:
insert 8-way map picture here
This mapping gives considerable leeway to the angles accepted for a given direction, so that being approximately in the area of the direction you want will give you the results you want. Without that, if you were slightly off center while holding the stick left, it would not recognize the action correctly.
The default is
auto, which means that a standard 8-way, 4-way, or 4-way diagonal map is selected automatically based on the input port configuration of the current system.Generally you will want to set up the -joystick_map setting in the per-system
<system>.inifile as opposed to the mainMAME.INIfile so that the mapping only affects the systems you want it to. See Multiple Configuration Files for further details on per-system configuration.Maps are defined as a string of numbers and characters. Since the grid is 9x9, there are a total of 81 characters necessary to define a complete map. Below is an example map for an 8-way joystick that matches the picture shown above:
To specify the map for this parameter, you can specify a string of rows separated by a '.' (which indicates the end of a row), like so:
-joymap 777888999.777888999.777888999.444555666.444555666.444555666.111222333.111222333.111222333
However, this can be reduced using several shorthands supported by the <map> parameter. If information about a row is missing, then it is assumed that any missing data in columns 5-9 are left/right symmetric with data in columns 0-4; and any missing data in columns 0-4 is assumed to be copies of the previous data. The same logic applies to missing rows, except that up/down symmetry is assumed.
By using these shorthands, the 81 character map can be simply specified by this 11 character string: 7778...4445 (which means we then use -joymap 7778...4445)
Looking at the first row, 7778 is only 4 characters long. The 5th entry can't use symmetry, so it is assumed to be equal to the previous character '8'. The 6th character is left/right symmetric with the 4th character, giving an '8'. The 7th character is left/right symmetric with the 3rd character, giving a '9' (which is '7' with left/right flipped). Eventually this gives the full 777888999 string of the row.
The second and third rows are missing, so they are assumed to be identical to the first row. The fourth row decodes similarly to the first row, producing 444555666. The fifth row is missing so it is assumed to be the same as the fourth.
The remaining three rows are also missing, so they are assumed to be the up/down mirrors of the first three rows, giving three final rows of 111222333.
With 4-way games, sticky becomes important to avoid problems with diagonals. Typically you would choose a map that looks something like this:
insert 9x9 4-way sticky grid picture here
This means that if you press left, then roll the stick towards up (without re-centering it) you'll pass through the sticky section in the corner. As you do, MAME will read that sticky corner as left as that's the last non-sticky input it received. As the roll gets into the upward space of the map, this then switches to an up motion.
This map would look somewhat like:
To specify the map for this parameter, you can specify a string of rows separated by a '.' (which indicates the end of a row), like so:
-joymap s8888888s.4s88888s6.44s888s66.444555666.444555666.444555666.44s222s66.4s22222s6.s2222222s
Like before, because of the symmetry between top and bottom and left and right, we can shorten this down to:
-joymap s8.4s8.44s8.4445
-joystick_deadzone <value> / -joy_deadzone <value> / -jdz <value>
If you play with an analog joystick, the center can drift a little. joystick_deadzone tells how far along an axis you must move before the axis starts to change. This option expects a float in the range of 0.0 to 1.0. Where 0 is the center of the joystick and 1 is the outer limit.
The default is
0.15.
- Example:
-joystick_saturation <value> / joy_saturation <value> / -jsat <value>
If you play with an analog joystick, the ends can drift a little, and may not match in the +/- directions. joystick_saturation tells how far along an axis movement change will be accepted before it reaches the maximum range. This option expects a float in the range of 0.0 to 1.0, where 0 is the center of the joystick and 1 is the outer limit.
The default is
0.85.
- Example:
-joystick_threshold <value> / joy_threshold <value> / -jthresh <value>
When a joystick axis (or other absolute analog axis) is assigned to a digital input, this controls how far it must be moved from the neutral position (or centre) to be considered active or switched on. This option expects a float in the range of 0.0 to 1.0, where 0 means any movement from the neutral position is considered active, and 1 means only the outer limits are considered active. This threshold is not adjusted to the range between the dead zone and saturation point.
Note that if a joystick map is configured, that will take precedence over this setting when a joystick’s main X/Y axes are assigned to digital inputs.
The default is
0.3.
- Example:
-[no]natural
Allows user to specify whether or not to use a natural keyboard or not. This allows you to start your system in a 'native' mode, depending on your region, allowing compatibility for non-"QWERTY" style keyboards.
The default is OFF (-nonatural)
In "emulated keyboard" mode (the default mode), MAME translates pressing/releasing host keys/buttons to emulated keystrokes. When you press/release a key/button mapped to an emulated key, MAME presses/releases the emulated key.
In "natural keyboard" mode, MAME attempts to translate characters to keystrokes. The OS translates keystrokes to characters (similarly to when you type into a text editor), and MAME attempts to translate these characters to emulated keystrokes.
There are a number of unavoidable limitations in "natural keyboard" mode:
The emulated system driver and/or keyboard device has to support it.
The selected keyboard layout must match the keyboard layout selected in the emulated OS!
Keystrokes that don’t produce characters can’t be translated (e.g. pressing a modifier on its own such as shift, ctrl, or alt).
Holding a key until the character repeats will cause the emulated key to be pressed repeatedly as opposed to being held down.
Dead key sequences are cumbersome to use at best.
It won’t work at all if IME edit is involved (e.g. for Chinese, Japanese or Korean language input).
- Example:
-[no]joystick_contradictory
Enable contradictory direction digital joystick input at the same time such as Left and Right or Up and Down at the same time.
The default is OFF (-nojoystick_contradictory)
- Example:
-coin_impulse [n]
Set coin impulse time based on n (n<0 disable impulse, n==0 obey driver, 0<n set time n).
Default is
0.
- Example:
Core Input Automatic Enable Options¶
-paddle_device ( none | keyboard | mouse | lightgun | joystick )
-adstick_device ( none | keyboard | mouse | lightgun | joystick )
-pedal_device ( none | keyboard | mouse | `lightgun | joystick )
-dial_device ( none | keyboard | mouse | lightgun | joystick )
-trackball_device ( none | keyboard | mouse | lightgun | joystick )
-lightgun_device ( none | keyboard | mouse | lightgun | joystick )
-positional_device ( none | keyboard | mouse | lightgun | joystick )
-mouse_device ( none | keyboard | mouse | lightgun | joystick )
Each of these options sets whether mouse, joystick or lightgun controllers should be enabled when running an emulated system that uses a particular class of analog inputs. These options can effectively set -mouse, -joystick and/or -lightgun depending on the type of inputs present on the emulated system. Note that these options will not override explicit -nomouse, -nojoystick and/or -nolightgun settings at a higher priority level (e.g. in a more specific INI file or on the command line).
For example, if you specify the option -paddle_device mouse, then mouse controls will automatically be enabled when you run a game that has paddle controls (e.g. Super Breakout), even if you specified -nomouse .
The default is to automatically enable mouse controls when running emulated systems with mouse inputs (-mouse_device mouse).
- Example:
Tip
Note that these settings can override -nomouse, -nojoystick and/or -nolightgun depending on the inputs present on the emulated system.
Debugging Options¶
-[no]verbose / -[no]v
Displays internal diagnostic information. This information is very useful for debugging problems with your configuration.
The default is OFF (-noverbose).
- Example:
Tip
IMPORTANT: When reporting bugs to MAMEdev, please run with -verbose and include the resulting information.
-[no]oslog
Output
error.logmessages to the system diagnostic output, if one is present.By default messages are sent to the standard error output (this is typically displayed in the terminal or command prompt window, or saved to a system log file). On Windows, if a debugger is attached (e.g. the Visual Studio debugger or WinDbg), messages will be sent to the debugger instead.
The default is OFF (-nooslog).
- Example:
-[no]log
Creates a file called error.log which contains all of the internal log messages generated by the MAME core and system drivers. This can be used at the same time as -oslog to output the log data to both targets as well.
The default is OFF (-nolog).
- Example 1:
- Example 2:
-[no]debug
Activates the integrated debugger. By default, pressing the backtick/tilde (~) key during emulation breaks into the debugger. MAME also breaks into the debugger after the initial soft reset on startup if the debugger is active. See MAME Debugger for information on using the debugger.
The default is OFF (-nodebug).
- Example:
-debugger <module>
Chooses the module to use for debugging the target system when the debug option is on. Available debugger modules depend on the host platform and build options.
Supported debugger modules:
- windows
Win32 GUI debugger (default on Windows). Only supported on Windows.
- qt
Qt GUI debugger (default on Linux). Supported on Windows, Linux and macOS, but only included on Linux by default. Set
USE_QTDEBUG=1when compiling MAME to include the Qt debugger on Windows or macOS.- osx
Cocoa GUI debugger (default on macOS). Only supported on macOS.
- imgui
ImgUi GUI debugger displayed in first MAME window. Requires video option to be set to bgfx. Supported on all platforms with BGFX video output support.
- gdbstub
Acts as a remote debugging server for the GNU debugger (GDB). Only a small subset of the CPUs emulated by MAME are supported. Use the debugger_port option to set the listening port on the loopback interface. Supported on all platforms with TCP socket support.
- Example:
-debugscript <filename>
Specifies a file that contains a list of debugger commands to execute immediately upon startup.
The default is
NULL(no commands).
- Example:
-[no]update_in_pause
Enables updating of the main screen bitmap while the system is paused. This means that the video update callback will be called repeatedly while the emulation is paused, which can be useful for debugging.
The default is OFF (-noupdate_in_pause).
- Example:
-watchdog <duration> / -wdog <duration>
Enables an internal watchdog timer that will automatically kill the MAME process if more than <duration> seconds passes without a frame update. Keep in mind that some systems sit for a while during load time without updating the screen, so <duration> should be long enough to cover that.
10-30 seconds on a modern system should be plenty in general.
By default there is no watchdog.
- Example:
-debugger_port <port>
Set the TCP port number to listen on for GDB connections when using the GDB stub debugger module (see the debugger option).
The default is
23946.
- Example:
-debugger_font <fontname> / -dfont <fontname>
Specifies the name of the font to use for debugger windows.
The Windows default font isLucida Console.The Mac (Cocoa) default font is system fixed-pitch font default (typicallyMonaco).The Qt default font isCourier New.
- Example:
-debugger_font_size <points> / -dfontsize <points>
Specifies the size of the font to use for debugger windows, in points.
The Windows default size is9points.The Qt default size is11points.The Mac (Cocoa) default size is the system default size.
- Example:
Core Communication Options¶
-comm_localhost <string>
Local address to bind to. This can be a traditional
xxx.xxx.xxx.xxxaddress or a string containing a resolvable hostname.The default is value is
0.0.0.0(which binds to all local IPv4 addresses).
- Example:
-comm_localport <string>
Local port to bind to. This can be any traditional communications port as an unsigned 16-bit integer (0-65535).
The default value is
15122.
- Example:
-comm_remotehost <string>
Remote address to connect to. This can be a traditional xxx.xxx.xxx.xxx address or a string containing a resolvable hostname.
The default is value is "
0.0.0.0" (which binds to all local IPv4 addresses).
- Example:
-comm_remoteport <string>
Remote port to connect to. This can be any traditional communications port as an unsigned 16-bit integer (0-65535).
The default value is "
15122".
- Example:
-[no]comm_framesync
Synchronize frames between the communications network.
The default is OFF (-nocomm_framesync).
- Example:
Core Misc Options¶
-[no]drc
Enable DRC (dynamic recompiler) CPU core if available for maximum speed.
The default is ON (-drc).
- Example:
-[no]drc_use_c
Force DRC to use the C code backend.
The default is OFF (-nodrc_use_c).
- Example:
-[no]drc_log_uml
Write DRC UML disassembly log.
The default is OFF (-nodrc_log_uml).
- Example:
-[no]drc_log_native
Write DRC native disassembly log.
The default is OFF (-nodrc_log_native).
- Example:
-bios <biosname>
Specifies the specific BIOS to use with the current system, for systems that make use of a BIOS. The -listbios output will list all of the possible BIOS names for a system, as does the -listxml output.
The default is
default.
- Example:
-[no]cheat / -[no]c
Activates the cheat menu with autofire options and other tricks from the cheat database, if present. This also activates additional options on the slider menu for overclocking/underclocking.
Be advised that savestates created with cheats on may not work correctly with this turned off and vice-versa.
The default is OFF (-nocheat).
- Example:
-[no]skip_gameinfo
Forces MAME to skip displaying the system info screen.
The default is OFF (-noskip_gameinfo).
- Example:
-uifont <fontname>
Specifies the name of a font file to use for the UI font. If this font cannot be found or cannot be loaded, the system will fall back to its built-in UI font. On some platforms fontname can be a system font name instead of a BDF font file.
The default is
default(use the OSD-determined default font).
- Example:
-ui <type>
Specifies the type of UI to use, either
simpleorcabinet.The default is cabinet (-ui cabinet).
- Example:
-ramsize [n]
Allows you to change the default RAM size (if supported by driver).
- Example:
-[no]confirm_quit
Display a Confirm Quit dialog to screen on exit, requiring one extra step to exit MAME.
The default is OFF (-noconfirm_quit).
- Example:
-[no]ui_mouse
Displays a mouse cursor when using the built-in MAME user interface.
The default is ON (-ui_mouse).
- Example:
mame -ui_mouse
-language <language>
Specify a localization language found in the
languagepathtree.
- Example:
-[no]nvram_save
Save the NVRAM contents when exiting machine emulation. By turning this off, you can retain your previous NVRAM contents as any current changes made will not be saved. Turning this option off will also unconditionally suppress the saving of .nv files associated with some types of software cartridges.
The default is ON (-nvram_save).
- Example:
Scripting Options¶
-autoboot_command "<command>"
Command string to execute after machine boot (in quotes " "). To issue a quote to the emulation, use """ in the string. Using \n will create a new line, issuing what was typed prior as a command.
This works only with systems that support natural keyboard mode.
- Example:
-autoboot_delay [n]
Timer delay (in seconds) to trigger command execution on autoboot.
- Example:
-autoboot_script / -script [filename.lua]
File containing scripting to execute after machine boot.
- Example:
-[no]console
Enables emulator Lua Console window.
The default of OFF (-noconsole).
- Example:
-plugins
Enable the use of Lua Plugins.
The default is ON (-plugins).
- Example:
-plugin [plugin shortname]
A list of Lua Plugins to enable, comma separated.
- Example:
-noplugin [plugin shortname]
A list of Lua Plugins to disable, comma separated.
- Example:
HTTP Server Options¶
-[no]http
Enable HTTP server.
The default is OFF (-nohttp).
- Example:
mame -http
-http_port <port>
Choose HTTP server port.
The default is
8080.
- Example:
-http_root <rootfolder>
Choose HTTP server document root.
The default is
web.
- Example:
PortAudio Options¶
-pa_api API
Choose which API that PortAudio should use to talk to your sound hardware. You can use -verbose to see which APIs are available.
The default is
none.
- Example 1:
- Example 2:
-pa_device device
Choose which sound device to output through. This would typically be one of the outputs on your sound card or a USB headset.
The default is
none.
- Example:
-pa_latency latency
Choose the buffer size for PortAudio output; this is specified in seconds. Lower numbers have less latency but may increase stutter in the sound. Decimal places are supported. Try starting from 0.20 and decrease or increase until you find the best number your hardware and OS are capable of handling.
The default is
0.
- Example: