SettingsManager

Simple settings manager to easily and quickly store/retrieve json settings files from local appdata.

Usage

Create a settings class

First we create a settings class. We can have as many of these as we want. Each will correspond to a file on the system.

using SettingsManager;

namespace ExampleProgram;

public class MySettings : Setting<MySettings>
{
    public string Username { get; set; } = "DefaultName";
    public bool IsRegistered { get; set; } = false;
    public float SomeValue { get; set; } = 0;
    public List<int> Numbers { get; set; } = new();
}

Use the settings

Then to use the settings, we simply need to get an instance of the settings file. By using instances, we ensure there's only ever one version and we keep the values consistent throughout the application.

// Let's grab the instance to make referencing it easier!
var mySettings = MySettings.Instance;

// Here we just print out the values to show them persisting.
Console.WriteLine($"Username: {mySettings.Username}");
Console.WriteLine($"IsRegistered: {mySettings.IsRegistered}");
Console.WriteLine($"SomeValue: {mySettings.SomeValue}");

Console.WriteLine("Numbers:");
foreach (var number in mySettings.Numbers)
{
    Console.WriteLine($"   - {number}");
}

if (!mySettings.IsRegistered)
{
    // Now set some new values to see the difference!
    Console.Write("Please choose a username: ");
    var newUsername = Console.ReadLine();
    mySettings.Username = newUsername;
    mySettings.IsRegistered = true;
    mySettings.SomeValue = 1.3f;
    
    mySettings.Numbers.Add(1);
    mySettings.Numbers.Add(3);
    mySettings.Numbers.Add(3);
    mySettings.Numbers.Add(7);
    
    MySettings.Save();
}

jeppevinkel/SettingsManager

SettingsManager

Usage

Create a settings class

Use the settings