Skip to content

cadenmarinozzi/CSFormat

Repository files navigation

CSFormat

CSFormat is the only package you need to format CS2 item queries into the Steam Market format.

Supported item types

  • Weapons
  • Gloves
  • Knives
  • Stickers
  • Cases
  • Case Keys
  • Music Kits
  • Music Kit Boxes
  • Patches
  • Graffiti
  • Pins

Installation

npm install csformat

Usage

Example:

const MarketHashNameBuilder = require("csformat");

const builder = new MarketHashNameBuilder();

const result = builder.build("karambit doppler fn");

console.log(result); // -> "★ Karambit | Doppler (Factory New)"

Testing

npm test

Reporting bugs/wrong formatting

If you find any bugs or wrong formatting, please open an issue on the GitHub repository.

TODO

  • Add support for

    • Agents
    • Souvenir Packages
    • Zeus x27
    • Gifts
    • Passes
    • Tools
    • Name tags
  • Rewrite in TypeScript

  • Add more tests

  • Add formatting string list

LICENSE

CSFormat is licensed under the MIT License. See LICENSE for more information.

About

The only package you need to format CS2 item queries into the Steam Market format

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published