You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-13Lines changed: 20 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,12 @@
1
-
<h1><imgsrc="./Misc/logo.png"width="64"align="center"> Valve's KeyValue for .NET</h1>
1
+
<h1align="center"><imgsrc="./Misc/logo.png"width="64"height="64"align="center"> Valve Key Value for .NET</h1>
2
2
3
-
[](https://github.com/ValveResourceFormat/ValveKeyValue/actions)
This library aims to be fully compatible with Valve's various implementations of
8
-
KeyValues format parsing (believe us, it's not consistent).
9
+
KeyValues is a simple key-value pair format used by Valve in Steam and the Source engine for configuration files, game data, and more (`.vdf`, `.res`, `.acf`, etc.). This library aims to be fully compatible with Valve's various implementations of KeyValues format parsing (believe us, it's not consistent).
9
10
10
11
# KeyValues1
11
12
@@ -14,7 +15,7 @@ Used by Steam and the Source engine.
14
15
## Deserializing text
15
16
16
17
### Basic deserialization
17
-
```cs
18
+
```csharp
18
19
varstream=File.OpenRead("file.vdf"); // or any other Stream
Essentially the same as text, just change `KeyValues1Text` to `KeyValues1Binary`.
104
+
105
+
# KeyValues3
106
+
107
+
This library does not currently support KeyValues3. There is an [open pull request](https://github.com/ValveResourceFormat/ValveKeyValue/pull/61) for KV3 support.
108
+
109
+
If you need KV3 support, use [ValveResourceFormat](https://github.com/ValveResourceFormat/ValveResourceFormat) which supports parsing Source 2 formats including KV3.
0 commit comments