trunk/docs/config.txt
| r17915 | r17916 | |
| 218 | 218 | you can limit this list by specifying a driver name or wildcard after |
| 219 | 219 | the -listsource command. |
| 220 | 220 | |
| 221 | | -listcrc |
| 221 | -listbrothers / -lb [<gamename|wildcard>] |
| 222 | 222 | |
| 223 | Displays a list of 'brothers', or rather, other sets which are located |
| 224 | in the same sourcefile as the gamename searched for. |
| 225 | |
| 226 | -listcrc [<gamename|wildcard>] |
| 227 | |
| 223 | 228 | Displays a full list of CRCs of all ROM images referenced by all |
| 224 | 229 | drivers within MAME. |
| 225 | 230 | |
| 226 | | -listroms <gamename> |
| 231 | -listroms [<gamename|wildcard>] |
| 227 | 232 | |
| 228 | 233 | Displays a list of ROM images referenced by the specified game. |
| 229 | 234 | |
| 230 | | -listsamples <gamename> |
| 235 | -listsamples [<gamename|wildcard>] |
| 231 | 236 | |
| 232 | 237 | Displays a list of samples referenced by the specified game. |
| 233 | 238 | |
| r17915 | r17916 | |
| 245 | 250 | however, you can limit this list by specifying a driver name or |
| 246 | 251 | wildcard after the -verifyroms command. |
| 247 | 252 | |
| 248 | | -romident |
| 253 | -romident [path\to\romstocheck.zip] |
| 249 | 254 | |
| 250 | 255 | Attempts to identify ROM files, if they are known to MAME, in the |
| 251 | 256 | specified .zip file or directory. This command can be used to try and |
| r17915 | r17916 | |
| 258 | 263 | 8: means some files were identified |
| 259 | 264 | 9: means no files were identified |
| 260 | 265 | |
| 266 | -listdevices / -ld [<gamename|wildcard>] |
| 261 | 267 | |
| 268 | Displays a list of all devices known to be hooked up to a game. The ":" |
| 269 | is considered the game itself with the devices list being attached to give |
| 270 | the user a better understanding of what the emulation is using. |
| 271 | |
| 272 | -listslots [<gamename|wildcard>] |
| 262 | 273 | |
| 274 | Show available slots and options for each slot (if available). Primarily |
| 275 | used for MESS to allow control over internal plug-in cards, much like PC's |
| 276 | needing video, sound and other cards. |
| 277 | |
| 278 | -listmedia / -lm [<gamename|wildcard>] |
| 279 | |
| 280 | List available media that the chosen game or system allows to be used. This |
| 281 | includes media types (cartridge, cassette, diskette and more) as well as |
| 282 | common file extentions which are supported. |
| 283 | |
| 284 | -listsoftware [<gamename|wildcard>] |
| 285 | |
| 286 | Posts to screen all software lists which can be used by the entered gamename |
| 287 | or system. Notice, this is simply a copy/paste of the .XML file which reside |
| 288 | in the HASH folder which are allowed to be used. |
| 289 | |
| 290 | -getsoftlist [<gamename|wildcard>] |
| 291 | |
| 292 | Posts to screen a specific software list which matches with the gamename |
| 293 | provided. |
| 294 | |
| 295 | |
| 296 | |
| 263 | 297 | Configuration options |
| 264 | 298 | --------------------- |
| 265 | 299 | |
| r17915 | r17916 | |
| 269 | 303 | (which is the default), MAME reads the following config files in order: |
| 270 | 304 | |
| 271 | 305 | - mame.ini |
| 272 | | - <mymame>.ini (i.e. if MAME was renamed mame060.exe, MAME |
| 273 | | parses mame060.ini here) |
| 274 | | - debug.ini (if the debugger is enabled) |
| 275 | | - vector.ini (for vector games only) |
| 276 | | - <driver>.ini (based on the source filename of the driver) |
| 277 | | - <parent>.ini (for clones only, may be called recursively) |
| 306 | - <mymame>.ini (i.e. if MAME was renamed mame060.exe, MAME |
| 307 | parses mame060.ini here) |
| 308 | - debug.ini (if the debugger is enabled) |
| 309 | - <parent>.ini (for clones only, may be called recursively) |
| 278 | 310 | - <gamename>.ini |
| 311 | - vertical.ini (for games with vertical monitor orientation) |
| 312 | - horizont.ini (for games with horizontal monitor orientation) |
| 313 | - vector.ini (for vector games only) |
| 314 | - <driver>.ini (based on the source filename of the driver) |
| 279 | 315 | |
| 316 | |
| 280 | 317 | The settings in the later ini's override those in the earlier ini's. |
| 281 | 318 | So, for example, if you wanted to disable overlay effects in the |
| 282 | 319 | vector games, you can create a vector.ini with the "effect none" line |
| r17915 | r17916 | |
| 302 | 339 | is 'samples' (that is, a directory "samples" in the same directory as |
| 303 | 340 | the MAME executable). |
| 304 | 341 | |
| 305 | | -artpath / -artwork_directory <path> |
| 342 | -artpath <path> / -artwork_directory <path> |
| 306 | 343 | |
| 307 | 344 | Specifies a list of paths within which to find artwork files. Multiple |
| 308 | 345 | paths can be specified by separating them with semicolons. The default |
| r17915 | r17916 | |
| 329 | 366 | paths can be specified by separating them with semicolons. The default |
| 330 | 367 | is '.' (that is, search in the same directory as the MAME executable). |
| 331 | 368 | |
| 369 | -cheatpath <path> |
| 370 | |
| 371 | Specifies a list of paths within which to find .XML cheat files. |
| 372 | Multiple paths can be specified by separating them with semicolons. The |
| 373 | default is 'cheat' (that is, a folder called 'cheat' located in the same |
| 374 | directory as the as the MAME executable). |
| 375 | |
| 332 | 376 | -crosshairpath <path> |
| 333 | 377 | |
| 334 | 378 | Specifies a list of paths within which to find crosshair files. Multiple |
| r17915 | r17916 | |
| 414 | 458 | |
| 415 | 459 | |
| 416 | 460 | |
| 417 | | Core Filename Options |
| 418 | | --------------------- |
| 419 | | |
| 420 | | -cheat_file <filename> |
| 421 | | |
| 422 | | Specifies the name of the cheat database file. The default is |
| 423 | | 'cheat.dat'. |
| 424 | | |
| 425 | | |
| 426 | | |
| 427 | 461 | Core state/playback options |
| 428 | 462 | --------------------------- |
| 429 | 463 | |
| r17915 | r17916 | |
| 459 | 493 | (.cfg), NVRAM (.nv), and memory card files deleted. The default is |
| 460 | 494 | NULL (no recording). |
| 461 | 495 | |
| 496 | -mngwrite <filename> |
| 497 | |
| 498 | Writes each video frame to the given <filename> in MNG format, |
| 499 | producing an animation of the game session. Note that -mngwrite only |
| 500 | writes video frames; it does not save any audio data. Use -wavwrite |
| 501 | for that, and reassemble the audio/video using offline tools. The |
| 502 | default is NULL (no recording). |
| 503 | |
| 504 | -aviwrite <filename> |
| 505 | |
| 506 | Stream video and sound data to the given <filename> in AVI format, |
| 507 | producing an animation of the game session complete with sound. The |
| 508 | default is NULL (no recording). |
| 509 | |
| 510 | -wavwrite <filename> |
| 511 | |
| 512 | Writes the final mixer output to the given <filename> in WAV format, |
| 513 | producing an audio recording of the game session. The default is |
| 514 | NULL (no recording). |
| 515 | |
| 462 | 516 | -snapname <name> |
| 463 | 517 | |
| 464 | 518 | Describes how MAME should name files for snapshots. <name> is a string |
| r17915 | r17916 | |
| 471 | 525 | find the next empty value for %i and use that for a filename. The |
| 472 | 526 | default is %g/%i, which creates a separate folder for each game, |
| 473 | 527 | and names the snapshots under it starting with 0000 and increasing |
| 474 | | from there. |
| 528 | from there. In the case of using different media, you can use the |
| 529 | %d_[media] indicator. Replace [media] with the default media being |
| 530 | used. In the example: 'mess nes megaman2u -snapname %g/%d_cart' |
| 531 | snapshots will then be placed in 'snaps\nes\megaman2u.png' |
| 475 | 532 | |
| 476 | 533 | -snapsize <width>x<height> |
| 477 | 534 | |
| r17915 | r17916 | |
| 497 | 554 | <viewname> can also be 'auto', which selects the first view with all |
| 498 | 555 | screens present. The default value is 'internal'. |
| 499 | 556 | |
| 500 | | -mngwrite <filename> |
| 501 | | |
| 502 | | Writes each video frame to the given <filename> in MNG format, |
| 503 | | producing an animation of the game session. Note that -mngwrite only |
| 504 | | writes video frames; it does not save any audio data. Use -wavwrite |
| 505 | | for that, and reassemble the audio/video using offline tools. The |
| 506 | | default is NULL (no recording). |
| 507 | | |
| 508 | | -aviwrite <filename> |
| 509 | | |
| 510 | | Stream video and sound data to the given <filename> in AVI format, |
| 511 | | producing an animation of the game session complete with sound. The |
| 512 | | default is NULL (no recording). |
| 513 | | |
| 514 | | -wavwrite <filename> |
| 515 | | |
| 516 | | Writes the final mixer output to the given <filename> in WAV format, |
| 517 | | producing an audio recording of the game session. The default is |
| 518 | | NULL (no recording). |
| 519 | | |
| 520 | 557 | -[no]burnin |
| 521 | 558 | |
| 522 | 559 | Tracks brightness of the screen during play and at the end of |
| r17915 | r17916 | |
| 616 | 653 | specified) or its native state (if -norotate is specified). The |
| 617 | 654 | default for both of these options is OFF (-noror -norol). |
| 618 | 655 | |
| 619 | | -[no]flipx |
| 620 | | -[no]flipy |
| 621 | | |
| 622 | | Flip (mirror) the game screen either horizontally (-flipx) or |
| 623 | | vertically (-flipy). The flips are applied after the -rotate and |
| 624 | | -ror/-rol options are applied. The default for both of these options |
| 625 | | is OFF (-noflipx -noflipy). |
| 626 | | |
| 627 | 656 | -[no]autoror |
| 628 | 657 | -[no]autorol |
| 629 | 658 | |
| r17915 | r17916 | |
| 633 | 662 | horizontally or vertically in one of the directions you can handle. |
| 634 | 663 | If your screen only pivots counter-clockwise, use -autoror. |
| 635 | 664 | |
| 665 | -[no]flipx |
| 666 | -[no]flipy |
| 636 | 667 | |
| 668 | Flip (mirror) the game screen either horizontally (-flipx) or |
| 669 | vertically (-flipy). The flips are applied after the -rotate and |
| 670 | -ror/-rol options are applied. The default for both of these options |
| 671 | is OFF (-noflipx -noflipy). |
| 637 | 672 | |
| 673 | |
| 674 | |
| 638 | 675 | Core artwork options |
| 639 | 676 | -------------------- |
| 640 | 677 | |
| r17915 | r17916 | |
| 658 | 695 | Enables/disables the display of overlays. The default is ON |
| 659 | 696 | (-use_overlays). |
| 660 | 697 | |
| 661 | | -[no]use_bezels / -[no]bezel |
| 698 | -[no]use_bezels / -[no]bezels |
| 662 | 699 | |
| 663 | 700 | Enables/disables the display of bezels. The default is ON |
| 664 | 701 | (-use_bezels). |
| 665 | 702 | |
| 703 | -[no]use_cpanels / -[no]cpanels |
| 666 | 704 | |
| 705 | Enables/disables the display of control panels. The default is ON |
| 706 | (-use_cpanels). |
| 667 | 707 | |
| 708 | -[no]use_marquees / -[no]marquees |
| 709 | |
| 710 | Enables/disables the display of marquees. The default is ON |
| 711 | (-use_marquees). |
| 712 | |
| 713 | |
| 714 | |
| 668 | 715 | Core screen options |
| 669 | 716 | ------------------- |
| 670 | 717 | |
| r17915 | r17916 | |
| 842 | 889 | but has the disadvantage of making controls less responsive. The |
| 843 | 890 | default is OFF (-nosteadykey) |
| 844 | 891 | |
| 892 | -[no]ui_active |
| 893 | |
| 894 | Enable user interface on top of emulated keyboard (if present). The |
| 895 | default if OFF (-noui_active) |
| 896 | |
| 845 | 897 | -[no]offscreen_reload / -[no]reload |
| 846 | 898 | |
| 847 | 899 | Controls whether or not MAME treats a second button input from a |
| r17915 | r17916 | |
| 927 | 979 | 1.0, where 0 is the center of the joystick and 1 is the outer limit. |
| 928 | 980 | The default is 0.85. |
| 929 | 981 | |
| 982 | -natural |
| 983 | Specific whether or not to use a natural keyboard or not. This allows |
| 984 | you to start your game or system in "partial" keyboard emulation mode, |
| 985 | giving you the ability to use all normal UI keys. The default is OFF, |
| 986 | (-nonatrual) |
| 930 | 987 | |
| 988 | -joystick_contradictory |
| 931 | 989 | |
| 990 | Enable contradictory direction digital joystick input at the same time |
| 991 | such as Left and Right or Up and Down at the same time. The default |
| 992 | is OFF (-nojoystick_contradictory) |
| 993 | |
| 994 | -coin_impulse [n] |
| 995 | |
| 996 | Set coin impulse time based on n (n<0 disable impulse, n==0 obey driver, |
| 997 | 0<n set time n). Default is 0. |
| 998 | |
| 999 | |
| 1000 | |
| 932 | 1001 | Core input automatic enable options |
| 933 | 1002 | ----------------------------------- |
| 934 | 1003 | |
| 935 | | -paddle_device <keyboard|mouse|joystick|lightgun|none> / -paddle |
| 936 | | -adstick_device <keyboard|mouse|joystick|lightgun|none> / -adstick |
| 937 | | -pedal_device <keyboard|mouse|joystick|lightgun|none> / -pedal |
| 938 | | -dial_device <keyboard|mouse|joystick|lightgun|none> / -dial |
| 939 | | -trackball_device <keyboard|mouse|joystick|lightgun|none> / -trackball |
| 940 | | -lightgun_device <keyboard|mouse|joystick|lightgun|none> |
| 941 | | -positional_device <keyboard|mouse|joystick|lightgun|none> |
| 1004 | -paddle_device enable (none|keyboard|mouse|lightgun|joystick) if a paddle control is present |
| 1005 | -adstick_device enable (none|keyboard|mouse|lightgun|joystick) if an analog joystick control is present |
| 1006 | -pedal_device enable (none|keyboard|mouse|lightgun|joystick) if a pedal control is present |
| 1007 | -dial_device enable (none|keyboard|mouse|lightgun|joystick) if a dial control is present |
| 1008 | -trackball_device enable (none|keyboard|mouse|lightgun|joystick) if a trackball control is present |
| 1009 | -lightgun_device enable (none|keyboard|mouse|lightgun|joystick) if a lightgun control is present |
| 1010 | -positional_device enable (none|keyboard|mouse|lightgun|joystick) if a positional control is present |
| 1011 | -mouse_device enable (none|keyboard|mouse|lightgun|joystick) if a mouse control is present |
| 942 | 1012 | |
| 943 | 1013 | Each of these options controls autoenabling the mouse, joystick, or |
| 944 | 1014 | lightgun depending on the presence of a particular class of analog |
| r17915 | r17916 | |
| 984 | 1054 | Specifies a file that contains a list of debugger commands to execute |
| 985 | 1055 | immediately upon startup. The default is NULL (no commands). |
| 986 | 1056 | |
| 1057 | -debug_internal |
| 987 | 1058 | |
| 1059 | A special 'internal' debugger for debugging. Activated when used along |
| 1060 | with -debug. The default if OFF (-nodebug_internal). |
| 1061 | |
| 988 | 1062 | |
| 1063 | |
| 989 | 1064 | Core misc options |
| 990 | 1065 | ----------------- |
| 991 | 1066 | |
| r17915 | r17916 | |
| 1007 | 1082 | |
| 1008 | 1083 | -uifont <fontname> |
| 1009 | 1084 | |
| 1010 | | Specifies the name of a BDF font file to use for the UI font. If this |
| 1011 | | font cannot be found or cannot be loaded, the system will fall back |
| 1012 | | to its built-in UI font. On some platforms 'fontname' can be a system |
| 1013 | | font name instead of a BDF font file. The default is 'default' (use |
| 1085 | Specifies the name of a font file to use for the UI font. If this font |
| 1086 | cannot be found or cannot be loaded, the system will fall back to its |
| 1087 | built-in UI font. On some platforms 'fontname' can be a system font |
| 1088 | name (TTF) instead of a (BDF) font file. The default is 'default' (use |
| 1014 | 1089 | the OSD-determined default font). |
| 1090 | |
| 1091 | -ramsize [n] |
| 1092 | |
| 1093 | Allows you to change the default RAM size (if supported by driver). |
| 1094 | |
| 1095 | -confirm_quit |
| 1096 | |
| 1097 | Display a Confirm Quit dialong to screen on exit, requiring one extra |
| 1098 | step to exit MAME. The default is OFF (-noconfirm_quit). |
| 1099 | |
| 1100 | -ui_mouse |
| 1101 | |
| 1102 | Displays a mouse cursor when using the built-in UI for MAME. The default |
| 1103 | is (-noui_mouse). |