npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@xan105/vdf

v1.0.0

Published

Valve VDF Key/Value format parser (text and binary)

Downloads

2

Readme

About

Valve VDF Key/Value format parser (text and binary).

This format can be found in Steam protobuffer message and in the Steam Client files as well as some Source Engine stuff.

📦 Scoped @xan105 packages are for my own personal use but feel free to use them.

Example

Reading binary VDF .bin file

import { parse } from "@xan105/vdf/binary";
import { readFile } from "node:fs/promises";

const filePath = "C:\\Program Files (x86)\\Steam\\appcache\\stats\\UserGameStatsSchema_218620.bin";
const buffer = await readFile(filePath);
const vdf = parse(buffer);

Reading text VDF file

import { parse } from "@xan105/vdf";
import { readFile } from "node:fs/promises";

const filePath = "C:\\Program Files (x86)\\Steam\\appcache\\localization.vdf";
const string = await readFile(filePath, "utf8");
const vdf = parse(string);

Install

npm install @xan105/vdf

API

⚠️ This module is only available as an ECMAScript module (ESM).

Named export

parse(string: string, option?: object): object

Decode the VDF key/value text formatted string into an object.

⚙️ Options

  • translate?: boolean | object

    translate option accepts the following object for granular control or a boolean which force all options to true/false:

|name|type|default|description| |----|----|-------|-----------| |bool|boolean|true|String to boolean| |number|boolean|false|String to number or bigint| |unsafe|boolean|false|Set to true to keep unsafe integer instead of bigint|

❌ Throws on error

Example:

import { parse } from "@xan105/vdf";
import { readFile } from "node:fs/promises";

const filePath = "steam_input_for_ps4_controller.vdf";
const string = await readFile(filePath, "utf8");

const vdf = parse(string, { translate: {
  bool: true,
  number: true,
  unsafe: false
}});

//All values will be string
const vdf = parse(string, { translate: false });

Some integers will be represented as BigInt due to their size if the related translate options are used. BigInt is not a valid value in the JSON spec. As such when stringify-ing the returned object you'll need to handle the JSON stringify replacer function to prevent it to fail.

A common workaround is to represent them as a string:

JSON.stringify(data, function(key, value) {
  if(typeof value === "bigint")
    return value.toString();
  else
    return value;
});

binary

parse(buffer: Buffer, offset?: number[]): object

Decode the VDF key/value binary formatted buffer into an object (starting at the given offset if any).

NB: offset is an array so it can be passed by reference

❌ Throws on error

Example:

import { parse } from "@xan105/vdf/binary";
import { readFile } from "node:fs/promises";

const filePath = "C:\\Program Files (x86)\\Steam\\appcache\\stats\\UserGameStatsSchema_218620.bin";
const buffer = await readFile(filePath);
const vdf = parse(buffer);

💡 Note that binary ".vdf" file usually requires additional processing like handling file header.

Some numbers will be represented as BigInt due to their size ((u)int64). BigInt is not a valid value in the JSON spec. As such when stringify-ing the returned object you'll need to handle the JSON stringify replacer function to prevent it to fail.

A common workaround is to represent them as a string:

JSON.stringify(data, function(key, value) {
  if(typeof value === "bigint")
    return value.toString();
  else
    return value;
});