DsSimpleSettings 2.2.5

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 a few minor changes:

• It was not intended that static properties were read or written from/to files. This has been fixed.
• The library now has its own base exception class from which all custom exceptions will inherit.

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.