docs/windows.txt
| r4489 | r4490 | |
| 1 | This file describes Windows-specific usage information about MAME. It is |
| 2 | intended to cover aspects of using and configuring the program that are |
| 3 | specific to running MAME from the command line on a Windows-based system. |
| 4 | For common options that apply to all systems, please see config.txt. |
| 1 | 5 | |
| 2 | | Using the program |
| 3 | | ----------------- |
| 4 | 6 | |
| 5 | | The usual way to run MAME is by telling it to run a particular game: |
| 6 | 7 | |
| 7 | | mame <gamename> [options] |
| 8 | | |
| 9 | | For example: |
| 10 | | |
| 11 | | mame robby -nosound |
| 12 | | |
| 13 | | ...will run Robby Roto without sound. There are many, many options |
| 14 | | available. All currently supported options are listed below. |
| 15 | | |
| 16 | | An alternative way to run MAME is to give it a command: |
| 17 | | |
| 18 | | mame <command> [parameters] |
| 19 | | |
| 20 | | For example: |
| 21 | | |
| 22 | | mame -listsource gridlee |
| 23 | | |
| 24 | | ...will print the name of the source file where the gridlee driver lives to |
| 25 | | the screen. There are just a handful of these commands in MAME. They are |
| 26 | | all listed below, just before the options list. |
| 27 | | |
| 28 | | |
| 29 | | |
| 30 | 8 | Default Keys |
| 31 | 9 | ------------ |
| 32 | 10 | |
| 33 | | All the keys below are fully configurable in the user interface. This list |
| 34 | | shows the standard keyboard configuration. |
| 11 | In addition to the keys described in config.txt, the following additional |
| 12 | keys are defined for Windows versions of MAME: |
| 35 | 13 | |
| 36 | | Tab Toggles the configuration menu |
| 37 | | |
| 38 | | ~ Toggles the On Screen Display. Use the up and down arrow keys to |
| 39 | | select which parameter to modify (global volume, mixing level, |
| 40 | | gamma correction etc.) Use the left and right to arrow keys to |
| 41 | | change modify the value. Some parameters adjust with finer or |
| 42 | | coarser control if you hold down the CTRL or SHIFT keys while |
| 43 | | pressing the left/right arrows. Use the ENTER key to reset a value |
| 44 | | to its default. |
| 45 | 14 | |
| 46 | | P Pauses the game |
| 15 | Alt+Enter Toggles between full-screen and windowed mode. |
| 47 | 16 | |
| 48 | | SHIFT+P While paused, advances to next frame |
| 49 | 17 | |
| 50 | | F1 Toggle crosshairs for games that use them |
| 51 | 18 | |
| 52 | | F2 Service Mode |
| 19 | Windows debugging options |
| 20 | ------------------------- |
| 53 | 21 | |
| 54 | | F3 Resets the game |
| 55 | | |
| 56 | | F4 Shows the game palette, decoded GFX, and any tilemaps. Use the |
| 57 | | ENTER key to switch between the three modes (palette, graphics, |
| 58 | | and tilemaps). Press F4 again to turn off the display. The key |
| 59 | | controls in each mode vary slightly: |
| 60 | | |
| 61 | | * Palette/colortable mode: |
| 62 | | [ ] - switch between palette and colortable modes |
| 63 | | up/down - scroll up/down one line at a time |
| 64 | | pgup/pgdn - scroll up/down one page at a time |
| 65 | | home/end - move to top/bottom of list |
| 66 | | -/+ - increase/decrease the number of colors per row |
| 67 | | ENTER - switch to graphics viewer |
| 68 | | |
| 69 | | * Graphics mode: |
| 70 | | [ ] - switch between different graphics sets |
| 71 | | up/down - scroll up/down one line at a time |
| 72 | | pgup/pgdn - scroll up/down one page at a time |
| 73 | | home/end - move to top/bottom of list |
| 74 | | left/right - change color displayed |
| 75 | | R - rotate tiles 90 degrees clockwise |
| 76 | | -/+ - increase/decrease the number of tiles per row |
| 77 | | ENTER - switch to tilemap viewer |
| 78 | | |
| 79 | | * Tilemap mode: |
| 80 | | [ ] - switch between different tilemaps |
| 81 | | up/down/left/right - scroll 8 pixels at a time |
| 82 | | SHIFT+up/down/left/right - scroll 1 pixel at a time |
| 83 | | CTRL+up/down/left/right - scroll 64 pixels at a time |
| 84 | | R - rotate tilemap view 90 degrees clockwise |
| 85 | | -/+ - increase/decrease the zoom factor |
| 86 | | ENTER - switch to palette/colortable mode |
| 87 | | |
| 88 | | Note: Not all games have decoded graphics and/or tilemaps. |
| 89 | | |
| 90 | | F6 Toggle cheat mode (if started with "-cheat") |
| 91 | | |
| 92 | | F7 Load a save state. You will be requested to press a key to |
| 93 | | determine which save state you wish to load. Note that the save |
| 94 | | state feature is not supported for a large number of drivers. If |
| 95 | | support is not enabled for a given driver, you will receive a |
| 96 | | warning when attempting to save or load. |
| 97 | | |
| 98 | | SHIFT+F7 Create a save state. Requires an additional keypress to identify |
| 99 | | the state, similar to the load option above. |
| 100 | | |
| 101 | | F8 Decrease frame skip on the fly |
| 102 | | |
| 103 | | F9 Increase frame skip on the fly |
| 104 | | |
| 105 | | F10 Toggle speed throttling |
| 106 | | |
| 107 | | F11 Toggles speed display |
| 108 | | |
| 109 | | SHIFT+F11 Toggles profiler display (debug builds only) |
| 110 | | |
| 111 | | F12 Saves a screen snapshot. |
| 112 | | |
| 113 | | INSERT Fast forward. While held, runs the game with throttling disabled |
| 114 | | and with the maximum frameskip. |
| 115 | | |
| 116 | | ESC Exits emulator |
| 117 | | |
| 118 | | |
| 119 | | |
| 120 | | |
| 121 | | Core commands |
| 122 | | ------------- |
| 123 | | |
| 124 | | -help / -? |
| 125 | | |
| 126 | | Displays current MAME version and copyright notice. |
| 127 | | |
| 128 | | -validate / -valid |
| 129 | | |
| 130 | | Performs internal validation on every driver in the system. Run this |
| 131 | | before submitting changes to ensure that you haven't violated any of |
| 132 | | the core system rules. |
| 133 | | |
| 134 | | |
| 135 | | |
| 136 | | Configuration commands |
| 137 | | ---------------------- |
| 138 | | |
| 139 | | -createconfig / -cc |
| 140 | | |
| 141 | | Creates the default MAME.INI file. All the configuration options |
| 142 | | (not commands) described below can be permanently changed by editing |
| 143 | | this configuration file. |
| 144 | | |
| 145 | | -showconfig / -sc |
| 146 | | |
| 147 | | Displays the current configuration settings. If you route this to a |
| 148 | | file, you can use it as an INI file. For example, the command: |
| 149 | | |
| 150 | | mame -showconfig >mame.ini |
| 151 | | |
| 152 | | is equivalent to -createconfig. |
| 153 | | |
| 154 | | -showusage / -su |
| 155 | | |
| 156 | | Displays a summary of all the command line options. For options that |
| 157 | | are not mentioned here, the short summary given by "mame -showusage" is |
| 158 | | usually sufficient. |
| 159 | | |
| 160 | | |
| 161 | | |
| 162 | | Frontend commands |
| 163 | | ----------------- |
| 164 | | |
| 165 | | Note: By default, all the '-list' commands below write info to the screen. |
| 166 | | If you wish to write the info to a textfile instead, add this to the end of |
| 167 | | your command: |
| 168 | | |
| 169 | | > filename |
| 170 | | |
| 171 | | ...where 'filename' is the textfile's path and name (e.g., c:\mame\list.txt). |
| 172 | | |
| 173 | | -listxml / -lx [<gamename|wildcard>] |
| 174 | | |
| 175 | | List comprehensive details for all of the supported games. The output |
| 176 | | is quite long, so it is usually better to redirect this into a file. |
| 177 | | The output is in XML format. By default all games are listed; however, |
| 178 | | you can limit this list by specifying a driver name or wildcard after |
| 179 | | the -listxml command. |
| 180 | | |
| 181 | | -listfull / -ll [<gamename|wildcard>] |
| 182 | | |
| 183 | | Displays a list of game driver names and descriptions. By default all |
| 184 | | games are listed; however, you can limit this list by specifying a |
| 185 | | driver name or wildcard after the -listfull command. |
| 186 | | |
| 187 | | -listsource / -ls [<gamename|wildcard>] |
| 188 | | |
| 189 | | Displays a list of drivers and the names of the source files their game |
| 190 | | drivers live in. Useful for finding which driver a game runs on in |
| 191 | | order to fix bugs. By default all games are listed; however, you can |
| 192 | | limit this list by specifying a driver name or wildcard after the |
| 193 | | -listsource command. |
| 194 | | |
| 195 | | -listclones / -lc [<gamename|wildcard>] |
| 196 | | |
| 197 | | Displays a list of clones. By default all clones are listed; however, |
| 198 | | you can limit this list by specifying a driver name or wildcard after |
| 199 | | the -listsource command. |
| 200 | | |
| 201 | | -listcrc |
| 202 | | |
| 203 | | Displays a full list of CRCs of all ROM images referenced by all |
| 204 | | drivers within MAME. |
| 205 | | |
| 206 | | -listroms <gamename> |
| 207 | | |
| 208 | | Displays a list of ROM images referenced by the specified game. |
| 209 | | |
| 210 | | -listsamples <gamename> |
| 211 | | |
| 212 | | Displays a list of samples referenced by the specified game. |
| 213 | | |
| 214 | | -verifyroms [<gamename|wildcard>] |
| 215 | | |
| 216 | | Checks for invalid or missing ROM images. By default all drivers that |
| 217 | | have valid ZIP files or directories in the rompath are verified; |
| 218 | | however, you can limit this list by specifying a driver name or |
| 219 | | wildcard after the -verifyroms command. |
| 220 | | |
| 221 | | -verifysamples |
| 222 | | |
| 223 | | Checks for invalid or missing samples. By default all drivers that |
| 224 | | have valid ZIP files or directories in the samplepath are verified; |
| 225 | | however, you can limit this list by specifying a driver name or |
| 226 | | wildcard after the -verifyroms command. |
| 227 | | |
| 228 | | -romident |
| 229 | | |
| 230 | | Attempts to identify ROM files, if they are known to MAME, in the |
| 231 | | specified .zip file or directory. This command can be used to try and |
| 232 | | identify ROM sets taken from unknown boards. On exit, the errorlevel |
| 233 | | is returned as one of the following: |
| 234 | | |
| 235 | | 0: means all files were identified |
| 236 | | 1: means all files were identified except for 1 or more "non-ROM" |
| 237 | | files |
| 238 | | 2: means some files were identified |
| 239 | | 3: means no files were identified |
| 240 | | |
| 241 | | -isknown |
| 242 | | |
| 243 | | Very terse romident. The errorlevel is set the same as for -romident. |
| 244 | | |
| 245 | | |
| 246 | | |
| 247 | | Configuration options |
| 248 | | --------------------- |
| 249 | | |
| 250 | | -[no]readconfig / -[no]rc |
| 251 | | |
| 252 | | Enables or disables the reading of the config files. When enabled |
| 253 | | (which is the default), MAME reads the following config files in order: |
| 254 | | |
| 255 | | - mame.ini |
| 256 | | - <mymame>.ini (i.e. if MAME was renamed mame060.exe, MAME |
| 257 | | parses mame060.ini here) |
| 258 | | - mamed.ini (if this is a debug build, i.e. mamed.exe) |
| 259 | | - vector.ini (for vector games only) |
| 260 | | - <driver>.ini (based on the source filename of the driver) |
| 261 | | - <parent>.ini (for clones only, may be called recursively) |
| 262 | | - <gamename>.ini |
| 263 | | |
| 264 | | The settings in the later ini's override those in the earlier ini's. |
| 265 | | So, for example, if you wanted to disable overlay effects in the |
| 266 | | vector games, you can create a vector.ini with the "effect none" line |
| 267 | | in it, and it will override whatever effect value you have in your |
| 268 | | mame.ini. The default is ON (-readconfig). |
| 269 | | |
| 270 | | -[no]skip_gameinfo |
| 271 | | |
| 272 | | Forces MAME to skip displaying the game info screen. The default is OFF |
| 273 | | (-noskip_gameinfo). |
| 274 | | |
| 275 | | |
| 276 | | |
| 277 | | Core search path options |
| 278 | | ------------------------ |
| 279 | | |
| 280 | | IMPORTANT: Please use the path, directory and file options ONLY in mame.ini. |
| 281 | | Otherwise, the outcome may be unpredictable and not consistent across |
| 282 | | releases. |
| 283 | | |
| 284 | | -rompath / -rp |
| 285 | | |
| 286 | | Specifies a list of paths within which to find ROM or hard disk images. |
| 287 | | Multiple paths can be specified by separating them with semicolons. |
| 288 | | The default is 'roms' (that is, a directory "roms" in the same directory |
| 289 | | as the MAME executable). |
| 290 | | |
| 291 | | -samplepath / -sp |
| 292 | | |
| 293 | | Specifies a list of paths within which to find sample files. Multiple |
| 294 | | paths can be specified by separating them with semicolons. The default |
| 295 | | is 'samples' (that is, a directory "samples" in the same directory as |
| 296 | | the MAME executable). |
| 297 | | |
| 298 | | -artpath / -artwork_directory |
| 299 | | |
| 300 | | Specifies a list of paths within which to find artwork files. Multiple |
| 301 | | paths can be specified by separating them with semicolons. The default |
| 302 | | is 'artwork' (that is, a directory "artwork" in the same directory as |
| 303 | | the MAME executable). |
| 304 | | |
| 305 | | -ctrlrpath / -ctrlr_directory |
| 306 | | |
| 307 | | Specifies a list of paths within which to find controller-specific |
| 308 | | configuration files. Multiple paths can be specified by separating |
| 309 | | them with semicolons. The default is 'ctrlr' (that is, a directory |
| 310 | | "ctrlr" in the same directory as the MAME executable). |
| 311 | | |
| 312 | | -inipath |
| 313 | | |
| 314 | | Specifies a list of paths within which to find .INI files. Multiple |
| 315 | | paths can be specified by separating them with semicolons. The default |
| 316 | | is '.;ini' (that is, search in the current directory first, and then |
| 317 | | in the directory "ini" in the same directory as the MAME executable). |
| 318 | | |
| 319 | | -fontpath |
| 320 | | |
| 321 | | Specifies a list of paths within which to find .BDF font files. Multiple |
| 322 | | paths can be specified by separating them with semicolons. The default |
| 323 | | is '.' (that is, search in the same directory as the MAME executable). |
| 324 | | |
| 325 | | |
| 326 | | |
| 327 | | Core Output Directory Options |
| 328 | | ----------------------------- |
| 329 | | |
| 330 | | -cfg_directory |
| 331 | | |
| 332 | | Specifies a single directory where configuration files are stored. |
| 333 | | Configuration files store user configurable settings that are read at |
| 334 | | startup and written when MAME exits. The default is 'cfg' (that is, |
| 335 | | a directory "cfg" in the same directory as the MAME executable). If this |
| 336 | | directory does not exist, it will be automatically created. |
| 337 | | |
| 338 | | -nvram_directory |
| 339 | | |
| 340 | | Specifies a single directory where NVRAM files are stored. NVRAM files |
| 341 | | store the contents of EEPROM and non-volatile RAM (NVRAM) for games |
| 342 | | which used this type of hardware. This data is read at startup and |
| 343 | | written when MAME exits. The default is 'nvram' (that is, a directory |
| 344 | | "nvram" in the same directory as the MAME executable). If this directory |
| 345 | | does not exist, it will be automatically created. |
| 346 | | |
| 347 | | -memcard_directory |
| 348 | | |
| 349 | | Specifies a single directory where memory card files are stored. Memory |
| 350 | | card files store the contents of removable memory cards for games which |
| 351 | | used this type of hardware. This data is read and written under control |
| 352 | | of the user via the "Memory Card" menu in the user interface. The |
| 353 | | default is 'memcard' (that is, a directory "memcard" in the same |
| 354 | | directory as the MAME executable). If this directory does not exist, |
| 355 | | it will be automatically created. |
| 356 | | |
| 357 | | -input_directory |
| 358 | | |
| 359 | | Specifies a single directory where input recording files are stored. |
| 360 | | Input recordings are created via the -record option and played back via |
| 361 | | the -playback option. The default is 'inp' (that is, a directory |
| 362 | | "inp" in the same directory as the MAME executable). If this directory |
| 363 | | does not exist, it will be automatically created. |
| 364 | | |
| 365 | | -state_directory |
| 366 | | |
| 367 | | Specifies a single directory where save state files are stored. Save |
| 368 | | state files are read and written either upon user request, or when using |
| 369 | | the -autosave option. The default is 'sta' (that is, a directory "sta" |
| 370 | | in the same directory as the MAME executable). If this directory does |
| 371 | | not exist, it will be automatically created. |
| 372 | | |
| 373 | | -snapshot_directory |
| 374 | | |
| 375 | | Specifies a single directory where screen snapshots are stored, when |
| 376 | | requested by the user. The default is 'snap' (that is, a directory |
| 377 | | "snap" in the same directory as the MAME executable). If this directory |
| 378 | | does not exist, it will be automatically created. |
| 379 | | |
| 380 | | -diff_directory |
| 381 | | |
| 382 | | Specifies a single directory where hard drive differencing files are |
| 383 | | stored. Hard drive differencing files store any data that is written |
| 384 | | back to a hard disk image, in order to preserve the original image. The |
| 385 | | differencing files are created at startup when a game with a hard disk |
| 386 | | image. The default is 'diff' (that is, a directory "diff" in the same |
| 387 | | directory as the MAME executable). If this directory does not exist, |
| 388 | | it will be automatically created. |
| 389 | | |
| 390 | | -comment_directory |
| 391 | | |
| 392 | | Specifies a single directory where debugger comment files are stored. |
| 393 | | Debugger comment files are written by the debugger when comments are |
| 394 | | added to the disassembly for a game. The default is 'comments' (that is, |
| 395 | | a directory "comments" in the same directory as the MAME executable). |
| 396 | | If this directory does not exist, it will be automatically created. |
| 397 | | |
| 398 | | |
| 399 | | |
| 400 | | Core Filename Options |
| 401 | | --------------------- |
| 402 | | |
| 403 | | -cheat_file |
| 404 | | |
| 405 | | Specifies the name of the cheat database file. The default is |
| 406 | | 'cheat.dat'. |
| 407 | | |
| 408 | | |
| 409 | | |
| 410 | | Misc options |
| 411 | | ------------ |
| 412 | | |
| 413 | | -bios <biosname> |
| 414 | | |
| 415 | | Specifies the specific BIOS to use with the current game, for game |
| 416 | | systems that make use of a BIOS. The -listxml output will list all of |
| 417 | | the possible BIOS names for a game. The default is 'default'. |
| 418 | | |
| 419 | | -[no]cheat / -[no]c |
| 420 | | |
| 421 | | Enables the reading of the cheat database, if present, and the Cheat |
| 422 | | menu in the user interface. The default is OFF (-nocheat). |
| 423 | | |
| 424 | | |
| 425 | | |
| 426 | | State/playback options |
| 427 | | ---------------------- |
| 428 | | |
| 429 | | -state <slot> |
| 430 | | |
| 431 | | Immediately after starting the specified game, will cause the save |
| 432 | | state in the specified <slot> to be loaded. |
| 433 | | |
| 434 | | -[no]autosave |
| 435 | | |
| 436 | | When enabled, automatically creates a save state file when exiting MAME |
| 437 | | and automatically attempts to reload it when later starting MAME with |
| 438 | | the same game. This only works for games that have explicitly enabled |
| 439 | | save state support in their driver. The default is OFF (-noautosave). |
| 440 | | |
| 441 | | -playback / -pb <filename> |
| 442 | | |
| 443 | | Specifies a file from which to play back a series of game inputs. This |
| 444 | | feature does not work reliably for all games, but can be used to watch |
| 445 | | a previously recorded game session from start to finish. In order to |
| 446 | | make things consistent, you should only record and playback with all |
| 447 | | configuration (.cfg), NVRAM (.nv), and memory card files deleted. The |
| 448 | | default is NULL (no playback). |
| 449 | | |
| 450 | | -record / -rec <filename> |
| 451 | | |
| 452 | | Specifies a file to record all input from a game session. This can be |
| 453 | | used to record a game session for later playback. This feature does not |
| 454 | | work reliably for all games, but can be used to watch a previously |
| 455 | | recorded game session from start to finish. In order to make things |
| 456 | | consistent, you should only record and playback with all configuration |
| 457 | | (.cfg), NVRAM (.nv), and memory card files deleted. The default is NULL |
| 458 | | (no recording). |
| 459 | | |
| 460 | | -mngwrite <filename> |
| 461 | | |
| 462 | | Writes each video frame to the given <filename> in MNG format, producing |
| 463 | | an animation of the game session. Note that -mngwrite only writes video |
| 464 | | frames; it does not save any audio data. Use -wavwrite for that, and |
| 465 | | reassemble the audio/video using offline tools. The default is NULL (no |
| 466 | | recording). |
| 467 | | |
| 468 | | -wavwrite <filename> |
| 469 | | |
| 470 | | Writes the final mixer output to the given <filename> in WAV format, |
| 471 | | producing an audio recording of the game session. The default is NULL |
| 472 | | (no recording). |
| 473 | | |
| 474 | | |
| 475 | | |
| 476 | | Debugging options |
| 477 | | ----------------- |
| 478 | | |
| 479 | | -[no]log |
| 480 | | |
| 481 | | Creates a file called error.log which contains all of the internal |
| 482 | | log messages generated by the MAME core and game drivers. The default |
| 483 | | is OFF (-nolog). |
| 484 | | |
| 485 | 22 | -[no]oslog |
| 486 | 23 | |
| 487 | 24 | Outputs the error.log data to the Windows debugger. This can be used at |
| 488 | 25 | the same time as -log to output the log data to both targets as well. |
| 489 | 26 | Default is OFF (-nooslog). |
| 490 | 27 | |
| 491 | | -[no]verbose / -[no]v |
| 492 | 28 | |
| 493 | | Displays internal diagnostic information. This information is very |
| 494 | | useful for debugging problems with your configuration. IMPORTANT: when |
| 495 | | reporting bugs, please run with mame -verbose and include the resulting |
| 496 | | information. The default is off (-noverbose) |
| 497 | 29 | |
| 498 | | -[no]debug |
| 30 | Windows performance options |
| 31 | --------------------------- |
| 499 | 32 | |
| 500 | | Activates the integrated debugger. This is available only if the program |
| 501 | | is compiled with MAME_DEBUG defined. By default, the debugger is |
| 502 | | entered by pressing the tilde (~) key during emulation. It is also |
| 503 | | entered immediately at startup. The default is OFF (-nodebug). |
| 504 | | |
| 505 | | -debugscript <filename> |
| 506 | | |
| 507 | | Specifies a file that contains a list of debugger commands to execute |
| 508 | | immediately upon startup. The default is NULL (no commands). |
| 509 | | |
| 510 | | |
| 511 | | |
| 512 | | Perormance options |
| 513 | | ------------------ |
| 514 | | |
| 515 | | -[no]autoframeskip / -[no]afs |
| 516 | | |
| 517 | | Automatically determines the frameskip level while you're playing the |
| 518 | | game, adjusting it constantly in a frantic attempt to keep the game |
| 519 | | running at full speed. Turning this on overrides the value you have set |
| 520 | | for -frameskip below. The default is OFF (-noautoframeskip). |
| 521 | | |
| 522 | | -frameskip / -fs |
| 523 | | |
| 524 | | Specifies the frameskip value. This is the number of frames out of |
| 525 | | every 12 to drop when running. For example, if you say -frameskip 2, |
| 526 | | then MAME will display 10 out of every 12 frames. By skipping those |
| 527 | | frames, you may be able to get full speed in a game that requires more |
| 528 | | horsepower than your computer has. The default value is -frameskip 0, |
| 529 | | which skips no frames. |
| 530 | | |
| 531 | | -frames_to_run / -ftr |
| 532 | | |
| 533 | | This option can be used for benchmarking and automated testing. It tells |
| 534 | | MAME to stop execution after a fixed number of frames. By combining |
| 535 | | this with a fixed set of other command line options, you can set up a |
| 536 | | consistent environment for benchmarking MAME performance. In addition, |
| 537 | | upon exit, the -ftr option will write a screenshot called |
| 538 | | _<gamename>.png to the snapshot directory. |
| 539 | | |
| 540 | | -[no]throttle |
| 541 | | |
| 542 | | Configures the default thottling setting. When throttling is on, MAME |
| 543 | | attempts to keep the game running at the game's intended speed. When |
| 544 | | throttling is off, MAME runs the game as fast as it can. Note that the |
| 545 | | fastest speed is more often than not limited by your graphics card, |
| 546 | | especially for older games. The default is ON (-throttle). |
| 547 | | |
| 548 | | -[no]sleep |
| 549 | | |
| 550 | | Allows MAME to give time back to the system when running with -throttle. |
| 551 | | This allows other programs to have some CPU time, assuming that the |
| 552 | | game isn't taxing 100% of your CPU resources. This option can |
| 553 | | potentially cause hiccups in performance if other demanding programs |
| 554 | | are running. The default is ON (-sleep). |
| 555 | | |
| 556 | | -[no]rdtsc |
| 557 | | |
| 558 | | Specifies that MAME should use RDTSC for timing. RDTSC is very fast but |
| 559 | | unfortunately rather inaccurate on many modern CPUs that dynamically |
| 560 | | change clock speeds to conserve power. By default, MAME uses the |
| 561 | | Windows function QueryPerformanceCounter for timing. The default is |
| 562 | | OFF (-nordtsc). |
| 563 | | |
| 564 | 33 | -priority <priority> |
| 565 | 34 | |
| 566 | 35 | Sets the thread priority for the MAME threads. By default the priority |
| 567 | | is left alone to guarantee proper cooperation with other applications. |
| 568 | | The valid range is -15 to 1, with 1 being the highest priority. The |
| 36 | is left alone to guarantee proper cooperation with other applications. |
| 37 | The valid range is -15 to 1, with 1 being the highest priority. The |
| 569 | 38 | default is 0 (NORMAL priority). |
| 570 | 39 | |
| 571 | 40 | -[no]multithreading / -[no]mt |
| 572 | 41 | |
| 573 | | Enables multithreading within MAME. At the moment, this causes the window |
| 574 | | and all DirectDraw/Direct3D code to execute on a second thread, which |
| 575 | | can improve performance on hyperthreaded and multicore systems. Consider |
| 576 | | this switch experimental for the moment. The default is OFF |
| 577 | | (-nomultithreading). |
| 42 | Enables multithreading within MAME. At the moment, this causes the |
| 43 | window and all DirectDraw/Direct3D code to execute on a second thread, |
| 44 | which can improve performance on hyperthreaded and multicore systems. |
| 45 | The default is OFF (-nomultithreading). |
| 578 | 46 | |
| 579 | 47 | |
| 580 | 48 | |
| 581 | | Video options |
| 582 | | ------------- |
| 49 | Windows video options |
| 50 | --------------------- |
| 583 | 51 | |
| 584 | 52 | -video <gdi|ddraw|d3d|none> |
| 585 | 53 | |
| 586 | 54 | Specifies which video subsystem to use for drawing. By specifying 'gdi' |
| 587 | 55 | here, you tell MAME to render video using standard Windows graphics |
| 588 | | drawing calls. This is the slowest but most compatible option. |
| 589 | | Specifying 'ddraw' instructs MAME to use DirectDraw for rendering. This |
| 590 | | causes MAME to render everything at a lower resolution and then upscale |
| 591 | | the results at the end. This produces high performance, especially on |
| 592 | | older or low-power video cards, but has a noticeably lower output |
| 593 | | quality. Specifying 'd3d' tells MAME to use Direct3D for rendering. This |
| 594 | | produces the highest quality output and enables all rendering options. |
| 595 | | It is recommended if you have a recent (2002+) video card. The final |
| 596 | | option 'none' displays no windows and does no drawing. This is primarily |
| 597 | | present for doing CPU benchmarks without the overhead of the video |
| 598 | | system. The default is d3d. |
| 599 | | |
| 56 | drawing calls. This is the slowest but most compatible option. |
| 57 | Specifying 'ddraw' instructs MAME to use DirectDraw for rendering. |
| 58 | This causes MAME to render everything at a lower resolution and then |
| 59 | upscale the results at the end. This produces high performance, |
| 60 | especially on older or low-power video cards, but has a noticeably |
| 61 | lower output quality. Specifying 'd3d' tells MAME to use Direct3D for |
| 62 | rendering. This produces the highest quality output and enables all |
| 63 | rendering options. It is recommended if you have a recent (2002+) |
| 64 | video card. The final option 'none' displays no windows and does no |
| 65 | drawing. This is primarily present for doing CPU benchmarks without |
| 66 | the overhead of the video system. The default is d3d. |
| 67 | |
| 600 | 68 | -numscreens <count> |
| 601 | 69 | |
| 602 | 70 | Tells MAME how many output windows to create. For most games, a single |
| r4489 | r4490 | |
| 604 | 72 | screens. Each screen (up to 4) has its own independent settings for |
| 605 | 73 | physical monitor, aspect ratio, resolution, and view, which can be |
| 606 | 74 | set using the options below. The default is 1. |
| 607 | | |
| 75 | |
| 608 | 76 | -[no]window |
| 609 | 77 | |
| 610 | 78 | Run MAME in either a window or full screen. The default is OFF |
| r4489 | r4490 | |
| 615 | 83 | Controls initial window size in windowed mode. If it is set on, the |
| 616 | 84 | window will initially be set to the maximum supported size when you |
| 617 | 85 | start MAME. If it is turned off, the window will start out at the |
| 618 | | smallest supported size. This option only has an effect when the |
| 86 | smallest supported size. This option only has an effect when the |
| 619 | 87 | -window option is used. The default is ON (-maximize). |
| 620 | 88 | |
| 621 | 89 | -[no]keepaspect / -[no]ka |
| r4489 | r4490 | |
| 638 | 106 | settings, the screen is expanded by a factor of <amount> before being |
| 639 | 107 | scaled. With -video ddraw or -video d3d, this produces a less blurry |
| 640 | 108 | image at the expense of some speed. In -video ddraw mode, this also |
| 641 | | increases the effective resolution of non-screen elements such as |
| 109 | increases the effective resolution of non-screen elements such as |
| 642 | 110 | artwork and fonts. The default is 1. |
| 643 | 111 | |
| 644 | 112 | -effect <filename> |
| 645 | 113 | |
| 646 | 114 | Specifies a single PNG file that is used as an overlay over any game |
| 647 | 115 | screens in the video display. This PNG file is assumed to live in the |
| 648 | | root of one of the artpath directories. The pattern in the PNG file is |
| 649 | | repeated both horizontally and vertically to cover the entire game |
| 116 | root of one of the artpath directories. The pattern in the PNG file is |
| 117 | repeated both horizontally and vertically to cover the entire game |
| 650 | 118 | screen areas (but not any external artwork), and is rendered at |
| 651 | 119 | the target resolution of the game image. For -video gdi and -video d3d |
| 652 | 120 | modes, this means that one pixel in the PNG will map to one pixel on |
| r4489 | r4490 | |
| 655 | 123 | use an effect that requires mapping n PNG pixels to each game screen |
| 656 | 124 | pixel with -video ddraw, you need to specify a -prescale factor of n as |
| 657 | 125 | well. The RGB values of each pixel in the PNG are multiplied against the |
| 658 | | RGB values of the target screen. The default is 'none', meaning no |
| 126 | RGB values of the target screen. The default is 'none', meaning no |
| 659 | 127 | effect. |
| 660 | 128 | |
| 661 | | -pause_brightness |
| 662 | | |
| 663 | | This controls the brightness level when MAME is paused. The default |
| 664 | | value is 0.65. |
| 665 | | |
| 666 | 129 | -[no]waitvsync |
| 667 | 130 | |
| 668 | 131 | Waits for the refresh period on your computer's monitor to finish |
| r4489 | r4490 | |
| 675 | 138 | your CPU cycles waiting for the proper time to draw, so you will see a |
| 676 | 139 | performance hit. You should only need to turn this on in windowed mode. |
| 677 | 140 | In full screen mode, it is only needed if -triplebuffer does not |
| 678 | | remove the tearing, in which case you should use -notriplebuffer |
| 141 | remove the tearing, in which case you should use -notriplebuffer |
| 679 | 142 | -waitvsync. Note that this option does not work with -video gdi mode. |
| 680 | 143 | The default is OFF (-nowaitvsync). |
| 681 | 144 | |
| r4489 | r4490 | |
| 684 | 147 | Enables speed throttling only to the refresh of your monitor. This |
| 685 | 148 | means that the game's actual refresh rate is ignored; however, the |
| 686 | 149 | sound code still attempts to keep up with the game's original refresh |
| 687 | | rate, so you may encounter sound problems. This option is intended |
| 150 | rate, so you may encounter sound problems. This option is intended |
| 688 | 151 | mainly for those who have tweaked their video card's settings to |
| 689 | | provide carefully matched refresh rate options. Note that this option |
| 152 | provide carefully matched refresh rate options. Note that this option |
| 690 | 153 | does not work with -video gdi mode.The default is OFF (-nosyncrefresh). |
| 691 | 154 | |
| 692 | 155 | |
| 693 | 156 | |
| 694 | | Video rotation options |
| 695 | | ---------------------- |
| 696 | | |
| 697 | | -[no]rotate |
| 698 | | |
| 699 | | Rotate the game to match its normal state (horizontal/vertical). This |
| 700 | | ensures that both vertically and horizontally oriented games show up |
| 701 | | correctly without the need to rotate your monitor. If you want to keep |
| 702 | | the game displaying 'raw' on the screen the way it would have in the |
| 703 | | arcade, turn this option OFF. The default is ON (-rotate). |
| 704 | | |
| 705 | | -[no]ror |
| 706 | | -[no]rol |
| 707 | | |
| 708 | | Rotate the game screen to the right (clockwise) or left (counter- |
| 709 | | clockwise) relative to either its normal state (if -rotate is specified) |
| 710 | | or its native state (if -norotate is specified). The default for both of |
| 711 | | these options is OFF (-noror -norol). |
| 712 | | |
| 713 | | -[no]flipx |
| 714 | | -[no]flipy |
| 715 | | |
| 716 | | Flip (mirror) the game screen either horizontally (-flipx) or |
| 717 | | vertically (-flipy). The flips are applied after the -rotate and |
| 718 | | -ror/-rol options are applied. The default for both of these options |
| 719 | | is OFF (-noflipx -noflipy). |
| 720 | | |
| 721 | | -[no]autoror |
| 722 | | -[no]autorol |
| 723 | | |
| 724 | | These options are designed for use with pivoting screens that only |
| 725 | | pivot in a single direction. If your screen only pivots clockwise, |
| 726 | | use -autorol to ensure that the game will fill the screen either |
| 727 | | horizontally or vertically in one of the directions you can handle. |
| 728 | | If your screen only pivots counter-clockwise, use -autoror. |
| 729 | | |
| 730 | | |
| 731 | | |
| 732 | 157 | DirectDraw-specific options |
| 733 | 158 | --------------------------- |
| 734 | 159 | |
| 735 | 160 | -[no]hwstretch / -[no]hws |
| 736 | 161 | |
| 737 | 162 | When enabled, MAME uses the hardware stretching abilities of your |
| 738 | | video card to scale the game image and associated artwork to the |
| 739 | | target resolution. Depending on the quality of your graphic card and |
| 740 | | its drivers, this may be a fractional, antialiased scaling (nice) or |
| 163 | video card to scale the game image and associated artwork to the |
| 164 | target resolution. Depending on the quality of your graphic card and |
| 165 | its drivers, this may be a fractional, antialiased scaling (nice) or |
| 741 | 166 | an integer, blocky scaling (not so nice), in which case you might want |
| 742 | 167 | to disable this option. In addition, if you have configured specific |
| 743 | 168 | arcade-like video modes for MAME and don't want MAME to perform any |
| r4489 | r4490 | |
| 779 | 204 | |
| 780 | 205 | Specifies which physical monitor on your system you wish to have each |
| 781 | 206 | window use by default. In order to use multiple windows, you must have |
| 782 | | increased the value of the -numscreens option. The name of each display |
| 783 | | in your system can be determined by running MAME with the -verbose |
| 784 | | option. The display names are typically in the format of: \\.\DISPLAYn, |
| 785 | | where 'n' is a number from 1 to the number of connected monitors. |
| 786 | | The default value for these options is 'auto', which means that the |
| 787 | | first window is placed on the first display, the second window on the |
| 788 | | second display, etc. |
| 789 | | |
| 207 | increased the value of the -numscreens option. The name of each |
| 208 | display in your system can be determined by running MAME with the |
| 209 | -verbose option. The display names are typically in the format of: |
| 210 | \\.\DISPLAYn, where 'n' is a number from 1 to the number of connected |
| 211 | monitors. The default value for these options is 'auto', which means |
| 212 | that the first window is placed on the first display, the second |
| 213 | window on the second display, etc. |
| 214 | |
| 790 | 215 | The -screen0, -screen1, -screen2, -screen3 parameters apply to the |
| 791 | 216 | specific window. The -screen parameter applies to all windows. The |
| 792 | 217 | window-specific options override values from the all window option. |
| r4489 | r4490 | |
| 798 | 223 | -aspect3 <width:height> |
| 799 | 224 | |
| 800 | 225 | Specifies the physical aspect ratio of the physical monitor for each |
| 801 | | window. In order to use multiple windows, you must have increased the |
| 226 | window. In order to use multiple windows, you must have increased the |
| 802 | 227 | value of the -numscreens option. The physical aspect ratio can be |
| 803 | | determined by measuring the width and height of the visible screen |
| 228 | determined by measuring the width and height of the visible screen |
| 804 | 229 | image and specifying them separated by a colon. The default value for |
| 805 | | these options is 'auto', which means that MAME assumes the aspect ratio |
| 806 | | is proportional to the number of pixels in the desktop video mode for |
| 807 | | each monitor. |
| 808 | | |
| 230 | these options is 'auto', which means that MAME assumes the aspect |
| 231 | ratio is proportional to the number of pixels in the desktop video |
| 232 | mode for each monitor. |
| 233 | |
| 809 | 234 | The -aspect0, -aspect1, -aspect2, -aspect3 parameters apply to the |
| 810 | 235 | specific window. The -aspect parameter applies to all windows. The |
| 811 | 236 | window-specific options override values from the all window option. |
| 812 | | |
| 237 | |
| 813 | 238 | -resolution <widthxheight[@refresh]> / -r <widthxheight[@refresh]> |
| 814 | 239 | -resolution0 <widthxheight[@refresh]> / -r0 <widthxheight[@refresh]> |
| 815 | 240 | -resolution1 <widthxheight[@refresh]> / -r1 <widthxheight[@refresh]> |
| 816 | 241 | -resolution2 <widthxheight[@refresh]> / -r2 <widthxheight[@refresh]> |
| 817 | 242 | -resolution3 <widthxheight[@refresh]> / -r3 <widthxheight[@refresh]> |
| 818 | 243 | |
| 819 | | Specifies an exact resolution to run in. In full screen mode, MAME will |
| 820 | | try to use the specific resolution you request. The width and |
| 244 | Specifies an exact resolution to run in. In full screen mode, MAME |
| 245 | will try to use the specific resolution you request. The width and |
| 821 | 246 | height are required; the refresh rate is optional. If omitted or |
| 822 | 247 | set to 0, MAME will determine the mode auomatically. For example, |
| 823 | 248 | -resolution 640x480 will force 640x480 resolution, but MAME is free to |
| 824 | 249 | choose the refresh rate. Similarly, -resolution 0x0@60 will force a |
| 825 | | 60Hz refresh rate, but allows MAME to choose the resolution. The string |
| 826 | | "auto" is also supported, and is equivalent to 0x0@0. In window mode, |
| 827 | | this resolution is used as a maximum size for the window. This option |
| 828 | | requires the -switchres option as well in order to actually enable |
| 829 | | resolution switching with -video ddraw or -video d3d. The default |
| 830 | | value for these options is 'auto'. |
| 831 | | |
| 832 | | The -resolution0, -resolution1, -resolution2, -resolution3 parameters |
| 250 | 60Hz refresh rate, but allows MAME to choose the resolution. The |
| 251 | string "auto" is also supported, and is equivalent to 0x0@0. In window |
| 252 | mode, this resolution is used as a maximum size for the window. This |
| 253 | option requires the -switchres option as well in order to actually |
| 254 | enable resolution switching with -video ddraw or -video d3d. The |
| 255 | default value for these options is 'auto'. |
| 256 | |
| 257 | The -resolution0, -resolution1, -resolution2, -resolution3 parameters |
| 833 | 258 | apply to the specific window. The -resolution parameter applies to all |
| 834 | | windows. The window-specific options override values from the all |
| 259 | windows. The window-specific options override values from the all |
| 835 | 260 | window option. |
| 836 | 261 | |
| 837 | 262 | -view <viewname> |
| 838 | | -view0 <viewname> |
| 263 | -view0 <viewname> |
| 839 | 264 | -view1 <viewname> |
| 840 | 265 | -view2 <viewname> |
| 841 | 266 | -view3 <viewname> |
| 842 | 267 | |
| 843 | | Specifies the initial view setting for each window. The <viewname> does |
| 844 | | not need to be a perfect match; rather, it will select the first view |
| 845 | | whose name matches all the characters specified by <viewname>. For |
| 846 | | example, -view native will match the "Native (15:14)" view even though |
| 847 | | it is not a perfect match. The value 'auto' is also supported, and |
| 848 | | requests that MAME perform a default selection. The default value for |
| 849 | | these options is 'auto'. |
| 850 | | |
| 268 | Specifies the initial view setting for each window. The <viewname> |
| 269 | does not need to be a perfect match; rather, it will select the first |
| 270 | view whose name matches all the characters specified by <viewname>. |
| 271 | For example, -view native will match the "Native (15:14)" view even |
| 272 | though it is not a perfect match. The value 'auto' is also supported, |
| 273 | and requests that MAME perform a default selection. The default value |
| 274 | for these options is 'auto'. |
| 275 | |
| 851 | 276 | The -view0, -view1, -view2, -view3 parameters apply to the |
| 852 | 277 | specific window. The -view parameter applies to all windows. The |
| 853 | 278 | window-specific options override values from the all window option. |
| r4489 | r4490 | |
| 864 | 289 | option enabled, MAME creates three buffers to draw to, and cycles |
| 865 | 290 | between them in order. It attempts to keep things flowing such that one |
| 866 | 291 | buffer is currently displayed, the second buffer is waiting to be |
| 867 | | displayed, and the third buffer is being drawn to. -triplebuffer will |
| 292 | displayed, and the third buffer is being drawn to. -triplebuffer will |
| 868 | 293 | override -waitvsync, if the buffer is sucessfully created. This option |
| 869 | 294 | does not work with -video gdi. The default is OFF (-notriplebuffer). |
| 870 | 295 | |
| r4489 | r4490 | |
| 874 | 299 | -resolution* options to switch resolutions in full screen mode. On |
| 875 | 300 | modern video cards, there is little reason to switch resolutions unless |
| 876 | 301 | you are trying to achieve the "exact" pixel resolutions of the original |
| 877 | | games, which requires significant tweaking. This option is also useful |
| 302 | games, which requires significant tweaking. This option is also useful |
| 878 | 303 | on LCD displays, since they run with a fixed resolution and switching |
| 879 | 304 | resolutions on them is just silly. This option does not work with |
| 880 | 305 | -video gdi. The default is OFF (-noswitchres). |
| r4489 | r4490 | |
| 893 | 318 | Controls the contrast, or white level, of the entire display. The |
| 894 | 319 | standard value is 1.0. Selecting lower values (down to 0.1) will produce |
| 895 | 320 | a dimmer display, while selecting higher values (up to 2.0) will |
| 896 | | give a more saturated display. Note that not all video cards have |
| 897 | | hardware to support this option. This option does not work with |
| 321 | give a more saturated display. Note that not all video cards have |
| 322 | hardware to support this option. This option does not work with |
| 898 | 323 | -video gdi. The default is 1.0. |
| 899 | 324 | |
| 900 | 325 | -full_screen_gamma / -fsg <value> |
| 901 | 326 | |
| 902 | 327 | Controls the gamma, which produces a potentially nonlinear black to |
| 903 | | white ramp, for the entire display. The standard value is 1.0, which |
| 904 | | gives a linear ramp from black to white. Selecting lower values (down |
| 905 | | to 0.1) will increase the nonlinearity toward black, while selecting |
| 906 | | higher values (up to 3.0) will push the nonlinearity toward white. Note |
| 907 | | that not all video cards have hardware to support this option. This |
| 328 | white ramp, for the entire display. The standard value is 1.0, which |
| 329 | gives a linear ramp from black to white. Selecting lower values (down |
| 330 | to 0.1) will increase the nonlinearity toward black, while selecting |
| 331 | higher values (up to 3.0) will push the nonlinearity toward white. Note |
| 332 | that not all video cards have hardware to support this option. This |
| 908 | 333 | option does not work with -video gdi. The default is 1.0. |
| 909 | 334 | |
| 910 | 335 | |
| 911 | 336 | |
| 912 | | Game screen options |
| 913 | | ------------------- |
| 337 | Windows sound options |
| 338 | --------------------- |
| 914 | 339 | |
| 915 | | -brightness <value> |
| 916 | | |
| 917 | | Controls the default brightness, or black level, of the game screens. |
| 918 | | This option does not affect the artwork or other parts of the display. |
| 919 | | Using the MAME UI, you can individually set the brightness for each game |
| 920 | | screen; this option controls the initial value for all visible game |
| 921 | | screens. The standard value is 1.0. Selecting lower values (down to 0.1) |
| 922 | | will produce a darkened display, while selecting higher values (up to |
| 923 | | 2.0) will give a brighter display. The default is 1.0. |
| 924 | | |
| 925 | | -contrast <value> |
| 926 | | |
| 927 | | Controls the contrast, or white level, of the game screens. This option |
| 928 | | does not affect the artwork or other parts of the display. Using the |
| 929 | | MAME UI, you can individually set the contrast for each game screen; |
| 930 | | this option controls the initial value for all visible game screens. The |
| 931 | | standard value is 1.0. Selecting lower values (down to 0.1) will produce |
| 932 | | a dimmer display, while selecting higher values (up to 2.0) will |
| 933 | | give a more saturated display. The default is 1.0. |
| 934 | | |
| 935 | | -gamma <value> |
| 936 | | |
| 937 | | Controls the gamma, which produces a potentially nonlinear black to |
| 938 | | white ramp, for the game screens. This option does not affect the |
| 939 | | artwork or other parts of the display. Using the MAME UI, you can |
| 940 | | individually set the gamma for each game screen; this option controls |
| 941 | | the initial value for all visible game screens. The standard value is |
| 942 | | 1.0, which gives a linear ramp from black to white. Selecting lower |
| 943 | | values (down to 0.1) will increase the nonlinearity toward black, |
| 944 | | while selecting higher values (up to 3.0) will push the nonlinearity |
| 945 | | toward white. The default is 1.0. |
| 946 | | |
| 947 | | |
| 948 | | |
| 949 | | Vector rendering options |
| 950 | | ------------------------ |
| 951 | | |
| 952 | | -[no]antialias / -[no]aa |
| 953 | | |
| 954 | | Enables antialiased line rendering for vector games. The default is ON |
| 955 | | (-antialias). |
| 956 | | |
| 957 | | -beam <width> |
| 958 | | |
| 959 | | Sets the width of the vectors. This is a scaling factor against the |
| 960 | | standard vector width. A value of 1.0 will keep the default vector line |
| 961 | | width. Smaller values will reduce the width, and larger values will |
| 962 | | increase the width. The default is 1.0. |
| 963 | | |
| 964 | | -flicker <value> |
| 965 | | |
| 966 | | Simulates a vector "flicker" effect, similar to a vector monitor that |
| 967 | | needs adjustment. This option requires a float argument in the range of |
| 968 | | 0.00 - 100.00 (0=none, 100=maximum). The default is 0. |
| 969 | | |
| 970 | | |
| 971 | | |
| 972 | | Artwork options |
| 973 | | --------------- |
| 974 | | |
| 975 | | -[no]artwork_crop / -[no]artcrop |
| 976 | | |
| 977 | | Enable cropping of artwork to the game screen area only. This works |
| 978 | | best with -video gdi or -video d3d, and means that vertically oriented |
| 979 | | games running full screen can display their artwork to the left and |
| 980 | | right sides of the screen. This does not work with -video ddraw because |
| 981 | | of the way the game screens are rendered and scaled after the fact. This |
| 982 | | option can also be controlled via the Video Options menu in the user |
| 983 | | interface. The default is OFF (-noartwork_crop). |
| 984 | | |
| 985 | | -[no]use_backdrops / -[no]backdrop |
| 986 | | |
| 987 | | Enables/disables the display of backdrops. The default is ON |
| 988 | | (-use_backdrops). |
| 989 | | |
| 990 | | -[no]use_overlays / -[no]overlay |
| 991 | | |
| 992 | | Enables/disables the display of overlays. The default is ON |
| 993 | | (-use_overlays). |
| 994 | | |
| 995 | | -[no]use_bezels / -[no]bezel |
| 996 | | |
| 997 | | Enables/disables the display of bezels. The default is ON |
| 998 | | (-use_bezels). |
| 999 | | |
| 1000 | | |
| 1001 | | |
| 1002 | | Sound options |
| 1003 | | ------------- |
| 1004 | | |
| 1005 | | -[no]sound |
| 1006 | | |
| 1007 | | Enable or disable sound altogether. The default is ON (-sound). |
| 1008 | | |
| 1009 | | -samplerate / -sr <value> |
| 1010 | | |
| 1011 | | Sets the audio sample rate. Smaller values (e.g. 11025) cause lower |
| 1012 | | audio quality but faster emulation speed. Higher values (e.g. 48000) |
| 1013 | | cause higher audio quality but slower emulation speed. The default is |
| 1014 | | 48000. |
| 1015 | | |
| 1016 | | -[no]samples |
| 1017 | | |
| 1018 | | Use samples if available. The default is ON (-samples). |
| 1019 | | |
| 1020 | | -volume / -vol <value> |
| 1021 | | |
| 1022 | | Sets the startup volume. It can later be changed with the user interface |
| 1023 | | (see Keys section). The volume is an attenuation in dB: e.g., |
| 1024 | | "-volume -12" will start with -12dB attenuation. The default is 0. |
| 1025 | | |
| 1026 | 340 | -audio_latency <value> |
| 1027 | 341 | |
| 1028 | 342 | This controls the amount of latency built into the audio streaming. By |
| r4489 | r4490 | |
| 1038 | 352 | Input device options |
| 1039 | 353 | -------------------- |
| 1040 | 354 | |
| 1041 | | -ctrlr <controller> |
| 1042 | | |
| 1043 | | Enables support for special controllers. Configuration files are |
| 1044 | | loaded from the ctrlrpath. They are in the same format as the .cfg |
| 1045 | | files that are saved, but only control configuration data is read |
| 1046 | | from the file. The default is NULL (no controller file). |
| 1047 | | |
| 1048 | | -[no]mouse |
| 1049 | | |
| 1050 | | Controls whether or not MAME looks for a mouse controller to use. Note |
| 1051 | | that in many cases, lightguns are treated as mice by the operating |
| 1052 | | system, so you may need to enable this to enable lightgun support. When |
| 1053 | | this is enabled, you will not be able to use your mouse in Windows |
| 1054 | | while playing a game. If you want to get control of your computer back, |
| 1055 | | you will need to either pause the game or quit. The default is OFF |
| 1056 | | (-nomouse). |
| 1057 | | |
| 1058 | | -[no]joystick / -[no]joy |
| 1059 | | |
| 1060 | | Controls whether or not MAME looks for joystick/gamepad controllers. |
| 1061 | | When this is enabled, MAME will ask DirectInput about which controllers |
| 1062 | | are connected. The default is OFF (-nojoystick). |
| 1063 | | |
| 1064 | | -[no]lightgun / -[no]gun |
| 1065 | | |
| 1066 | | Controls whether or not MAME treats mouse inputs as lightgun inputs. |
| 1067 | | Note that most lightguns map to the mouse, so using -lightgun and |
| 1068 | | -mouse together may produce strange results. The default is OFF |
| 1069 | | (-nolightgun). |
| 1070 | | |
| 1071 | 355 | -[no]dual_lightgun / -[no]dual |
| 1072 | 356 | |
| 1073 | 357 | Controls whether or not MAME attempts to track two lightguns connected |
| 1074 | 358 | at the same time. This option requires -lightgun. This option is a hack |
| 1075 | | for supporting older dual lightgun setups. If you have multiple |
| 359 | for supporting older dual lightgun setups. If you have multiple |
| 1076 | 360 | lightguns connected, you will probably just need to enable -mouse and |
| 1077 | 361 | configure each lightgun independently. The default is OFF |
| 1078 | 362 | (-nodual_lightgun). |
| 1079 | | |
| 1080 | | -[no]offscreen_reload / -[no]reload |
| 1081 | | |
| 1082 | | Controls whether or not MAME treats a second button input from a |
| 1083 | | lightgun as a reload signal. In this case, MAME will report the gun's |
| 1084 | | position as (0,MAX) with the trigger held, which is equivalent to an |
| 1085 | | offscreen reload. This is only needed for games that required you to |
| 1086 | | shoot offscreen to reload, and then only if your gun does not support |
| 1087 | | off screen reloads. The default is OFF (-nooffscreen_reload). |
| 1088 | | |
| 1089 | | -[no]steadykey / -[no]steady |
| 1090 | | |
| 1091 | | Some games require two or more buttons to be pressed at exactly the |
| 1092 | | same time to make special moves. Due to limitations in the PC keyboard |
| 1093 | | hardware, it can be difficult or even impossible to accomplish that |
| 1094 | | using the standard keyboard handling. This option selects a different |
| 1095 | | handling that makes it easier to register simultaneous button presses, |
| 1096 | | but has the disadvantage of making controls less responsive. The |
| 1097 | | default is OFF (-nosteadykey) |
| 1098 | | |
| 1099 | | -a2d_deadzone / -a2d |
| 1100 | | |
| 1101 | | If you play with an analog joystick, but the game requires digital |
| 1102 | | input, MAME needs to convert the signals. Here you can give the ratio |
| 1103 | | of movement along an axis that accounts for a digital signal. This |
| 1104 | | option expects a float in the range of 0.0 to 1.0. Note that the |
| 1105 | | current handling is not accurate enough to handle diagonal movement |
| 1106 | | properly. The default is 0.3. |
| 1107 | | |
| 1108 | | -digital <all|none|j<N>[a<M>[a<K>...]][,j<X>[a<Y>...]][,...]> |
| 1109 | | |
| 1110 | | Controls which joystick axes are considered digital. If MAME knows that |
| 1111 | | a given joystick axis is digital, it can make much better decisions about |
| 1112 | | how to treat that axis. If you are using a digital gamepad with MAME, |
| 1113 | | you will want to use this option. There are a number of ways to do this: |
| 1114 | | |
| 1115 | | -digital all means that all axes of all connected joysticks will be |
| 1116 | | treated as digital. |
| 1117 | | |
| 1118 | | -digital none means that all axes of all connected joysticks will be |
| 1119 | | treated as analog (this is the default behavior). |
| 1120 | | |
| 1121 | | -digital j2 will treat all axes of joystick #2 as digital; axes on all |
| 1122 | | other joysticks will be treated as analog. |
| 1123 | | |
| 1124 | | -digital j1a0a1 will treat axis 0 and 1 on joystick #1 as digital; all |
| 1125 | | other axes will be treated as analog. |
| 1126 | | |
| 1127 | | -digital j1a0a1,j2a5 will treat axis 0 and 1 on joystick #1 as digital, |
| 1128 | | as well as axis 5 on joystick #2; all other axes will be treated |
| 1129 | | as analog. |
| 1130 | | |
| 1131 | | Make use of the information provided by -verbose to determine which |
| 1132 | | joysticks and axes you should be configuring this way. The default is |
| 1133 | | 'none'. |
| 1134 | | |
| 1135 | | |
| 1136 | | |
| 1137 | | Automatic device selection options |
| 1138 | | ---------------------------------- |
| 1139 | | |
| 1140 | | -paddle_device <keyboard|mouse|joystick|lightgun> / -paddle |
| 1141 | | -adstick_device <keyboard|mouse|joystick|lightgun> / -adstick |
| 1142 | | -pedal_device <keyboard|mouse|joystick|lightgun> / -pedal |
| 1143 | | -dial_device <keyboard|mouse|joystick|lightgun> / -dial |
| 1144 | | -trackball_device <keyboard|mouse|joystick|lightgun> / -trackball |
| 1145 | | -lightgun_device <keyboard|mouse|joystick|lightgun> |
| 1146 | | -positional_device <keyboard|mouse|joystick|lightgun> |
| 1147 | | |
| 1148 | | Each of these options controls autoenabling the mouse, joystick, or |
| 1149 | | lightgun depending on the presence of a particular class of analog |
| 1150 | | control for a particular game. For example, if you specify the option |
| 1151 | | -paddle mouse, then any game that has a paddle control will automatically |
| 1152 | | enable mouse controls just as if you had explicitly specified -mouse. |
| 1153 | | Note that these controls override the values of -[no]mouse, |
| 1154 | | -[no]joystick, etc. |