Library for LiteLoader.NET for easier plugin development. It provides features such as:
var config = new Config();
If you work with
Example of work with the config:
- Saving plugin resources to the plugin data folder
- Reading and editing
YAML,JSONandPropertiesconfigs
Install
- Download the latest
LLNETUtils.dllfrom Releases - Copy
LLNETUtils.dllintoplugins/libin the server directory
Get started
To start working with the library, you can add the NuGet package LLNETUtils to your project. Or you can do the following:- [Optional] Copy the documentation file
LLNETUtils.xml(from Releases) to the folder withLLNETUtils.dll - Add
LLNETUtils.dllto the project references
PluginBase class:
C#:
[PluginMain("Plugin name")]
public class Main : PluginBase
{
...
}Plugin resources
Save resource file
Use theSaveResource and SaveDefaultConfig methods of the PluginBase class to save the resource file to plugin data folder.
C#:
// Suppose we have a "Resources" folder in the project with the following structure:
// - Resources
// - lang
// - en_US.json
// - config.yml
// Save (if does not exist) "en_US.json" to ".../plugins/<plugin>/en_US.json"
SaveResource("en_US.json")
// Save (with replace) "en_US.json" to ".../plugins/<plugin>/lang/en_US.json"
SaveResource("lang/en_US.json", true)
// Save (if does not exist) "en_US.json" to ".../plugins/<plugin>/eng.json"
SaveResource("Resources/lang/en_US.json", false, "eng.json")
// Save (if does not exist) "config.yml" to ".../plugins/<plugin>/config.yml"
SaveDefaultConfig()
// Save (with replace) "config.yml" to ".../plugins/<plugin>/config.yml"
SaveDefaultConfig(true)Get resource file stream
Use theGetResource method of the PluginBase class. This allows you to read the resource file (using it's stream) without saving it to data folder.
C#:
Stream? resource = GetResource("lang.json");Configs
TheConfig class allows you to easily read and modify YAML, JSON and Properties configs.Load config
You can load the config from a file or from a stream using theLoad and Reload methods of the Config class, or immediately on initialization.var config = new Config();
C#:
// Load from a file
config.Load(Path.Join(DataPath, "en_US.json"));
// Load from a stream
config.Load(GetResource("en_US.json")!, ConfigType.Json);
// Reload from a file
config.Reload();
// Create an object and load it immediately from a file
var config2 = new Config(Path.Join(DataPath, "en_US.json"));If you work with
config.yml, you don't have to manually create a new Config object and load it. Just use the Config property of the PluginBase class. The config will load automatically if there is a corresponding file or embedded resource.
C#:
Config defaultConfig = Config;Save config
To save the config, use theSave method of the Config class.
C#:
// Save to ".../plugins/<plugin>/lang/en_US.json"
config.Save(Path.Join(DataPath, "lang/en_US.json"));Read and modify config
All necessary methods are in theIConfigSection interface (classes Config and ConfigSection implement this interface).Example of work with the config:
C#:
Config config = new Config(Path.Join(DataPath, "user1.yml"));
string? name = config.Get<string>("name");
string lastName = config.GetString("last-name", "Unknown");
int id = config.GetInt("id");
List<string>? perms = config.GetList<string>("perms");
IConfigSection settings = config.GetSection("settings")!;
DateTime birthDate = settings.GetDateTime("birth-date");
config.Set("name", "Pavel");
config.Set("extra-data", new ConfigSection());
config.Remove("perms");
settings.Clear();
config.Set("settings.mute-notifications", true);
