HowTo: Config-File

TracNav(TracNav/TOC_Development)?

The config-file is usually located in bin/orxonox.ini.

Structure

Every config-file is subdivided into sections:

[Section1]
...

[Section2]
...

[AnotherSection]
...

The name between the brackets defines the sections name and is usually identical to a class name.

After a sectionname follows a list of values belonging to the section:

[Sectionname]
varname1=value
varname2=value
varname3=value
...

Every variable refers to a variable within Orxonox. See ConfigValueIncludes? and howto/ConfigValue for more information about how to create and use those values.

Modifying a value in the config-file

To modify a value, just change the right side of the assignment

[Sectionname]
varname=oldvalue

into

[Sectionname]
varname=newvalue

If you restart Orxonox, the new value will be assigned to all instances of "Sectionname". If you don't want to restart Orxonox, call reloadConfig in the Shell?.

Modifying a value in the Shell

To change a value wihtout leaving Orxonox, open the Shell? and type:

config Sectionname varname newvalue

This will change the config-value in all existing instances of "Sectionname" and changes the entry in the config-file.

Alternatively you can use

tconfig Sectionname varname newvalue

This will only change the value in all existing instances, but not changing the config-file. Therefore the change will be lost if you restart Orxonox.