Sprinter/mame
2
0
Fork 0
mirror of https://github.com/holub/mame synced 2025-04-19 15:11:37 +03:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Overhaul commandline section of docs, includes index with linkable anchors. (#3112)

Browse Source 
* The first set of commandline overhauls. (NW)

* Correct case on headings, further improvements to index, spelling fix

* More updates to the index and cleanup to the commandline stuff. [NW]

* More core options in the index. [NW]

* Finished multiplatform commandline index [NW]

* Completion of first revision commandline index [NW]
This commit is contained in:
Firehawke 2018-01-24 14:37:48 -07:00 committed by Vas Crabb
parent b6d2d7ce33
commit f481e6b23a
5 changed files with 1007 additions and 418 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

550
docs/source/commandline/commandline-all.rst
View File

File diff suppressed because it is too large Load Diff

400
docs/source/commandline/commandline-index.rst Normal file
View File

@ -0,0 +1,400 @@
.. _index-commandline:
Commandline Index
=================
This is a complete index of all commandline options and commands for MAME, suitable for quickly finding a given command.
Universal Commandline Options
-----------------------------
This section contains configuration options that are applicable to *all* MAME sub-builds (both SDL and Windows native).
Core Commands
~~~~~~~~~~~~~
| :ref:`help <mame-commandline-help>`
| :ref:`validate <mame-commandline-validate>`
Configuration Commands
~~~~~~~~~~~~~~~~~~~~~~
| :ref:`createconfig <mame-commandline-createconfig>`
| :ref:`showconfig <mame-commandline-showconfig>`
| :ref:`showusage <mame-commandline-showusage>`
Frontend Commands
~~~~~~~~~~~~~~~~~
| :ref:`listxml <mame-commandline-listxml>`
| :ref:`listfull <mame-commandline-listfull>`
| :ref:`listsource <mame-commandline-listsource>`
| :ref:`listclones <mame-commandline-listclones>`
| :ref:`listbrothers <mame-commandline-listbrothers>`
| :ref:`listcrc <mame-commandline-listcrc>`
| :ref:`listroms <mame-commandline-listroms>`
| :ref:`listsamples <mame-commandline-listsamples>`
| :ref:`verifyroms <mame-commandline-verifyroms>`
| :ref:`verifysamples <mame-commandline-verifysamples>`
| :ref:`romident <mame-commandline-romident>`
| :ref:`listdevices <mame-commandline-listdevices>`
| :ref:`listslots <mame-commandline-listslots>`
| :ref:`listmedia <mame-commandline-listmedia>`
| :ref:`listsoftware <mame-commandline-listsoftware>`
| :ref:`verifysoftware <mame-commandline-verifysoftware>`
| :ref:`getsoftlist <mame-commandline-getsoftlist>`
| :ref:`verifysoftlist <mame-commandline-verifysoftlist>`
OSD-related Options
~~~~~~~~~~~~~~~~~~~
| :ref:`uimodekey <mame-commandline-uimodekey>`
| :ref:`uifontprovider <mame-commandline-uifontprovider>`
| :ref:`menu <mame-commandline-menu>`
| :ref:`keyboardprovider <mame-commandline-keyboardprovider>`
| :ref:`mouseprovider <mame-commandline-mouseprovider>`
| :ref:`lightgunprovider <mame-commandline-lightgunprovider>`
| :ref:`joystickprovider <mame-commandline-joystickprovider>`
OSD CLI Options
~~~~~~~~~~~~~~~
| :ref:`listmidi <mame-commandline-listmidi>`
| :ref:`listnetwork <mame-commandline-listnetwork>`
OSD Output Options
~~~~~~~~~~~~~~~~~~
| :ref:`output <mame-commandline-output>`
Configuration Options
~~~~~~~~~~~~~~~~~~~~~
| :ref:`noreadconfig <mame-commandline-noreadconfig>`
Core Search Path Options
~~~~~~~~~~~~~~~~~~~~~~~~
| :ref:`rompath <mame-commandline-rompath>`
| :ref:`hashpath <mame-commandline-hashpath>`
| :ref:`samplepath <mame-commandline-samplepath>`
| :ref:`artpath <mame-commandline-artpath>`
| :ref:`ctrlrpath <mame-commandline-ctrlrpath>`
| :ref:`inipath <mame-commandline-inipath>`
| :ref:`fontpath <mame-commandline-fontpath>`
| :ref:`cheatpath <mame-commandline-cheatpath>`
| :ref:`crosshairpath <mame-commandline-crosshairpath>`
| :ref:`pluginspath <mame-commandline-pluginspath>`
| :ref:`languagepath <mame-commandline-languagepath>`
Core Output Directory Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| :ref:`cfg_directory <mame-commandline-cfgdirectory>`
| :ref:`nvram_directory <mame-commandline-nvramdirectory>`
| :ref:`input_directory <mame-commandline-inputdirectory>`
| :ref:`state_directory <mame-commandline-statedirectory>`
| :ref:`snapshot_directory <mame-commandline-snapshotdirectory>`
| :ref:`diff_directory <mame-commandline-diffdirectory>`
| :ref:`comment_directory <mame-commandline-commentdirectory>`
Core State/Playback Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~
| :ref:`[no]rewind / rewind<mame-commandline-norewind>`
| :ref:`rewind_capacity <mame-commandline-rewindcapacity>`
| :ref:`state <mame-commandline-state>`
| :ref:`[no]autosave <mame-commandline-noautosave>`
| :ref:`playback <mame-commandline-playback>`
| :ref:`exit_after_playback <mame-commandline-exitafterplayback>`
| :ref:`record <mame-commandline-record>`
| :ref:`record_timecode <mame-commandline-recordtimecode>`
| :ref:`mngwrite <mame-commandline-mngwrite>`
| :ref:`aviwrite <mame-commandline-aviwrite>`
| :ref:`wavwrite <mame-commandline-wavwrite>`
| :ref:`snapname <mame-commandline-snapname>`
| :ref:`snapsize <mame-commandline-snapsize>`
| :ref:`snapview <mame-commandline-snapview>`
| :ref:`[no]snapbilinear <mame-commandline-nosnapbilinear>`
| :ref:`statename <mame-commandline-statename>`
| :ref:`[no]burnin <mame-commandline-noburnin>`
Core Performance Options
~~~~~~~~~~~~~~~~~~~~~~~~
| :ref:`[no]autoframeskip <mame-commandline-noautoframeskip>`
| :ref:`frameskip <mame-commandline-frameskip>`
| :ref:`seconds_to_run <mame-commandline-secondstorun>`
| :ref:`[no]throttle <mame-commandline-nothrottle>`
| :ref:`[no]sleep <mame-commandline-nosleep>`
| :ref:`speed <mame-commandline-speed>`
| :ref:`[no]refreshspeed <mame-commandline-norefreshspeed>`
| :ref:`numprocessors <mame-commandline-numprocessors>`
| :ref:`bench <mame-commandline-bench>`
Core Rotation Options
~~~~~~~~~~~~~~~~~~~~~
| :ref:`[no]rotate <mame-commandline-norotate>`
| :ref:`[no]ror <mame-commandline-noror>`
| :ref:`[no]rol <mame-commandline-norol>`
| :ref:`[no]autoror <mame-commandline-noautoror>`
| :ref:`[no]autorol <mame-commandline-noautorol>`
| :ref:`[no]flipx <mame-commandline-noflipx>`
| :ref:`[no]flipy <mame-commandline-noflipy>`
Core Video Options
~~~~~~~~~~~~~~~~~~
| :ref:`video <mame-commandline-video>`
| :ref:`numscreens <mame-commandline-numscreens>`
| :ref:`[no]window <mame-commandline-window>`
| :ref:`[no]maximize <mame-commandline-maximize>`
| :ref:`[no]keepaspect <mame-commandline-keepaspect>`
| :ref:`[no]waitvsync <mame-commandline-waitvsync>`
| :ref:`[no]syncrefresh <mame-commandline-syncrefresh>`
| :ref:`prescale <mame-commandline-prescale>`
| :ref:`[no]filter <mame-commandline-filter>`
| :ref:`[no]unevenstretch <mame-commandline-unevenstretch>`
Core Full Screen Options
~~~~~~~~~~~~~~~~~~~~~~~~
| :ref:`[no]switchres <mame-commandline-switchres>`
Core Per-Window Video Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| :ref:`screen <mame-commandline-screen>`
| :ref:`aspect <mame-commandline-aspect>`
| :ref:`resolution <mame-commandline-resolution>`
| :ref:`view <mame-commandline-view>`
Core Artwork Options
~~~~~~~~~~~~~~~~~~~~
| :ref:`[no]artwork_crop <mame-commandline-noartworkcrop>`
| :ref:`[no]use_backdrops <mame-commandline-nousebackdrops>`
| :ref:`[no]use_overlays <mame-commandline-nouseoverlays>`
| :ref:`[no]use_bezels <mame-commandline-nousebezels>`
| :ref:`[no]use_cpanels <mame-commandline-nousecpanels>`
| :ref:`[no]use_marquees <mame-commandline-nousemarquees>`
Core Screen Options
~~~~~~~~~~~~~~~~~~~
| :ref:`brightness <mame-commandline-brightness>`
| :ref:`contrast <mame-commandline-contrast>`
| :ref:`gamma <mame-commandline-gamma>`
| :ref:`pause_brightness <mame-commandline-pausebrightness>`
| :ref:`effect <mame-commandline-effect>`
Core Vector Options
~~~~~~~~~~~~~~~~~~~
| :ref:`[no]antialias <mame-commandline-noantialias>`
| :ref:`beam <mame-commandline-beam>`
| :ref:`flicker <mame-commandline-flicker>`
Core Sound Options
~~~~~~~~~~~~~~~~~~
| :ref:`samplerate <mame-commandline-samplerate>`
| :ref:`[no]samples <mame-commandline-nosamples>`
| :ref:`volume <mame-commandline-volume>`
| :ref:`sound <mame-commandline-sound>`
| :ref:`audio_latency <mame-commandline-audiolatency>`
Core Input Options
~~~~~~~~~~~~~~~~~~
| :ref:`[no]coin_lockout <mame-commandline-nocoinlockout>`
| :ref:`ctrlr <mame-commandline-ctrlr>`
| :ref:`[no]mouse <mame-commandline-nomouse>`
| :ref:`[no]joystick <mame-commandline-nojoystick>`
| :ref:`[no]lightgun <mame-commandline-nolightgun>`
| :ref:`[no]multikeyboard <mame-commandline-nomultikeyboard>`
| :ref:`[no]multimouse <mame-commandline-nomultimouse>`
| :ref:`[no]steadykey <mame-commandline-nosteadykey>`
| :ref:`[no]ui_active <mame-commandline-uiactive>`
| :ref:`[no]offscreen_reload <mame-commandline-nooffscreenreload>`
| :ref:`joystick_map <mame-commandline-joystickmap>`
| :ref:`joystick_deadzone <mame-commandline-joystickdeadzone>`
| :ref:`joystick_saturation <mame-commandline-joysticksaturation>`
| :ref:`natural <mame-commandline-natural>`
| :ref:`joystick_contradictory <mame-commandline-joystickcontradictory>`
| :ref:`coin_impulse <mame-commandline-coinimpulse>`
Core Input Automatic Enable Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| :ref:`paddle_device <mame-commandline-paddledevice>`
| :ref:`adstick_device <mame-commandline-adstickdevice>`
| :ref:`pedal_device <mame-commandline-pedaldevice>`
| :ref:`dial_device <mame-commandline-dialdevice>`
| :ref:`trackball_device <mame-commandline-trackballdevice>`
| :ref:`lightgun_device <mame-commandline-lightgundevice>`
| :ref:`positional_device <mame-commandline-positionaldevice>`
| :ref:`mouse_device <mame-commandline-mousedevice>`
Core Debugging Options
~~~~~~~~~~~~~~~~~~~~~~
| :ref:`[no]verbose <mame-commandline-verbose>`
| :ref:`[no]oslog <mame-commandline-oslog>`
| :ref:`[no]log <mame-commandline-log>`
| :ref:`[no]debug <mame-commandline-debug>`
| :ref:`debugscript <mame-commandline-debugscript>`
| :ref:`[no]update_in_pause <mame-commandline-updateinpause>`
| :ref:`watchdog <mame-commandline-watchdog>`
Core Communication Options
~~~~~~~~~~~~~~~~~~~~~~~~~~
| :ref:`comm_localhost <mame-commandline-commlocalhost>`
| :ref:`comm_localport <mame-commandline-commlocalport>`
| :ref:`comm_remotehost <mame-commandline-commremotehost>`
| :ref:`comm_remoteport <mame-commandline-commremoteport>`
Core Misc Options
~~~~~~~~~~~~~~~~~
| :ref:`[no]drc <mame-commandline-drc>`
| :ref:`drc_use_c <mame-commandline-drcusec>`
| :ref:`drc_log_uml <mame-commandline-drcloguml>`
| :ref:`drc_log_native <mame-commandline-drclognative>`
| :ref:`bios <mame-commandline-bios>`
| :ref:`[no]cheat <mame-commandline-cheat>`
| :ref:`[no]skip_gameinfo <mame-commandline-skipgameinfo>`
| :ref:`uifont <mame-commandline-uifont>`
| :ref:`ramsize <mame-commandline-ramsize>`
| :ref:`confirm_quit <mame-commandline-confirmquit>`
| :ref:`ui_mouse <mame-commandline-uimouse>`
| :ref:`autoboot_command <mame-commandline-autobootcommand>`
| :ref:`autoboot_delay <mame-commandline-autobootdelay>`
| :ref:`autoboot_script <mame-commandline-autobootscript>`
| :ref:`language <mame-commandline-language>`
Windows-Specific Commandline Options
------------------------------------
Windows Debugging options
~~~~~~~~~~~~~~~~~~~~~~~~~
| :ref:`debugger_font <mame-wcommandline-debuggerfont>`
| :ref:`debugger_font_size <mame-wcommandline-debuggerfontsize>`
Windows Performance Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~
| :ref:`priority <mame-wcommandline-priority>`
| :ref:`profile <mame-wcommandline-profile>`
Windows Full Screen Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~
| :ref:`[no]triplebuffer <mame-wcommandline-triplebuffer>`
| :ref:`full_screen_brightness <mame-wcommandline-fullscreenbrightness>`
| :ref:`full_screen_contrast <mame-wcommandline-fullscreencontrast>`
| :ref:`full_screen_gamma <mame-wcommandline-fullscreengamma>`
Windows Input Device Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| :ref:`[no]dual_lightgun <mame-wcommandline-duallightgun>`
SDL-Specific Commandline Options
--------------------------------
This section contains configuration options that are specific to any build supported by SDL (including Windows where compiled as SDL instead of native).
SDL Performance Options
~~~~~~~~~~~~~~~~~~~~~~~
| :ref:`sdlvideofps <mame-scommandline-sdlvideofps>`
SDL Video Options
~~~~~~~~~~~~~~~~~
| :ref:`[no]centerh <mame-scommandline-centerh>`
| :ref:`[no]centerv <mame-scommandline-centerv>`
SDL Video Soft-Specific Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| :ref:`scalemode <mame-scommandline-scalemode>`
SDL Video OpenGL Debugging Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| :ref:`[no]gl_forcepow2texture <mame-scommandline-glforcepow2texture>`
| :ref:`[no]gl_notexturerect <mame-scommandline-glnotexturerect>`
| :ref:`[no]gl_vbo <mame-scommandline-glvbo>`
| :ref:`[no]gl_pbo <mame-scommandline-glpbo>`
SDL Video OpenGL GLSL Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| :ref:`gl_glsl <mame-scommandline-glglsl>`
| :ref:`gl_glsl_filter <mame-scommandline-glglslfilter>`
| :ref:`glsl_shader_mame[0-9] <mame-scommandline-glslshadermame>`
| :ref:`glsl_shader_screen[0-9] <mame-scommandline-glslshaderscreen>`
| :ref:`gl_glsl_vid_attr <mame-scommandline-glglslvidattr>`
SDL Keyboard Mapping
~~~~~~~~~~~~~~~~~~~~
| :ref:`keymap <mame-scommandline-keymap>`
| :ref:`keymap_file <mame-scommandline-keymapfile>`
SDL Joystick Mapping
~~~~~~~~~~~~~~~~~~~~
| :ref:`joyidx <mame-scommandline-joyidx>`
| :ref:`sixaxis <mame-scommandline-sixaxis>`
SDL Low-level Driver Options
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
| :ref:`videodriver <mame-scommandline-videodriver>`
| :ref:`audiodriver <mame-scommandline-audiodriver>`
| :ref:`gl_lib <mame-scommandline-gllib>`

2
docs/source/commandline/index.rst
View File

@ -7,3 +7,5 @@ MAME Commandline Usage and OS-Specific Configuration
commandline-all
windowsconfig
sdlconfig
commandline-index

319
docs/source/commandline/sdlconfig.rst
View File

@ -5,375 +5,182 @@ SDL-Specific Commandline Options
This section contains configuration options that are specific to any build supported by SDL (including Windows where compiled as SDL instead of native).
In addition to the keys described in config.txt, the following additional keys are defined for SDL-specific versions of MAME:
Debugging options
-----------------
**-[no]oslog**
Outputs the error.log data to the stderr TTY channel (usually the command line window MAME was started in). This can be used at the same time as *-log* to output the log data to both targets as well. Default is OFF (*-nooslog*).
**-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 games 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.
Performance options
Performance Options
-------------------
**-numprocessors** *<auto|value>* / **-np** *<auto|value>*
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-scommandline-sdlvideofps:
**-sdlvideofps**
Enable output of benchmark data on the SDL video subsystem, including your system's video driver, X server (if applicable), and OpenGL stack in **-video opengl** mode.
**-bench** *[n]*
Benchmark for [n] number of emulated seconds; implies the command string: **-str [n] -video none -sound none -nothrottle**. Default is OFF (*-nobench*)
Video options
Video Options
-------------
**-video** *<soft|opengl|none>*
Specifies which video subsystem to use for drawing. 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*'.
**-numscreens** *<count>*
Tells MAME how many output windows to create. For most games, a single output window is all you need, but some games originally used multiple screens. Each screen (up to 4) has its own independent settings for physical monitor, aspect ratio, resolution, and view, which can be set using the options below. The default is 1.
**-[no]window** / **-[no]w**
Run MAME in either a window or full screen. The default is OFF (*-nowindow*).
**-[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 smallest supported size. This option only has an effect when the **-window** option is used. The default is ON (*-maximize*).
**-[no]keepaspect** / **-[no]ka**
Enables aspect ratio enforcement. When this option is on, the game's proper aspect ratio (generally 4:3 or 3:4) is enforced, so you get the game 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 games will stretch to the full screen size (even vertical games). In window mode, it means that you can freely resize the window without any constraints. The default is ON (*-keepaspect*).
**-[no]unevenstretch**
Allow non-integer stretch factors allowing for great window sizing flexability. The default is ON. (*-unevenstretch*)
.. _mame-scommandline-centerh:
**-[no]centerh**
Center horizontally within the view area. Default is ON (*-centerh*).
.. _mame-scommandline-centerv:
**-[no]centerv**
Center vertically within the view area. Default is ON (*-centerv*).
**-[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 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 games, 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 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. The default is OFF (*-nowaitvsync*).
**-[no]syncrefresh**
Enables speed throttling only to the refresh of your monitor. This means that the game's actual refresh rate is ignored; however, the sound code still attempts to keep up with the game'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. The default is OFF (*-nosyncrefresh*).
Video soft-specific options
Video Soft-Specific Options
---------------------------
.. _mame-scommandline-scalemode:
**-scalemode**
Scale mode: none, async, yv12, yuy2, yv12x2, yuy2x2 (**-video soft** only). Default is '*none*'.
Video OpenGL-specific options
-----------------------------
**-[no]filter** / **-[no]flt**
Enable bilinear filtering on the game 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*).
**-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 by a factor of *<amount>* before being scaled. This produces a less blurry image at the expense of some speed and also increases the effective resolution of non-screen elements such as artwork and fonts. The default is *1*.
Video OpenGL debugging options
Video OpenGL Debugging Options
------------------------------
These 4 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-scommandline-glforcepow2texture:
**-[no]gl_forcepow2texture**
Always use only power-of-2 sized textures (default *off*)
.. _mame-scommandline-glnotexturerect:
**-[no]gl_notexturerect**
Don't use OpenGL GL_ARB_texture_rectangle (default *on*)
.. _mame-scommandline-glvbo:
**-[no]gl_vbo**
Enable OpenGL VBO, if available (default *on*)
.. _mame-scommandline-glpbo:
**-[no]gl_pbo**
Enable OpenGL PBO, if available (default *on*)
Video OpenGL GLSL options
Video OpenGL GLSL Options
-------------------------
.. _mame-scommandline-glglsl:
**-gl_glsl**
Enable OpenGL GLSL, if available (default *off*)
.. _mame-scommandline-glglslfilter:
**-gl_glsl_filter**
Enable OpenGL GLSL filtering instead of FF filtering -- *0-plain, 1-bilinear* (default is *1*)
**-glsl_shader_mame0**
.. _mame-scommandline-glslshadermame:
Custom OpenGL GLSL shader set MAME bitmap 0 [todo: better details on usage at some point. See http://forums.bannister.org/ubbthreads.php?ubb=showflat&Number=100988#Post100988 ]
|
| **-glsl_shader_mame0**
| **-glsl_shader_mame1**
| ...
| **-glsl_shader_mame9**
|
**-glsl_shader_mame1**
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 1
**-glsl_shader_mame2**
Custom OpenGL GLSL shader set MAME bitmap 2
**-glsl_shader_mame3**
Custom OpenGL GLSL shader set MAME bitmap 3
**-glsl_shader_mame4**
Custom OpenGL GLSL shader set MAME bitmap 4
**-glsl_shader_mame5**
Custom OpenGL GLSL shader set MAME bitmap 5
**-glsl_shader_mame6**
Custom OpenGL GLSL shader set MAME bitmap 6
**-glsl_shader_mame7**
Custom OpenGL GLSL shader set MAME bitmap 7
**-glsl_shader_mame8**
Custom OpenGL GLSL shader set MAME bitmap 8
**-glsl_shader_mame9**
Custom OpenGL GLSL shader set MAME bitmap 9
[todo: better details on usage at some point. See http://forums.bannister.org/ubbthreads.php?ubb=showflat&Number=100988#Post100988 ]
**-glsl_shader_screen0**
Custom OpenGL GLSL shader screen bitmap 0
.. _mame-scommandline-glslshaderscreen:
**-glsl_shader_screen1**
|
| **-glsl_shader_screen0**
| **-glsl_shader_screen1**
| ...
| **-glsl_shader_screen9**
|
Custom OpenGL GLSL shader screen bitmap 1
Custom OpenGL GLSL shader screen bitmap in the provided slot (0-9).
**-glsl_shader_screen2**
[todo: better details on usage at some point. See http://forums.bannister.org/ubbthreads.php?ubb=showflat&Number=100988#Post100988 ]
Custom OpenGL GLSL shader screen bitmap 2
**-glsl_shader_screen3**
Custom OpenGL GLSL shader screen bitmap 3
**-glsl_shader_screen4**
Custom OpenGL GLSL shader screen bitmap 4
**-glsl_shader_screen5**
Custom OpenGL GLSL shader screen bitmap 5
**-glsl_shader_screen6**
Custom OpenGL GLSL shader screen bitmap 6
**-glsl_shader_screen7**
Custom OpenGL GLSL shader screen bitmap 7
**-glsl_shader_screen8**
Custom OpenGL GLSL shader screen bitmap 8
**-glsl_shader_screen9**
Custom OpenGL GLSL shader screen bitmap 9
.. _mame-scommandline-glglslvidattr:
**-gl_glsl_vid_attr**
Enable OpenGL GLSL handling of brightness and contrast. Better RGB game performance. Default is *on*.
Per-window options
------------------
NOTE: **Multiple Screens may fail to work correctly on some Macintosh machines as of right now.**
| **-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 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.
|
|
| **-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.
|
|
| **-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. 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.
|
|
| **-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.
|
|
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 games, 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. The default is OFF (*-noswitchres*).
Sound options
-------------
**-sound** *<sdl|none>*
Specifies which sound subsystem to use. '*none*' disables sound altogether. The default is *sdl*.
**-audio_latency** *<value>*
This controls the amount of latency built into the audio streaming. By default MAME tries to keep the audio buffer between 1/5 and 2/5 full. On some systems, this is pushing it too close to the edge, and you get poor sound sometimes. The latency parameter controls the lower threshold. The default is *1* (meaning lower=1/5 and upper=2/5). Set it to 2 (**-audio_latency 2**) to keep the sound buffer between 2/5 and 3/5 full. If you crank it up to 4, you can *definitely* notice audio lag.
SDL Keyboard Mapping
--------------------
.. _mame-scommandline-keymap:
**-keymap**
Enable keymap. Default is OFF (*-nokeymap*)
.. _mame-scommandline-keymapfile:
**-keymap_file** *<file>*
Keymap Filename. Default is '*keymap.dat*'.
**-uimodekey** *<key>*
Key to toggle keyboard mode. Default is '*SCRLOCK*'
SDL Joystick Mapping
--------------------
**-joy_idx1** *<name>*
.. _mame-scommandline-joyidx:
Name of joystick mapped to joystick #1, default is *auto*.
|
| **-joy_idx1** *<name>*
| **-joy_idx2** *<name>*
| ...
| **-joy_idx8** *<name>*
|
**-joy_idx2** *<name>*
Name of joystick mapped to a given joystick slot, default is *auto*.
Name of joystick mapped to joystick #2, default is *auto*.
**-joy_idx3** *<name>*
Name of joystick mapped to joystick #3, default is *auto*.
**-joy_idx4** *<name>*
Name of joystick mapped to joystick #4, default is *auto*.
**-joy_idx5** *<name>*
Name of joystick mapped to joystick #5, default is *auto*.
**-joy_idx6** *<name>*
Name of joystick mapped to joystick #6, default is *auto*.
**-joy_idx7** *<name>*
Name of joystick mapped to joystick #7, default is *auto*.
**-joy_idx8** *<name>*
Name of joystick mapped to joystick #8, default is *auto*.
.. _mame-scommandline-sixaxis:
**-sixaxis**
Use special handling for PS3 Sixaxis controllers. Default is OFF (*-nosixaxis*)
Use special handling for PS3 SixAxis controllers. Default is OFF (*-nosixaxis*)
SDL Low-level Driver Options
~---------------------------
SDL Lowlevel driver options
---------------------------
.. _mame-scommandline-videodriver:
**-videodriver** *<driver>*
SDL video driver to use ('x11', 'directfb', ... or '*auto*' for SDL default)
.. _mame-scommandline-audiodriver:
**-audiodriver** *<driver>*
SDL audio driver to use ('alsa', 'arts', ... or '*auto*' for SDL default)
.. _mame-scommandline-gllib:
**-gl_lib** *<driver>*
Alternative **libGL.so** to use; '*auto*' for system default

154
docs/source/commandline/windowsconfig.rst
View File

@ -8,191 +8,69 @@ This section contains configuration options that are specific to the native (non
Debugging options
-----------------
**-[no]oslog**
Outputs the error.log data to the Windows debugger. This can be used at the same time as -log to output the log data to both targets as well. Default is OFF (*-nooslog*).
**-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 games 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-wcommandline-debuggerfont:
**-debugger_font** *<fontname>* / **-dfont** *<fontname>*
Specifies the name of the font to use for debugger windows. By default, the font is Lucida Console.
.. _mame-wcommandline-debuggerfontsize:
**-debugger_font_size** *<points>* / **-dfontsize** *<points>*
Specifies the size of the font to use for debugger windows, in points. By default, this is set to 9pt.
Performance options
-------------------
.. _mame-wcommandline-priority:
**-priority** *<priority>*
Sets the thread priority for the MAME threads. By default the priority is left alone to guarantee proper cooperation with other applications. The valid range is -15 to 1, with 1 being the highest priority. The default is *0* (*NORMAL priority*).
**-numprocessors** *<auto|value>* / **-np** *<auto|value>*
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-wcommandline-profile:
**-profile** *[n]*
Enables profiling, specifying the stack depth of *[n]* to track.
Enables profiling, specifying the stack depth of *[n]* to track.
**-bench** *[n]*
Benchmark for *[n]* number of emulated seconds; implies the command string:
**-str [n] -video none -sound none -nothrottle**
Video options
-------------
**-video** *<bgfx|gdi|d3d|none>*
Specifies which video subsystem to use for drawing. Using '*bgfx*' specifies the new hardware accelerated renderer. By specifying '*gdi*' here, you tell MAME to render video using older standard Windows graphics drawing calls. This is the slowest but most compatible option on older versions of Windows. Specifying '*d3d*' tells MAME to use Direct3D for rendering. This produces the highest quality output and enables all rendering options. It is recommended if you have a semi-recent (2002+) video card or onboard Intel video of the HD3000 line or better. The final option 'none' displays no windows and does no drawing. This is primarily present for doing CPU benchmarks without the overhead of the video system. The default is *d3d*.
**-numscreens** *<count>*
Tells MAME how many output windows to create. For most games, a single output window is all you need, but some games originally used multiple screens (*e.g. Darius, PlayChoice-10*). 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*.
**-[no]window** / **-[no]w**
Run MAME in either a window or full screen. The default is OFF (*-nowindow*).
**-[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 smallest supported size. This option only has an effect when the -window option is used. The default is ON (*-maximize*).
**-[no]keepaspect** / **-[no]ka**
Enables aspect ratio enforcement. When this option is on, the game's proper aspect ratio (generally 4:3 or 3:4) is enforced, so you get the game 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 games will stretch to the full screen size (even vertical games). In window mode, it means that you can freely resize the window without any constraints. The default is ON (*-keepaspect*).
The MAME team heavily suggests you leave this at default. Stretching games beyond their original aspect ratio will mangle the appearance of the game in ways that no filtering or HLSL can repair.
**-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 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*.
**-[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 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 games, 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*).
**-[no]syncrefresh**
Enables speed throttling only to the refresh of your monitor. This means that the game's actual refresh rate is ignored; however, the sound code still attempts to keep up with the game'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*).
Direct3D-specific options
-------------------------
**-[no]filter** / **-[no]d3dfilter** / **-[no]flt**
Enable bilinear filtering on the game 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*).
Per-window options
------------------
| **-screen** *<display>*
| **-screen0** *<display>*
| **-screen1** *<display>*
| **-screen2** *<display>*
| **-screen3** *<display>*
|
| Specifies which physical monitor on your system you wish to have each window use by default. In order to use multiple windows, you must have increased the value of the **-numscreens** option. The name of each display in your system can be determined by running MAME with the -verbose option. The display names are typically in the format of: *\\\\.\\DISPLAYn*, where 'n' is a number from 1 to the number of connected monitors. The default value for these options is '*auto*', which means that the first window is placed on the first display, the second window on the second display, etc.
|
| The **-screen0**, **-screen1**, **-screen2**, **-screen3** parameters apply to the specific window. The **-screen** parameter applies to all windows. The window-specific options override values from the all window option.
|
|
| **-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.
|
|
| **-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.
|
|
| **-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.
|
|
Full screen options
-------------------
.. _mame-wcommandline-triplebuffer:
**-[no]triplebuffer** / **-[no]tb**
Enables or disables "triple buffering". Normally, MAME just draws directly to the screen, without any fancy buffering. But with this option enabled, MAME creates three buffers to draw to, and cycles between them in order. It attempts to keep things flowing such that one buffer is currently displayed, the second buffer is waiting to be displayed, and the third buffer is being drawn to. **-triplebuffer** will override **-waitvsync**, if the buffer is successfully created. This option does not work with **-video gdi**. The default is OFF (*-notriplebuffer*).
**-[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 games, 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*).
.. _mame-wcommandline-fullscreenbrightness:
**-full_screen_brightness** *<value>* / **-fsb** *<value>*
Controls the brightness, or black level, of the entire display. 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. Note that not all video cards have hardware to support this option. This option does not work with **-video gdi**. The default is *1.0*.
.. _mame-wcommandline-fullscreencontrast:
**-full_screen_contrast** *<value>* / **-fsc** *<value>*
Controls the contrast, or white level, of the entire display. 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. Note that not all video cards have hardware to support this option. This option does not work with **-video gdi**. The default is *1.0*.
.. _mame-wcommandline-fullscreengamma:
**-full_screen_gamma** *<value>* / **-fsg** *<value>*
Controls the gamma, which produces a potentially nonlinear black to white ramp, for the entire display. 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. Note that not all video cards have hardware to support this option. This option does not work with **-video gdi**. The default is *1.0.*
Sound options
-------------
**-sound** *<dsound|sdl|none>*
Specifies which sound subsystem to use. '*none*' disables sound altogether. The default is *dsound*.
**-audio_latency** *<value>*
This controls the amount of latency built into the audio streaming. By default MAME tries to keep the DirectSound audio buffer between 1/5 and 2/5 full. On some systems, this is pushing it too close to the edge, and you get poor sound sometimes. The latency parameter controls the lower threshold. The default is *1* (meaning lower=1/5 and upper=2/5). Set it to 2 (**-audio_latency 2**) to keep the sound buffer between 2/5 and 3/5 full. If you crank it up to 4, you can *definitely* notice audio lag.
Input device options
--------------------
.. _mame-wcommandline-duallightgun:
**-[no]dual_lightgun** / **-[no]dual**
Controls whether or not MAME attempts to track two lightguns connected at the same time. This option requires -lightgun. This option is a hack for supporting certain older dual lightgun setups. If you have multiple lightguns connected, you will probably just need to enable -mouse and configure each lightgun independently. The default is *OFF* (*-nodual_lightgun*).