ModMaster Manual - Configuration

Configuration

Configuration dialog

The EditConfiguration menu item opens a dialog (Figure 2, “Configuration dialog”) that enables you to configure ModMaster.

On the left side of the dialog there is a list of configuration options. When you select one of these options, a panel is displayed on the right side of the dialog, which contains the items corresponding to the option.

The configuration options are in three groups:

  • Settings: These options are described in the Settings section.

  • Registers: These options are described in the Registers section.

  • Commands: These options are described in the Commands section.

Each panel has buttons, typically an Apply button (which saves the changes you have made), a Reset button (which restores the settings to their last saved state), and a Help button (which provides help on the panel - you can also get help by pressing the F1 key).

Each panel also has a "status bar" below its buttons, which is used to display error and information messages. Many of the error messages displayed in the status bar have an Error Help button, which provides help on the error message (you can also get this help by pressing the F4 key).

The list of configuration options uses colour-coding to indicate the state of the corresponding panel:

  • Blue/grey: The panel is selected (i.e. displayed in the dialog).

  • Yellow: The panel has unapplied changes.

  • Red: The panel has an error message in its status bar.

Saving and restoring the configuration

ModMaster's configuration can be saved to a disk file by selecting the FileSave Configuration menu item. This displays a dialog that enables you to enter or select the name of the file to save the configuration to. All of ModMaster's configuration (including register and command definitions) is saved to the file in an XML format.

To restore the configuration from a file, use the FileLoad Configuration menu item. This displays a dialog that enables you to enter or select the name of the file to restore the configuration from. If ModMaster is "running" (i.e. the Run button is depressed), you will have to click the Run button before you can load the configuration.

Loading the configuration from a file will add new register definitions and replace existing register definitions, but will not delete any register definitions. If you want to totally replace the set of register definitions you should use EditDelete All Registers before FileLoad Configuration.

Similarly, loading the configuration will add new command definitions and replace existing command definitions, but will not delete any command definitions. If you want to totally replace the set of command definitions you should use CommandsDelete All before FileLoad Configuration.

You can also load the configuration from a file when you start ModMaster, by passing the name of the file as a command-line argument, e.g.:

java -jar modmaster2.13.jar chromat.xml

There is, currently, no formal DTD (Document Type Definition) or XML schema for the format of the XML files in which the configuration is saved. However, the format should be fairly evident to a human reader, and can easily be edited, if necessary, using a text editor.