SharpConfig is an easy to use CFG/INI configuration library for .NET.
You can use SharpConfig to read, modify and save configuration files and streams, in either text or binary format.
The library is fully compatible with .NET 2.0 and higher, and the Mono Framework.
SharpConfig is also available at NuGet! Just search for
sharpconfig.
[General]
# a comment
SomeString = Hello World!
SomeInteger = 10 # an inline comment
SomeFloat = 20.05
SomeBoolean = true
SomeArray = { 1, 2, 3 }
Day = Monday
[Person]
Name = Peter
Age = 50To read these values, your C# code would look like:
var config = Configuration.LoadFromFile("sample.cfg");
var section = config["General"];
string someString = section["SomeString"].StringValue;
int someInteger = section["SomeInteger"].IntValue;
float someFloat = section["SomeFloat"].FloatValue;
bool someBool = section["SomeBoolean"].BoolValue;
int[] someIntArray = section["SomeArray"].IntValueArray;
string[] someStringArray = section["SomeArray"].StringValueArray;
DayOfWeek day = section["Day"].GetValue<DayOfWeek>();
// Entire user-defined objects can be created from sections and vice versa.
// See the wiki for more details.
var person = config["Person"].ToObject<Person>();
// ...foreach (var section in myConfig)
{
foreach (var setting in section)
{
// ...
}
}// Create the configuration.
var myConfig = new Configuration();
// Set some values.
// This will automatically create the sections and settings.
myConfig["Video"]["Width"].IntValue = 1920;
myConfig["Video"]["Height"].IntValue = 1080;
// Set an array value.
myConfig["Video"]["Formats"].StringValueArray = new[] { "RGB32", "RGBA32" };
// Get the values just to test.
int width = myConfig["Video"]["Width"].IntValue;
int height = myConfig["Video"]["Height"].IntValue;
string[] formats = myConfig["Video"]["Formats"].StringValueArray;
// ...myConfig.SaveToFile("myConfig.cfg"); // Save to a text-based file.
myConfig.SaveToStream(myStream); // Save to a text-based stream.
myConfig.SaveToBinaryFile("myConfig.cfg"); // Save to a binary file.
myConfig.SaveToBinaryStream(myStream); // Save to a binary stream.SharpConfig has more features, such as arrays, enums and object mapping.
For details and examples, please visit the Wiki. There are also use case examples available in the Example File.