Configuration - Types

Paths

When specifying a path in a configuration file, make sure to include a file name if one is required. If a folder is required, you do not need to include a folder separator character at the end.

The separator character is:

Windows   \
MacOS   :
Unix   /

All of the separators are recognized on all supported platforms and are automatically converted to the correct separator for the platform. The 'up one folder' symbol is .. for all platforms.

When a path is specified in a configuration file, you can specify it in many ways:

Note: the following examples all use the Windows separator.

Absolute  

C:\test_engine\data

UNC   \\network\volume
relative  

..\..\data\items

Note: If you use a relative path, make not of the location which will be the root.

file  

project.cfg

Note: This is the same as a relative path, so make sure of the root location.

Booleans

True  

true (any case), yes (any case), 1

False   everything else

Identifers

An identifier can be any combination of numbers, letters and the '_' character, but must begin with a letter. All key values must be identifiers.