SourceSchemaParser
This is a .NET library that attempts to make reading Valve's Source-engine schema files a little easier. The intention is to be able to consume .vdf and .txt (in VDF format) files into JSON and in memory objects.
About this Library
This library was created to read various schema files in Valve's source-engine games. Schema files contain details about items, heroes, classes, and more. Unfortunately, the schema files are in VDF format, which is JSON-like, but significantly worse than JSON.
These are the rules on which the library was built:
- Make the library as easy and user friendly as possible.
- Document everything as thoroughly as possible.
- Allow for conversion from VDF to JSON.
- Replace string tokens with localized text where appropriate and possible.
- Provide "flattened" objects from schemas such as "Items" and "Leagues" (still in progress).
Install the Library from NuGet
See the library in the NuGet gallery here. You can install the library into your project directly from the package manager.
How to Use the Library
- Read the
Aboutsection so you understand why this library exists - Install the library from NuGet
- Convert whatever VDF you have into JSON and use it however you want
- (future) Call methods to get "flattened" objects from schemas for easier consumption
Sample Usage
// this will return a collection of schema items which describe "Dota League" specific items like league images, web page, and more
var leagues = SchemaFactory.GetDotaLeaguesFromText(schema, languageToLoad);
// this will convert VDF format to JSON from a VDF file
var vdf = File.ReadAllLines("path/to/file.vdf");
var json = VDFConverter.ToJson(vdf);
// this will get the latest dota 2 game item schema and convert it to JSON
HttpClient client = new HttpClient();
var schema = await client.GetStringAsync(schemaUrl);
var json = VDFConverter.ToJson(schema);