https://github.com/mann-conomy/tf-parser

A Node.js parser for converting Team Fortress 2 game files to JSON objects.
https://github.com/mann-conomy/tf-parser

file json language mann-conomy nodejs parser tf2 typescript

Last synced: 5 days ago
JSON representation

A Node.js parser for converting Team Fortress 2 game files to JSON objects.

• Host: GitHub
• URL: https://github.com/mann-conomy/tf-parser
• Owner: Mann-Conomy
• License: mit
• Created: 2024-05-10T10:37:11.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-08-31T13:34:09.000Z (3 months ago)
• Last Synced: 2024-08-31T13:38:40.033Z (3 months ago)
• Topics: file, json, language, mann-conomy, nodejs, parser, tf2, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@mann-conomy/tf-parser
• Size: 162 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tf-parser

A Node.js parser for converting Team Fortress 2 game files to JSON objects.

[![npm version](https://img.shields.io/npm/v/@mann-conomy/tf-parser?style=flat-square&logo=npm)](https://npmjs.com/package/@mann-conomy/tf-parser)

[![npm downloads](https://img.shields.io/npm/d18m/@mann-conomy/tf-parser?style=flat-square&logo=npm)](https://npmjs.com/package/@mann-conomy/tf-parser)

[![Node.js version](https://img.shields.io/node/v/@mann-conomy/tf-parser?style=flat-square&logo=nodedotjs)](https://nodejs.org/en/about/releases/)

[![GitHub actions](https://img.shields.io/github/actions/workflow/status/Mann-Conomy/tf-parser/test.yml?branch=main&style=flat-square&logo=github&label=test)](https://github.com/Mann-Conomy/tf-parser/blob/main/.github/workflows/test.yml)

[![GitHub license](https://img.shields.io/github/license/Mann-Conomy/tf-parser?style=flat-square&logo=github)](https://github.com/Mann-Conomy/tf-parser/blob/main/LICENSE)

## Installation

Using [npm](https://www.npmjs.com/package/@mann-conomy/tf-parser):

```bash

$ npm install @mann-conomy/tf-parser

```

Using [yarn](https://yarnpkg.com/package/@mann-conomy/tf-parser):

```bash

$ yarn add @mann-conomy/tf-parser

```

## Testing

Using [npm](https://docs.npmjs.com/cli/v8/commands/npm-run-script):

```bash

$ npm test

```

Using [yarn](https://classic.yarnpkg.com/lang/en/docs/cli/run/):

```bash

$ yarn test

```

## Examples

Parsing UTF-16 encoded language files from the Team Fortress 2 game client into JSON objects.

```js

import { readFile } from "fs/promises";

import { LanguageParser } from "@mann-conomy/tf-parser";

(async () => {

    try {

        // Read the contents of the tf_english.txt file

        const file = await readFile("tf_english.txt", { encoding: "utf16le" });

        // Parse english language translations

        const { lang } = LanguageParser.parse(file);

        console.log(lang.Language); // English

        console.log(lang.Tokens.rarity4); // Unusual

    } catch (error) {

        console.error("Error parsing tf_english.txt", error.message);

    }

})();

```

Some more examples are available in the [examples](https://github.com/Mann-Conomy/tf-parser/tree/main/examples) and [test](https://github.com/Mann-Conomy/tf-parser/tree/main/test) directories.

## Documentation

See the [Wiki pages](https://github.com/Mann-Conomy/tf-parser/wiki) for further documentation.

## License

[MIT](LICENSE)

Copyright 2024, The Mann-Conomy Project