summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorGravatarGravatar andreasnaive <andreasnaive@gmail.com>2019-03-25 23:13:40 +0100
committerGravatarGravatar andreasnaive <andreasnaive@gmail.com>2019-03-25 23:13:40 +0100
commitb380514764cf857469bae61c11143a19f79a74c5 (patch) (github)
tree63c8012e262618f08a332da31dd714281aa2c5ed /docs
parentc24473ddff715ecec2e258a6eb38960cf8c8e98e (diff)
downloadmame-b380514764cf857469bae61c11143a19f79a74c5.tar.bz2
mame-b380514764cf857469bae61c11143a19f79a74c5.zip
Revert "conflict resolution (nw)"
Diffstat (limited to 'docs')
-rw-r--r--docs/source/advanced/multiconfig.rst127
-rw-r--r--docs/source/commandline/commandline-all.rst1778
-rw-r--r--docs/source/conf.py7
-rw-r--r--docs/source/images/MAMElogo.svg68
-rw-r--r--docs/source/index.rst10
-rw-r--r--docs/source/initialsetup/compilingmame.rst127
-rw-r--r--docs/source/license.rst2
-rw-r--r--docs/source/techspecs/device_memory_interface.rst2
-rw-r--r--docs/source/techspecs/layout_files.rst24
-rw-r--r--docs/source/techspecs/luaengine.rst4
-rw-r--r--docs/source/whatis.rst2
11 files changed, 490 insertions, 1661 deletions
diff --git a/docs/source/advanced/multiconfig.rst b/docs/source/advanced/multiconfig.rst
index abae10f5a78..48385781392 100644
--- a/docs/source/advanced/multiconfig.rst
+++ b/docs/source/advanced/multiconfig.rst
@@ -8,115 +8,44 @@ MAME has a very powerful configuration file system that can allow you to tweak s
Order of Config Loading
-----------------------
-1. The command line is parsed first, and any settings passed that way *will take
- precedence over anything in an INI file*.
-
-2. ``mame.ini`` (or other platform INI; e.g. ``mess.ini``) is parsed twice. The
- first pass may change various path settings, so the second pass is done to
- see if there is a valid configuration file at that new location (and if so,
- change settings using that file).
-
-3. ``debug.ini`` if the debugger is enabled. This is an advanced config file,
- most people won't need to use it or be concerned by it.
-
-4. Screen orientation INI file (either ``horizont.ini`` or ``vertical.ini``).
- For example Pac-Man has a vertical screen, so it loads ``vertical.ini``,
- while Street Fighter Alpha uses a horizontal screen, so it loads
- ``horizont.ini``.
-
- Systems with no monitors, multiple monitors with different orientations, or
- monitors connected to slot devices will usually load ``horizont.ini``.
-
-5. System type INI file (``arcade.ini``, ``console.ini``, ``computer.ini``, or
- ``othersys.ini``). Both Pac-Man and Street Fighter Alpha are arcade games,
- so ``arcade.ini`` will be loaded here, while Atari 2600 will load
- ``console.ini`` as it is a home game console.
-
-6. Monitor type INI file (``vector.ini`` for vector monitors, ``raster.ini`` for
- CRT raster monitors, or ``lcd.ini`` for LCD/EL/plasma matrix monitors).
- Pac-Man and Street Fighter Alpha use raster CRTs, so ``raster.ini`` is loaded
- here, while Tempest uses a vector monitor, so ``vector.ini`` is loaded here.
-
- For systems that have multiple monitor types, such as House Mannequin with
- its CRT raster monitor and dual LCD matrix monitors, the INI file relevant to
- the first monitor is used (``raster.ini`` in this case). Systems without
- monitors or with other kinds of monitors will not load an INI file for this
- step.
-
-7. Driver source file INI file. MAME will attempt to load
- ``source/``\ *<sourcefile>*\ ``.ini`` where *<sourcefile>* is the base name
- of the source code file where the system driver is defined. A system's
- source file can be found using **mame -listsource <pattern>** at the command
- line.
-
- For instance, Banpresto's Sailor Moon, Atlus's Dodonpachi, and Nihon System's
- Dangun Feveron all run on similar hardware and are defined in the
- ``cave.cpp`` source file, so they will all load ``source/cave.ini`` at this
- step.
-
-8. BIOS set INI file (if applicable). For example The Last Soldier uses the
- Neo-Geo MVS BIOS, so it will load ``neogeo.ini``. Systems that don't use a
- BIOS set won't load an INI file for this step.
-
-9. Parent system INI file. For example The Last Soldier is a clone of The Last
- Blade / Bakumatsu Roman - Gekka no Kenshi, so it will load ``lastblad.ini``.
- Parent systems will not load an INI file for this step.
-
-10. System INI file. Using the previous example, The Last Soldier will load
- ``lastsold.ini``.
+1. The command line is parsed first, and any settings passed that way *will take priority over anything in an INI file*.
+2. ``mame.ini`` (or other platform INI; e.g. ``mess.ini``) is parsed twice.
+ The first pass may change various path settings, so the second pass is done to see if there is a valid config file at that new location (and if so, change settings using that file)
+3. ``debug.ini`` if in debug mode.
+ This is an advanced config file, most people won't need to use it or be concerned by it.
+4. System-specific INI files where appropriate (e.g. ``neogeo_noslot.ini`` or ``cps2.ini``)
+ As an example, Street Fighter Alpha is a CPS2 game, and so ``cps2.ini`` would be loaded here.
+5. Monitor orientation INI file (either ``horizont.ini`` or ``vertical.ini``)
+ Pac-Man, for one example, is a vertical monitor setup, so it would load ``vertical.ini``. Street Fighter Alpha is a horizontal game, so it loads ``horizont.ini``.
+6. System-type INI files (``arcade.ini``, ``console.ini``, ``computer.ini``, or ``othersys.ini``)
+ Both Pac-Man and Street Fighter Alpha are arcade games, so ``arcade.ini`` would be loaded here. Atari 2600 would load ``console.ini``.
+7. Screen-type INI file (``vector.ini`` for vector games, ``raster.ini`` for raster games, ``lcd.ini`` for LCD games)
+ Pac-Man and Street Fighter Alpha are raster, so ``raster.ini`` gets loaded here. Tempest is a vector monitor game, and ``vector.ini`` would be loaded here.
+8. Source INI files.
+ This is an advanced config file, most people won't need to use it and it can be safely ignored.
+ MAME will attempt to load ``source/sourcefile.ini`` and ``sourcefile.ini``, where sourcefile is the actual filename of the source code file.
+ *mame -listsource <game>* will show the source file for a given game.
+
+ For instance, Banpresto's Sailor Moon, Atlus's Dodonpachi, and Nihon System's Dangun Feveron all share a large amount of hardware and are grouped into the ``cave.c`` file, meaning they all parse ``source/cave.ini``
+9. Parent INI file.
+ For example, if running Pac-Man, which is a clone of Puck-Man, it'd be ``puckman.ini``
+10. Driver INI file.
+ Using our previous example of Pac-Man, this would be ``pacman.ini``.
Examples of Config Loading Order
--------------------------------
-* Brix, which is a clone of Zzyzzyxx. (**mame brix**)
-
- 1. Command line
- 2. ``mame.ini`` (global)
- 3. (debugger not enabled, no extra INI file loaded)
- 4. ``vertical.ini`` (screen orientation)
- 5. ``arcade.ini`` (system type)
- 6. ``raster.ini`` (monitor type)
- 7. ``source/jack.ini`` (driver source file)
- 8. (no BIOS set)
- 9. ``zzyzzyxx.ini`` (parent system)
- 10. ``brix.ini`` (system)
-
-* Super Street Fighter 2 Turbo (**mame ssf2t**)
-
- 1. Command line
- 2. ``mame.ini`` (global)
- 3. (debugger not enabled, no extra INI file loaded)
- 4. ``horizont.ini`` (screen orientation)
- 5. ``arcade.ini`` (system type)
- 6. ``raster.ini`` (monitor type)
- 7. ``source/cps2.ini`` (driver source file)
- 8. (no BIOS set)
- 9. (no parent system)
- 10. ``ssf2t.ini`` (system)
-
-* Final Arch (**mame finlarch**)
-
- 1. Command line
- 2. ``mame.ini`` (global)
- 3. (debugger not enabled, no extra INI file loaded)
- 4. ``horizont.ini`` (screen orientation)
- 5. ``arcade.ini`` (system type)
- 6. ``raster.ini`` (monitor type)
- 7. ``source/stv.ini`` (driver source file)
- 8. ``stvbios.ini`` (BIOS set)
- 9. ``smleague.ini`` (parent system)
- 10. ``finlarch.ini`` (system)
+1. Alcon, which is the US clone of Slap Fight. (**mame alcon**)
+ Command line, mame.ini, vertical.ini, arcade.ini, raster.ini, slapfght.ini, and lastly alcon.ini (*remember command line parameters take precedence over all else!*)
-*Remember command line parameters take precedence over all else!*
+2. Super Street Fighter 2 Turbo (**mame ssf2t**)
+ Command line, mame.ini, horizont.ini, arcade.ini, raster.ini, cps2.ini, and lastly ssf2t.ini (*remember command line parameters take precedence over all else!*)
Tricks to Make Life Easier
--------------------------
-Some users may have a wall-mounted or otherwise rotatable monitor, and may wish
-to actually play vertical games with the rotated display. The easiest way to
-accomplish this is to put your rotation modifiers into ``vertical.ini``, where
-they will only affect vertical games.
+Some users may have a wall-mounted or otherwise rotatable monitor, and may wish to actually play vertical games with the rotated display. The easiest way to accomplish this is to put your rotation modifiers into ``vertical.ini``, where they will only affect vertical games.
[todo: more practical examples]
diff --git a/docs/source/commandline/commandline-all.rst b/docs/source/commandline/commandline-all.rst
index acbd9b50099..ef7fb663a33 100644
--- a/docs/source/commandline/commandline-all.rst
+++ b/docs/source/commandline/commandline-all.rst
@@ -3,79 +3,26 @@
Universal Commandline Options
=============================
-This section contains configuration options that are applicable to *all* MAME
-sub-builds (both SDL and Windows native).
+
+This section contains configuration options that are applicable to *all* MAME sub-builds (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**.
+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)
-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\*"**).
+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\*"**)
-.. _mame-commandline-paths:
-
-File Names and Directory Paths
-------------------------------
-
-A number of options for specifying directories support multiple paths (for
-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 recognised 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 ./mame64
-
-You should be able to use any text editor. If you have a choice of file format
-or line ending style, chose UNIX. I've assumed you're using a 64-bit release
-build of MAME, but if you aren't you just need to change ``mame64`` to the name
-of your MAME executable. Once you've created the file, you need to mark is 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
@@ -85,20 +32,18 @@ Core Verbs
**-help** / **-h** / **-?**
- Displays current MAME version and copyright notice.
+ Displays current MAME version and copyright notice.
.. _mame-commandline-validate:
**-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.
+ 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.
+ If a pattern is specified, it will validate systems matching
+ the pattern, otherwise it will validate all systems and devices.
@@ -109,153 +54,112 @@ Configuration Verbs
**-createconfig** / **-cc**
- Creates the default ``mame.ini`` file. All the configuration options (not
- verbs) described below can be permanently changed by editing this
- configuration file.
+ Creates the default ``mame.ini`` file. All the configuration options
+ (not verbs) described below can be permanently changed by editing
+ this configuration file.
.. _mame-commandline-showconfig:
**-showconfig** / **-sc**
- Displays the current configuration settings. If you route this to a file,
- you can use it as an INI file. For example, the command:
+ Displays the current configuration settings. If you route this to a
+ file, you can use it as an INI file. For example, the command:
- **mame -showconfig > mame.ini**
+ **mame -showconfig >mame.ini**
- is equivalent to **-createconfig**.
+ is equivalent to **-createconfig**.
.. _mame-commandline-showusage:
**-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.
+ 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 sufficient.
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:
+Note: By default, all the '**-list**' verbs below write info to the screen. If you wish to write the info to a textfile instead, add this to the end of your command:
- **>** *filename*
+ **> 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.
+...where 'filename' is the textfile's path and name (e.g., list.txt).
Example:
| **mame -listcrc puckman > list.txt**
|
-
- This creates (or overwrites the existing file if already there) ``list.txt``
- and 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.
-
+| This creates (or overwrites if it's already there) ``list.txt`` and 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.
+|
.. _mame-commandline-listxml:
-**-listxml** / **-lx** [*<pattern>*...]
+**-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.
+ List comprehensive details for all of the supported systems and drivers. The output is quite long, so it is usually better to redirect this into a file. The output is in XML format. By default all systems are listed; however, you can limit this list by specifying a *pattern* after the -listxml command.
.. _mame-commandline-listfull:
-**-listfull** / **-ll** [*<pattern>*...]
+**-listfull** / **-ll** [*<pattern>*]
- 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.
+ 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 a *pattern* after the **-listfull** command.
.. _mame-commandline-listsource:
-**-listsource** / **-ls** [*<pattern>*...]
+**-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.
+ Displays a list of drivers and the names of the source files their system drivers are defined in. Useful for finding which driver a system runs on in order to fix bugs. By default all systems are listed; however, you can limit this list by specifying a *pattern* after the **-listsource** command.
.. _mame-commandline-listclones:
-**-listclones** / **-lc** [*<pattern>*]
+**-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.
+ Displays a list of clones. By default all clones are listed; however, you can limit this list by specifying a driver name or wildcard after the **-listsource** command.
.. _mame-commandline-listbrothers:
-**-listbrothers** / **-lb** [*<pattern>*]
+**-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*.
+ Displays a list of '*brothers*', or rather, other sets which are located in the same sourcefile as the system name searched for.
.. _mame-commandline-listcrc:
-**-listcrc** [*<pattern>*...]
+**-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.
+ Displays a full list of CRCs of all ROM images referenced by the specified pattern of system or device names. If no pattern is specified, the results will be *all* systems and devices.
.. _mame-commandline-listroms:
-**-listroms** / **-lr** [*<pattern>*...]
+**-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.
+ Displays a list of ROM images referenced by the specified pattern of system or device names. If no pattern is specified, the results will be *all* systems and devices.
.. _mame-commandline-listsamples:
**-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.
+ 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.
.. _mame-commandline-verifyroms:
**-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.
+ 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.
.. _mame-commandline-verifysamples:
**-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.
+ 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.
.. _mame-commandline-romident:
**-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:
+ 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
@@ -266,70 +170,47 @@ 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.
+ 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.
.. _mame-commandline-listslots:
**-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.
+ 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.
+ 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)
+ The slot name (e.g. **ctrl1**) can be used from the command line (**-ctrl1** in this case)
.. _mame-commandline-listmedia:
**-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.
+ 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.
.. _mame-commandline-listsoftware:
**-listsoftware** / **-lsoft** [<*pattern*>]
- Posts to screen all software lists which can be used by the entered
- *pattern* or system. Note that this is simply a copy/paste of the .XML file
- which reside in the HASH folder which are allowed to be used.
+ Posts to screen all software lists which can be used by the entered *pattern* or system. Note that this is simply a copy/paste of the .XML file which reside in the HASH folder which are allowed to be used.
.. _mame-commandline-verifysoftware:
**-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.
+ 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.
.. _mame-commandline-getsoftlist:
**-getsoftlist** / **-glist** [<*pattern*>]
- Posts to screen a specific software list which matches with the system name
- provided.
+ Posts to screen a specific software list which matches with the system name provided.
.. _mame-commandline-verifysoftlist:
**-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.
+ 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.
.. _osd-commandline-options:
@@ -341,86 +222,66 @@ OSD-related Options
**-uimodekey** [*keystring*]
- Key used to enable/disable MAME keyboard controls when the emulated system
- has keyboard inputs. The default setting is **Forward Delete** on macOS or
- **SCRLOCK** on other operating systems (including Windows and Linux). Use
- **FN-Delete** on Macintosh computers with notebook/compact keyboards.
+ Key used to toggle emulated keyboard on and off. Default setting is **SCRLOCK** on Windows, **Forward Delete** on Mac (use **FN-Delete** on laptop/compact keyboards).
.. _mame-commandline-uifontprovider:
-**-uifontprovider**
+**\-uifontprovider**
- Chooses provider for UI font rendering.
+ Chooses provider for UI font.
-| On Windows, you can choose from: ``win``, ``dwrite``, ``none`` or ``auto``.
-| On macOS, you can choose from: ``osx``, ``none`` or ``auto``.
-| On other platforms, you can choose from: ``sdl``, ``none`` or ``auto``.
-|
-| Default setting is ``auto``.
-|
+ On Windows, you can choose from: ``win``, ``dwrite``, ``none`` or ``auto``.
+ On Mac, you can choose from: ``osx`` or ``auto``.
+ On other platforms, you can choose from: ``sdl`` or ``auto``.
+
+ Default setting is *auto*.
.. _mame-commandline-keyboardprovider:
-**-keyboardprovider**
+**\-keyboardprovider**
- Chooses how MAME will get keyboard input.
+ Chooses how MAME will get keyboard input.
-| On Windows, you can choose from: ``auto``, ``rawinput``, ``dinput``, ``win32``, or ``none``
-| On SDL, you can choose from: ``auto``, ``sdl``, ``none``
-|
-| The default is ``auto``.
-|
-| On Windows, ``auto`` will try ``rawinput`` with fallback to ``dinput``.
-| On SDL, ``auto`` will default to ``sdl``.
-|
+ On Windows, you can choose from: ``auto``, ``rawinput``, ``dinput``, ``win32``, or ``none``
+ On SDL, you can choose from: ``auto``, ``sdl``, ``none``
+
+ The default is *auto*. On Windows, auto will try rawinput with fallback to dinput. On SDL, auto will default to sdl.
.. _mame-commandline-mouseprovider:
**\-mouseprovider**
- Chooses how MAME will get mouse input.
+ Chooses how MAME will get mouse input.
-| On Windows, you can choose from: ``auto``, ``rawinput``, ``dinput``, ``win32``, or ``none``
-| On SDL, you can choose from: ``auto``, ``sdl``, ``none``
-|
-| The default is ``auto``.
-|
-| On Windows, ``auto`` will try ``rawinput`` with fallback to ``dinput``.
-| On SDL, ``auto`` will default to ``sdl``.
-|
+ On Windows, you can choose from: ``auto``, ``rawinput``, ``dinput``, ``win32``, or ``none``
+ On SDL, you can choose from: ``auto``, ``sdl``, ``none``
+
+ The default is *auto*. On Windows, auto will try rawinput with fallback to dinput. On SDL, auto will default to sdl.
.. _mame-commandline-lightgunprovider:
**\-lightgunprovider**
- Chooses how MAME will get light gun input.
+ Chooses how MAME will get light gun input.
-| On Windows, you can choose from: ``auto``, ``rawinput``, ``win32``, or ``none``
-| On SDL, you can choose from: ``auto``, ``x11`` or ``none``
-|
-| The default is ``auto``.
-|
-| On Windows, auto will try ``rawinput`` with fallback to ``win32``, or ``none`` if it doesn't find any.
-| On SDL/Linux, ``auto`` will default to ``x11``, or ``none`` if it doesn't find any.
-| On other SDL, ``auto`` will default to ``none``.
-|
+ On Windows, you can choose from: ``auto``, ``rawinput``, ``win32``, or ``none``
+ On SDL, you can choose from: ``auto``, ``x11`` or ``none``
+
+ The default is *auto*. On Windows, auto will try rawinput with fallback to win32, or none if it doesn't find any. On SDL/Linux, auto will default to x11, or none if it doesn't find any. On other SDL, auto will default to none.
.. _mame-commandline-joystickprovider:
**\-joystickprovider**
- Chooses how MAME will get joystick input.
+ Chooses how MAME will get joystick input.
+
+ On Windows, you can choose from: ``auto, ``winhybrid``, ``dinput``, ``xinput``, or ``none``
+ On SDL, you can choose from: ``auto``, ``sdl``, ``none``
+
+ The default is *auto*. On Windows, auto will default to dinput.
+
+ Note that Microsoft XBox 360 and XBox One controllers will be happiest with ``winhybrid`` or ``xinput``. The ``winhybrid`` option supports a mix of DirectInput and XInput controllers at the same time. On SDL, auto will default to sdl.
-| On Windows, you can choose from: ``auto, ``winhybrid``, ``dinput``, ``xinput``, or ``none``
-| On SDL, you can choose from: ``auto``, ``sdl``, ``none``
-|
-| The default is ``auto``.
-|
-| On Windows, auto will default to ``dinput``.
-|
-| Note that Microsoft XBox 360 and XBox One controllers connected to Windows will work best with ``winhybrid`` or ``xinput``. The ``winhybrid`` option supports a mix of DirectInput and XInput controllers at the same time.
-| On SDL, auto will default to ``sdl``.
-|
OSD CLI Options
@@ -436,7 +297,7 @@ OSD CLI Options
**\-listnetwork**
- Create a list of available Network Adapters for use with emulation.
+ Create a list of available Network Adapters for use with emulation.
@@ -447,11 +308,11 @@ OSD Output Options
**\-output**
- Chooses how MAME will handle processing of output notifiers.
+ Chooses how MAME will handle processing of output notifiers.
- You can choose from: ``auto``, ``none``, ``console`` or ``network``
+ you can choose from: ``auto``, ``none``, ``console`` or ``network``
- Note that network port is fixed at 8000.
+ Note that network port is fixed at 8000.
@@ -462,30 +323,25 @@ 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 with ``GAME()`` macro)
- - ``console.ini`` (for systems in source added with ``CONS()`` macro)
- - ``computer.ini`` (for systems in source added with ``COMP()`` macro)
- - ``othersys.ini`` (for systems in source added with ``SYST()`` macro)
- - ``vector.ini`` (for vector systems only)
- - *<parent>*\ ``.ini`` (for clones only, may be called recursively)
- - *<systemname>*\ ``.ini``
+ Enables or disables the reading of the config files. When enabled (which is the default), MAME reads the following config files in order:
- (See :ref:`advanced-multi-CFG` for further details)
+ - mame.ini
+ - debug.ini (if the debugger is enabled)
+ - <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 with GAME() macro)
+ - console.ini (for systems in source added with CONS() macro)
+ - computer.ini (for systems in source added with COMP() macro)
+ - othersys.ini (for systems in source added with SYST() macro)
+ - vector.ini (for vector systems only)
+ - <parent>.ini (for clones only, may be called recursively)
+ - <systemname>.ini
- 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.ini`` with line ``effect none`` in it, and it will
- override whatever ``effect`` value you have in your ``mame.ini``.
+ (See :ref:`advanced-multi-CFG` for further details)
- The default is ON (**-readconfig**).
+ 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.ini`` with the "effect none" line in it, and it will override whatever effect value you have in your ``mame.ini``. The default is ON (**-readconfig**).
@@ -496,141 +352,79 @@ 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).
+ Specifies a path where the base 'plugins' folder is to be found. The default is '.' (that is, in the current working directory).
.. _mame-commandline-rompath:
-**-rompath** / **-rp** / **-biospath** / **-bp** *<path>*
-
- Specifies one or more paths within which to find ROM or disk images.
- Multiple paths can be specified by separating them with semicolons.
+**-rompath** / **-rp** *<path>*
- The default is ``roms`` (that is, a directory ``roms`` in the current
- working directory).
+ Specifies a list of paths within which to find ROM or hard disk images. Multiple paths can be specified by separating them with semicolons. The default is ``roms`` (that is, a directory "roms" in the same directory as the MAME executable).
.. _mame-commandline-hashpath:
-**-hashpath** / **-hash_directory** / **-hash** *<path>*
+**-hashpath** *<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 directory ``hash`` in the current
- working directory).
+ Specifies a list of paths within which to find Software List HASH files. Multiple paths can be specified by separating them with semicolons. The default is ``hash`` (that is, a directory "roms" in the same directory as the MAME executable).
.. _mame-commandline-samplepath:
**-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 directory ``samples`` in the current
- working directory).
+ Specifies a list of paths within which to find sample files. Multiple paths can be specified by separating them with semicolons. The default is ``samples`` (that is, a directory "samples" in the same directory as the MAME executable).
.. _mame-commandline-artpath:
-**-artpath** *<path>* *<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.
+**-artpath** *<path>* / **-artwork_directory** *<path>*
- The default is ``artwork`` (that is, a directory ``artwork`` in the current
- working directory).
+ Specifies a list of paths within which to find artwork files. Multiple paths can be specified by separating them with semicolons. The default is ``artwork`` (that is, a directory "artwork" in the same directory as the MAME executable).
.. _mame-commandline-ctrlrpath:
-**-ctrlrpath** *<path>*
+**-ctrlrpath** / **-ctrlr_directory** *<path>*
- Specifies one or more paths within which to find default input configuration
- files. Multiple paths can be specified by separating them with semicolons.
-
- The default is ``ctrlr`` (that is, a directory ``ctrlr`` in the current
- working directory).
+ Specifies a list of paths within which to find controller-specific configuration files. Multiple paths can be specified by separating them with semicolons. The default is ``ctrlr`` (that is, a directory "ctrlr" in the same directory as the MAME executable).
.. _mame-commandline-inipath:
**-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 directory ``ini`` in the current
- working directory, and finally the directory ``presets`` inside that
- directory).
-
- On macOS, the default is
- ``$HOME/Library/Application Support/mame;$HOME/.mame;.;ini`` (that is,
- search the ``mame`` folder inside the current user's Application Support
- folder, followed by the ``.mame`` folder in the current user's home
- directory, then the current working directory, and finally the directory
- ``ini`` in the current working directory).
-
- On other platforms (including Linux), the default is ``$HOME/.mame;.;ini``
- (that is search the ``.mame`` directory in the current user's home
- directory, followed by the current working directory, and finally the
- directory ``ini`` in the current working directory).
+ Specifies a list of paths within which to find .INI files. Multiple paths can be specified by separating them with semicolons. The default is ``.;ini`` (that is, search in the current directory first, and then in the directory "ini" in the same directory as the MAME executable).
.. _mame-commandline-fontpath:
**-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).
+ Specifies a list of paths within which to find .BDF font files. Multiple paths can be specified by separating them with semicolons. The default is ``.`` (that is, search in the current working directory).
.. _mame-commandline-cheatpath:
**-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 called ``cheat`` located in the
- current working directory).
+ Specifies a list of 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 called 'cheat' located in the same directory as the as the MAME executable).
.. _mame-commandline-crosshairpath:
**-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 directory ``crsshair`` in the
- current working directory).
+ Specifies a list of paths within which to find crosshair files. Multiple paths can be specified by separating them with semicolons. The default is ``crsshair`` (that is, a directory "crsshair" in the same directory as the MAME executable). If the crosshair is set to default in the menu, MAME will look for ``systemname\\cross#.png`` and then cross#.png in the specified crsshairpath, where # is the player number. Failing that, MAME will use built-in default crosshairs.
.. _mame-commandline-pluginspath:
**-pluginspath** *<path>*
- Specifies one or more paths within which to find Lua plugins for MAME.
-
- The default is ``plugins`` (that is, a directory ``plugins`` in the current
- working directory).
+ Specifies a list of paths within which to find Lua plugins for MAME.
.. _mame-commandline-languagepath:
**-languagepath** *<path>*
- Specifies one or more paths within which to find language files for
- localized UI text.
-
- The default is ``language`` (that is, a directory ``language`` in the
- current working directory).
+ Specifies a list of paths within which to find language files for localized UI text.
.. _mame-commandline-swpath:
**-swpath** *<path>*
- Specifies the default path from which to load loose software image files.
-
- The default is ``sofware`` (that is, a directory ``software`` in the current
- working directory).
+ Specifies a path within which to find loose software to be used by emulation.
Core Output Directory Options
@@ -640,89 +434,43 @@ 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 directory ``cfg`` in the current working
- directory). If this directory does not exist, it will be created
- automatically.
+ Specifies a single directory where configuration files are stored. Configuration files store user configurable settings that are read at startup and written when MAME exits. The default is ``cfg`` (that is, a directory "cfg" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
.. _mame-commandline-nvramdirectory:
**-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 directory ``nvram`` in the current
- working directory)). If this directory does not exist, it will be created
- automatically.
+ Specifies a single directory where NVRAM files are stored. NVRAM files store the contents of EEPROM and non-volatile RAM (NVRAM) for systems which used this type of hardware. This data is read at startup and written when MAME exits. The default is ``nvram`` (that is, a directory "nvram" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
.. _mame-commandline-inputdirectory:
**-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 directory ``inp`` in the current working
- directory). If this directory does not exist, it will be created
- automatically.
+ Specifies a single directory where input recording files are stored. Input recordings are created via the -record option and played back via the -playback option. The default is ``inp`` (that is, a directory "inp" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
.. _mame-commandline-statedirectory:
**-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 directory ``sta`` in the current working
- directory). If this directory does not exist, it will be created
- automatically.
+ Specifies a single 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 directory "sta" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
.. _mame-commandline-snapshotdirectory:
**-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 directory ``snap`` in the current
- working directory). If this directory does not exist, it will be created
- automatically.
+ Specifies a single directory where screen snapshots are stored, when requested by the user. The default is ``snap`` (that is, a directory "snap" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
.. _mame-commandline-diffdirectory:
**-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 directory ``diff`` in the current
- working directory). If this directory does not exist, it will be created
- automatically.
+ Specifies a single directory where hard drive differencing files are stored. Hard drive differencing files store any data that is written back to a hard disk image, in order to preserve the original image. The differencing files are created at startup with a system with a hard disk image. The default is ``diff`` (that is, a directory "diff" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
.. _mame-commandline-commentdirectory:
**-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 directory ``comments`` in the
- current working directory). If this directory does not exist, it will be
- created automatically.
+ Specifies a single 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 directory "comments" in the same directory as the MAME executable). If this directory does not exist, it will be automatically created.
@@ -733,248 +481,125 @@ 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**).
+ 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.
+ 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.
.. _mame-commandline-rewindcapacity:
**-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.
+ 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.
.. _mame-commandline-state:
**-state** *<slot>*
- Immediately after starting the specified system, will cause the save state
- in the specified <slot> to be loaded.
+ Immediately after starting the specified system, will cause the save state in the specified <slot> to be loaded.
.. _mame-commandline-noautosave:
**-[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**).
+ 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**).
.. _mame-commandline-playback:
**-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. In order to make
- things consistent, you should only record and playback with all
- configuration (.cfg), NVRAM (.nv), and memory card files deleted.
-
- The default is ``NULL`` (no playback).
+ 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. In order to make things consistent, you should only record and playback with all configuration (.cfg), NVRAM (.nv), and memory card files deleted. The default is ``NULL`` (no playback).
.. _mame-commandline-exitafterplayback:
-**-[no]exit_after_playback**
+**-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**).
+ Tells MAME to exit after finishing playback of the input file.
.. _mame-commandline-record:
**-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 watch a previously recorded session from
- start to finish. In order to make things consistent, you should only record
- and playback with all configuration (.cfg), NVRAM (.nv), and memory card
- files deleted.
-
- The default is ``NULL`` (no recording).
+ 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 watch a previously recorded session from start to finish. In order to make things consistent, you should only record and playback with all configuration (.cfg), NVRAM (.nv), and memory card files deleted. The default is ``NULL`` (no recording).
.. _mame-commandline-recordtimecode:
**-record_timecode**
- Tells MAME to create a timecode file. It contains a line with elapsed times
- on each press of timecode shortcut key (default is **F12**). This option
- works only when recording mode is enabled (**-record** option). The
- timecode file is saved in the ``inp`` folder.
-
- By default, no timecode file is saved.
+ Tells MAME to create a timecode file. It contains a line with elapsed times on each press of timecode shortcut key (default is **F12**). This option works only when recording mode is enabled (**-record** option). The file is saved in the ``inp`` folder. By default, no timecode file is saved.
.. _mame-commandline-mngwrite:
**-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).
+ 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. Use -wavwrite for that, and reassemble the audio/video using offline tools. The default is ``NULL`` (no recording).
.. _mame-commandline-aviwrite:
**-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).
+ Stream video and sound data to the given <filename> in AVI format, producing an animation of the session complete with sound. The default is ``NULL`` (no recording).
.. _mame-commandline-wavwrite:
**-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).
+ 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).
.. _mame-commandline-snapname:
**-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 ``%g``
- represents the driver name of the current system; and the string ``%i``
- represents an incrementing index. If ``%i`` is omitted, then each snapshot
- taken will overwrite the previous one; otherwise, MAME will find the next
- empty value for ``%i`` and 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.
+ Describes how MAME should name files for snapshots. <name> is a string that provides a template that is used to generate a filename.
- A few examples:
+ Three simple substitutions are provided: the / character represents the path separator on any target platform (even Windows); the string ``%g`` represents the driver name of the current system; and the string ``%i`` represents an incrementing index. If ``%i`` is omitted, then each snapshot taken will overwrite the previous one; otherwise, MAME will find the next empty value for ``%i`` and use that for a filename.
- If you use **mame robby -snapname foo/%g%i** snapshots will be saved as
- ``snaps\\foo\\robby0000.png`` , ``snaps\\foo\\robby0001.png`` and so on.
+ 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.
- If you use **mame nes -cart robby -snapname %g/%d_cart** snapshots will be
- saved as ``snaps\\nes\\robby.png``.
+ 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.
- If you use **mame c64 -flop1 robby -snapname %g/%d_flop1/%i** snapshots will
- be saved as ``snaps\\c64\\robby\\0000.png``.
+ A few examples: if you use ``mame robby -snapname foo/%g%i`` snapshots will be saved as ``snaps\\foo\\robby0000.png`` , ``snaps\\foo\\robby0001.png`` and so on; if you use **mame nes -cart robby -snapname %g/%d_cart** snapshots will be saved as ``snaps\\nes\\robby.png``; if you use **mame c64 -flop1 robby -snapname %g/%d_flop1/%i** snapshots will be saved as ``snaps\\c64\\robby\\0000.png``.
.. _mame-commandline-snapsize:
**-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. Note that this
- size does not automatically rotate if the system is vertically oriented.
-
- The default is ``auto``.
+ 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. Note that this size does not automatically rotate if the system is vertically oriented. The default is ``auto``.
.. _mame-commandline-snapview:
**-snapview** *<viewname>*
- Specifies the view to use when rendering snapshots and movies.
-
- By default, both use a special 'internal' view, which renders a separate
- snapshot per screen or renders movies only of the first screen. By
- specifying this option, you can override this default behavior and select a
- single view that will apply to all snapshots and movies. Note that
- <viewname> does not need to be a perfect match; rather, it will select the
- first view whose name matches all the characters specified by <viewname>.
+ Specifies the view to use when rendering snapshots and movies. By default, both use a special 'internal' view, which renders a separate snapshot per screen or renders movies only of the first screen. By specifying this option, you can override this default behavior and select a single view that will apply to all snapshots and movies. Note that <viewname> does not need to be a perfect match; rather, it will select the first view whose name matches all the characters specified by <viewname>.
- For example, **-snapview native** will match the "Native (15:14)" view even
- though it is not a perfect match. <viewname> can also be 'auto', which
- selects the first view with all screens present.
-
- The default value is ``internal``.
+ For example, **-snapview native** will match the "Native (15:14)" view even though it is not a perfect match. <viewname> can also be 'auto', which selects the first view with all screens present. The default value is ``internal``.
.. _mame-commandline-nosnapbilinear:
**-[no]snapbilinear**
- Specify if the snapshot or movie should have bilinear filtering applied.
- Shutting this off can improve performance while recording video to a file.
-
- The default is ON (**-snapbilinear**).
+ Specify if the snapshot or movie should have bilinear filtering applied. Shutting this off can make a difference in some performance while recording video to a file. The default is ON (**-snapbilinear**).
.. _mame-commandline-statename:
**-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.
+ 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 ``%g``
- represents the driver name of the current system.
+ Two simple substitutions are provided: the / character represents the path separator on any target platform (even Windows); the string ``%g`` represents the driver name of the current system.
- The default is ``%g``, which creates a separate folder for each 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.
+ 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.
- A few examples:
-
- If you use **mame robby -statename foo/%g** save states will be stored
- inside ``sta\\foo\\robby\\``.
-
- If you use **mame nes -cart robby -statename %g/%d_cart** save states will
- be stored inside ``sta\\nes\\robby\\``.
-
- If you use **mame c64 -flop1 robby -statename %g/%d_flop1** save states will
- be stored inside 'sta\\c64\\robby\\'.
+ A few examples: if you use **mame robby -statename foo/%g** save states will be stored inside ``sta\\foo\\robby\\``; if you use **mame nes -cart robby -statename %g/%d_cart** save states will be stored inside ``sta\\nes\\robby\\``; if you use **mame c64 -flop1 robby -statename %g/%d_flop1** save states will be stored inside 'sta\\c64\\robby\\'.
.. _mame-commandline-noburnin:
**-[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``.
+ 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 default is OFF (**-noburnin**).
+ 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**).
@@ -985,107 +610,57 @@ 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**).
+ Automatically determines the frameskip level while you're running the system, adjusting it constantly in a frantic attempt to keep the system running at full speed. Turning this on overrides the value you have set for -frameskip below. The default is OFF (**-noautoframeskip**).
.. _mame-commandline-frameskip:
**-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.
+ Specifies the frameskip value. This is the number of frames out of every 12 to drop when running. For example, if you say **-frameskip 2**, then MAME will display 10 out of every 12 frames. By skipping those frames, you may be able to get full speed in a system that requires more horsepower than your computer has. The default value is **-frameskip 0**, which skips no frames.
.. _mame-commandline-secondstorun:
**-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 called ``final.png`` to the system's
- snapshot directory.
+ This option can be used for benchmarking and automated testing. It tells MAME to stop execution after a fixed number of seconds. By combining this with a fixed set of other command line options, you can set up a consistent environment for benchmarking MAME performance. In addition, upon exit, the **-str** option will write a screenshot called ``final.png`` to the system's snapshot directory.
.. _mame-commandline-nothrottle:
**-[no]throttle**
- Enable or disable thottling 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**).
+ Configures the default thottling setting. When throttling is on, MAME attempts to keep the system running at the system's intended speed. When throttling is off, MAME runs the system as fast as it can. Note that the fastest speed is more often than not limited by your graphics card, especially for older systems. The default is ON (**-throttle**).
.. _mame-commandline-nosleep:
**-[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**).
+ Allows MAME to give time back to the system when running with **-throttle**. This allows other programs to have some CPU time, assuming that the system isn't taxing 100% of your CPU resources. This option can potentially cause hiccups in performance if other demanding programs are running. The default is ON (**-sleep**).
.. _mame-commandline-speed:
**-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.0`` means to
- run the system at its normal speed, a *<factor>* of ``0.5`` means 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>* of ``1.002`` is rounded to ``1.00``.
-
- The default is ``1.0`` (normal speed).
+ Changes the way MAME throttles the emulated system such that it runs at some multiplier of the original speed. A <factor> of 1.0 means to run the system at its normal speed. A <factor> of 0.5 means run at half speed, and a <factor> of 2.0 means run at 2x speed. Note that changing this value affects sound playback as well, which will scale in pitch accordingly. The internal resolution of the fraction is two decimal places, so a value of 1.002 is the same as 1.0. The default is ``1.0``.
.. _mame-commandline-norefreshspeed:
**-[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**).
+ Allows MAME to dynamically adjust the system's speed such that it 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 actually designed to run at 60.6Hz, MAME will dynamically change the speed down 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**).
.. _mame-commandline-numprocessors:
-**-numprocessors** / **-np** **auto**\ \|\ *<value>*
-
- Specify the number of threads to use for work queues. Specifying ``auto``
- will use the value reported by the system or environment variable
- ``OSDPROCESSORS``. This value is internally limited to four times the
- number of processors reported by the system.
+**-numprocessors** *<auto|value>* / **-np** *<auto|value>*
- The default is ``auto``.
+ Specify the number of processors to use for work queues. Specifying ``auto`` will use the value reported by the system or environment variable **OSDPROCESSORS**. To avoid abuse, this value is internally limited to 4 times the number of processors reported by the system. The default is ``auto``.
.. _mame-commandline-bench:
-**-bench** *<n>*
+**-bench** *[n]*
- Benchmark for *<n>* emulated seconds. This is equivalent to the following
- options:
+ Benchmark for *[n]* number of emulated seconds; implies the command string:
- **-str** *<n>* **-video none -sound none -nothrottle**
+ **-str [n] -video none -sound none -nothrottle**
@@ -1094,61 +669,49 @@ Core Rotation Options
.. _mame-commandline-norotate:
-**-[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**).
-
+| **-[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**).
+|
+|
.. _mame-commandline-noror:
-**-[no]ror**
-
.. _mame-commandline-norol:
-**-[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**).
-
+| **-[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**).
+|
+|
.. _mame-commandline-noautoror:
-**-[no]autoror**
-
.. _mame-commandline-noautorol:
-**-[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**.
+| **-[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**.
+|
+|
.. _mame-commandline-noflipx:
-**-[no]flipx**
-
.. _mame-commandline-noflipy:
-**-[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**).
+| **-[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**).
+|
+|
Core Video Options
@@ -1158,194 +721,95 @@ 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 ``bgfx`` specifies the new hardware accelerated renderer.
- |
- | Using ``opengl`` tells MAME to render video using OpenGL acceleration.
- |
- | Using ``none`` displays no windows and does no drawing. This is primarily present for doing CPU benchmarks without the overhead of the video system.
- |
-
- On Windows:
-
- | Using ``gdi`` tells MAME to render video using older standard Windows graphics drawing calls. This is the slowest but most compatible option on older versions of Windows.
- |
- | Using ``d3d`` tells MAME to use Direct3D for rendering. This produces the better quality output than ``gdi`` and enables additional rendering options. It is recommended if you have a semi-recent (2002+) video card or onboard Intel video of the HD3000 line or better.
- |
-
- On other platforms (including SDL on Windows):
-
- | Using ``accel`` tells MAME to render video using SDL's 2D acceleration if possible.
- |
- | Using ``soft`` uses software rendering for video output. This isn't as fast or as nice as OpenGL but will work on any platform.
- |
-
- Defaults:
-
- | The default on Windows is ``d3d``.
- |
- | The default for Mac OS X is ``opengl`` because OS X is guaranteed to have a compliant OpenGL stack.
- |
- | The default on all other systems is ``soft``.
- |
+|
+| 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 ``bgfx`` specifies the new hardware accelerated renderer.
+| Using ``opengl`` tells MAME to render video using OpenGL acceleration.
+| Using ``none`` displays no windows and does no drawing. This is primarily present for doing CPU benchmarks without the overhead of the video system.
+|
+| On Windows:
+|
+| Using ``gdi`` here, tells MAME to render video using older standard Windows graphics drawing calls. This is the slowest but most compatible option on older versions of Windows.
+| Using ``d3d`` tells MAME to use Direct3D for rendering. This produces the better quality output than ``gdi`` and enables additional rendering options. It is recommended if you have a semi-recent (2002+) video card or onboard Intel video of the HD3000 line or better.
+|
+| On other platforms (including SDL on Windows):
+|
+| Using ``accel`` tells MAME to render video using SDL's 2D acceleration if possible.
+| Using ``soft`` uses software rendering for video output. This isn't as fast or as nice as OpenGL but will work on any platform.
+|
+| Defaults:
+|
+| The default on Windows is ``d3d``.
+| The default for Mac OS X is ``opengl`` because OS X is guaranteed to have a compliant OpenGL stack.
+| The default on all other systems is ``soft``.
+|
.. _mame-commandline-numscreens:
**-numscreens** *<count>*
- Tells MAME how many output windows to create. For most systems, a single
- output window is all you need, but some systems originally used multipl
- screens (*e.g. Darius and PlayChoice-10 arcade machines*). 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``.
+ Tells MAME how many output windows 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*). 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``.
.. _mame-commandline-window:
**-[no]window** / **-[no]w**
- Run MAME in either a window or full screen.
-
- The default is OFF (**-nowindow**).
+ Run MAME in either a window or full screen. The default is OFF (**-nowindow**).
.. _mame-commandline-maximize:
**-[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**).
+ 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 smallest supported size. This option only has an effect when the -window option is used. The default is ON (**-maximize**).
.. _mame-commandline-keepaspect:
**-[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).
+ Enables aspect ratio enforcement. When this option is on, the system's proper aspect ratio (generally 4:3 or 3:4) is enforced, so you get the system looking like it should. When running in a window with this option on, you can only resize the window to the proper aspect ratio, unless you are holding down the CONTROL key. By turning the option off, the aspect ratio is allowed to float. In full screen mode, this means that all systems will stretch to the full screen size (even vertical systems). In window mode, it means that you can freely resize the window without any constraints. The default is ON (**-keepaspect**).
- 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.
+ The MAME team heavily suggests you leave this at default. Stretching systems beyond their original aspect ratio will mangle the appearance of the system in ways that no filtering or HLSL can repair.
.. _mame-commandline-waitvsync:
**-[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.
+ 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 at any old time, even 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. Tearing is not noticeable on all systems, and some people hate it more than others. However, if you turn this option on, you will waste more of your CPU cycles waiting for the proper time to draw, so you will see a performance hit. 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 this option does not work with **-video gdi** mode. The default is OFF (**-nowaitvsync**).
- 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**).
+ 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.
.. _mame-commandline-syncrefresh:
**-[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**).
+ 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**).
.. _mame-commandline-prescale:
**-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.
+ 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 by a factor of *<amount>* before being scaled. With **-video d3d**, this produces a less blurry image at the expense of some speed. The default is ``1``.
- The default is ``1``.
-
- This is supported with all video output types (``bgfx``, ``d3d``, etc) on
- Windows and is **ONLY** supported with OpenGL on other platforms.
+ This is supported with all video output types (``bgfx``, ``d3d``, etc) on Windows and is **ONLY** supported with OpenGL on other platforms.
.. _mame-commandline-filter:
**-[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**).
+ 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.
+ This is supported with OpenGL and D3D video on Windows and is **ONLY** supported with OpenGL on other platforms.
- Use ``bgfx_screen_chains`` in your INI file(s) to adjust filtering with the
- BGFX video system.
+ Use bgfx_screen_chains with BGFX to adjust filtering with that video system.
.. _mame-commandline-unevenstretch:
**-[no]unevenstretch**
- Allow non-integer scaling factors allowing for great window sizing
- flexability.
-
- The default is ON. (**-unevenstretch**)
+ Allow non-integer stretch factors allowing for great window sizing flexability. The default is ON. (**-unevenstretch**)
Core Full Screen Options
@@ -1355,17 +819,7 @@ 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 option is also useful
- 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**.
-
- The default is OFF (**-noswitchres**).
+ 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 option is also useful 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**. The default is OFF (**-noswitchres**).
Core Per-Window Options
@@ -1373,121 +827,65 @@ Core Per-Window Options
.. _mame-commandline-screen:
-NOTE: **Multiple Screens may fail to work correctly on some Mac machines as of
-right now.**
-
-**-screen** *<display>*
-
-**-screen0** *<display>*
-
-**-screen1** *<display>*
-
-**-screen2** *<display>*
-
-**-screen3** *<display>*
-
+NOTE: **Multiple Screens may fail to work correctly on some Mac machines as of right now.**
- 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.
+| **-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.
+|
+|
.. _mame-commandline-aspect:
-**-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.
+| **-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.
+|
+|
.. _mame-commandline-resolution:
-**-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 ``auto`` is also supported, and
- is equivalent to ``0x0@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.
+| **-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 ``auto`` is also supported, and is equivalent to ``0x0@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.
+|
+|
.. _mame-commandline-view:
-**-view** *<viewname>*
-
-**-view0** *<viewname>*
-
-**-view1** *<viewname>*
-
-**-view2** *<viewname>*
-
-**-view3** *<viewname>*
-
- Specifies the initial view setting for each window. The *<viewname>* does
- not need to be a perfect match; rather, it will select the first view whose
- name matches all the characters specified by *<viewname>*. For example,
- **-view native** will match the "*Native (15:14)*" view even though it is
- not a perfect match. The value ``auto`` is also supported, and requests
- that MAME perform a default selection.
-
- 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 window option.
+| **-view** *<viewname>*
+| **-view0** *<viewname>*
+| **-view1** *<viewname>*
+| **-view2** *<viewname>*
+| **-view3** *<viewname>*
+|
+| Specifies the initial view setting for each window. The *<viewname>* does not need to be a perfect match; rather, it will select the first view whose name matches all the characters specified by *<viewname>*. For example, **-view native** will match the "*Native (15:14)*" view even though it is not a perfect match. The value ``auto`` is also supported, and requests that MAME perform a default selection. 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 window option.
+|
+|
Core Artwork Options
@@ -1497,65 +895,49 @@ 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**.
+ Enable cropping of artwork to the system screen area only. This works best with **-video gdi** or **-video d3d**, and 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**.
.. _mame-commandline-nousebackdrops:
**-[no]use_backdrops** / **-[no]backdrop**
- Enables/disables the display of backdrops.
-
- The default is ON (**-use_backdrops**).
+ Enables/disables the display of backdrops. The default is ON (**-use_backdrops**).
.. _mame-commandline-nouseoverlays:
**-[no]use_overlays** / **-[no]overlay**
- Enables/disables the display of overlays.
-
- The default is ON (**-use_overlays**).
+ Enables/disables the display of overlays. The default is ON (**-use_overlays**).
.. _mame-commandline-nousebezels:
**-[no]use_bezels** / **-[no]bezels**
- Enables/disables the display of bezels.
-
- The default is ON (**-use_bezels**).
+ Enables/disables the display of bezels. The default is ON (**-use_bezels**).
.. _mame-commandline-nousecpanels:
**-[no]use_cpanels** / **-[no]cpanels**
- Enables/disables the display of control panels.
-
- The default is ON (**-use_cpanels**).
+ Enables/disables the display of control panels. The default is ON (**-use_cpanels**).
.. _mame-commandline-nousemarquees:
**-[no]use_marquees** / **-[no]marquees**
- Enables/disables the display of marquees.
-
- The default is ON (**-use_marquees**).
+ Enables/disables the display of marquees. The default is ON (**-use_marquees**).
.. _mame-commandline-fallbackartwork:
**-fallback_artwork**
- Specifies fallback artwork if no external artwork or internal driver layout
- is defined.
+ Specifies fallback artwork if no external artwork or internal driver layout is defined.
.. _mame-commandline-overrideartwork:
**-override_artwork**
- Specifies override artwork for external artwork and internal driver layout.
+ Specifies override artwork for external artwork and internal driver layout.
@@ -1566,70 +948,31 @@ 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 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.
-
- The default is ``1.0``.
+ 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 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. The default is ``1.0``.
.. _mame-commandline-contrast:
**-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 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.
-
- The default is ``1.0``.
+ 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 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. The default is ``1.0``.
.. _mame-commandline-gamma:
**-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 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``.
+ 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 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``.
.. _mame-commandline-pausebrightness:
**-pause_brightness** *<value>*
- This controls the brightness level when MAME is paused.
-
- The default value is ``0.65``.
+ This controls the brightness level when MAME is paused. The default value is ``0.65``.
.. _mame-commandline-effect:
**-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.
+ 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.
@@ -1640,62 +983,50 @@ Core Vector Options
**-beam_width_min** *<width>*
- Sets the vector beam minimum width.
+ Sets the vector beam minimum width.
.. _mame-commandline-beamwidthmax:
**-beam_width_max** *<width>*
- Sets the vector beam maximum width.
+ Sets the vector beam maximum width.
.. _mame-commandline-beamintensityweight:
**-beam_intensity_weight** *<weight>*
- Sets the vector beam intensity weight.
+ Sets the vector beam intensity weight.
.. _mame-commandline-flicker:
**-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).
+ 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``.
- The default is ``0``.
Core Video OpenGL Debugging 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 devs, but
-normally they should be left at their defaults which results in the best
-possible video performance.
+These options are for compatibility in **-video opengl**. If you report rendering artifacts you may be asked to try messing with them by the devs, but normally they should be left at their defaults which results in the best possible video performance.
.. _mame-commandline-glforcepow2texture:
**-[no]gl_forcepow2texture**
- Always use only power-of-2 sized textures.
-
- The default is OFF. (**-nogl_forcepow2texture**)
+ Always use only power-of-2 sized textures (default ``off``)
.. _mame-commandline-glnotexturerect:
**-[no]gl_notexturerect**
- Don't use OpenGL GL_ARB_texture_rectangle.
-
- The default is ON. (**-gl_notexturerect**)
+ Don't use OpenGL GL_ARB_texture_rectangle (default ``on``)
.. _mame-commandline-glvbo:
**-[no]gl_vbo**
- Enable OpenGL VBO (Vertex Buffer Objects), if available.
-
- The default is ON. (**-gl_vbo**)
+ Enable OpenGL VBO (Vertex Buffer Objects), if available (default ``on``)
.. _mame-commandline-glpbo:
@@ -1703,76 +1034,57 @@ possible video performance.
Enable OpenGL PBO (Pixel Buffer Objects), if available (default ``on``)
- The default is ON. (**-gl_pbo**)
-
Core Video OpenGL GLSL Options
------------------------------
+
.. _mame-commandline-glglsl:
**-gl_glsl**
- Enable OpenGL GLSL, if available.
-
- The default is OFF.
+ Enable OpenGL GLSL, if available (default ``off``)
.. _mame-commandline-glglslfilter:
**-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**)
+ Enable OpenGL GLSL filtering instead of FF filtering -- *0-plain, 1-bilinear, 2-bicubic* (default is ``1``)
.. _mame-commandline-glslshadermame:
-**-glsl_shader_mame0**
-
-**-glsl_shader_mame1**
-
-...
-
-**-glsl_shader_mame9**
-
+|
+| **-glsl_shader_mame0**
+| **-glsl_shader_mame1**
+| ...
+| **-glsl_shader_mame9**
+|
- Custom OpenGL GLSL shader set MAME bitmap in the provided slot (0-9); one
- can be applied to each slot.
+ Custom OpenGL GLSL shader set MAME bitmap in the provided slot (0-9); one can be applied to each slot.
- [todo: better details on usage at some point.
- See http://forums.bannister.org/ubbthreads.php?ubb=showflat&Number=100988#Post100988 ]
+ [todo: better details on usage at some point. See http://forums.bannister.org/ubbthreads.php?ubb=showflat&Number=100988#Post100988 ]
.. _mame-commandline-glslshaderscreen:
+|
+| **-glsl_shader_screen0**
+| **-glsl_shader_screen1**
+| ...
+| **-glsl_shader_screen9**
+|
-**-glsl_shader_screen0**
-
-**-glsl_shader_screen1**
-
-...
-
-**-glsl_shader_screen9**
-
-
- Custom OpenGL GLSL shader screen bitmap in the provided slot (0-9).
+ Custom OpenGL GLSL shader screen bitmap in the provided slot (0-9).
- [todo: better details on usage at some point.
- See http://forums.bannister.org/ubbthreads.php?ubb=showflat&Number=100988#Post100988 ]
+ [todo: better details on usage at some point. See http://forums.bannister.org/ubbthreads.php?ubb=showflat&Number=100988#Post100988 ]
.. _mame-commandline-glglslvidattr:
**-gl_glsl_vid_attr**
- Enable OpenGL GLSL handling of brightness and contrast.
- Better RGB system performance.
-
- Default is ``on``.
+ Enable OpenGL GLSL handling of brightness and contrast. Better RGB system performance. Default is ``on``.
Core Sound Options
@@ -1782,62 +1094,39 @@ 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``.
+ 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``.
.. _mame-commandline-nosamples:
**-[no]samples**
- Use samples if available.
-
- The default is ON (**-samples**).
+ Use samples if available. The default is ON (**-samples**).
.. _mame-commandline-volume:
**-volume** / **-vol** *<value>*
- Sets the startup volume. It can later be changed with the user interface
- (see Keys section). The volume is an attenuation in dB: e.g.,
- "**-volume -12**" will start with -12dB attenuation.
-
- The default is ``0``.
+ Sets the startup volume. It can later be changed with the user interface (see Keys section). The volume is an attenuation in dB: e.g., "**-volume -12**" will start with -12dB attenuation. The default is ``0``.
.. _mame-commandline-sound:
**-sound** *<``dsound``|``coreaudio``|``sdl``|``xaudio2``|``portaudio``|``none``>*
- Specifies which sound subsystem to use. Selecting ``none`` disables sound
- output altogether (sound hardware is still emulated).
+ Specifies which sound subsystem to use. Selecting ``none`` disables sound output altogether (sound hardware is still emulated). On Windows, ``dsound``, ``xaudio2``, ``portaudio`` and ``none`` are available. On macOS, ``coreaudio``, ``sdl``, ``portaudio`` and ``none`` are available. On other operating systems, ``sdl``, ``portaudio`` and ``none`` are available. (Special build options allow ``sdl`` to be used on Windows, or ``portaudio`` to be disabled.)
-| On Windows, ``dsound``, ``xaudio2``, ``portaudio`` and ``none`` are available.
-| On macOS, ``coreaudio``, ``sdl``, ``portaudio`` and ``none`` are available.
-| On other operating systems, ``sdl``, ``portaudio`` and ``none`` are available. (Special build options allow ``sdl`` to be used on Windows, or ``portaudio`` to be disabled.)
-|
-| The default is ``dsound`` on Windows. On Mac, ``coreaudio`` is the default. On all other platforms, ``sdl`` is the default.
-|
+ The default is ``dsound`` on Windows. On Mac, ``coreaudio`` is the default. On all other platforms, ``sdl`` is the default.
- On Windows and Linux, *portaudio* is likely to give the lowest possible
- latency, while Mac users will find *coreaudio* provides the best results.
+ On Windows and Linux, *portaudio* is likely to give the lowest possible latency, where on Mac *coreaudio* provides the best results.
- When using the ``sdl`` sound 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 set
- ``SDL_AUDIODRIVER=directsound`` if no sound output is produced by default.
+ When using the ``sdl`` sound 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 set ``SDL_AUDIODRIVER=directsound`` if no sound output is produced by default.
.. _mame-commandline-audiolatency:
**-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 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``.
+
- The default is ``1``.
Core Input Options
@@ -1847,135 +1136,69 @@ 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**).
+ 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**).
.. _mame-commandline-ctrlr:
**-ctrlr** *<controller>*
- Enables support for special controllers. Configuration files are loaded from
- the ctrlrpath. They are in the same format as the .cfg files that are
- saved, but only control configuration data is read from the file.
-
- The default is ``NULL`` (no controller file).
+ Enables support for special controllers. Configuration files are loaded from the ctrlrpath. They are in the same format as the .cfg files that are saved, but only control configuration data is read from the file. The default is ``NULL`` (no controller file).
.. _mame-commandline-nomouse:
**-[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.
-
- The default is OFF (**-nomouse**).
+ 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. The default is OFF (**-nomouse**).
.. _mame-commandline-nojoystick:
**-[no]joystick** / **-[no]joy**
- Controls whether or not MAME makes use of joystick/gamepad controllers.
-
- When this is enabled, MAME will ask the system about which controllers are
- connected.
-
- The default is OFF (**-nojoystick**).
+ Controls whether or not MAME makes use of joystick/gamepad controllers. When this is enabled, MAME will ask DirectInput about which controllers are connected. The default is OFF (**-nojoystick**).
.. _mame-commandline-nolightgun:
**-[no]lightgun** / **-[no]gun**
- Controls whether or not MAME makes use of lightgun controllers. Note that
- most lightguns map to the mouse, so using **-lightgun** and **-mouse**
- together may produce strange results.
-
- The default is OFF (**-nolightgun**).
+ Controls whether or not MAME makes use of lightgun controllers. Note that most lightguns map to the mouse, so using -lightgun and -mouse together may produce strange results. The default is OFF (**-nolightgun**).
.. _mame-commandline-nomultikeyboard:
**-[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**).
+ 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**).
.. _mame-commandline-nomultimouse:
**-[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**).
+ 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**).
.. _mame-commandline-nosteadykey:
**-[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**)
+ 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**)
.. _mame-commandline-uiactive:
**-[no]ui_active**
- Enable user interface on top of emulated keyboard (if present).
-
- The default is OFF (**-noui_active**)
+ Enable user interface on top of emulated keyboard (if present). The default is OFF (**-noui_active**)
.. _mame-commandline-nooffscreenreload:
**-[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**).
+ 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**).
.. _mame-commandline-joystickmap:
**-joystick_map** *<map>* / **-joymap** *<map>*
- Controls how joystick values map to digital joystick controls. MAME accepts
- all joystick input from the system as analog data. For true analog
- joysticks, this needs to be mapped down to the usual 4-way or 8-way digital
- joystick values. To do this, MAME divides the analog range into a 9x9 grid.
- It 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.
+ Controls how joystick values map to digital joystick controls. MAME accepts all joystick input from the system as analog data. For true analog joysticks, this needs to be mapped down to the usual 4-way or 8-way digital joystick values. To do this, MAME divides the analog range into a 9x9 grid. It 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. 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.
- 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.
-
- 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:
+ 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:
+-------------+---------------------------------------------------------+
| | 777888999 | |
@@ -1989,109 +1212,64 @@ Core Input Options
| | 111222333 | |
+-------------+---------------------------------------------------------+
- 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:
+ 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** |
- +-------------------------------------------------------------------------------------------------------+
+ +-------------------------------------------------------------------------------------------+
+ | 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.
+ 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**)
+ By using these shorthands, the 81 character map can be simply specified by this 11 character string: 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.
+ 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 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.
+ 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.
.. _mame-commandline-joystickdeadzone:
**-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.3``.
+ 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.3``.
.. _mame-commandline-joysticksaturation:
**-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``.
+ 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``.
.. _mame-commandline-natural:
**\-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 compatability for non-"QWERTY" style keyboards.
-
- The default is OFF (**-nonatural**)
+ 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 compatability 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 "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 when you type into a text editor), and MAME attempts to translate
- these characters to emulated keystrokes.
+ In "natural keyboard" mode, MAME attempts to translate characters to keystrokes. The OS translates keystrokes to characters (similarly 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:**
+ **There are a number of unavoidable limitations in "natural keyboard" mode:**
- * The emulated system driver and/or keyboard device or has to support it.
- * The selected keyboard *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/Korean)
+ * The emulated system driver and/or keyboard device or has to support it.
+ * The selected keyboard *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/Korean)
.. _mame-commandline-joystickcontradictory:
**-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**)
+ 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**)
.. _mame-commandline-coinimpulse:
**-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``.
+ Set coin impulse time based on n (n<0 disable impulse, n==0 obey driver, 0<n set time n). Default is ``0``.
@@ -2100,45 +1278,38 @@ Core Input Automatic Enable Options
.. _mame-commandline-paddledevice:
-**-paddle_device** (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``)
+**\-paddle_device** enable (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``) if a paddle control is present
.. _mame-commandline-adstickdevice:
-**-adstick_device** (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``)
+**\-adstick_device** enable (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``) if an analog joystick control is present
.. _mame-commandline-pedaldevice:
-**-pedal_device** (``none``|``keyboard``|``mouse``|```lightgun``|``joystick``)
+**\-pedal_device** enable (``none``|``keyboard``|``mouse``|```lightgun``|``joystick``) if a pedal control is present
.. _mame-commandline-dialdevice:
-**-dial_device** (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``)
+**\-dial_device** enable (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``) if a dial control is present
.. _mame-commandline-trackballdevice:
-**-trackball_device** (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``)
+**\-trackball_device** enable (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``) if a trackball control is present
.. _mame-commandline-lightgundevice:
-**-lightgun_device** (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``)
+**\-lightgun_device** enable (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``) if a lightgun control is present
.. _mame-commandline-positionaldevice:
-**-positional_device** (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``)
+**\-positional_device** enable (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``) if a positional control is present
.. _mame-commandline-mousedevice:
-**-mouse_device** (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``)
+**\-mouse_device** enable (``none``|``keyboard``|``mouse``|``lightgun``|``joystick``) if a mouse control is present
- Each of these options controls autoenabling the mouse, joystick, or lightgun
- depending on the presence of a particular class of analog control for a
- particular system. For example, if you specify the option
- **-paddle mouse**, then any game that has a paddle control will
- automatically enable mouse controls just as if you had explicitly specified
- **-mouse**.
+ Each of these options controls autoenabling the mouse, joystick, or lightgun depending on the presence of a particular class of analog control for a particular system. For example, if you specify the option **-paddle mouse**, then any game that has a paddle control will automatically enable mouse controls just as if you had explicitly specified **-mouse**. Note that these controls override the values of **-[no]mouse**, **-[no]joystick**, etc.
- Note that these controls override the values of **-[no]mouse**,
- **-[no]joystick**, etc.
Debugging Options
@@ -2148,98 +1319,63 @@ Debugging Options
**-[no]verbose** / **-[no]v**
- Displays internal diagnostic information. This information is very useful
- for debugging problems with your configuration. IMPORTANT: when reporting
- bugs, please run with **mame -verbose** and include the resulting
- information.
-
- The default is OFF (**-noverbose**).
+ Displays internal diagnostic information. This information is very useful for debugging problems with your configuration. IMPORTANT: when reporting bugs, please run with **mame -verbose** and include the resulting information. The default is OFF (**-noverbose**).
.. _mame-commandline-oslog:
**-[no]oslog**
- Output ``error.log`` messages 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**).
+ Output error.log data to the system debugger. The default is OFF (**-nooslog**).
.. _mame-commandline-log:
**-[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 **-log** to output the log data to both targets as well.
-
- The default is OFF (**-nolog**).
+ 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 **-log** to output the log data to both targets as well. The default is OFF (**-nolog**).
.. _mame-commandline-debug:
**-[no]debug**
- Activates the integrated debugger. By default, the debugger is entered by
- pressing the tilde (**~**) key during emulation. It is also entered
- immediately at startup.
-
- The default is OFF (**-nodebug**).
+ Activates the integrated debugger. By default, the debugger is entered by pressing the tilde (**~**) key during emulation. It is also entered immediately at startup. The default is OFF (**-nodebug**).
.. _mame-commandline-debugscript:
**-debugscript** *<filename>*
- Specifies a file that contains a list of debugger commands to execute
- immediately upon startup.
-
- The default is ``NULL`` (*no commands*).
+ Specifies a file that contains a list of debugger commands to execute immediately upon startup. The default is ``NULL`` (*no commands*).
.. _mame-commandline-updateinpause:
**-[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**).
+ Enables updating of the main screen bitmap while the system is paused. This means that the VIDEO_UPDATE callback will be called repeatedly during pause, which can be useful for debugging. The default is OFF (**-noupdate_in_pause**).
.. _mame-commandline-watchdog:
**-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.
+ 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.
.. _mame-commandline-debuggerfont:
**-debugger_font** *<fontname>* / **-dfont** *<fontname>*
- Specifies the name of the font to use for debugger windows.
+ Specifies the name of the font to use for debugger windows.
- | The Windows default font is ``Lucida Console``.
- | The Mac (Cocoa) default font is system fixed-pitch font default (typically ``Monaco``).
- | The Qt default font is ``Courier New``.
+ The Windows default font is ``Lucida Console``.
+ The Mac (Cocoa) default font is system fixed-pitch font default (typically ``Monaco``).
+ The Qt default font is ``Courier New``.
.. _mame-commandline-debuggerfontsize:
**-debugger_font_size** *<points>* / **-dfontsize** *<points>*
- Specifies the size of the font to use for debugger windows, in points.
+ Specifies the size of the font to use for debugger windows, in points.
- | The Windows default size is ``9`` points.
- | The Qt default size is ``11`` points.
- | The Mac (Cocoa) default size is the system default size.
+ The Windows default size is ``9`` points.
+ The Qt default size is ``11`` points.
+ The Mac (Cocoa) default size is the system default size.
Core Communication Options
@@ -2249,47 +1385,32 @@ Core Communication Options
**-comm_localhost** *<string>*
- Local address to bind 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).
+ Local address to bind 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``"
.. _mame-commandline-commlocalport:
**-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``".
+ 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``".
.. _mame-commandline-commremotehost:
**-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).
+ 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``"
.. _mame-commandline-commremoteport:
**-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``".
+ 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``".
.. _mame-commandline-commframesync:
**-[no]comm_framesync**
- Synchronize frames between the communications network.
+ Synchronize frames between the communications network. The default is OFF (**-nocomm_framesync**).
- The default is OFF (**-nocomm_framesync**).
Core Misc Options
@@ -2298,124 +1419,85 @@ Core Misc Options
.. _mame-commandline-drc:
**-[no]drc**
-
- Enable DRC (dynamic recompiler) CPU core if available for maximum speed.
-
- The default is ON (**-drc**).
+ Enable DRC (dynamic recompiler) CPU core if available for maximum speed. The default is ON (**-drc**).
.. _mame-commandline-drcusec:
**\-drc_use_c**
- Force DRC to use the C code backend.
-
- The default is OFF (**-nodrc_use_c**).
+ Force DRC to use the C code backend. The default is OFF (**-nodrc_use_c**).
.. _mame-commandline-drcloguml:
**\-drc_log_uml**
- Write DRC UML disassembly log.
-
- The default is OFF (**-nodrc_log_uml**).
+ Write DRC UML disassembly log. The default is OFF (**-nodrc_log_uml**).
.. _mame-commandline-drclognative:
**\-drc_log_native**
- Write DRC native disassembly log.
-
- The default is OFF (**-nodrc_log_native**).
+ write DRC native disassembly log. The default is OFF (**-nodrc_log_native**).
.. _mame-commandline-bios:
**-bios** *<biosname>*
- Specifies the specific BIOS to use with the current system, for systems that
- make use of a BIOS. The **-listxml** output will list all of the possible
- BIOS names for a system.
-
- The default is ``default``.
+ Specifies the specific BIOS to use with the current system, for systems that make use of a BIOS. The **-listxml** output will list all of the possible BIOS names for a system. The default is ``default``.
.. _mame-commandline-cheat:
**-[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**).
+ Activates the cheat menu with autofire options and other tricks from the cheat database, if present. The default is OFF (**-nocheat**).
.. _mame-commandline-skipgameinfo:
**-[no]skip_gameinfo**
- Forces MAME to skip displaying the system info screen.
-
- The default is OFF (**-noskip_gameinfo**).
+ Forces MAME to skip displaying the system info screen. The default is OFF (**-noskip_gameinfo**).
.. _mame-commandline-uifont:
**-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).
+ 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).
.. _mame-commandline-ui:
**-ui** *<type>*
- Specifies the type of UI to use, either ``simple`` or ``cabinet``.
-
- The default is Cabinet (**-ui cabinet**).
+ Specifies the type of UI to use, either ``simple`` or ``cabinet``. The default is Cabinet (**-ui cabinet**).
.. _mame-commandline-ramsize:
**-ramsize** *[n]*
- Allows you to change the default RAM size (if supported by driver).
+ Allows you to change the default RAM size (if supported by driver).
.. _mame-commandline-confirmquit:
**\-confirm_quit**
- Display a Confirm Quit dialong to screen on exit, requiring one extra step
- to exit MAME.
-
- The default is OFF (**-noconfirm_quit**).
+ Display a Confirm Quit dialong to screen on exit, requiring one extra step to exit MAME. The default is OFF (**-noconfirm_quit**).
.. _mame-commandline-uimouse:
**\-ui_mouse**
- Displays a mouse cursor when using the built-in UI for MAME.
-
- The default is (**-noui_mouse**).
+ Displays a mouse cursor when using the built-in UI for MAME. The default is (**-noui_mouse**).
.. _mame-commandline-language:
**-language** *<language>*
- Specify a localization language found in the ``languagepath`` tree.
+ Specify a localization language found in the ``languagepath`` tree.
.. _mame-commandline-nvramsave:
**-[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**).
+ 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. The default is ON (**-nvram_save**).
@@ -2426,53 +1508,45 @@ 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 issue a
- create a new line, issuing what was typed prior as a command.
+ Command string to execute after machine boot (in quotes " "). To issue a quote to the emulation, use """ in the string. Using **\\n** will issue a create a new line, issuing what was typed prior as a command.
- This works only with systems that support natural keyboard mode.
-
- Example: **-autoboot_command "load """$""",8,1\\n"**
+ Example: **-autoboot_command "load """$""",8,1\\n"**
.. _mame-commandline-autobootdelay:
**-autoboot_delay** *[n]*
- Timer delay (in seconds) to trigger command execution on autoboot.
+ Timer delay (in seconds) to trigger command execution on autoboot.
.. _mame-commandline-autobootscript:
**-autoboot_script** / **-script** *[filename.lua]*
- File containing scripting to execute after machine boot.
+ File containing scripting to execute after machine boot.
.. _mame-commandline-console:
**-[no]console**
- Enables emulator Lua Console window.
-
- The default of OFF (**-noconsole**).
+ Enables emulator Lua Console window. The default of OFF (**-noconsole**).
.. _mame-commandline-plugins:
**-plugins**
- Enable the use of Lua Plugins.
-
- The default is ON (**-plugins**).
+ Enable the use of Lua Plugins. The default is ON (**-plugins**).
.. _mame-commandline-plugin:
**-plugin** *[plugin shortname]*
- A list of Lua Plugins to enable, comma separated.
+ A list of Lua Plugins to enable, comma separated.
.. _mame-commandline-noplugin:
**-noplugin** *[plugin shortname]*
- A list of Lua Plugins to disable, comma separated.
+ A list of Lua Plugins to disable, comma separated.
@@ -2482,22 +1556,16 @@ HTTP Server Options
**-[no]http**
- Enable HTTP server.
-
- The default is OFF (**-nohttp**).
+ Enable HTTP server. The default is OFF (**-nohttp**).
.. _mame-commandline-httpport:
**-http_port** *[port]*
- Choose HTTP server port.
-
- The default is ``8080``.
+ Choose HTTP server port. The default is ``8080``.
.. _mame-commandline-httproot:
**-http_root** *[rootfolder]*
- Choose HTTP server document root.
-
- The default is ``web``.
+ Choose HTTP server document root. The default is ``web``.
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 4130e982e30..acc99a66fbd 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -32,7 +32,6 @@ extensions = [
'sphinx.ext.mathjax',
'sphinx.ext.viewcode',
'edit_on_github',
- 'sphinxcontrib.rsvgconverter'
]
edit_on_github_project = 'mamedev/mame'
@@ -55,16 +54,16 @@ master_doc = 'index'
# General information about the project.
project = u'MAME Documentation'
-copyright = u'2019, MAMEdev Team'
+copyright = u'2018, MAMEdev Team'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
-version = '0.205'
+version = '0.194'
# The full version, including alpha/beta/rc tags.
-release = '0.205'
+release = '0.194'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
diff --git a/docs/source/images/MAMElogo.svg b/docs/source/images/MAMElogo.svg
deleted file mode 100644
index b45bc7ebdb3..00000000000
--- a/docs/source/images/MAMElogo.svg
+++ /dev/null
@@ -1,68 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<svg
- xmlns:dc="http://purl.org/dc/elements/1.1/"
- xmlns:cc="http://creativecommons.org/ns#"
- xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
- xmlns:svg="http://www.w3.org/2000/svg"
- xmlns="http://www.w3.org/2000/svg"
- xmlns:xlink="http://www.w3.org/1999/xlink"
- id="svg4563"
- version="1.1"
- viewBox="0 0 321.26581 91.07238"
- height="91.07238mm"
- width="321.26581mm">
- <defs
- id="defs4557">
- <linearGradient
- id="left-dark">
- <stop
- style="stop-color:#00274f;stop-opacity:1"
- offset="0"
- id="stop5213" />
- <stop
- style="stop-color:#68cafb;stop-opacity:1"
- offset="1"
- id="stop5215" />
- </linearGradient>
- <linearGradient
- gradientUnits="userSpaceOnUse"
- y2="299.328"
- x2="11"
- y1="299.328"
- x1="1213.16"
- id="right-dark">
- <stop
- id="stop4"
- stop-color="#68cafb"
- offset="0" />
- <stop
- id="stop6"
- stop-color="#00274f"
- offset="1" />
- </linearGradient>
- <linearGradient
- gradientUnits="userSpaceOnUse"
- y2="162.44048"
- x2="237.65611"
- y1="162.44048"
- x1="-80.41803"
- id="linearGradient5175"
- xlink:href="#right-dark" />
- <linearGradient
- gradientUnits="userSpaceOnUse"
- y2="162.44048"
- x2="237.65611"
- y1="162.44048"
- x1="-80.41803"
- id="linearGradient5211"
- xlink:href="#left-dark" />
- </defs>
- <g
- transform="translate(82.012688,-116.4355)"
- id="layer1">
- <path
- style="fill:url(#linearGradient5175);fill-rule:evenodd;stroke:url(#linearGradient5211);stroke-width:1.32291663px;stroke-linejoin:miter;stroke-opacity:0.75"
- d="m -80.418029,184.88601 66.4546,-66.5869 v 28.92769 l 29.05998,-28.92769 v 46.56667 l 46.74315,-46.83125 v 52.51979 l 52.519789,-52.51979 v 29.19227 l 29.01579,-28.92769 v 44.6704 l 43.56815,-43.65625 h 50.71269 l -16.36184,16.36025 h -25.83921 l -7.40833,7.40833 h 13.44877 l -17.02064,17.24184 h -13.80332 l -7.67291,7.54062 h 44.93418 l -17.15293,17.02171 h -68.74748 l 4.14496,-4.54211 V 161.91118 L 101.6153,186.07663 V 158.0308 L 74.715911,184.88601 H 44.421121 V 162.17576 L -0.24927857,206.84642 H -26.707609 L -2.1013586,182.1518 V 162.17576 L -26.707609,186.6058 v -29.10417 l -27.25209,27.38438 z"
- class="cls-1" />
- </g>
-</svg>
diff --git a/docs/source/index.rst b/docs/source/index.rst
index bf90036aa92..1cee5d6f714 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -2,17 +2,12 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-.. image:: images/MAMElogo.svg
- :width: 100%
- :align: center
- :alt: MAME
-
MAME Documentation
==================
.. note::
This documentation is a work in progress. You can track the status of these topics through MAME's `issue tracker <https://github.com/mamedev/mame/issues>`_. Learn how you can `contribute <https://github.com/mamedev/mame/blob/master/docs/CONTRIBUTING.md>`_ on GitHub.
-
+
.. toctree::
:titlesonly:
@@ -30,8 +25,9 @@ MAME Documentation
security
license
-
+
Contribute
----------
The documentation on this site is the handiwork of our many contributors.
+
diff --git a/docs/source/initialsetup/compilingmame.rst b/docs/source/initialsetup/compilingmame.rst
index b8a854db322..993ffb8e5fb 100644
--- a/docs/source/initialsetup/compilingmame.rst
+++ b/docs/source/initialsetup/compilingmame.rst
@@ -36,79 +36,15 @@ Rebuilding MAME on a dual-core (e.g. i3 or laptop i5) machine:
Microsoft Windows
-----------------
-MAME for Windows is built using the MSYS2 environment. You will need Windows 7
-or later and a reasonably up-to-date MSYS2 installation. We strongly recommend
-building MAME on a 64-bit system. Instructions may need to be adjusted for
-32-bit systems.
-
-* A pre-packaged MSYS2 installation including the prerequisites for building
- MAME can be downloaded from the `MAME Build Tools
- <http://mamedev.org/tools/>`_ page.
-* After initial installation, you can update the MSYS2 environment using the
- **pacman** (Arch package manage) command.
-* By default, MAME will be built using native Windows OS interfaces for
- window management, audio/video output, font rendering, etc. If you want to
- use the portable SDL (Simple DirectMedia Layer) interfaces instead, you can
- add **OSD=sdl** to the make options. The main emulator binary will have an
- ``sdl`` prefix prepended (e.g. ``sdlmame64.exe`` or ``sdlmame.exe``). You
- will need to install the MSYS2 packages for SDL 2 version 2.0.3 or later.
-* By default, MAME will include the native Windows debugger. To also inculde
- the portable Qt debugger, add **USE_QTDEBUG=1** to the make options. You
- will need to install the MSYS2 packages for Qt 5.
-
-Using a standard MSYS2 installation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-You may also build MAME using a standard MSYS2 installation and adding the tools
-needed for building MAME. These instructions assume you have some familiarity
-with MSYS2 and the **pacman** package manager.
-
-* Install the MSYS2 environment from the `MSYS2 homepage
- <https://www.msys2.org/>`_.
-* Download the latest version of the ``mame-essentials`` package from the
- `MAME package repository <https://repo.mamedev.org/x86_64/>`_ and install it
- using the **pacman** command.
-* Add the ``mame`` repository to ``/etc/pacman.conf`` using
- ``/etc/pacman.d/mirrorlist.mame`` for locations.
-* Install packages necessary to build MAME. At the very least, you'll need
- ``bash``, ``git``, ``make``.
-* For 64-bit builds you'll need ``mingw-w64-x86_64-gcc`` and
- ``mingw-w64-x86_64-python2``.
-* For 32-bit builds you'll need ``mingw-w64-i686-gcc`` and
- ``mingw-w64-i686-python2``.
-* For debugging you may want to install ``gdb``.
-* To build against the portable SDL interfaces, you'll need
- ``mingw-w64-x86_64-SDL2`` and ``mingw-w64-x86_64-SDL2_ttf`` for 64-bit builds,
- or ``mingw-w64-i686-SDL2`` and ``mingw-w64-i686-SDL2_ttf`` for 32-bit builds.
-* To build the Qt debugger, you'll need ``mingw-w64-x86_64-qt5`` for 64-bit
- builds, or ``mingw-w64-i686-qt5`` for 32-bit builds.
-* To generate API documentation from source, you'll need ``doxygen``.
-* For 64-bit builds, open **MSYS2 MinGW 64-bit** from the start menu, and set
- up the environment variables ``MINGW64`` to ``/mingw64`` and ``MINGW32`` to an
- empty string (e.g. using the command **export MINGW64=/mingw64 MINGW32=** in
- the Bash shell).
-* For 32-bit builds, open **MSYS2 MinGW 32-bit** from the start menu, and set
- up the environment variables ``MINGW32`` to ``/mingw32`` and ``MINGW64`` to an
- empty string (e.g. using the command **export MINGW32=/mingw32 MINGW64=** in
- the Bash shell).
-
-Building with Microsoft Visual Studio
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-* You can generate Visual Studio 2017 projects using **make vs2017**. The
- solution and project files will be created in
- ``build/projects/windows/mame/vs2017`` by default (the name of the ``build``
- folder can be changed using the ``BUILDDIR`` option). This will always
- regenerate the settings, so **REGENIE=1** is *not* needed.
-* Adding **MSBUILD=1** to the make options will build build the solution using
- the Microsoft Build Engine after generating the project files. Note that this
- requires paths and environment variables to be configured so the correct
- Visual Studio tools can be located.
-* MAME can only be compiled with the Visual Studio 15.7.6 tools. Bugs in newer
- versions of the Microsoft Visual C/C++ compiler prevent it from compiling
- MAME.
-* The MSYS2 environment is still required to generate the project files, convert
- built-in layouts, compile UI translations, etc.
+Here are specific notes about compiling MAME for Microsoft Windows.
+
+* Refer to `the MAME tools site <http://mamedev.org/tools/>`_ for the latest toolkit for getting MAME compiled on Windows.
+
+* You will need to download the toolset from that link to begin. Periodically, these tools are updated and newer versions of MAME from that point on will **require** updated tools to compile.
+
+* You can do compilation on Visual Studio 2017 (if installed on your PC) by using **make vs2017**. This will always regenerate the settings, so **REGENIE=1** is *not* needed.
+
+* Make sure you get SDL 2 2.0.3 or 2.0.4 as earlier versions are buggy.
.. _compiling-fedora:
@@ -252,27 +188,15 @@ IGNORE_GIT
revision description in the version string.
Tool locations
-~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~
OVERRIDE_CC
- Set the C/Objective-C compiler command. (This sets the target C compiler
- command when cross-compiling.)
+ Set the C/Objective-C compiler command.
OVERRIDE_CXX
- Set the C++/Objective-C++ compiler command. (This sets the target C++
- compiler command when cross-compiling.)
-OVERRIDE_LD
- Set the linker command. This is often not necessary or useful because the C
- or C++ compiler command is used to invoke the linker. (This sets the target
- linker command when cross-compiling.)
+ Set the C++/Objective-C++ compiler command.
PYTHON_EXECUTABLE
Set the Python interpreter command. You need Python 2.7 or Python 3 to build
MAME.
-CROSS_BUILD
- Set to **1** to use separate host and target compilers and linkers, as
- required for cross-compilation. In this case, **OVERRIDE_CC**,
- **OVERRIDE_CXX** and **OVERRIDE_LD** set the target C compiler, C++ compiler
- and linker commands, while **CC**, **CXX** and **LD** set the host C
- compiler, C++ compiler and linker commands.
Optional features
~~~~~~~~~~~~~~~~~
@@ -331,10 +255,10 @@ ARCHOPTS_CXX
source files.
ARCHOPTS_OBJC
Additional command-line options to pass to the compiler when compiling
- Objective-C source files.
+ Objecive-C source files.
ARCHOPTS_OBJCXX
Additional command-line options to pass to the compiler when compiling
- Objective-C++ source files.
+ Objecive-C++ source files.
Library/framework locations
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -404,8 +328,8 @@ Issues with specific compiler versions
Adding **DEPRECATED=0** to your build options works around this by disabling
deprecation warnings.
* MinGW GCC 7 for Windows i386 produces spurious out-of-bounds access warnings.
- Adding **NOWERROR=1** to your build options works around this by not treating
- warnings as errors.
+ Adding **NOWERROR=1** to your build options works around this by disabling
+ deprecation warnings.
* Initial versions of GNU libstdc++ 6 have a broken ``std::unique_ptr``
implementation. If you encounter errors with ``std::unique_ptr`` you need to
upgrade to a newer version of libstdc++ that fixes the issue.
@@ -438,7 +362,7 @@ a **CFLAGS** or **CXXFLAGS** environment variable). You can check to see
whether the ``_FORTIFY_SOURCE`` macro is a built-in macro with your version of
GCC with a command like this:
-**gcc -dM -E - < /dev/null | grep _FORTIFY_SOURCE**
+**gcc -dM -E - | grep _FORTIFY_SOURCE**
If ``_FORTIFY_SOURCE`` is defined to a non-zero value by default, you can work
around it by adding **-U_FORTIFY_SOURCE** to the compiler flags (e.g. by using
@@ -451,23 +375,6 @@ variables.
Unusual Build Configurations
----------------------------
-Cross-compiling MAME
-~~~~~~~~~~~~~~~~~~~~
-
-MAME's build system has basic support for cross-compilation. Set
-**CROSS_BUILD=1** to enable separate host and target compilers, set
-**OVERRIDE_CC** and **OVERRIDE_CXX** to the target C/C++ compiler commands, and
-if necessary set **CC** and **CXX** to the host C/C++ compiler commands. If the
-target OS is different to the host OS, set it with **TARGETOS**. For example it
-may be possible to build a MinGW32 x64 build on a Linux host using a command
-like this:
-
-**make TARGETOS=windows PTR64=1 OVERRIDE_CC=x86_64-w64-mingw32-gcc OVERRIDE_CXX=x86_64-w64-mingw32-g++ OVERRIDE_LD=x86_64-w64-mingw32-ld MINGW64=/usr**
-
-(The additional packages required for producing a standard MinGW32 x64 build on
-a Fedora Linux host are ``mingw64-gcc-c++``, ``mingw64-winpthreads-static`` and
-their dependencies. Non-standard builds may require additional packages.)
-
Using libc++ on Linux
~~~~~~~~~~~~~~~~~~~~~
diff --git a/docs/source/license.rst b/docs/source/license.rst
index db2eb2f41d0..9e61b9ca349 100644
--- a/docs/source/license.rst
+++ b/docs/source/license.rst
@@ -6,7 +6,7 @@ The MAME project as a whole is distributed under the terms of the `GNU General P
Please note that MAME is a registered trademark of Gregory Ember, and permission is required to use the "MAME" name, logo, or wordmark.
- Copyright (C) 1997-2019 MAMEDev and contributors
+ Copyright (C) 1997-2018 MAMEDev and contributors
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
diff --git a/docs/source/techspecs/device_memory_interface.rst b/docs/source/techspecs/device_memory_interface.rst
index 4efa6a75234..f35a1887cee 100644
--- a/docs/source/techspecs/device_memory_interface.rst
+++ b/docs/source/techspecs/device_memory_interface.rst
@@ -70,7 +70,7 @@ Associating maps to spaces is done at the machine config level, after the device
| **MCFG_DEVICE_PROGRAM_MAP**\ (_map)
| **MCFG_DEVICE_DATA_MAP**\ (_map)
| **MCFG_DEVICE_IO_MAP**\ (_map)
-| **MCFG_DEVICE_OPCODES_MAP**\ (_map)
+| **MCFG_DEVICE_DECRYPTED_OPCODES_MAP**\ (_map)
The generic macro and the four specific ones associate a map to a
given space. Address maps associated to non-existing spaces are
diff --git a/docs/source/techspecs/layout_files.rst b/docs/source/techspecs/layout_files.rst
index 10467a8d0e9..de9bdff916c 100644
--- a/docs/source/techspecs/layout_files.rst
+++ b/docs/source/techspecs/layout_files.rst
@@ -32,7 +32,7 @@ There are two kinds of numbers in MAME layouts: integers and floating-point
numbers.
Integers may be supplied in decimal or hexadecimal notation. A decimal integer
-consists of an optional # (hash) prefix, an optional +/- (plus or minus) sign
+consists of and optional # (hash) prefix, an optional +/- (plus or minus) sign
character, and a sequence of digits 0-9. A hexadecimal number consists of one
of the prefixes $ (dollar sign) or 0x (zero ex) followed by a sequence of
hexadecimal digits 0-9 and A-F. Hexadecimal numbers are case-insensitive for
@@ -768,14 +768,12 @@ how digital displays may be connected to emulated outputs::
If an element instantiating a layout element has ``inputtag`` and ``inputmask``
attributes but lacks a ``name`` attribute, it will take its state from the value
-of the corresponding I/O port, masked with the ``inputmask`` value and XORed
-with the I/O port default field value. The latter is useful for inputs that are
-active-low. If the result is non-zero, the state is 1, otherwise it's 0. This
-is often used to allow clickable buttons and toggle switches to provide visible
-feedback. By using ``inputraw="1"``, it's possible to obtain the raw data from
-the I/O port, masked with the ``inputmask`` value and shifted to the right to
-remove trailing zeroes (for example a mask of 0x05 will result in no shift, while
-a mask of 0xb0 will result in the value being shifted four bits to the right).
+of the corresponding I/O port, masked with the ``inputmask`` value, and shifted
+to the right so that the least significant one bit of the mask aligns with the
+least significant bit of the value (for example a mask of 0x05 will result in no
+shift, while a mask of 0xb0 will result in the value being shifted four bits to
+the right). This is often used to allow clickable buttons and toggle switches
+to provide visible feedback.
When handling mouse input, MAME treats all layout elements as being rectangular,
and only activates the frontmost element whose area includes the location of the
@@ -1092,9 +1090,9 @@ when parameters are used, or recursively nested groups. The ``complay.py``
script is compatible with both Python 2.7 and Python 3 interpreters.
The ``complay.py`` script takes three parameters -- an input file name, an
-output file name, and a base name for variables in the output:
+output file name, and a base name for variables in the output::
- **python scripts/build/complay.py** *<input>* [*<output>* [*<varname>*]]
+ python scripts/build/complay.py input [output [varname]]
The input file name is required. If no output file name is supplied,
``complay.py`` will parse and check the input, reporting any errors found,
@@ -1106,6 +1104,6 @@ in case of an I/O error. If an output file name is specified, the file will be
created/overwritten on success or removed on failure.
To check a layout file for common errors, run the script with the path to the
-file no check and no output file name or base variable name. For example:
+file no check and no output file name or base variable name. For example::
- **python scripts/build/complay.py artwork/dino/default.lay**
+ python scripts/build/complay.py artwork/dino/default.lay
diff --git a/docs/source/techspecs/luaengine.rst b/docs/source/techspecs/luaengine.rst
index 26d6da6a253..fa1c04cdb10 100644
--- a/docs/source/techspecs/luaengine.rst
+++ b/docs/source/techspecs/luaengine.rst
@@ -53,7 +53,7 @@ Let's first run MAME in a terminal to reach the LUA console:
_/ _/ _/ _/_/_/_/ _/ _/ _/ _/_/_/
_/ _/ _/ _/ _/ _/ _/
_/ _/ _/ _/ _/ _/ _/_/_/_/
- mame v0.205
+ mame v0.195
Copyright (C) Nicola Salmoria and the MAME team
Lua 5.3
@@ -77,7 +77,7 @@ You can check at runtime which version of MAME you are running, with:
::
[MAME]> print(emu.app_name() .. " " .. emu.app_version())
- mame 0.205
+ mame 0.195
We now start exploring screen related methods. First, let's enumerate available screens:
diff --git a/docs/source/whatis.rst b/docs/source/whatis.rst
index 51f9d244226..fb5dffe497b 100644
--- a/docs/source/whatis.rst
+++ b/docs/source/whatis.rst
@@ -7,7 +7,7 @@ MAME's purpose is to preserve decades of software history. As electronic technol
|
| **MAME®**
-| **Copyright © 1997-2019 by Nicola Salmoria and the MAME team**
+| **Copyright © 1997-2018 by Nicola Salmoria and the MAME team**
| **MAME is a registered trademark owned by Gregory Ember**
|