Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andygrunwald/vdf
A Lexer and Parser for Valves Data Format (known as vdf) written in Go
https://github.com/andygrunwald/vdf
counter-strike go hacktoberfest lexer steam valve valve-data-file valve-data-format vdf vdf-parser
Last synced: 3 days ago
JSON representation
A Lexer and Parser for Valves Data Format (known as vdf) written in Go
- Host: GitHub
- URL: https://github.com/andygrunwald/vdf
- Owner: andygrunwald
- License: mit
- Created: 2016-02-27T21:43:03.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2024-12-14T08:31:08.000Z (29 days ago)
- Last Synced: 2025-01-01T15:07:42.366Z (10 days ago)
- Topics: counter-strike, go, hacktoberfest, lexer, steam, valve, valve-data-file, valve-data-format, vdf, vdf-parser
- Language: Go
- Homepage:
- Size: 167 KB
- Stars: 44
- Watchers: 4
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- trackawesomelist - vdf (⭐44) - A Lexer and Parser for Valves Data Format (known as vdf) written in Go. (Recently Updated / [Oct 31, 2024](/content/2024/10/31/README.md))
README
# vdf: A Lexer and Parser for Valves Data Format (known as vdf)
[](https://pkg.go.dev/github.com/andygrunwald/vdf)
[](https://goreportcard.com/report/github.com/andygrunwald/vdf)
A Lexer and Parser for [Valves Data Format (known as vdf)](https://developer.valvesoftware.com/wiki/KeyValues) written in Go.
## Table of Contents
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Usage](#usage)
- [API-Documentation](#api-documentation)
- [Development](#development)
- [Unit testing](#unit-testing)
- [Fuzzing tests](#fuzzing-tests)
- [Press](#press)
- [VDF parser in other languages](#vdf-parser-in-other-languages)
- [Inspiration](#inspiration)
- [License](#license)
## Installation
It is go gettable
```
$ go get github.com/andygrunwald/vdf
```
## Usage
Given a file named [`gamestate_integration_consolesample.cfg`](testdata/gamestate_integration_consolesample.cfg) with content:
```
"Console Sample v.1"
{
"uri" "http://127.0.0.1:3000"
"timeout" "5.0"
"buffer" "0.1"
"throttle" "0.5"
"heartbeat" "60.0"
[...]
}
```
Can be parsed with this Go code:
```go
package main
import (
"fmt"
"os"
"github.com/andygrunwald/vdf"
)
func main() {
f, err := os.Open("gamestate_integration_consolesample.cfg")
if err != nil {
panic(err)
}
p := vdf.NewParser(f)
m, err := p.Parse()
if err != nil {
panic(err)
}
fmt.Println(m)
}
```
And it will output:
```
map[
Console Sample v.1:map[
uri:http://127.0.0.1:3000
timeout:5.0
buffer:0.1
throttle:0.5
heartbeat:60.0
[...]
]
]
```
## API-Documentation
The official Go package documentation can be found at https://pkg.go.dev/github.com/andygrunwald/vdf.
## Development
### Unit testing
To run the local unit tests, execute
```sh
$ make test
```
To run the local unit tests and view the unit test code coverage in your local web browser, execute
```sh
$ make test-coverage-html
```
### Fuzzing tests
This library implements [Go fuzzing](https://go.dev/security/fuzz/).
The generated fuzzing corpus is stored in [andygrunwald/vdf-fuzzing-corpus](https://github.com/andygrunwald/vdf-fuzzing-corpus/), to avoid blowing up the size of this repository.
To run fuzzing locally, execute
```sh
$ make init-fuzzing # Clone the corpus into testdata/fuzz
$ make clean-fuzzing # Clean the local fuzzing cache
$ make test-fuzzing # Execute the fuzzing
```
## Press
* Podcast: [Engineering Kiosk Episode "#42 Lexer, Parser und Open Source in Counterstrike" (25th of October 2022, German Software Engineering Podcast)](https://engineeringkiosk.dev/podcast/episode/42-lexer-parser-und-open-source-in-counterstrike/?pk_campaign=github_vdf)
## VDF parser in other languages
* PHP and JavaScript: [rossengeorgiev/vdf-parser](https://github.com/rossengeorgiev/vdf-parser)
* PHP: [devinwl/keyvalues-php](https://github.com/devinwl/keyvalues-php)
* PHP: [lukezbihlyj/vdf-parser](https://github.com/lukezbihlyj/vdf-parser)
* PHP: [EXayer/vdf-converter](https://github.com/EXayer/vdf-converter)
* C#: [sanmadjack/VDF](https://github.com/sanmadjack/VDF)
* C#: [shravan2x/Gameloop.Vdf](https://github.com/shravan2x/Gameloop.Vdf)
* C#: [Indieteur/Steam-Apps-Management-API](https://github.com/Indieteur/Steam-Apps-Management-API)
* C#: [GerhardvanZyl/Steam-VDF-Converter](https://github.com/GerhardvanZyl/Steam-VDF-Converter)
* C++: [TinyTinni/ValveFileVDF](https://github.com/TinyTinni/ValveFileVDF)
* Java: [DHager/hl2parse](https://github.com/DHager/hl2parse)
* JavaScript [node-steam/vdf](https://github.com/node-steam/vdf)
* JavaScript: [Corecii/steam-binary-vdf-ts](https://github.com/Corecii/steam-binary-vdf-ts)
* JavaScript: [RoyalBingBong/vdfplus](https://github.com/RoyalBingBong/vdfplus)
* JavaScript: [key-values/key-values-ts](https://github.com/key-values/key-values-ts)
* Python: [ValvePython/vdf](https://github.com/ValvePython/vdf)
* Python: [gorgitko/valve-keyvalues-python](https://github.com/gorgitko/valve-keyvalues-python)
* Python: [noriah/PyVDF](https://github.com/noriah/PyVDF)
* Go: [marshauf/keyvalues](https://github.com/marshauf/keyvalues)
* Go: [Jleagle/steam-go](https://github.com/Jleagle/steam-go/)
* Go: [Wakeful-Cloud/vdf](https://github.com/Wakeful-Cloud/vdf)
* Rust: [LovecraftianHorror/vdf-rs](https://github.com/LovecraftianHorror/vdf-rs)
* Rust: [Corecii/steam_vdf](https://github.com/Corecii/steam_vdf)
* Other (VS-Code Extension): [cooolbros/vscode-vdf](https://github.com/cooolbros/vscode-vdf)
* And some more: [Github search for vdf valve](https://github.com/search?p=1&q=vdf+valve&ref=searchresults&type=Repositories&utf8=%E2%9C%93)
## Inspiration
The code is inspired by [@benbjohnson](https://github.com/benbjohnson)'s article [Handwritten Parsers & Lexers in Go](https://blog.gopheracademy.com/advent-2014/parsers-lexers/) and his example [sql-parser](https://github.com/benbjohnson/sql-parser).
Thank you Ben!
## License
This project is released under the terms of the [MIT license](http://en.wikipedia.org/wiki/MIT_License).