A toolkit providing GUI, configuration, networking and Assembly-based plugin system for Barotrauma. Currently in Alpha. Incomplete.

Readme is WIP.

IMPORTANT: Assembly loading has been added to LuaCsForBarotrauma and thus is currently deprecated.

Steam Workshop

Feature List

[☑ Complete ⬛ Partial ☐ Not Available]

☑ Assembly-based Plugin Loading

☑ Configuration Loading/Saving

☑ Settings Menu Integration (requires SettingsMenu plugin, included on Steam Workshop)

☑ Automatic Dependency Resolution

☑ Network Sync

⬛ Custom GUI Helpers

For Lua Developers: How to Use - Config Variables (C# Developers look further down)

NOTE: Please use the Wiki articles instead of the below as they will generally be more up to date.

NOTE2: Not all features are implemented, see beginning of this README for details.

NOTE3: As Lua doesn't handle Generic method calls without mess, the only C# function you CANNOT use is AddConfigEntry<T>(), please make use of the helper extensions below. Everything else should follow the C# Config Var instructions further down (but written in Lua Syntax obviously).

-- Availability: CLIENT AND SERVER
-- Simplest verion
local mySimpleVar = ConfigManager.AddConfigBool(
    "MyVarName1",   -- [REQUIRED] Variable name
    "MyModName",    -- [REQUIRED] Mod name, used for the config file name.
    false           -- [REQUIRED] Default value.
)

-- Set your value
mySimpleVar.Value = true

-- Access your value
print(mySimpleVar.Value)

-- Save your value to file/disk
ModdingToolkit.Config.ConfigManager.Save(mySimpleVar)

-- Want to access it somewhere else?
local myVar2 = ModdingToolkit.Config.ConfigManager.GetConfigMember("MyModName","MyVarName1")

For C# Developers: How to Use - Config Variables

NOTE: You do NOT need to use the Assembly Plugin system in order to use the below. You can make use of this as a regular LuaCs mod.

NOTE2: Not all features are implemented, see beginning of this README for details.

All configuration variables are stored under <Game_Root>/Config/<ModName>/<ModName>.xml. ModName is the sanitized version of the Mod Name value so they may not match.

To create a configuration var simply use the API as per the below examples. The API is defined in the ConfigManager class (in /Client and /Shared).

You can manipulate these vars using the following Console Commands:

• cl_cfglistvars : Lists all defined vars, their types and their values.
• cl_cfggetvar <ModName> <VarName> : Prints out the data for this value.
• cl_cfgsetvar <ModName> <VarName> <NewValue> : Sets the var to a new value (use quotes for entries with spaces)
• cl_cfgsaveall : Saves all loaded vars to disk.

Example:

using ModdingToolkit.Config;
//...
void Initialize()
{
    // Availability: CLIENT AND SERVER
    // Simplest verion
    IConfigEntry<bool> mySimpleVar = ConfigManager.AddConfigEntry<bool>(
        "MyVarName1",   // [REQUIRED] Variable name
        "MyModName",    // [REQUIRED] Mod name, used for the config file name.
        false           // [REQUIRED] Default value.
    );
    
    //Set your value
    mySimpleVar.Value = true;
    //Access your value
    LuaCsSetup.PrintCsMessage($"MySimpleVar={mySimpleVar.Value}");
    //Save your value to file/disk
    ConfigManager.Save(mySimpleVar);
 }

More Examples:

using ModdingToolkit.Config;
//...
void Initialize()
{
    // Availability: CLIENT AND SERVER
    // T implements IConvertible: Primitive variable (bool, int, float, etc) and string, enum.
    IConfigEntry<int> myConfigvar = ConfigManager.AddConfigEntry<int>(
        "MyVarName2",    // [REQUIRED] Variable name
        "MyModName",    // [REQUIRED] Mod name, used for the config file name.
        10,             // [REQUIRED] Default value.
        IConfigBase.Category.Gameplay,  // [OPTIONAL] Which menu in the settings should it appear under?
        IConfigBase.NetworkSync.NoSync, // [OPTIONAL] Whether or not it should be synced between server and clients. IGNORED for IConfigControl.
        // [OPTIONAL] Called whenever the value is sucessfully updated.
        () =>                           
        { 
            LuaCsSetup.PrintCsMessage($"Value updated! Now: {myConfigVar.Value}") 
        },
        // [OPTIONAL] Predicate/Validation for a new value, returning false stops Var.Value from being changed. 
        (newVal) =>                     
        { 
            return newVal > 20; 
        }
    );
    
    // Availability: CLIENT AND SERVER
    // Dropdown List of strings
    IConfigList myConfigList = ConfigManager.AddConfigList(
        "MyListVar3",       // [REQUIRED] Variable name
        "MyModName",        // [REQUIRED] Mod name, used for the config file name.
        "SomeValue2",       // [REQUIRED] Default value, MUST exist in the list of values.
        new List<string>(){ "SomeValue1", "SomeValue2", "SomeValue3" }, // [REQUIRED] List of values in the list.
        IConfigBase.NetworkSync.NoSync, // [OPTIONAL] Which menu in the settings should it appear under?
        IConfigBase.Category.Gameplay,  // [OPTIONAL] Whether or not it should be synced between server and clients. IGNORED for IConfigControl.
        // [OPTIONAL] Predicate/Validation for a new value, returning false stops Var.Value from being changed. 
        (newValue) => 
        { 
            return ValidateChoice(newValue); 
        },
        // [OPTIONAL] Called whenever the value is sucessfully updated.
        () =>                           
        {
            LuaCsSetup.PrintCsMessage($"Value updated! Now: {myConfigList.Value}") 
        }
    );
    
    // Availability: CLIENT AND SERVER
    // Displays as a Slider in the Settings Menu: Gameplay Tab 
    // Creates a limited range variable, only available as INT or FLOAT.    
    // FOR FLOAT: IConfigRangeFloat => ConfigManager.AddConfigRangeFloat() 
    IConfigRangeInt icri = ConfigManager.AddConfigRangeInt(
        "TestEntry04",  // [REQUIRED] Variable name
        "ModdingTK",    // [REQUIRED] Mod name, used for the config file name.
        10,             // [REQUIRED] Default value.
        0,              // [REQUIRED] Minimum value.
        20,             // [REQUIRED] Maximum value.
        21              // [REQUIRED] Steps on the Slider. Should be ((Max - Min)/IncrementPerStep) + 1
    );
    
    // Availability: CLIENT ONLY
    // Creates a Key/Mouse Bind in the Settings Menu: Controls Tab
    IControlConfig myKeybind = ConfigManage.AddConfigKeyOrMouseBind(
        "MyListVar4",           // [REQUIRED] Variable name
        "MyModName",            // [REQUIRED] Mod name, used for the config file name.
        new KeyOrMouse(Keys.C), // [REQUIRED] Default value. Use the "MouseButton" Enum for mouse binds.
        // [OPTIONAL] Called whenever the value is sucessfully updated.
        () =>                           
        {
            LuaCsSetup.PrintCsMessage($"Value updated! Now: {myKeybind.GetStringValue()}") 
        }   
    );
}