next up previous
Next: general Up: OPENCP 2.5 Previous: MIDI files

   
Configuration

OPENCP can be widely configured using the cp.ini file, which should reside in the home directory of the player itself. This file is processed at every startup and informs the player about various modules / plugins and their respective configuration. For average users the default configuration should be sufficient. However if you want to change certain aspects of the player permanently you have to modify this file. You can use every ascii editor to edit the ini file.

The cp.ini consists of many sections. Each section starts with a section identifier tag in square brackets []. Examples of sections are [general] or [sound]. The sections id tag should be followed by a newline. After a section has been declared with the id tag the options describing the sections follow. Each options takes a single line ans consists of a keyword followed by a ''='' and the parameters. Example: mixrate=44100.

All options following a section id are options for that section. If a new section starts with a id tag all forthcoming options are assigned to the new section. All options for a section have to be grouped together. Multiple declarations of sections are not valid.

[general]
  link=dos4gfix
[defaultconfig]
  link=mchasm
[general]
  dos4gfix=off
the above example has to be written as:
[general]
  link=dos4gfix
  dos4gfix=off
[defaultconfig]
  link=mchasm
Not that in the above example the option link has not been overridden by the defaultconfig section. Both sections now can access an options named link, but both options are totally independant of each other.

Comments can be placed anywhere in the configuration file and are marked by a ;. The rest of the line starting from the ; is considered as a comment and not processed.

Normally the definition for an option ends with the end of the line. If many parameters are needed to specify an option they may exceed the default line width of 80 characters. Although this is no problem for OPENCP it is not nice looking. You can extend a line logically by using the unix like backquote at the end of a line to begin a newline without interupting the current option definition.

[example]
  option1=parameter1 parameter2
  option2=parameter1 \
          parameter2
Both options contain exactly the same parameters.

When modifying the configuration you should always start with the default configuration file and configure it to your needs. Building a bug free config file from scratch is difficult.6.1

We will now have a look at the individual sections and their options.



Footnotes

... difficult.6.1
And remember to make backups before changing vital parts of the cp.ini


 
next up previous
Next: general Up: OPENCP 2.5 Previous: MIDI files
documentation by doj - homepage www.cubic.org