Settings module

config.ini und config.lua

The following initialization files are located in the "ini" subfolder of the installation path:

config.ini

This initialization file is called before all other settings files and determines the basic parameters.

• Specifies the path to the programdata folder (see chapter Installation for more information about this folder)
• Sets the default language selected in the setup

config.lua

This initialization file is called directly after config.ini and performs additional initializations.

settings.lua

By default, the settings.lua file is located in the Programdata folder and defines all basic and custom settings for VxCraft.

This file is a Lua script that is executed by VxCraft to set the preferences.

A description of the individual setting options is included in the script itself in the form of comments.

The module provides the following functions for setting the settings:

activate(string)

Function	activate(string)
Description	Activates the specified settings group. All subsequent settings are set in this group.
Example	activate("settings")

The function accepts the following values as arguments:

Argument	Description
"envar"	Activates the list of VxCraft environment variables for setting important paths.
"settings"	Activates the VxCraft settings. This group contains all other system settings.

set(string, string)
setoptional(string, string)

Function	set(string, string)
Description	Sets the specified setting in the active settings list. The first string is the setting key, and the second string contains the setting value. Multiple entries are overwritten, the last set setting is always valid.
Example	set("language", "en")

Function	setoptional(string, string)
Description	Works like set(), but the setting is only set if it does not already exist in the active list.
Example	setoptional("language", "de")

colors.lua

Works on the same principle as the settings.lua settings file. In this list, entries related to colors can be added or removed.

It should be noted, however, that this file is generated automatically by VxCraft. This means that all comments, user-defined formulas and functions are taken into account when the colors are read in, but are lost due to the automatic generation.

In other words, all formulas are converted into standardized entries.