Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 1.15 KB

README.md

File metadata and controls

37 lines (27 loc) · 1.15 KB

VDF

Go Version 1.16 Status Shield Test Status

Golang Binary Valve Data Format implementation

Install

go get -u github.com/wakeful-cloud/vdf

Features

  • Binary VDF support
  • Fully unit tested
  • No dependencies

Limitations

  • No support for non-binary VDF's
  • Order of key-value's are not preserved (Steam doesn't care though)

Docs

  • vdf.Map: structure use to represent a parsed/read VDF

    • Signature: map[string]interface{}
  • vdf.ReadVdf: function that reads bytes to a vdf.Map

    • Signature: ReadVdf([]byte): (vdf.Map, error)
  • vdf.WriteVdf: function that writes a vdf.Map to bytes

    • Signature: WriteVdf(vdf.Map): ([]byte, error)

Example

See example/main.go

Credit

Heavily based on Corecii's Steam Binary VSF TS Package.