EasyConfig

Updated Wiki: Home

SimReality — Sun, 15 Jun 2008 03:59:24 GMT

EasyConfig is a simple configuration file parsing library created by Nick Gravelyn (http://nick.gravelyn.com).

EasyConfig supports files that follow the following format:

[GroupName]
name = value #comment
#comment

Configuration files consist of one or more groups designated by using the [] brackets with a name inside. Each group consists of one or more settings. A setting is set up as a name and a value separated by an equals sign (=).

Setting values can be integers, floating point numbers, booleans, or strings. Strings are designated with quotes like the following:

aStringSetting = "SomeString"

Booleans can be set using any of the following: on, off, true, false, yes, no. Booleans are also not case sensitive so the following works:

aBoolSetting = yEs

Settings can also be arrays which are defined simply by using a comma-separated list of values of the same type. You could make an array of booleans like so:

aBoolArray = no, yes, false, true, on, off, off

You can also place comments in your configuration files using the pound sign (#). Any contents of a line following a pound sign (#) will be ignored by the parser.

EasyConfig parses these files and converts all the groups and settings into easy to navigate classes for easy access to these properties in your application without you having to manually parse the files. The following is a sample of how to parse a window size for an XNA game:

(The configuration file:)
[Video]
Width = 1280
Height = 720

(The code:)
graphics.PreferredBackBufferWidth = config.SettingGroups["Video"].Settings["Width"].GetValueAsInt();
graphics.PreferredBackBufferHeight = config.SettingGroups["Video"].Settings["Height"].GetValueAsInt();
graphics.ApplyChanges();

If you find this library of any use, please also consider donating at the following page: http://nick.gravelyn.com/donations.php.

Patch Uploaded: #1381

Christian24 — Fri, 13 Jun 2008 18:41:46 GMT

Christian24 has uploaded a patch.

Description:
Updated to XNA 3.0

NEW POST: Saving to file on Xbox

SimReality — Wed, 14 May 2008 08:35:35 GMT

The file system on the Xbox doesn't just allow you to write files like that. You have to use the StorageDevice to get a StorageContainer and use that to get a file path to save the file. See this tutorial: http://msdn.microsoft.com/en-us/library/bb203921.aspx.

NEW POST: Saving to file on Xbox

DasiNF — Mon, 05 May 2008 10:02:09 GMT

Hi,

I don't know if I'm brain farting here, but my game crashes every time I try to write on the Xbox360. Reading works fine.

My writing code is simply...

config.SettingGroups"Game".Settings"Players".SetValue(amountOfPlayers);
config.Save("config.ini");

Works like a charm on the PC, have I missed something critical? config.ini has been copied to both bin\x86\debug and bin\xbox360\debug

Source code checked in

SimReality — Tue, 08 Apr 2008 05:59:04 GMT

Globalized the Get/Set methods for integers, floats, integer arrays, and float arrays.

CREATED RELEASE: EasyConfig 1.0.2 Release (Mar 20, 2008)

Fri, 21 Mar 2008 06:45:12 GMT

Just updated the XNA projects to work with XNA Game Studio 2.0.

Patch Applied

SimReality — Fri, 21 Mar 2008 06:43:07 GMT

SimReality has applied patch #1011.

Comment:
Updated projects to 2.0.

Source code checked in

SimReality — Fri, 21 Mar 2008 06:42:46 GMT

Updated projects to XNA 2.0.

Patch Uploaded

Christian24 — Thu, 20 Mar 2008 19:36:38 GMT

Christian24 has uploaded a patch.

Description:
Made new projects for XNA 2.0.
The sample now just loads the video config settings.

UPDATED WIKI: Home

SimReality — Tue, 18 Mar 2008 17:48:10 GMT

UPDATED WIKI: Home

SimReality — Tue, 18 Mar 2008 17:46:51 GMT

EasyConfig is a simple configuration file parsing library created by Nick Gravelyn (http://nick.gravelyn.com).

EasyConfig supports files that follow the following format:

[GroupName]
name = value #comment
#comment

Configuration files consist of one or more groups designated by using the [] brackets with a name inside. Each group consists of one or more settings. A setting is set up as a name and a value separated by an equals sign (=).

Setting values can be integers, floating point numbers, booleans, or strings. Strings are designated with quotes like the following:

aStringSetting = "SomeString"

Booleans can be set using any of the following: on, off, true, false, yes, no. Booleans are also not case sensitive so the following works:

aBoolSetting = yEs

Settings can also be arrays which are defined simply by using a comma-separated list of values of the same type. You could make an array of booleans like so:

aBoolArray = no, yes, false, true, on, off, off

You can also place comments in your configuration files using the pound sign (#). Any contents of a line following a pound sign (#) will be ignored by the parser.

EasyConfig parses these files and converts all the groups and settings into easy to navigate classes for easy access to these properties in your application without you having to manually parse the files. The following is a sample of how to parse a window size for an XNA game:

(The configuration file:)
[Video]
Width = 1280
Height = 720

(The code:)
graphics.PreferredBackBufferWidth = config.SettingGroups["Video"].Settings["Width"].GetValueAsInt();
graphics.PreferredBackBufferHeight = config.SettingGroups["Video"].Settings["Height"].GetValueAsInt();
graphics.ApplyChanges();

EasyConfig is open source and licensed under the MIT License. Feel free to use EasyConfig however you would like so long as you credit me (Nick Gravelyn) with creating EasyConfig.

NEW POST: Xbox project will not open

SimReality — Sun, 16 Mar 2008 22:37:10 GMT

It's probably because it's an XNA 1.0 project. I will hopefully get around to updating this by the end of the week, but you should be able to make a new Xbox project on your own and just copy the files in there. Nothing real special involved.

NEW POST: Save changes/new items

SimReality — Sun, 16 Mar 2008 22:36:25 GMT

That functionality does exist. The ConfigFile class has a Save method to save out any changes to a file.

NEW POST: Does EasyConfig works for XNA 2?

SimReality — Sun, 16 Mar 2008 22:35:46 GMT

That's correct. There is nothing but pure .NET C# in there, so you can use it with any .NET application and any version of the XNA framework.

NEW POST: Xbox project will not open

JTripodo — Tue, 11 Mar 2008 22:12:49 GMT

Not sure if there is a problem on my side but the Xbox projects do not appear to be working. Every time I try and open the project I get a message box saying that the project type is not supported. I am using Visual C# Express 2005.

Thanks,
John

NEW POST: Save changes/new items

Chr0n1x — Sun, 02 Mar 2008 02:31:11 GMT

Hi,
Is/would it be possible to enable save functionality so changes made in application to the in-memory data can be saved back to the ini file?

NEW POST: Does EasyConfig works for XNA 2?

Chr0n1x — Sun, 02 Mar 2008 02:27:39 GMT

Hi, EasyConfig does not require XNA at all from the looks of it. So you could theoretically use it on a non-XNA .Net application.

UPDATED WIKI: Home

SimReality — Sat, 01 Mar 2008 02:47:26 GMT

EasyConfig is a simple configuration file parsing library created by Nick Gravelyn.

EasyConfig supports files that follow the following format:

[GroupName]
name = value #comment
#comment

Configuration files consist of one or more groups designated by using the [] brackets with a name inside. Each group consists of one or more settings. A setting is set up as a name and a value separated by an equals sign (=).

Setting values can be integers, floating point numbers, booleans, or strings. Strings are designated with quotes like the following:

aStringSetting = "SomeString"

Booleans can be set using any of the following: on, off, true, false, yes, no. Booleans are also not case sensitive so the following works:

aBoolSetting = yEs

Settings can also be arrays which are defined simply by using a comma-separated list of values of the same type. You could make an array of booleans like so:

aBoolArray = no, yes, false, true, on, off, off

You can also place comments in your configuration files using the pound sign (#). Any contents of a line following a pound sign (#) will be ignored by the parser.

EasyConfig parses these files and converts all the groups and settings into easy to navigate classes for easy access to these properties in your application without you having to manually parse the files. The following is a sample of how to parse a window size for an XNA game:

(The configuration file:)
[Video]
Width = 1280
Height = 720

(The code:)
graphics.PreferredBackBufferWidth = config.SettingGroups["Video"].Settings["Width"].GetValueAsInt();
graphics.PreferredBackBufferHeight = config.SettingGroups["Video"].Settings["Height"].GetValueAsInt();
graphics.ApplyChanges();

EasyConfig is open source and licensed under the MIT License. Feel free to use EasyConfig however you would like so long as you credit me (Nick Gravelyn) with creating EasyConfig.

NEW POST: Does EasyConfig works for XNA 2?

extrakun — Wed, 16 Jan 2008 04:05:46 GMT

Hi, will EasyConfig work for XNA 2?

RELEASED: Easy Config 1.0.1 Release (Nov 06, 2007)

Tue, 06 Nov 2007 05:26:48 GMT

* Added Xbox 360 project to solution
* Added Load method to ConfigFile so an instance can be reused
* Added new constructor to ConfigFile to create blank configuration file
* Added methods for adding/deleting settings groups from a ConfigFile
* Added methods for adding/deleting settings from a SettingsGroup
* Added methods for setting the value of a Setting
* Added a Save method to ConfigFile to allow for saving out of the configuration file