Booster Manager Plugin for ArchiSteamFarm

Introduction

This plugin is based off of the Booster Creator Plugin by Outzzz and Ryzhehvost. At its core it serves the same purpose: to provide an easy-to-use interface for turning gems into booster packs. The major difference being: this plugin is more tailored for users wanting to craft a lot of booster packs. To that end, the scope of this project is a bit wider, intending to encompass all manner of features that could, even indirectly, facilitate crafting boosters. Although this plugin is designed for power users, casual booster crafters should find it just as useful.

Installation

Download the .zip file from the latest release
Unpack the downloaded .zip file to the plugins folder inside your ASF folder.
(Re)start ASF, you should get a message indicating that the plugin loaded successfully.

Please note, this plugin is only tested to work with ASF-generic. It may or may not work with other ASF variants.

Usage

Parameters in square brackets are sometimes [Optional], parameters in angle brackets are always <Required>. Plural parameters such as [Bots] can accept multiple values separated by , such as A,B,C

Booster Commands

Command	Access	Description
`booster [Bots] <AppIDs>`	`Master`	Adds `AppIDs` to the given bot's booster queue. `AppIDs` added to the booster queue this way will be crafted one time as soon as they become available.
`bstatus [Bots]`	`Master`	Prints the status of the given bot's booster queue.
`bstop [Bots] <AppIDs>`	`Master`	Removes `AppIDs` from the given bot's booster queue.
`bstoptime [Bots] <Hours>`	`Master`	Removes everything from the given bot's booster queue that will take more than the given `Hours` to craft.
`bstopall [Bots]`	`Master`	Removes everything from the given bot's booster queue.

Inventory Commands

Command	Access	Description
`gems [Bots]`	`Master`	Displays the number of gems owned by the given bot.
`keys [Bots]`	`Master`	Displays the number of "Mann Co. Supply Crate Key" owned by the given bot.
`lootboosters [Bots]`	`Master`	Sends all marketable booster packs from the given bot to the `Master` user.
`lootcards [Bots]`	`Master`	Sends all marketable non-foil trading cards from the given bot to the `Master` user.
`lootfoils [Bots]`	`Master`	Sends all marketable foil trading cards from the given bot to the `Master` user.
`lootgems [Bots]`	`Master`	Sends all gems from the given bot to the `Master` user.
`lootitems [Bots] <AppID> <ContextID> [ClassID]`	`Master`	Sends all items with the matching `AppID`, `ContextID`, and `ClassID` from the given bot to the `Master` user.
`lootkeys [Bots]`	`Master`	Sends all "Mann Co. Supply Crate Key" from the given bot to the `Master` user.
`lootsacks [Bots]`	`Master`	Sends all "Sack of Gems" from the given bot to the `Master` user.
`trade2faok [Bot]`	`Master`	Accepts all pending 2FA trade confirmations for given bot instances.
`transferboosters [Bots] <TargetBot>`	`Master`	Sends all marketable booster packs from the given bot to the given target bot.
`transfercards [Bots] <TargetBot>`	`Master`	Sends all marketable non-foil trading cards from the given bot to the given target bot.
`transferfoils [Bots] <TargetBot>`	`Master`	Sends all marketable foil trading cards from the given bot to the given target bot.
`transfergems [Bot] <TargetBots> <Amounts>`	`Master`	Sends the provided `Amounts` of unpacked gems from the given bot to the given target bot. The `Amounts` specified may be a single amount sent to all target bots, or multiple amounts sent to each target bot respectively. You may also use `queue` or `q` as an amount to represent the number of gems needed to complete the target bot's booster queue.
`transferitems <Bots> <TargetBot> <AppID> <ContextID> [ClassID]`	`Master`	Sends all items with the matching `AppID`, `ContextID`, and `ClassID` from the given bot to the given target bot.
`transferitems^ <Bot> <TargetBots> <Amounts> <ItemIdentifiers>`	`Master`	Sends items matching the `ItemIdentifiers` from the given bot to the given target bot. The `Amounts` specified may be a single amount of each item sent, or multiple amounts of each item sent respectively. The only valid `ItemIdentifiers` for this command are those that begin with `AppID::ContextID`
`transferkeys [Bot] <TargetBots> <Amounts>`	`Master`	Sends the provided `Amounts` of "Mann Co. Supply Crate Key" from the given bot to the given target bot. The `Amounts` specified may be a single amount sent to all target bots, or multiple amounts sent to each target bot respectively.
`transfersacks [Bots] <TargetBot>`	`Master`	Sends all "Sack of Gems" from the given bot to the given target bot.
`unpackgems [Bots]`	`Master`	Unpacks all "Sack of Gems" owned by the given bot.

Market Commands

Command	Access	Description
`findlistings <Bots> <ItemIdentifiers>`	`Master`	Displays the `ListingIDs` of any market listing belonging to the given bot and matching any of the `ItemIdentifiers`.
`findandremovelistings <Bots> <ItemIdentifiers>`	`Master`	Removes any market listing belonging to the given bot and matching any of the `ItemIdentifiers`.
`listings [Bots]`	`Master`	Displays the total value of all market listings owned by the given bot.
`removelistings [Bot] <ListingIDs>`	`Master`	Removes market `ListingIDs` belonging to the given bot.
`market2faok [Bot]`	`Master`	Accepts all pending 2FA market confirmations for given bot instances.
`value [Bots] [BalanceLimit]`	`Master`	Displays the combined wallet balance and total value of all market listings owned by the given bot. The maximum allowed balance in your region may be provided as `BalanceLimit`, a whole number, and it will instead display how close the given bot is to reaching that limit.

Log Commands

Command	Access	Description
`logdata [Bots]`	`Master`	A combination of the `logboosterdata`, `loginventoryhistory`, `logmarketlistings` and `logmarkethistory` commands.
`logboosterdata [Bots]`	`Master`	Collects booster data from the given bot and sends it to `BoosterDataAPI`
`loginventoryhistory [Bots] [Count] [StartTime] [TimeFrac] [S]`	`Master`	Collects inventory history data from the given bot and sends it to `InventoryHistoryAPI`. The number of pages of inventory history may be specified using `Count`, and may begin on the page specified by either `StartTime` alone or by the combination of `StartTime`, `TimeFrac`, and `S`
`logmarketlistings [Bots]`	`Master`	Collects market listings data from the given bot and sends it to `MarketListingsAPI`
`logmarkethistory [Bots] [Count] [Start]`	`Master`	Collects market history data from the given bot and sends it to `MarketHistoryAPI`. The number of pages of market history may be specified using `Count`, and may begin on the page specified by `Start`
`logstop [Bots]`	`Master`	Stops any actively running `loginventoryhistory` or `logmarkethistory` commands.

ItemIdentifiers

An item identifier is an input used in certain commands that allows you to operate on only certain items. Multiple item identifiers may be provided to a command, but must be separated with && instead of a comma. The valid formats for an item identifier are as follows:

Format	Example
`AppID::ContextID`	The identifier `753::6` will match with all Steam Community items
`AppID::ContextID::ClassID`	The identifier `753::6::667933237` will match all "Sack of Gems" items
`ItemName`	The identifier `Gems` will match the all "Gems" items
`ItemType`	The identifier `Steam Gems` will match all "Sack of Gems" and "Gems" items
`HashName`	The identifiers `753-Sack of Gems` or `753-Sack%20of%20Gems` will match all "Sack of Gems" items

Command Aliases

Most pluralized commands also have a non-pluralized alias; ex: lootboosters has the alias lootbooster

Command	Alias
`findlistings`	`flistings`, `findl`
`findandremovelistings`	`frlistings`, `findremovel`
`removelistings`	`rlistings`, `removel`
`logboosterdata`	`logbd`
`loginventoryhistory`	`logih`
`logmarketlistings`	`logml`
`logmarkethistory`	`logmh`
`market2faok`	`m2faok`
`trade2faok`	`t2faok`

Command	Alias
`bstatus ASF`	`bsa`
`gems ASF`	`ga`
`keys ASF`	`ka`
`listings ASF`	`lia`
`logdata ASF`	`lda`, `loga`
`lootboosters ASF`	`lba`
`lootcards ASF`	`lca`
`lootfoils ASF`	`lfa`
`lootgems ASF`	`lga`
`lootkeys ASF`	`lka`
`lootsacks ASF`	`lsa`
`market2faok ASF`	`m2faoka`
`trade2faok ASF`	`t2faoka`
`transferboosters ASF <TargetBot>`	`tba <TargetBot>`
`transfercards ASF <TargetBot>`	`tca <TargetBot>`
`transferfoils ASF <TargetBot>`	`tfa <TargetBot>`
`value ASF [BalanceLimit]`	`va [BalanceLimit]`

AllowCraftUntradableBoosters

"AllowCraftUntradableBoosters": <true/false>,

Example: "AllowCraftUntradableBoosters": true,

This bool type configuration setting can be added to your ASF.json config file. If set to false, untradable gems will not be used to craft boosters, and the unpackgems command will not unpack untradable "Sack of Gems".

By default, this is set to true

GamesToBooster

"GamesToBooster": [<AppIDs>],

Example: "GamesToBooster": [730, 570],

This HashSet<uint> type configuration setting can be added to your individual bot config files. It will automatically add all of the AppIDs to that bot's booster queue, and will automatically re-queue them after they've been crafted.

Note: It's not possible to remove any of these AppIDs from the booster queue using any commands. Any changes you want to make will need to be made in the configuration file.

BoosterDelayBetweenBots

"BoosterDelayBetweenBots": <Seconds>,

Example: "BoosterDelayBetweenBots": 60,

This uint type configuration setting can be added to your ASF.json config file. It will add a Seconds delay between each of your bot's booster crafts. For example: when crafting a booster at 12:00 using a 60 second delay; Bot 1 will craft at 12:00, Bot 2 will craft at 12:01, Bot 3 will craft at 12:02, and so on.

By default this delay is set to 0, and is not recommended to be used except in the most extreme cases.

BoosterDataAPI

"BoosterDataAPI": "<Url>",

Example:

"BoosterDataAPI": "http://localhost/api/boosters",

This string type configuration setting can be added to your ASF.json config file. When the logboosterdata command is used, booster data will be gathered and sent to the API located at Url.

You will need to design your API to accept requests and return responses per the following specifications:

Request

Method: POST

Content-Type: application/json

Name Type Description

steamid ulong SteamID of the bot that data belongs to

source string https://steamcommunity.com/tradingcards/boostercreator/

data JArray The data parsed from source and sent as an array of objects. Detailed below.

data[][appid] uint Booster game AppID

data[][name] string Booster game name

data[][series] uint Booster series number

data[][price] uint Price of booster in gems

data[][unavailable] bool Set to true when the booster is on a 24 hour cooldown

data[][available_at_time] string? A date and time string in ISO 8601 format, if unavailable is false then this will be null

Response

Content-Type: application/json

Name Type Required Description

success bool Yes Whether your operations succeeded or failed.

message string No A custom message that will be displayed in place of the default succeed/fail message

show_message bool No Whether or not to show any message

MarketListingsAPI

"MarketListingsAPI": "<Url>",

Example:

"MarketListingsAPI": "http://localhost/api/listings",

This string type configuration setting can be added to your ASF.json config file. When the logmarketlistings command is used, market listing data will be gathered and sent to the API located at Url.

You will need to design your API to accept requests and return responses per the following specifications:

Request

Method: POST

Content-Type: application/json

Note: Pagination here is not supported. While source does support pagination for data[listings], that information can be recreated using the Market History API.

Name Type Description

steamid ulong SteamID of the bot that data belongs to

source string https://steamcommunity.com/market/mylistings?norender=1

data JObject The data taken directly from source with empty string values converted to null

Response

Content-Type: application/json

Name Type Required Description

success bool Yes Whether your operations succeeded or failed.

message string No A custom message that will be displayed in place of the default succeed/fail message

show_message bool No Whether or not to show any message

MarketHistoryAPI

"MarketHistoryAPI": "<Url>",

Example:

"MarketHistoryAPI": "http://localhost/api/markethistory",

This string type configuration setting can be added to your ASF.json config file. When the logmarkethistory command is used, market history data will be gathered and sent to the API located at Url.

You will need to design your API to accept requests and return responses per the following specifications:

Request

Method: POST

Content-Type: application/json

Note: Multiple pages of data will be requested sequentially, and not in parallel.

Name Type Description

steamid ulong SteamID of the bot that data belongs to

source string https://steamcommunity.com/market/myhistory?norender=1&count=500

page uint Page number, defined as floor(data[start] / 500) + 1

data JObject The data taken directly from source with empty string values converted to null

Response

Content-Type: application/json

Name Type Required Description

success bool Yes Whether your operations succeeded or failed. If there's more pages to fetch, the plugin will only continue when success is true

message string No A custom message that will be displayed in place of the default succeed/fail message

show_message bool No Whether or not to show any message

get_next_page bool No Whether or not to fetch the next page. If the plugin was already going to fetch the next page anyway, this does nothing.

next_page uint No If get_next_page is set to true, the next page will be fetched using this page number

InventoryHistoryAPI

"InventoryHistoryAPI": "<Url>",

Example:

"InventoryHistoryAPI": "http://localhost/api/inventoryhistory",

This string type configuration setting can be added to your ASF.json config file. When the loginventoryhistory command is used, inventory history data will be gathered and sent to the API located at Url.

You will need to design your API to accept requests and return responses per the following specifications:

Request

Method: POST

Content-Type: application/json

Note: Important documentation of Steam's Inventory History API can be found here

Note: Multiple pages of data will be requested sequentially, and not in parallel.

Name Type Description

steamid ulong SteamID of the bot that data belongs to

source string https://steamcommunity.com/my/inventoryhistory/?ajax=1

page uint The value of the start_time query parameter used to request source. If a cursor object was used to request source instead, this will be equal to cursor[time]

cursor JObject The value of the cursor object query parameter used to request source

data JObject The data taken directly from source with empty string values converted to null

Response

Content-Type: application/json

Name Type Required Description

success bool Yes Whether your operations succeeded or failed. If there's more pages to fetch, the plugin will only continue when success is true

message string No A custom message that will be displayed in place of the default succeed/fail message

show_message bool No Whether or not to show any message

get_next_page bool No Whether or not to fetch the next page. If the plugin was already going to fetch the next page anyway, this does nothing.

next_page uint No If get_next_page is set to true, the next page will be fetched using this page number

next_cursor JObject No If get_next_page is set to true, the next page will be fetched using this cursor object

InventoryHistoryAppFilter

"InventoryHistoryAppFilter": [<AppIDs>],

Example: "InventoryHistoryAppFilter": [730, 570],

This HashSet<uint> type configuration setting can be added to your ASF.json config file. When using the loginventoryhistory command or InventoryHistory IPC interface API endpoint, the results will be filtered to only show inventory history events from these AppIDs

LogDataPageDelay

"LogDataPageDelay": <Seconds>,

Example: "LogDataPageDelay": 15,

This uint type configuration setting can be added to your ASF.json config file. When using the loginventoryhistory or logmarkethistory commands to fetch multiple pages, it will add a Seconds delay between each page fetch.

By default, this is set to 15

IPC Interface

API	Method	Parameters	Description
`/API/BoosterManager/{botName}/BoosterData`	`GET`		Retrieves booster data for given bot
`/API/BoosterManager/{botName}/MarketListings`	`GET`		Retrieves market listings data for given bot
`/API/BoosterManager/{botName}/MarketHistory`	`GET`	`page`	Retrieves market history data for given bot
`/API/BoosterManager/{botName}/InventoryHistory`	`GET`	`startTime`, `timeFrac`, `s`	Retrieves inventory history data for given bot
`/API/BoosterManager/{botName}/GetBadgeInfo/{appID}`	`GET`	`border`	Retrieves badge info for given bot
`/API/BoosterManager/{botName}/GetPriceHistory/{appID}/{hashName}`	`GET`		Retrieves price history for market items

Name		Name	Last commit message	Last commit date
Latest commit History 150 Commits
ArchiSteamFarm @ 17d9c9b		ArchiSteamFarm @ 17d9c9b
BoosterManager		BoosterManager
.editorconfig		.editorconfig
.gitattributes		.gitattributes
.gitignore		.gitignore
.gitmodules		.gitmodules
BoosterManager.sln		BoosterManager.sln
LICENSE		LICENSE
README.md		README.md
build.bat		build.bat
build.sh		build.sh
github-pandoc.css		github-pandoc.css

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Booster Manager Plugin for ArchiSteamFarm

Introduction

Installation

Usage

Booster Commands

Inventory Commands

Market Commands

Log Commands

ItemIdentifiers

Command Aliases

AllowCraftUntradableBoosters

GamesToBooster

BoosterDelayBetweenBots

BoosterDataAPI

Request

Response

MarketListingsAPI

Request

Response

MarketHistoryAPI

Request

Response

InventoryHistoryAPI

Request

Response

InventoryHistoryAppFilter

LogDataPageDelay

IPC Interface

About

Releases

Packages

Languages

Name	Type	Description
`steamid`	`ulong`	SteamID of the bot that `data` belongs to
`source`	`string`	`https://steamcommunity.com/tradingcards/boostercreator/`
`data`	`JArray`	The data parsed from `source` and sent as an array of objects. Detailed below.
`data[][appid]`	`uint`	Booster game AppID
`data[][name]`	`string`	Booster game name
`data[][series]`	`uint`	Booster series number
`data[][price]`	`uint`	Price of booster in gems
`data[][unavailable]`	`bool`	Set to `true` when the booster is on a 24 hour cooldown
`data[][available_at_time]`	`string?`	A date and time string in ISO 8601 format, if `unavailable` is `false` then this will be `null`

Name	Type	Required	Description
`success`	`bool`	Yes	Whether your operations succeeded or failed.
`message`	`string`	No	A custom message that will be displayed in place of the default succeed/fail message
`show_message`	`bool`	No	Whether or not to show any message

License

pacopepepipo/BoosterManager

Folders and files

Latest commit

History

Repository files navigation

Booster Manager Plugin for ArchiSteamFarm

Introduction

Installation

Usage

Booster Commands

Inventory Commands

Market Commands

Log Commands

ItemIdentifiers

Command Aliases

AllowCraftUntradableBoosters

GamesToBooster

BoosterDelayBetweenBots

BoosterDataAPI

Request

Response

MarketListingsAPI

Request

Response

MarketHistoryAPI

Request

Response

InventoryHistoryAPI

Request

Response

InventoryHistoryAppFilter

LogDataPageDelay

IPC Interface

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages