https://github.com/valveresourceformat/valvekeyvalue

📃 Next-generation Valve's key value framework for .NET
https://github.com/valveresourceformat/valvekeyvalue

csharp dotnet hacktoberfest source2 steam valve

Last synced: 4 days ago
JSON representation

📃 Next-generation Valve's key value framework for .NET

• Host: GitHub
• URL: https://github.com/valveresourceformat/valvekeyvalue
• Owner: ValveResourceFormat
• License: mit
• Created: 2016-02-27T10:37:34.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-11-18T12:49:18.000Z (about 1 month ago)
• Last Synced: 2024-12-14T13:13:50.710Z (11 days ago)
• Topics: csharp, dotnet, hacktoberfest, source2, steam, valve
• Language: C#
• Homepage: https://www.nuget.org/packages/ValveKeyValue/
• Size: 491 KB
• Stars: 151
• Watchers: 10
• Forks: 38
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


 Valve's KeyValue for .NET


[![Build Status (GitHub)](https://img.shields.io/github/actions/workflow/status/ValveResourceFormat/ValveKeyValue/ci.yml?label=Build&style=flat-square&branch=master)](https://github.com/ValveResourceFormat/ValveKeyValue/actions)

[![NuGet](https://img.shields.io/nuget/v/ValveKeyValue.svg?label=NuGet&style=flat-square)](https://www.nuget.org/packages/ValveKeyValue/)

[![Coverage Status](https://img.shields.io/codecov/c/github/ValveResourceFormat/ValveKeyValue/master?label=Coverage&style=flat-square)](https://app.codecov.io/gh/ValveResourceFormat/ValveKeyValue)

This library aims to be fully compatible with Valve's various implementations of

KeyValues format parsing (believe us, it's not consistent).

# KeyValues1

Used by Steam and the Source engine.

## Deserializing text

### Basic deserialization

```cs

var stream = File.OpenRead("file.vdf"); // or any other Stream

var kv = KVSerializer.Create(KVSerializationFormat.KeyValues1Text);

KVObject data = kv.Deserialize(stream);

Console.WriteLine(data["some key"]);

```

### Typed deserialization

```cs

public class SimpleObject

{

    public string Name { get; set; }

    public string Value { get; set; }

}

var stream = File.OpenRead("file.vdf"); // or any other Stream

var kv = KVSerializer.Create(KVSerializationFormat.KeyValues1Text);

KVObject data = kv.Deserialize(stream);

```

### Options

`Deserialize` method also accepts an `KVSerializerOptions` object.

By default, operating system specific conditionals are enabled based on the OS the code is running on (`RuntimeInformation`).

`KVSerializerOptions` accepts has the following options:

* `Conditions` - List of conditions to use to match conditional values.

* `HasEscapeSequences` - Whether the parser should translate escape sequences (e.g. `\n`, `\t`).

* `EnableValveNullByteBugBehavior` - Whether invalid escape sequences should truncate strings rather than throwing a `InvalidDataException`.

* `FileLoader` - Provider for referenced files with `#include` or `#base` directives.

```cs

var options = new KVSerializerOptions

{

    HasEscapeSequences = true,

};

options.Conditions.Clear(); // Remove default conditionals set by the library

options.Conditions.Add("X360WIDE");

var stream = File.OpenRead("file.vdf");

var kv = KVSerializer.Create(KVSerializationFormat.KeyValues1Text);

var data = kv.Deserialize(stream, options);

```

## Deserializing binary

Essentially the same as text, just change `KeyValues1Text` to `KeyValues1Binary`.

## Serializing to text

```cs

class DataObject

{

    public string Name { get; set; }

    public string Developer { get; set; }

    [KVProperty("description")]

    public string Summary { get; set; }

    [KVIgnore]

    public string ExtraData { get; set; }

}

var data = new DataObject

{

    Developer = "Valve Software",

    Name = "Dota 2",

    Summary = "Dota 2 is a complex game.",

    ExtraData = "This will not be serialized."

};

using var stream = File.OpenWrite("file.vdf");

var kv = KVSerializer.Create(KVSerializationFormat.KeyValues1Text);

kv.Serialize(stream, data, "root object name");

```

## Serializing to binary

Essentially the same as text, just change `KeyValues1Text` to `KeyValues1Binary`.