nucs.JsonSettings 2.0.0-alpha4

.NET Standard 2.0
This is a prerelease version of nucs.JsonSettings.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package nucs.JsonSettings --version 2.0.0-alpha4
NuGet\Install-Package nucs.JsonSettings -Version 2.0.0-alpha4
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="nucs.JsonSettings" Version="2.0.0-alpha4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add nucs.JsonSettings --version 2.0.0-alpha4
#r "nuget: nucs.JsonSettings, 2.0.0-alpha4"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install nucs.JsonSettings as a Cake Addin
#addin nuget:?package=nucs.JsonSettings&version=2.0.0-alpha4&prerelease

// Install nucs.JsonSettings as a Cake Tool
#tool nuget:?package=nucs.JsonSettings&version=2.0.0-alpha4&prerelease


Nuget downloads NuGet GitHub license

Easiest way you'll ever write settings for your app. The library is built to be Modular and One Liner exploiting the powerful serialization capabilities of Json.NET out of the box without any mapping necessary to serialize nested custom objects, dictionaries and lists.


PM> Install-Package nucs.JsonSettings

Getting Started

See <br> Test project: <br> Blog Posts: </br> Serialization Guide: </br>

JsonSettings is the base abstract class that inherits ISavable. <br> Here is a self explanatory quicky of to how and what:

  • I want a hardcoded settings file
//Step 1: create a class and inherit JsonSettings
class MySettings : JsonSettings {
    //Step 2: override a default FileName or keep it empty. Just make sure to specify it when calling Load!
    //This is used for default saving and loading so you won't have to specify the filename/path every time.
    //Putting just a filename without folder will put it inside the executing file's directory.
    public override string FileName { get; set; } = "TheDefaultFilename.extension"; //for loading and saving.

    #region Settings

    public string SomeProperty { get; set; }
    public Dictionary<string, object> Dictionary { get; set; } = new Dictionary<string, object>();
    public int SomeNumberWithDefaultValue { get; set; } = 1;
    [JsonIgnore] public char ImIgnoredAndIWontBeSaved { get; set; }
    //Step 3: Override parent's constructors
    public MySettings() { }
    public MySettings(string fileName) : base(fileName) { }
//Step 4: Load
public MySettings Settings = JsonSettings.Load<MySettings>("config.json"); //relative path to executing file.
//or create a new empty
public MySettings Settings = JsonSettings.Construct<MySettings>("config.json");

//Step 5: Pwn.
Settings.SomeProperty = "ok";
  • I want a dynamic settings
    • Dynamic settings will automatically create new keys.
    • ValueTypes are returned as Nullable<Type>, therefore if a key doesn't exist - a null is returned.
//Step 1: Just load it, it'll be created if doesn't exist.
public SettingsBag Settings = JsonSettings.Load<SettingsBag>("config.json");
//Step 2: use!
Settings["key"]  = "dat value tho";
Settings["key2"] = 123; //dat number tho
dynamic dyn = Settings.AsDynamic();
if ((int?)dyn.key2==123)
dyn.Save(); /* or */ Settings.Save();
  • I want a encrypted settings file
    • Uses AES/Rijndael
    • Can be applied to any settings class because it is a module.
MySettings Settings = JsonSettings.Load<MySettings>("config.json", q=>q.WithEncryption("mysupersecretpassword"));
SettingsBag Settings = JsonSettings.Load<SettingsBag>("config.json", q=>q.WithEncryption("mysupersecretpassword"));
MySettings Settings = JsonSettings.Configure<MySettings>("config.json")
               //or: .WithModule<RijndaelModule>("pass");

SettingsBag Settings = JsonSettings.Configure<SettingsBag>("config.json")
               //or: .WithModule<RijndaelModule>("pass");

  • I want dynamic settings to automatically save when changed
    • note: SettingsBag has it's own implementation of EnableAutosave().
//Step 1:
SettingsBag Settings = JsonSettings.Load<SettingsBag>("config.json").EnableAutosave();
//Unavailable for hardcoded settings yet! (ty netstandard2.0 for not being awesome on proxies)
//Step 2:
Settings.AsDynamic().key = "wow"; //BOOM! SAVED!
Settings["key"] = "wow two"; //BOOM! SAVED!
  • I want hardcoded settings to automatically save when changed
    • Requires package nucs.JsonSettings.Autosave that uses Castle.Core.
Settings x  = JsonSettings.Load<Settings>().EnableAutosave();
ISettings x = JsonSettings.Load<Settings>().EnableIAutosave<ISettings>(); //Settings implements interface ISettings

x.Property = "value"; //Booyah! SAVED!
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on nucs.JsonSettings:

Package Downloads

Windows 11 settings page in WinUI 3 apps With many useful helper classes


An extension to JsonSettings that allows to wrap a class via transparent proxy that autosaves. Support for Autosaving on INotifyPropertyChanged/INotifyCollectionChanged.

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on nucs.JsonSettings:

Repository Stars
GUI for installing apps through WinGet and Creating Yaml file
Windows 11 settings page in WinUI 3 applications ported from Powertoys
Version Downloads Last updated
2.0.0-alpha7 2,022 5/23/2021
2.0.0-alpha5 236 5/9/2021
2.0.0-alpha4 212 5/8/2021
2.0.0-alpha3 257 5/1/2021
2.0.0-alpha2 283 3/31/2021
2.0.0-alpha1 226 3/29/2021
1.0.7 7,645 6/3/2018
1.0.6 900 5/26/2018
1.0.5 950 5/11/2018
1.0.4 934 4/12/2018
1.0.3 916 4/12/2018
1.0.2 941 4/8/2018 1,089 9/30/2017

- Added RecoveryModule  and .WithRecovery to capture parsing errors
- Added JsonSettings.SuspendAutosave() extension
- Added proxy construction guard to prevent unncessary allocation on proxy creation.
- Fix non virtual built-in properties returning null after being wrapped with proxy.
- Added ProxyGeneratedAttribute that is attached to every proxy-generated class
- Module: made Dispose() inheritable.
- Module.Socket: changed to WeakReference<JsonSettings>
- SettingsBag: added support for SuspendAutosave #26
- VersioningModule: some internal fixes and renames #19
- Added RecoveryModule and WithRecovery api. #19
- JsonSettings: added TryingRecover and Recovered events.
- JsonSettings: Removed ThrowOnEmptyFile, this is handled by RecoveryModule now
- Made all module functions and variables protected or virtual.
- FluentJsonSettings: replaced dynamic creation with hardcoded creation (faster).
- Added proper Versioning example
- JsonSettings: add OnXXXX methods that trigger event changed to protected internal.