Skip to content

Latest commit

 

History

History
83 lines (52 loc) · 4.36 KB

README.md

File metadata and controls

83 lines (52 loc) · 4.36 KB
Raw

ASF-FreeGames

License: AGPL v3 Plugin-ci Github All Releases

Description

ASF-FreeGames is a plugin for ArchiSteamFarm allowing one to automatically collect free steam games 🔑 posted on Reddit.

Requirements

Installation

  • 🔽 Download latest Dll from the release page
  • ➡️ Move the dll into the plugins folder of your ArchiSteamFarm installation
  • 🔄 (re)start ArchiSteamFarm
  • 🎉 Have fun

How does it works

Every ⏰30 minutes the plugins starts 🔬analysing reddit for new free games⚾.
Then every 🔑addlicense asf appid commands found are broadcasted to each currently logged bot 💪.

Commands

  • freegames to collect free games right now 🚀
  • getip to get the ip used by ASF 👀
  • set to configure this plugin options (see below) 🛠️

for information about issuing 📢commands see ASF's wiki

Advanced configuration

The plugin behavior is configurable via command

  • freegames set nof2p to ⛔prevent the plugin to collect free to play games
  • freegames set f2p to ☑️allow the plugin to collect f2p (the default)
  • freegames set nodlc to ⛔prevent the plugin to collect dlc
  • freegames set dlc to ☑️allow the plugin to collect dlc (the default)

In addition to the command above, the configuration is stored in a 📖config/freegames.json.config json file, one may 🖊 edit it using a text editor to suit its need.

Proxy Setup

The plugin can be configured to use a proxy (HTTP(S), SOCKS4 or SOCKS5) for its HTTP requests to Reddit. You can achieve this in two ways:

  1. Environment Variable: Set the environment variable FREEGAMES_RedditProxy with your desired proxy URL (e.g., http://yourproxy:port).
  2. freegames.json.config: Edit the redditProxy property within the JSON configuration file located at <asf>/config/freegames.json.config. Set the value to your proxy URL.

Example freegames.json.config with Proxy:

{
   ...
  "redditProxy": "http://127.0.0.1:1080"
}

Important Note: If you pass a proxy password, it will be stored in clear text in the freegames.json.config file, even when passing it via the environment variable.

Note: Whichever method you choose (environment variable or config file), only one will be used at a time. The environment variable takes precedence over the config file setting.

FAQ

Log is full of Request failed after 5 attempts! messages is there something wrong ?

  • There's nothing wrong (most likely), those error messages are the result of the plugin trying to add a steam key which is unavailable. With time those errors should occurs less frequently (see #3 for more details).

How to configure automatic updates for the plugin?

The plugin supports checking for updates on GitHub. You can enable automatic updates by modifying the PluginsUpdateList property in your ArchiSteamFarm configuration (refer to the ArchiSteamFarm wiki for details).

Important note: Enabling automatic updates for plugins can have security implications. It's recommended to thoroughly test updates in a non-production environment before enabling them on your main system.

Dev notes

Compilation

Simply execute dotnet build ASFFreeGames -c Release and find the dll in ASFFreeGames/bin folder, which you can drag to ASF's plugins folder.

GitHub sponsor