Configs 1.0.4

.NET Standard 2.1
There is a newer version of this package available.
See the version list below for details.
dotnet add package Configs --version 1.0.4
NuGet\Install-Package Configs -Version 1.0.4
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="Configs" Version="1.0.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Configs --version 1.0.4
#r "nuget: Configs, 1.0.4"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Configs as a Cake Addin
#addin nuget:?package=Configs&version=1.0.4

// Install Configs as a Cake Tool
#tool nuget:?package=Configs&version=1.0.4

Configs icon


A simple way to save the configurations of a C# app as a json file.

The json file(s) is saved in AppData/Local/{YourAppName} and there is currently no way to change that.

How to use

Before we start, install the package from NuGet.

This package uses Newtonsoft.Json and the idea is to make a class that's going to be used as the model for the configuration file.


Make a class that inherits from ConfigsTools. This class is the model for your configurations file, so it details how the json file is going to look like. Model example:

using Configs;
using Newtonsoft.Json;

namespace MyApp
    class AppConfigs : ConfigsTools
	public AppConfigs()
	    ConfigsFileName = "MyConfigurations.json";

	[JsonProperty("activated", Required = Required.AllowNull)]
	public bool Activated { get; set; }

	[JsonProperty("randomString", Required = Required.Default)]
	public string RandomString { get; set; }

	[JsonProperty("importantStuff", Required = Required.AllowNull)]
	public List<ImportantThing> ImportantStuff { get; set; }

	public ImportantThing GetImportantThing(string owner)
	    return ImportantStuff.Find(x => x.OwnerName.Equals(owner));

Pretty much anything supported by Newtonsoft.Json and is serializable can be used in this model. You can of course make multiple models each with a different ConfigsFileName to have multiple configurations files.


Getting the file's values

using Configs;


// Get the current app configurations from the json configurations file.
AppConfigs appConfigs = ConfigsTools.GetConfigs<AppConfigs>();
// Get a value from the configurations file.
bool appConfigActivated = appConfigs.Activated;

Editing and saving the file

using Configs;


// Get the current app configurations from the json configurations file.
AppConfigs appConfigs = ConfigsTools.GetConfigs<AppConfigs>();
// Change value.
appConfigs.Activated = false;
// Save the file.


  "activated": false,
  "randomString": "Hey",
  "importantStuff": [
      "ownerName": "Elias Youssef"
      "ownerName": "Slim Shady"

Window Settings icon icon by Icons8

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 net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.1
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen 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

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.5 337 4/24/2022
2.0.4 289 4/23/2022
2.0.3 296 7/25/2021
2.0.2 287 4/11/2021
2.0.1 265 4/8/2021
1.0.4 228 4/1/2021
1.0.3 279 2/26/2021

Enabled "XML documentation file"