DsSimpleSettings 3.0.1

SimpleSettings

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

In this version

This is marked as a major update, which means that stuff breaks when you update.

• WriteTemplate is removed in favour of ToFile.
• Write templates by calling ToFile with null as instance.
• Methods that use IO are more generalised so you can insert your own TextReaders/Writers.
• You can now pass instances of a class to the library to overwrite the settings in given instance.
• This library is now unit tested!

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 save the settings to a file, call Settings.ToFile(mySettingsInstance, "path/to/file.txt").
To create a template settings file from this class, call Settings.ToFile<MySettings>(null, "path/to/file.txt").

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 methods from instances.

The library can only create instances of classes that have a parameterless constructor. If your class doesn't have a parameterless constructor, you will have to create an instance yourself and pass that instance to the library instead.

If you have found a bug, something doesn't work as you would expect or you think this package could be improved in any way, please submit a feature request or bug report on the GitHub page of this project: https://github.com/D-Inventor/SimpleSettings