ConfigLib

Description

ConfigLib provides functions for mods to display and edit their settings. It is a mod that does nothing on it's own and is only used by other mods.

You can review game folders in the ConfigLib mod settings or set mods list ordering.

Requirements

• []Zero Sievert 1. 2. 59+[/]

  []GMLoader[/]

  []UiPatchLib[/]

  Installation instructions

  • []Extract the ZIP file into SteamLibrary\steamapps\common\ZERO Sievert[/]

    []run GMLoader[/]

    Documentation

    The library allows transparent access to the mod settings for the user. All settings are saved immediately to the INI file. The mod settings are global (ie. not specific to the save).

    The best practice:

    • []define the settings once (eg. in gml_Object_obj_logo_screen_Create_0) using configlib_define_setting()[/]

      []save all of the settings and their values using configlib_save_settings()[/]

      []get the value whenever needed in other parts of the mod using configlib_get()[/]

      []set the value if needed using configlib_set()[/]

      []user can use Main menu/Mod settings/my mod[/]

    [/]

    []There is no option for user to edit a "string" datatype.. yet.[/]

    []The actual INI file may be in the ZERO Sievert installation folder (... SteamLibrary\steamapps\common\ZERO Sievert\mods\config) OR %localappdata%\ZERO Sievert (ie.: C:\Users\<User Name>\AppData\Local\ZERO Sievert\mods\config).[/]

    []If you use "int" or "real", the mod setting scrollbar will break... ugh![/]

    []"language" is currently not used; "bool" and "string" do not use "minvalue"/"maxvalue"

    To create optional dependency in your mod, use

    if (!variable_global_exists("configlib")) {

    show_message("My mod needs ConfigLib mod!");

    Functions available:

    // configlib_define_setting() - Define a setting for your mod, later to be used/saved

    // - modname - name of your mod (will be used as INI file name)

    // - section - name of setting section (default: "General")

    // - key - name of the setting

    // - datatype - one of:

    //      "bool" - logical values: true or false

    //      "int" - integer numeric value

    //      "real" - float/real numeric value

    //      "string" - string value (user has no option to edit this!)

    //      "key_code" - integer numeric value in range 0-255 that represents Ord() of a keypress and uses slider to set the key (sorry no keyboard/gamepad scanning or keyboard modifiers yet!)

    // - minvalue - minimum value for int and real datatypes

    // - maxvalue - maximum value for int and real datatypes

    // - default_value - initial value when first loaded

    // - description - single line description presented to the user (recommended shorter than 40-60 chars)

    // - tooltip - setting values explanation, shown as tooltip

    // - language - unused (language of modname, section, description and tooltip)

    configlib_define_setting(modname, section = "General", key, datatype = "bool", minvalue = undefined, maxvalue = undefined, default_value = undefined, description = undefined, tooltip = undefined, language = undefined);

    // Example:

    configlib_define_setting("HP and Stamina Bar in Inventory Screen", "General", "show_hp", "bool", false, true, true, "Show HP in Inventory", "My tootlip for showing HP!", "en");

    // configlib_get_key_definition() - get setting definition struct (as previously defined above using configlib_define_setting())

    // - modname - name of your mod

    // - section - name of setting section

    // - key - name of the setting

    // returns struct with keys: modname, section, key, datatype, minvalue, maxvalue, default_value, description, tooltip, language and value

    configlib_get_key_definition(modname, section, key);

    // Example:

    var show_hp_configdef = configlib_get_key_definition("HP and Stamina Bar in Inventory Screen", "General", "show_hp");

    scr_draw_text_with_box(show_hp_configdef.description); // show description of setting "show_hp" to the user

    // configlib_get() - get a setting value

    // - modname - name of your mod

    // - section - name of setting section

    // - key - name of the setting

    // returns struct with keys: modname, section, key, datatype, minvalue, maxvalue, default_value, description, tooltip, language and value

    configlib_get(modname, section = "General", key);