diff --git a/README.md b/README.md index f21401a35..3794f7068 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,38 @@ -# ArchiSteamFarm +ArchiSteamFarm +=================== -Big work-in-progress +Big work-in-progress. This bot allows you to farm steam cards using multiple accounts simultaneously. Each account is defined by it's own XML config in `config` directory and you donĀ“t need any steam-client running in the background. -Allows you to farm steam cards using multiple accounts simultaneously. +**Current functions:** -Each account is defined by it's own XML config in "config" directory. + - Automatically farm steam cards using any number of active accounts + - Automatically accept friend requests sent from master + - Automatically accept all trades coming from master + - Automatically accept all steam cd-keys sent via chat from master + - SteamGuard / 2-factor-authentication support + - Full Mono support, tested on Debian "9.0" Stretch (testing) -Current functions: -- Does not need Steam client running, or even a GUI. Fully based on SteamKit2 and reverse-engineered Steam protocol. -- Automatically farm steam cards using any number of active accounts -- Automatically accept friend requests sent from master -- Automatically accept all trades coming from master -- Automatically accept all steam cd-keys sent via chat from master -- SteamGuard / 2-factor-authentication support -- Full Mono support, tested on Debian "9.0" Stretch (testing) +**Current Commands:** -TODO: -- Smart multi-games farming till every game reaches 2 hours, then one-by-one (similar to Idle Master) - Backend code is already here, just missing the logic and tests. -- Possible integration with SteamTradeMatcher, bot can detect dupes and trade them automatically. Again, backend code is already here, just missing actual implementation. -- Automatic sending of steam trades to master, after game is fully farmed. + - `!farm` Restarts the bot and starts card-farming (again) + - `!exit` Stops the bot + +> You can use chat-commands in group-chat or private-chat with your bot. +> The MasterID has to be set for this specific bot / config-file. + +**Supported / Tested Operating-Systems:** + + - Windows 10 Enterprise Edition + - Debian 9.0 Stretch (Mono) + +**TODO**: + +- Smart Multi-Game-Farming +- Possible integration with SteamTradeMatcher, bot can detect dupes and trade them automatically. Backend-code is already here, just missing actual implementation. +- Automatic sending of steamtrades to master(after game is fully farmed) - Probably much more -This is big WIP, so feel free to send pull requests if you wish. -I'll release some releases later, when everything is tested and code cleaned up. +> This is big WIP, so feel free to send pull requests if you wish. I'll +> release some releases later, when everything is tested and code +> cleaned up.