Difference between revisions of "Mamewah 161 Ini Description"
(moved information from Ini files page to here for 1.61 information) |
m (Mamewah 161 Ini files moved to Mamewah 161 Ini Description) |
(No difference)
| |
Revision as of 01:12, 3 June 2007
Contents
General about mamewah ini files
Ini files are commonly used for configuring program options. These files end in the extension .ini and are standard text files which can be opened in any text editing application, such as notepad.
MAMEWAH uses three main types of ini config files; mamewah.ini (main/global settings), emuname.ini (emulator-specific settings), and emuname-?.ini (list-specific settings, where ? is the list no.).
mamewah.ini is auto-generated/updated when you run MAMEWAH, and resides in \mamewah.
To generate emuname.ini or emuname-?.ini, simply place suitably named text file(s) in the \mamewah\ini folder (eg mame.ini, mame-0.ini, mame-1.ini etc.), and run MAMEWAH. The ini files will be automatically populated/updated with default settings. You must have emuname.ini for each emulator you require, and the number of lists available is determined by however many emuname-?.ini files you have (emuname-0.ini will be the main, non-filterable list).
mamewah.ini
The mamewah.ini file is the global configuration file, allowing you to configure the general options for mamewah, such as audio, video, or screensaver options.
(Global) Screen Saver Options
| Setting | default | description |
|---|---|---|
| delay | 300 | in seconds, the delay before the screen saver begins |
| slide_duration | 3 | in seconds, the time to wait in between slides |
Audio Options
| Setting | default | description |
|---|---|---|
| enable_sounds | 1 | 1=yes/0=no, whether sounds are enabled |
| sound_volume | 100 | 0-100, % of the sound volume |
| music_path | (empty) | full path to folder containing music (mid, midi, rmi, mp3 or wma) to play |
| enable_music | 1 | 1=yes/0=no, whether music is enabled |
| music_volume | 100 | 0-100, % of the music volume |
Movie Options
| Setting | default | description |
|---|---|---|
| intro_movie_file | (empty) | full path to a movie file (mpg/avi) that plays at startup |
| exit_movie_file | (empty) | full path to a movie file (mpg/avi) that plays at exit |
| keep_movie_preview_aspect | game_aspect | (no/video_aspect/game_aspect) |
| delay_before_movie_preview | 2 | in seconds, the delay before a movie preview is shown |
| music_movie_mix | mute_movies | (mute_movies/merge/pause_music) when playing movies and music, should it mute the movie sound and only play the music, play the movie sound with the music, or pause the music and only play the movie sound |
| movie_volume | 100 | 0-100, % of the movie volume |
Misc Options
| Setting | default | description |
|---|---|---|
| layout | Classic 640x480 | the name of the layout/skin to use |
| ctrlr | (empty) | name of the ctrlr file to use |
| wrap_list | 0 | 1=yes/0=no, |
| remember_current_game | 1 | 1=yes/0=no, should MAMEWAH start on the last game selected |
| keep_image_aspect | 1 | 1=yes/0=no, should MAMEWAH keep the image aspect ratio |
| refresh_images | 0 | 1=yes/0=no, should MAMEWAH refresh images as you are scrolling (1) or once you have finished scrolling (0) |
| correct_orientations | horizontal | (horizontal/vertical/no) |
| safe_mode | 0 | 1=yes/0=no |
| show_cursor | 0 | 1=yes/0=no, show/hide the windows cursor |
| keyboard_led_states | (-,-,-) | (x,x,x where x=: -=leave, 0=off, 1=on, eg 1,1,1) |
| winipac_file | (empty) | full path of the winipac.exe file |
| mamewah_ipc_file | (empty) | default ipac ipc file |
| lcd_com_port | 1 | 1-4, com port that an LCD is hooked up to |
| lcd_settings | (empty) | baud rate (110/300/600/1200/2400/9600/14400/19200/28800/38400/56000/128000/256000), parity ([e]ven, [o]dd, [n]one, [m]ark, [s]pace), data bits (4-8), stop bits (1, 1.5, 2)
|
| exit_action | choice | (choice / windows / run_app / reboot / shutdown) |
| app_to_run_on_exit | (empty) | full path of application to run on exit of MAMEWAH |
Settings used by MAMEWAH
DO NOT CHANGE, THIS IS GENERATED AUTOMATICALLY BY MAMEWAH
| Setting | Default | Description |
|---|---|---|
| current_emulator | mame | the last emulator that was used |
| locked | 0 | whether or not the menu is locked |
| last_ipc | (empty) | last ipc file used |
(emuname).ini
The emulator specific ini files are the settings which tell Mamewah how to run or launch a particular emulator. There should be one of these for each emulator you wish to run from Mamewah.
List Generation Settings
| Setting | default | description |
|---|---|---|
| rom_path | (empty) | the full path of the location to your rom files |
| rom_extension | zip | the file extension(s) that your roms use |
| dat_file | (empty) | the full file path to a dat file with rom information |
| nms_file | (empty) | the full file path to an nms file with rom information |
| catver_ini_file | (empty) | the full file path to a catver.ini file |
| list_generation_method | rom_folder_vs_listxml | (rom_folder / rom_folder_subfolders / dat_file / rom_folder_vs_dat_file / rom_folder_vs_listinfo / verifysets_vs_listinfo / rom_folder_vs_listxml / verifysets_vs_listxml), how Mamewah generates its game list |
Execution Settings
| Setting | default | description |
|---|---|---|
| emulator_executable | (empty) | the full path to the executable for the emulator |
| commandline_format | (empty) | any command line parameters that need to be passed to the emulator when executed |
| alt_commandline_format_1 | (empty) | an alternate set of commandline options to pass |
| alt_commandline_format_2 | (empty) | a 2nd set of alternate commandline options to pass |
| game_specific_config_path | (empty) | certain emulators require a specific path to the config files, which can be included here |
Artwork Locations
| Setting | default | description |
|---|---|---|
| artwork_#_image_path | (empty) | 1-10, ten seperate paths for image locations (i.e. screens, titles, boxart, etc) |
| movie_preview_path | (empty) | full path to a movie preview |
| movie_artwork_no | 1 | which artwork_#_image_path contains movies instead of images |
Screen-Saver Settings
| Setting | default | description |
|---|---|---|
| enable_music_in_screensaver | 1 | 1=yes,0=no, if music should be enabled when the screensaver is active |
| saver_type | slideshow | (blank_screen / slideshow / movie / run_selected_game / run_random_game / run_random_game_and_quit / run_random_game_using_wrapper / launch_scr / power_saving / shutdown) type of screen saver to use |
| movie_path | (empty) | (movie folder, eg c:\movies - saver_type movie only) |
| quit_delay | (empty) | in seconds, (saver_type run_random_game_and_quit only ) |
| wrapper_executable | (empty) | wrapper filename, eg c:\mame\cmd-launch2.exe - run_random_game_using_wrapper only |
| wrapper_commandline_format | (empty) | emulator commandline format - (run_random_game_using_wrapper only) |
| scr_file | (empty) | screensaver filename, eg c:\mamess\mamescreensaver.scr - (launch_scr only) |
External Application Settings
| Setting | default | description |
|---|---|---|
| ipc_file_or_path | (empty) | ipc filename or path, (eg c:\ipc\mame.ipc or c:\ipc) |
| app_#_executable | (empty) | 1-3, external applications filename, eg c:\cpviewer\cpviewer.exe) |
| app_#_commandline_format | (empty) | 1-3, (external applications commandline format *) |
| auto_launch_apps | (empty) | the order apps are launched prior to the emulator, eg 1,2,3 or 3,2,1 or 1,2 or 1 etc.) |
Additional Settings
| Setting | default | description |
|---|---|---|
| music_path | (empty) | music folder, (eg c:\music) |
| lcd_display_file_path | (empty) | lcd file folder, (eg c:\lcd) |
| lcd_fe_text | (empty) | text of your choice, (eg M.A.M.E. - Multiple Arcade Machine Emulator) |
Settings Used by Mamewah
DO NOT CHANGE, THESE SETTINGS ARE ADJUSTED BY MAMEWAH
| Setting | default | description |
|---|---|---|
| current_list | 0 | the currently selected list |
emuname-?.ini
The emulator list specific ini files are the settings which tell Mamewah how to handle each list that is created for a particular emulator. While it is not required to configure these, it allows you to create custom lists, such as favorites, or "best of", without losing the Main/Full list option. There should be a (emuname)-0.ini which handles settings for the main list, and then a (emuname)-#.ini for each additional list configured for that emulator.
| Setting | default | description |
|---|---|---|
| list_title | (empty) | title of your choice for this game list, (e.g. Joystick Games) |
Games List Settings
NOTE: emuname-0.ini does not have the list_type, display_clone_info or max_favorites settings, as these properties for the main list are fixed.
| Setting | default | description |
|---|---|---|
| cycle_list | 1 | 1=yes, 0=no, when going through list, should it "wrap-around" to the beginning |
| list_type | normal | (normal / most_played / longest_played), if you want to created a most played list, or a longest played list, change this, otherwise, leave as normal |
| display_clone_info | 0 | 1=yes,0=no, should it display clones |
| max_favorites | 0 | 0=no limit, >0=limit, limit number of maximum favorites for list |
Execution Settings
| Setting | default | description |
|---|---|---|
| commandline_format | (empty) | emulator commandline format |
| alt_commandline_format_1 | (empty) | emulator commandline format |
| alt_commandline_format_2 | (empty) | emulator commandline format |
Settings Used by Mamewah
DO NOT CHANGE, GENERATED BY MAMEWAH
| Setting | default | description |
|---|---|---|
| current_game | 1 | number of currently selected game in the list |
Command Line Format Flags
Command line format lines that are required in the emuname and emuname-# ini files use the following flags. What you need to do is run the application by itself, and figure out what the format is that is needed by the application to work. Once you have done so, use the following flags to tell mamewah what is needed in the ini file.
As well as regular switches etc., the following strings can be used, and MAMEWAH will replace them suitably with information on the currently selected game when the application is launched:
- [description] - full game name
- [name] - romname
- [year] - year made
- [manufacturer] - manufacturer
- [cloneof] - parent romname
- [romof] - bios/parent romname
- [screen] - screen type
- [orientation] - screen orientation
- [input] - input type
- [status] - driver status
- [color] - color status
- [sound] - sound status
- [category] - game category/genre
Note that if '-clone [cloneof]' is present in the commandline_format, and the selected game is not a clone, then '-clone [cloneof]' will be ignored.
In order to alter the commandline format used, the following flags can also be used:
- [rompath] - rom path excluding trailing '\',
- [romext] - rom extension excluding '.',
- {8.3string} - can be used to convert 'string' to a short (8.3) filename (note that quotes if applicable must be used outside of the {}'s),
- {dosbox} - this specifies dos window is to be visible upon launching emulator/app,
- {nodosbox} - this specifies dos window is to be hidden upon launching emulator/app,
- {autodosbox} - this specifies dos window is to be visible only if necessary upon launching emulator/app (this should be used for M.A.M.E. only!!),
- {safelaunch} - this 'safe launches' the emulator/app, use this if the emulator/app is not launching properly from MAMEWAH,
- {nosafelaunch} - this launches the emulator/app as normal (use if possible),
- {nomusic} - this pauses music playback while the emulator/app is running,
- {music} - this allows music playback to continue while emulator/app is running,
- {nocursor} - this hides the cursor while the emulator/app is running,
- {cursor} - this makes the default cursor visible while the emulator/app is running,
- {cursor filename} - this makes the cursor specified by 'filename' visible while the emulator/app is running.
Note: If no 'dosbox' flag is set then '{dosbox}' will be assumed, If no 'safelaunch' flag is set then '{safelaunch}' will be assumed, If no 'music' flag is set then '{nomusic}' will be assumed, If no 'cursor' flag is set then '{nocursor}' will be assumed.
Flags in {curley brackets} are not used in the actual commandline sent to the emulator.
