Configuration

Matthiesen Lib API has a few configuration options available to the end user, which can be found in the <game_directory>/config/matthiesen_lib_api/ folder after running the game with the mod installed at least once. Below is an overview of the available configuration files and their options.

• config.json - Main configuration file for Matthiesen Lib API
• metrics.properties - Configuration for faststats metrics collection (if enabled)

config.json

The config.json file contains the main configuration options for Matthiesen Lib API. Here are the available options:

<game_directory>/config/matthiesen_lib_api/config.json

{
  "suppressedLogging": false
}

suppressedLogging

• Type: boolean
• Default: false
• Description: If true, the API will suppress most internal logging output. This is intended for use in cases where the API is being used in a context where logging is not desired, such as in a mod that wants to handle its own logging or in a testing environment.

metrics.properties

<game_directory>/config/matthiesen_lib_api/metrics.properties

configVersion=1
debug=false
enabled=true
serverId=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
submitAdditionalMetrics=true
submitErrors=true
submitMetrics=true

Properties

• configVersion - Internal version number for the metrics configuration. Do not modify.
• debug - If true, the metrics system will output additional debug information to the logs. Default is false.
• enabled - If false, the metrics system will be completely disabled and will not collect or submit any data. Default is true.
• serverId - This is an autogenerated UUID that identifies your server for metrics purposes.
• submitAdditionalMetrics - If true, additional metrics beyond the required minimum will be collected and submitted. Default is true.
• submitErrors - If true, error reports will be submitted when exceptions occur within the API. Default is true.
• submitMetrics - If false, no metrics will be submitted, but the API will still collect them. This can be used in conjunction with enabled=false to disable submission but keep local collection for debugging purposes. Default is true.