This plugin finds free packages on Steam and adds them to your account.

This plugin works by listening for changes to Steam's PICS. The plugin can discover new packages as they're released, but is limited due to PICS not showing all old changes. As a result, the plugin can only discover packages that have changed recently, usually in the last ~12 hours.

• 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.

You can enable the plugin per individual bot by adding EnableFreePackages to that bot's config file:

"EnableFreePackages": true,

Under certain conditions, activating a free package while playing a game on Steam can cause the game to temporarily freeze. You can prevent the plugin from activating packages while you're in-game by adding PauseFreePackagesWhilePlaying to your individual bot's config file. It's recommended you use this for any account you play games on:

"PauseFreePackagesWhilePlaying": true,

A maximum of 30 packages can be activated per 1.5 hours. By default, this plugin will use at most 25 of those activations and will resume where it left off if it's ever interrupted. You can control this limit by adding FreePackagesLimit to your individual bot's config files of uint type:

"FreePackagesLimit": 25,

By default, the plugin will attempt to activate all free non-demo and non-playtest packages. You can control what kinds of packages are activated by adding FreePackagesFilters to your individual bot's config files with the following structure:

"FreePackagesFilters": [{
  "Types": [],
  "Tags": [],
  "Categories": [],
  "Languages": [],
  "Systems": [],
  "MinReviewScore": 0,
  "MinDaysOld": 0,
  "IgnoredContentDescriptors": [],
  "IgnoredTypes": [],
  "IgnoredTags": [],
  "IgnoredCategories": [],
  "IgnoredAppIDs": [],
  "RequireAllTags": false,
  "RequireAllCategories": false,
  "ImportStoreFilters": false,
  "WishlistOnly": false,
  "IgnoreFreeWeekends": false,
  "NoCostOnly": false,
  "PlaytestMode": 0,
}],

All filter options are explained below:

HashSet<string> type with default value of []. Packages must contain an app with one of the TypeNames specified here or they will not be added to your account. You can leave this empty to allow for all types. The available TypeNames for filtering are: "Game", "Application", "Tool", "Demo", "DLC", "Music", "Video"

HashSet<uint> type with default value of []. Packages must contain an app with at least one of these TagIDs or they will not be added to your account. You can leave this empty to allow for all tags. A list of tags can be found here. The TagID will be at the end of the URL. For example, the TagID for the Indie tag is 492.

HashSet<uint> type with default value of []. Packages must contain an app with at least one of these CategoryIDs or they will not be added to your account. You can leave this empty to allow for all categories.

HashSet<string> type with default value of []. Packages must contain an app with support for at least one of these LanguageIDs or they will not be added to your account. You can leave this empty to allow for all languages.

HashSet<string> type with default value of []. Packages must contain an app with support for one of the SystemNames specified here or they will not be added to your account. You can leave this empty to allow for all systems. The available SystemNames for filtering are: "Windows", "MacOS", "Linux", "DeckVerified", "DeckPlayable", "DeckUnsupported", "DeckUnknown"

uint type with default value of 0. Packages must contain an app with a ReviewScore greater than or equal to this or they will not be added to your account. You can leave this at 0 to allow for all values. A ReviewScore may range from 1 to 9 and is not the same as the percentage of positive reviews. Refer to the list below for more information. This filter is not applied to demos or playtests as they can't normally be reviewed.

uint type with default value of 0. Packages must contain an app which was released on Steam within the last MinDaysOld days or they will not be added to your account. You can leave this at 0 to not filter by release date.

HashSet<uint> type with default value of []. Packages containing apps with any of the ContentDescriptorIDs specified here will not be added to your account. Detailed information about content descriptors can be found here under "Mature Content Filtering".

HashSet<string> type with default value of []. Packages containing apps with any of the TypeNames specified here will not be added to your account. Refer to Types for more information about TypeNames.

HashSet<uint> type with default value of []. Packages containing apps with any of these TagIDs will not be added to your account. Refer to Tags for more information about TagIDs.

HashSet<uint> type with default value of []. Packages containing apps with any of these CategoryIDs will not be added to your account. Refer to Categories for more information about CategoryIDs.

HashSet<uint> type with default value of []. Packages containing apps with any of these AppIDs will not be added to your account.

bool type with default value of false. If set to true, packages must contain an app with all of the TagIDs specified in the Tags filter or they will not be added to your account.

bool type with default value of false. If set to true, packages must contain an app with all of the CategoryIDs specified in the Categories filter or they will not be added to your account.

bool type with default value of false. If set to true, the filter will also use the ignored games, ignored tags, and ignored content descriptor settings you use on the Steam storefront.

bool type with default value of false. If set to true, packages must contain an app your account has wishlisted or followed on the Steam storefront or they will not be added to your account.

bool type with default value of false. Free weekend packages will be ignored if set to true.

bool type with default value of false. If set to true, only "No Cost" packages will be added to your account. "No Cost" packages tend to be those which are free for only a limited time, and can also sometimes give a +1 to your owned games count.

uint type with default value of 0. Some or all playtests will be ignored based on the provided value.

You can define as many filters as you'd like, and packages that pass any one of your filters will be added to your account. For example, with the three filters below we can allow for any of:

• Free games with Steam Trading Cards, but without nudity
• Free games or playtests which have English or French language support, and Puzzle or Programming tags
• Free DLC for games you own

"FreePackagesFilters": [{
  "Types": ["Game"],
  "Categories": [29],
  "IgnoredContentDescriptors": [3, 4],
},{
  "Types": ["Game"],
  "Tags": [1664, 5432],
  "Languages": ["english", "french"],
  "PlaytestMode": 3,
},{
  "Types": ["DLC"],
  "IgnoredTypes": ["Game", "Application"],
}],

While the plugin can be used passively, you can also manually import free packages from SteamDB using the importer userscript, or through the commands and IPC interface endpoints below.