Merge branch 'master' of https://github.com/JustArchi/ArchiSteamFarm

ArchiSteamFarm/config/example.xml

@@ -31,9 +31,9 @@
 	<!-- TIP: Most likely you don't want to change it. You can use "null" if you wish to enter PIN on every startup, 0 means there is no PIN -->
 	<SteamParentalPIN type="string" value="0"/>
 
-	<!-- This is steamID of the bot-master - you, in steamID64 format -->
+	<!-- This is steamID64 of the bot-master - you, [Example: 76561198006963719] -->
 	<!-- TIP: You can use "0", but bot won't accept steam cd-keys or trades from anybody" -->
-	<SteamMasterID type="ulong" value="76561198006963719"/>
+	<SteamMasterID type="ulong" value="0"/>
 
 	<!-- This defines clan of the master, bot will join chatroom of that clan automatically after logging in if set -->
 	<!-- SteamMasterClanID could be found by visiting your group-page  -->

README.md

@@ -1,26 +1,39 @@
-# 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:
+**Current Commands:**
-- 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)
 
-TODO:
+ - `!farm` Restarts the bot and starts card-farming (again)
-- 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.
+ - `!exit` Stops the bot
-- 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.
+> 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)
+ - Debian 8.1 Jessie (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.