tf2-item-format
v5.9.25
Published
Format's TF2 items like backpack.tf does
Downloads
664
Readme
TF2 Item Format
Formatting for TF2 items.
Use v5
branch for current version.
Install it via npm install tf2-item-format
Features
- Parses item name into attribute object
- Stringifies attribute object into item name same as backpack.tf
- Parses ECON item into attributes
- Parses SKU into attributes
- Makes SKU out of attributes
- Creates backpack.tf compatible format for listing creation
Support the project
tf2-item-format is now used in number of production grade projects for handling item data, help support the project by donating items here.
Migrating from v4 to v5
To keep your application working like before with version 5 you have to:
import { parseString } from 'tf2-item-format/static' // -> from 'tf2-item-format'
const { parseString } = require('tf2-item-format/static') // -> from 'tf2-item-format'
New
To inject your own schema use this interface:
export type ISchema = {
getDefindex(search: number | string): number|null;
getName(search: number | string): string;
getEffectName(effect: number | string): string;
getWearName(wear: number | string): string;
getKillstreakName(killstreak: number | string): string;
getTextureName(texture: number | string): string;
getQualityName(quality: number | string): string;
getEffectEnum(effect: number | string): number;
getWearEnum(wear: number | string): number;
getKillstreakEnum(killstreak: number | string): number;
getTextureEnum(texture: number | string): number;
getQualityEnum(quality: number | string): number;
getTextures(): SchemaEnum;
getEffects(): SchemaEnum;
isUniqueHat(defindexOrName: string | number): boolean;
}
// Extra types you might need:
export type NameToDefindex = { [name: string]: number };
export type DefindexToName = { [defindex: number]: string };
export type SchemaEnum = NameToDefindex & DefindexToName;
// Import these like:
// import { ISchema, NameToDefindex, DefindexToName, SchemaEnum } from 'tf2-item-format'
Then you just have to:
import { createFormat } from 'tf2-item-format';
const format = createFormat(schema);
Every method is then export same as before.
You can use parseSKU
and toSKU
without schema:
import { parseSKU, toSKU } from 'tf2-item-format';
Please note that static schema has implemented a lot of overwrites for defindexes that simply cannot be obtained by the limited data we have, so when you are implementing it yourself you should use the current Schema
as your guide.
Instalation
Via NPM: npm install tf2-item-format
Or Yarn: yarn add tf2-item-format
Documentation
Currently there is no full documentation.
We export these methods:
parseString
stringify
parseEconItem
toSKU
parseSKU
createBPListing
fixName
And static schema:
- under property
schema
Everything is fully typed so you should be able to get this working on your own, until I make a documentation. Some of the types are a bit confusing which will get fixed in next major version.
parseEconItem
parseEconItem(econ: EconItem, inNumbers: boolean, useDefindexes: boolean, options?: { useTrueDefindex: boolean }): ParsedEconItem;
econ
is raw item you receive from the apiinNumbers
- changes return type of certain attributes to numbers instead of pure strings, eg. quality, texture, wear, ...useDefindexes
- appends item defindex to the object, adds target & output aswelloptions
useTrueDefindex
- returns true defindex item has on this econ, doesn't ask schema.
- Returns
ParsedEconItem
which is an object of all attributes the econ gives us
createBPListing
createBPListing(attributes: ItemAttributes | StringifySKUAttributes, options?: CreateBPListingOptions): BackpackTFListing
attributes
- these you get fromparseString
,parseSKU
orparseEconItem
, all are compatibleoptions
unuSkinsToDecorated
- defaults unusual skins to decorated weapon quality, default value istrue
- Returns
BackpackTFListing
object compatible withitem
object in backpack.tf listing creation api
stringify
stringify(attributes: StrigifySKUAttributes | ItemAttributes, options?: StringifyOptions): string
attributes
- these you get fromparseString
,parseSKU
orparseEconItem
, all are compatibleoptions
determineUniqueHat
- if set it checks in schema if given item should useThe
in name, defaults tofalse
- Returns the item name
Note for stringify
If you are using sku format to store your items and want to use The
in your names, you have to turn determineUniqueHat
to true
.
Compability usage
// Have a name, want a sku
const attributes = parseString(name, true, true); // To get defindexes and enums
const sku = toSKU(attributes);
// Have a sku, want a name
const attributes = parseSKU(sku);
const name = stringify(attributes);
// Have a sku, want a bp listing
const attributes = parseSKU(sku);
const listing = createBPListing(attributes);
Every method should be interchangable in similar ways.