@automatedtf/sherpa

Sherpa ⛰️

📖 Table of Contents

• 👋 Introduction
• 🔌 Getting Started
  • ItemInstance
  • Getting a Backpack
    • getUsedSlots
    • getItemByAssetId
    • getInstances
    • getInstancesByBaseSKU
    • ownsItem
  • Dealing with Backpack Errors
• 📚 Helpful Resources

👋 Introduction

Sherpa provides a simplified representation of a player's Team Fortress 2 backpack, utilising @automatedtf/catalog to fully represent items each as compactly as a single SKU string.

🔌 Getting Started

You can install this module with npm within your project by running the command:

npm install @automatedtf/sherpa

ItemInstance

One of the key types within this module is the ItemInstance interface. It details the least sufficient information required to uniquely identify an item instance within TF2.

interface ItemInstance {
    appid: number; // Game id (440 for TF2, 730 for CS:GO)
    assetid: string; // Steam-given id for possession of item
    instanceid: string; // Internal Steam field for item information caching
    classid: string; // Internal Steam field for item information caching
    icon_url: string; // Image url hash to attach onto CDN link for display purposes
    sku: string; // Item base SKU generated from `@automatedtf/catalog`
    full_sku: string; // sku for item, with any additional item modifications included
}

A class object CItemInstance can be used as a container to extract the properties of an ItemInstance object from EconItem.

class CItemInstance implements ItemInstance {
    appid: number; // Game id (440 for TF2, 730 for CS:GO)
    assetid: string; // Steam-given id for possession of item
    instanceid: string; // Internal Steam field for item information caching
    classid: string; // Internal Steam field for item information caching
    icon_url: string; // Image url hash to attach onto CDN link for display purposes
    sku: string; // Item base SKU generated from `@automatedtf/catalog` 
    full_sku: string; // sku for item, with any additional item modifications included
    ...
}

You would then be able to create an instance of CItemInstance by passing in an EconItem object and then turn it into a ItemInstance object by calling toItemInstance() on it.

const econItem: EconItem = ...; // get some EconItem object from somewhere

const itemInstance: ItemInstance = new CItemInstance(econItem).toItemInstance();

Getting a Backpack

For interacting with the module, getTF2Backpack should be your main entry point. You should query for a user's backpack by using their steamid64.

const steamid = "76561198081082634";
...
const backpack = await getTF2Backpack(steamid);

After resolving and getting a Backpack from getTF2Backpack, you will have access to a number of methods.

getUsedSlots

const totalNumberOfItems: number = backpack.getUsedSlots();

Gets the total number of item instances recorded within the user's backpack, even if they have gone over their maximum number of inventory slots.

getItemByAssetId

const assetidOfItemToFind: string = "837141231";
const item: ItemInstance = backpack.getItemByAssetId(assetidOfItemToFind);

Gets the specific item instance with that assetid. As assetid is unique to every item instance, we can return the specific item saved within the dictionary indexed by assetid.

getInstances

// Warning: Case sensitive!
const nameOfItemsToFind: string = "Scream Fortress XII War Paint Case";
const items: ItemInstance[] = backpack.getInstances(nameOfItemsToFind);

Gets all instances with that itemName.

getInstancesBySKU

const baseSKUOfItemsToFind: string = "5918;6";
const items: ItemInstance[] = backpack.getInstancesBySKU(baseSKUOfItemsToFind);

Gets all instances with that baseSKUOfItemsToFind.

ownsItem

const specialAssetid: string = "837141231";
const ownsSpecialItem: boolean = backpack.ownsItem(specialAssetid);

Checks if the user owns an item with that assetid.

Dealing with Backpack Errors

Calling getTF2Backpack can result in the following errors. These errors are exported by the module to allow you to catch for them.

• PrivateBackpackError: The user's backpack is private and cannot be accessed.
• InvalidSteamIdError: The provided steamid is invalid.

📚 Helpful Resources

• Getting someone's Steam inventory
• @automatedtf/catalog