Code Monkey home page Code Monkey logo

asffreegames's Introduction

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

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.