Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 3.13 KB

File metadata and controls

41 lines (29 loc) · 3.13 KB
description Description about the configuration file.

Configuration

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

{% hint style="info" %} If there is no configuration file present then the file is automatically generated, with the default values, when the game is started. {% endhint %}

{% hint style="info" %} Even if the configuration file has ini extension, in fact, it is a TOML file See toml.io for more information. {% endhint %}

Options

NameTypeDefaultDescription
NameTypeDefaultDescription
versionunsigned integer0The file's version.
logging
levelstringinfo

The global log level.

Accepted values:

  • off
  • trace
  • debug
  • info
  • warning
  • error
  • critical
flush_onstringinfo

The minimum log level that will trigger the flush.


Accepted values:

  • trace
  • debug
  • info
  • warning
  • error
  • critical
max_filesinteger5

The maximum number of rotated log files.

Minimum value: 1

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

max_file_sizeinteger10The maximum size, in megabytes, of a log file.

Minimum value: 1
plugins
enabledbooleantrueEnable / disable plugins system.
ignoredstring[][]The specified plugins are ignored and will not loaded.
dev
consolebooleantrueEnable / disable the external console (useful for development).
wait_for_debuggerbooleanfalseBlock 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