Configuration

Description about the configuration file.

The configuration file can be found in <game_directory>/red4ext/config.ini.

If there is no configuration file present then the file is automatically generated, with the default values, when the game is started.

Even if the configuration file has ini extension, in fact, it is a TOML file See toml.io for more information.

Options

Name

Type

Default

Description

version

unsigned integer

0

The file's version.

logging

level

string

info

The global log level.

Accepted values:

  • off

  • trace

  • debug

  • info

  • warning

  • error

  • critical

flush_on

string

info

The minimum log level that will trigger the flush.

Accepted values:

  • trace

  • debug

  • info

  • warning

  • error

  • critical

max_files

integer

5

The maximum number of rotated log files.

Minimum value: 1

Note: A log file is rotated every time the game starts.

max_file_size

integer

10

The maximum size, in megabytes, of a log file. Minimum value: 1

plugins

enabled

boolean

true

Enable / disable plugins system.

ignored

string[]

[]

The specified plugins are ignored and will not loaded.

dev

console

boolean

true

Enable / disable the external console (useful for development).

wait_for_debugger

boolean

false

Block the process until a debugger is attached.

Example

An example of the configuration file.

version = 0

[logging]
level = "info"
flush_on = "info"
max_files = 5
max_file_size = 10

[plugins]
enabled = true
ignored = [ "RED4ext.Playgorund" ]

[dev]
console = false
wait_for_debugger = false

Last updated