vdfplus
vdfplus is a small library that aims to help with converting Valve's KeyValue format to JSON and vice versa. vdfplus is special in that it "arrayifies" key-tokens that appear multiple times in the .vdf
, e.g. Steam Controller configurations. Per default tt also tries to casts values-tokens into their respective data type.
vdfplus can be used with nodejs, in the browser or via command-line.
Installation
For your project:
npm install vdfplus
For the CLI feature:
npm install vdfplus -g
API
VDF exposes two functions parse
and stringify
. They are derived from the JSON.parse
and JSON.stringify
.
VDF.parse(str:string, types?:boolean)
Parses a VDF string into a JavaScript object
Parameter | Type | Description | default |
---|---|---|---|
str |
string |
A VDF string that will be parsed into an object. | - |
types |
boolean |
(Optional) Sets the data type casting of the VDF values | true |
VDF.stringify(obj:object, indentation?:number|string, separator?:string)
Stringifies an object to VDF.
Parameter | Type | Description | default |
---|---|---|---|
object |
object |
Object that will be stringified into VDF. | - |
indentation |
number|string |
(Optional): Indentation of the string. Number of spaces or a string of whitespace characters. If an empty string is passed, then line breaks will be disabled | 2 |
separator |
number|string |
(Optional): Whitespace between key-value pairs. Number of spaces or a string of whitespace characters | \t |
Usage
Library
node.js
const vdfplus = // or ES6
Browser
<!-- OR minified-->
vdfplus is using UMD for exports It supports most common module loaders in the browser or simply adds a global namespace VDF
if no loader is present.
Example
- Read file or get the text from a textarea
- Parse the VDF into an object
- Modify object
- Stringify object
- Save to file or fill textarea with JSON string
// It is important to use the proper encodinglet vdfRaw = // or read from textarealet vdfRaw = documentvalue // Parse VDF stringlet vdf = VDF // Change datavdf"a-new-root-key" = "foo": "bar" "baz": 1 2 3 4 5 // Stringify the changes to vdf, indent using tabs and separate pairs with two spaceslet str = VDF // Save file// or write to textareadocumentvalue = str
CLI
vdfplus can also be used via command-line. Per default vdfplus parses VDF to JSON, so adding -j
or --json
s not needed! Data can be piped in via stdin
and will be piped out to stdout
if no uutput file was specified.
indentation
is used for VDF and for JSON (defaults to 2 spaces [" "
]), separate
only relevant for VDF (defaults to tabs [\t
]). Per default vdfplus
will try to cast value-tokens into their respective data types. encoding
and output-encoding
are only for files
Usage: vdfplus [options] <input> <output>
Options:
-V, --version output the version number
-j, --json VDF to JSON (default behavior)
-v, --vdf JSON to VDF
-d, --indentation <char or number> indentation for the VDF/JSON. number or whitespace characters. defaults to 2 spaces
-s, --separator <char> space between VDF key-value pairs. defaults to '\t'
-e, --encoding <encoding> encoding of input. defaults to 'utf8'
-o, --output-encoding <encoding> encoding of the output. defaults to 'utf8'
-n, --no-types disable JSON types. all values will be strings
-h, --help output usage information
Example
Simple VDF to JSON conversion:
$ vdfplus input.vdf output.vdf
Simple JSON to VDF conversion:
$ vdfplus -v input.vdf output.vdf
Piping:
# stdin, file out $ echo "foo"
Formatting
# create vdf, indent with tabs and use two spaces between pairs vdfplus -v -i \t -s 2 input.json output.vdf
Notes
- Unquoted keys and values are not supported
- Comments will be lost when converting from and to VDF