https://github.com/noxer/ventil
Valve Key-Value file parser in Go
https://github.com/noxer/ventil
go golang golang-library hacktoberfest key-value parser steam valve valve-data-format valve-keyvalues-files
Last synced: 4 months ago
JSON representation
Valve Key-Value file parser in Go
- Host: GitHub
- URL: https://github.com/noxer/ventil
- Owner: noxer
- License: mit
- Created: 2020-10-30T19:42:48.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-09-06T10:23:42.000Z (over 4 years ago)
- Last Synced: 2024-06-21T03:15:42.557Z (almost 2 years ago)
- Topics: go, golang, golang-library, hacktoberfest, key-value, parser, steam, valve, valve-data-format, valve-keyvalues-files
- Language: Go
- Homepage:
- Size: 17.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ventil
Valve Key-Value file parser in Go
## installation
`go get -u github.com/noxer/ventil`
## documentation
This Go package allows the parsing of key-value files used in Steam and other Valve products. It maintains the tree-like structure of the files and even supports the `#import` and `#base` directives. Because Valve's KV files are only loosely defined, this package can make no guarantees about compatibility. If you encounter a file that can't be read or is parsed incorrectly, please open an issue. The package name is the German translation of the word "valve".
You can find the API documentation here:
[https://pkg.go.dev/github.com/noxer/ventil](https://pkg.go.dev/github.com/noxer/ventil)
## usage
The package offers the two functions `ventil.Parse` and `ventil.ParseFile`. `ventil.Parse` takes a reader and parses it into a `*ventil.KV`. `ventil.ParseFile` is a simple wrapper which opens the file and passes it to `ventil.Parse`.
### KV
`*ventil.KV` represents a Key-Value pair. It may contain a value or child pairs, depending on the type of the KV. You can check it with the `HasValue` flag. Be aware that `kv.HasValue == false` does not guarantee, that `kv.FirstChild != nil`, in that case the list of children was empty.
You can call `kv.WriteTo(w)` to write an equivalent representation to the original file but without the comments to w.
## features
* Quoted and unquoted keys and values
* Comments
* Escape codes in strings
* Newlines in keys and values
* Subkeys
* Includes