summaryrefslogtreecommitdiffstatshomepage
path: root/docs/source/advanced/multiconfig.rst
blob: d81853d4734f71eb3701342ecb27e02da051cc37 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
Multiple Configuration Files
============================

MAME has a very powerful configuration file system that can allow you to tweak settings on a per-game, per-system, or even per-monitor type basis, but requires careful thought about how you arrange your configs.

.. _advanced-multi-CFG:

Order of Config Loading
-----------------------

1. The command line is parsed first, and any settings passed that way *will take
   precedence over anything in an INI file*.

2. ``mame.ini`` (or other platform INI; e.g. ``mess.ini``) is parsed twice.  The
   first pass may change various path settings, so the second pass is done to
   see if there is a valid configuration file at that new location (and if so,
   change settings using that file).

3. ``debug.ini`` if the debugger is enabled.  This is an advanced config file,
   most people won't need to use it or be concerned by it.

4. Screen orientation INI file (either ``horizont.ini`` or ``vertical.ini``).
   For example Pac-Man has a vertical screen, so it loads ``vertical.ini``,
   while Street Fighter Alpha uses a horizontal screen, so it loads
   ``horizont.ini``.

   Systems with no monitors, multiple monitors with different orientations, or
   monitors connected to slot devices will usually load ``horizont.ini``.

5. Monitor type INI file (``vector.ini`` for vector monitors, ``raster.ini`` for
   CRT raster monitors, or ``lcd.ini`` for LCD/EL/plasma matrix monitors).
   Pac-Man and Street Fighter Alpha use raster CRTs, so ``raster.ini`` is loaded
   here, while Tempest uses a vector monitor, so ``vector.ini`` is loaded here.

   For systems that have multiple monitor types, such as House Mannequin with
   its CRT raster monitor and dual LCD matrix monitors, the INI file relevant to
   the first monitor is used (``raster.ini`` in this case).  Systems without
   monitors or with other kinds of monitors will not load an INI file for this
   step.

6. Driver source file INI file.  MAME will attempt to load
   ``source/``\ *<sourcefile>*\ ``.ini`` where *<sourcefile>* is the base name
   of the source code file where the system driver is defined.  A system's
   source file can be found using **mame -listsource <pattern>** at the command
   line.

   For instance, Banpresto's Sailor Moon, Atlus's Dodonpachi, and Nihon System's
   Dangun Feveron all run on similar hardware and are defined in the
   ``cave.cpp`` source file, so they will all load ``source/cave.ini`` at this
   step.

7. BIOS set INI file (if applicable).  For example The Last Soldier uses the
   Neo-Geo MVS BIOS, so it will load ``neogeo.ini``.  Systems that don't use a
   BIOS set won't load an INI file for this step.

8. Parent system INI file.  For example The Last Soldier is a clone of The Last
   Blade / Bakumatsu Roman - Gekka no Kenshi, so it will load ``lastblad.ini``.
   Parent systems will not load an INI file for this step.

9. System INI file.  Using the previous example, The Last Soldier will load
   ``lastsold.ini``.


Examples of Config Loading Order
--------------------------------

* Brix, which is a clone of Zzyzzyxx. (**mame brix**)

  1. Command line
  2. ``mame.ini`` (global)
  3. (debugger not enabled, no extra INI file loaded)
  4. ``vertical.ini`` (screen orientation)
  5. ``raster.ini`` (monitor type)
  6. ``source/jack.ini`` (driver source file)
  7. (no BIOS set)
  8. ``zzyzzyxx.ini`` (parent system)
  9. ``brix.ini`` (system)

* Super Street Fighter 2 Turbo (**mame ssf2t**)

  1. Command line
  2. ``mame.ini`` (global)
  3. (debugger not enabled, no extra INI file loaded)
  4. ``horizont.ini`` (screen orientation)
  5. ``raster.ini`` (monitor type)
  6. ``source/cps2.ini`` (driver source file)
  7. (no BIOS set)
  8. (no parent system)
  9. ``ssf2t.ini`` (system)

* Final Arch (**mame finlarch**)

  1. Command line
  2. ``mame.ini`` (global)
  3. (debugger not enabled, no extra INI file loaded)
  4. ``horizont.ini`` (screen orientation)
  5. ``raster.ini`` (monitor type)
  6. ``source/stv.ini`` (driver source file)
  7. ``stvbios.ini`` (BIOS set)
  8. ``smleague.ini`` (parent system)
  9. ``finlarch.ini`` (system)

*Remember command line parameters take precedence over all else!*


Tricks to Make Life Easier
--------------------------

Some users may have a wall-mounted or otherwise rotatable monitor, and may wish
to actually play vertical games with the rotated display.  The easiest way to
accomplish this is to put your rotation modifiers into ``vertical.ini``, where
they will only affect vertical games.