DsSimpleSettings 2.3.0

SimpleSettings

SimpleSettings is a small library that allows easy access to settings reading and writing, with user-defined class blueprints.

In this version

This version brings back what was removed as a bug:

• You can now target static properties as settings, using the StaticSetting attribute.
• Everything in this package now comes with documentation!
• This package was supposed to have a standard MIT license, but I am currently unable to actually put it on the package.
• In the near future, I might be reworking the attributes a bit, because currently it's becoming really cluttered. Beware for a 3.0.0 release somewhere soon!

Usage

Using this library is very straightforward. One simply needs to create a class with publicly exposed properties and call the library function to load settings into it.

MySettings.cs

using SimpleSettings;

namespace MyProject
{
  class MySettings
  {
    public string MyFirstSetting { get; set; }
    
    [Description("This is a very important integer value")]
    [Default(2)]
    public int MySecondSetting { get; set; }
    
    [Description("This class has a public method called 'Parse'")]
    public SomeClass MyThirdSetting { get; set; }
    
    [Ignore]
    public float MyIgnoredSetting { get; set; } // this setting gets ignored by the settings reader
    
    [Group("My group!")]
    public float MyFirstGroupSetting { get; set; }
    [Group("My group!")]
    public System.Version MySecondGroupSetting { get; set; }
  }
}

To read settings from a file into an instance of this class, one simply has to call Settings.FromFile<MySettings>("path/to/file.txt").
To create a template settings file from this class, call Settings.WriteTemplate<MySettings>().
To save the settings to a file, call Settings.ToFile(mySettingsInstance, "path/to/file.txt").

The WriteTemplate method uses the default value and the description. The output would look like this:

MySettings_template.txt

;===(My group!)===
MyFirstGroupSetting:0
MySecondGroupSetting:
;=================
MyFirstSetting:

; This is a very important integer value
MySecondSetting:2

; This class has a public method called 'Parse'
MyThirdSetting:

Alternatively, the class can inherit the Settings class and can then call the ToFile and WriteTemplate methods from instances.

A class must have a parameterless constructor, otherwise the settings loader cannot create a new instance of the class.