README
¶
keyvalues
Go library for parsing Valve keyvalue format files. This library constructs a simple kv node tree that you can query any structure(s) and any property(s) of.
It has been tested against various gameinfo.txt engine files, but should work with other KeyValue files as well (such as .vmf or .vmt).
Usage
package main
import (
"log"
"os"
"github.com/galaco/keyvalues"
)
func main() {
file,_ := os.Open("gameinfo.txt")
reader := keyvalues.NewReader(file)
kv,_ := reader.Read()
// counterstrike: source's gameinfo.txt would return "Counter-Strike Source"
gameInfoNode,_ := kv.Find("GameInfo")
gameNode,_ := gameInfoNode.Find("game")
log.Println(gameNode.AsString())
// counterstrike: source's gameinfo.txt would return 1
noModelsNode,_ := gameInfoNode.Find("nomodels")
log.Println(noModelsNode.AsInt())
// counterstrike: source's gameinfo.txt would return 240
fileSystemNode,_ := gameInfoNode.Find("FileSystem")
appIdNode,_ := fileSystemNode.Find("SteamAppId")
log.Println(appIdNode.AsInt())
}
Todo
- Implement multi-line values. At present, a
\ncharacter in a quoted value will break the parser. This is how CS:GO Hammer behaves. However, other versions of Hammer support this, as well as all engine versions. Worth noting what spec is available doesn't cover this behaviour. - Implement pointer value type (unsure if there is any point to this besides matching spec)
- Proper test coverage
Documentation
¶
Index ¶
- Constants
- type KeyValue
- func (node *KeyValue) AddChild(value *KeyValue) error
- func (node *KeyValue) AsFloat() (float32, error)
- func (node *KeyValue) AsInt() (int32, error)
- func (node *KeyValue) AsString() (string, error)
- func (node *KeyValue) Children() (children []*KeyValue, err error)
- func (node *KeyValue) Find(key string) (*KeyValue, error)
- func (node *KeyValue) FindAll(key string) (children []*KeyValue, err error)
- func (node *KeyValue) HasChildren() bool
- func (node *KeyValue) Key() string
- func (node *KeyValue) MergeInto(parent *KeyValue) (merged KeyValue, err error)
- func (node *KeyValue) Parent() *KeyValue
- func (node *KeyValue) Type() ValueType
- type Reader
- type ValueType
Constants ¶
const ValueArray = ValueType("array")
const ValueFloat = ValueType("float")
const ValueInt = ValueType("integer")
const ValuePtr = ValueType("ptr")
const ValueString = ValueType("string")
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type KeyValue ¶
type KeyValue struct {
// contains filtered or unexported fields
}
A KeyValue object, that may hold multiple Values
func (*KeyValue) AddChild ¶
Add adds a new KeyValue pair to an existing Key Existing key's value must be an Array type
func (*KeyValue) Children ¶
GetChildren gets all node child values This is used for keys that contain 1 or more children as its value rather than a basic type
func (*KeyValue) Find ¶
Find returns a keyvalue pair where the key matches input It will return the first found KeyValue in cases where the key is defined multiple times
func (*KeyValue) FindAll ¶
FindAll returns all children of a given type for a node. This is different from properties, as a property is a string:<primitive> This will return an array of all KeyValues that match a given key, even though there should be only one.
func (*KeyValue) HasChildren ¶
HasChildren returns if this Key has KeyValues as its own value.
func (*KeyValue) MergeInto ¶ added in v1.2.0
MergeInto merges this KeyValue tree into another. The resultant tree will contain all nodes in the same tree from both this and the target. In the case where a key exists in both trees, this key's value will replace the parent's value
type Reader ¶
type Reader struct {
// contains filtered or unexported fields
}
Reader is used for parsing a KeyValue format stream There are various KeyValue based formats (vmt, vmf, gameinfo.txt etc.) This should be able to parse all of them.
Source Files
Directories