https://github.com/galaco/keyvalues

Source engine KeyValue format parser (e.g. gameinfo.txt, vmt, vmf)
https://github.com/galaco/keyvalues

game-info gameinfo keyvalue keyvalue-files source-engine valve vmt

Last synced: 20 days ago
JSON representation

Source engine KeyValue format parser (e.g. gameinfo.txt, vmt, vmf)

• Host: GitHub
• URL: https://github.com/galaco/keyvalues
• Owner: Galaco
• License: unlicense
• Created: 2018-10-09T14:47:23.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T05:46:58.000Z (about 1 year ago)
• Last Synced: 2024-10-22T05:24:34.818Z (2 months ago)
• Topics: game-info, gameinfo, keyvalue, keyvalue-files, source-engine, valve, vmt
• Language: Go
• Homepage:
• Size: 28.3 KB
• Stars: 6
• Watchers: 3
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![GoDoc](https://godoc.org/github.com/Galaco/KeyValues?status.svg)](https://godoc.org/github.com/Galaco/KeyValues)

[![Go report card](https://goreportcard.com/badge/github.com/galaco/KeyValues)](https://goreportcard.com/badge/github.com/galaco/KeyValues)

[![Build Status](https://travis-ci.com/Galaco/KeyValues.svg?branch=master)](https://travis-ci.com/Galaco/KeyValues)

# keyvalues

> A zero-dependency library for Parsing Valve KeyValue format data.

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).

It is important to note that KeyValue's appear to support (in certain rare uses of the format) multiple root nodes in a 

single definition. This package will create a root node with Key `$root` in this situation, with all root nodes as 

children. If there is only a single root node, the root node will be as defined in the KeyValues.

### Usage

```golang

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 `\n` character 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