Skip to content

Commit 7b24f3d

Browse files
committed
Update README
1 parent 3505016 commit 7b24f3d

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

BoosterManager/Docs/InventoryHistory.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ I feel the need to provide unofficial documentation here, because doing anything
4747

4848
Much of the inventory history is delivered as `html` that needs to be parsed.
4949

50+
> [!NOTE]
5051
> The BoosterManager plugin does not, and likely never will, support parsing of `html`. The best I can do is to offer this incomplete list of possible history event descriptions.
5152
5253
Be aware that each of these descriptions describes a unique type of event. For example, "Listed on the Community Market" and "You listed an item on the Community Market." are different types of events, and not two different ways to describe the same event.
@@ -138,6 +139,7 @@ Not all gaps are as large as in the examples above. It's very common to have lo
138139

139140
In my experience, because small gaps tend to only happen due to market-related activity, they can be safely ignored, as market history is more accurately collected using the Market History API.
140141

142+
> [!NOTE]
141143
> The BoosterManager plugin cannot detect this bug. You'll need to monitor the plugin's activity yourself to ensure there's no gaps. Within your `InventoryHistoryAPI`, `page - data["cursor"]["time"]` represents the size of the gap in seconds between the current page and the next page. Be aware that `data["cursor"]` [can be](#history-ends-early-bug) `null`. You can attempt to address this bug with your API by setting the `next_page` or `next_cursor` response parameters, telling the plugin which page you'd like it to fetch next.
142144
143145
## History Ends Early Bug
@@ -152,6 +154,7 @@ For example, assuming we have history older than `4/30/21`, this can happen:
152154

153155
This is resolved the same way as the [Missing History Bug](#missing-history-bug): by searching for history events at times past the cutoff.
154156

157+
> [!NOTE]
155158
> The BoosterManager plugin will detect when the bug may have occurred. On the `InventoryHistoryAPI` side of things, the value for `data[cursor]` will be `null` when it receives a page with this bug on it. If your API does not send a `next_page` or `next_cursor` response parameter, then the plugin will stop running and send a link in the Steam Chat to the page where the bug occurred.
156159
157160
## Missing Descriptions Bugs
@@ -170,4 +173,5 @@ There's at least one instance where this type of error will never go away by rel
170173

171174
- Most events involving Steam Gems on or before December 12, 2014 will appear as "Unknown Asset" in place of the gems, and will have no `descriptions` entry. This is likely due to a gem duplication exploit and the resulting rollbacks.
172175

176+
> [!NOTE]
173177
> The BoosterManager plugin does not detect these bugs. You can tell the plugin to refresh the page by sending back `cursor` and `page` in the `next_cursor` and `next_page` response parameters respectively.

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This project is based off of the [Booster Creator Plugin](https://github.com/Rud
1313
- Unpack the downloaded .zip file to the `plugins` folder inside your ASF folder.
1414
- (Re)start ASF, you should get a message indicating that the plugin loaded successfully.
1515

16-
> **Note**
16+
> [!NOTE]
1717
> This plugin is only tested to work with ASF-generic. It may or may not work with other ASF variants, but feel free to report any issues you may encounter.
1818
1919
## Usage
@@ -197,7 +197,7 @@ Example:
197197
"GamesToBooster": [730, 570],
198198
```
199199

200-
> **Note**
200+
> [!NOTE]
201201
> 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.
202202
203203
---
@@ -212,7 +212,7 @@ Example:
212212
"BoosterDelayBetweenBots": 60,
213213
```
214214

215-
> **Note**
215+
> [!NOTE]
216216
> This is not recommended to be used except in the most extreme cases.
217217
218218
---

0 commit comments

Comments
 (0)