Initial commit

Author: tacheometry

.editorconfig

@@ -0,0 +1,12 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = tab
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

.gitignore

@@ -0,0 +1,3 @@
+node_modules
+SteamData
+*.tgz

.prettierrc

@@ -0,0 +1,3 @@
+{
+	"semi": true
+}

LICENSE.md

@@ -0,0 +1,24 @@
+# The MIT License (MIT)
+
+Copyright © `2022` `tacheometry`
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the “Software”), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,55 @@
+# Simple Steam hour farmer
+
+_`steam-hour-farmer` is a program that emulates you playing a game on Steam, with the purpose of effortlessly getting hours played on certain games on your profile._
+
+-   Can be deployed on a VPS to run 24/7.
+-   Only requires the games to be in your Steam library - they don't need to be installed.
+-   When you start playing games on your main computer, it pauses automatically.
+-   After you're finished playing, the bot resumes automatically (provided it's able to log in again).
+-   Doesn't require multiple accounts.
+-   Inspired by [@Gunthersuper/steam-idle-bot](https://github.com/Gunthersuper/steam-idle-bot).
+
+## How to use
+
+1. Have Node.js configured (minimum version 16). This can be done through [nvm](https://github.com/nvm-sh/nvm) on a VPS or through the [official website](https://nodejs.org/).
+2. Install this package:
+    ```
+    npm install -g steam-hour-farmer
+    ```
+3. Make a directory somewhere. This is where your Steam data will be stored, and where you can configure the bot.
+4. Find your Steam game ids. In each game, go to Properties -> Updates -> Copy the App ID.
+5. In this directory, make an `.env` file with the content:
+
+    ```sh
+    USERNAME="your_steam_username",
+    PASSWORD="your_steam_password",
+    GAMES="440,4000"
+    ```
+
+    This will start playing Team Fortress 2 and Garry's Mod for example.
+
+    The `GAMES` part of the file describes what games you'd like the bot to play, separated by a comma.
+
+    Additionally, a `PERSONA` value may be supplied to set the online status of the user. Can be Online (1), Busy (2), Away (3), Snooze (4). For example,
+
+    ```sh
+    PERSONA="1"
+    ```
+
+    to be Online. Do not write this value if you don't want the user's presence to change.
+
+    If you have access to your Steam Shared Secret, you can input it into a `SHARED_SECRET` variable. This will prevent you from needing to input your Steam Guard code at all.
+
+    All of this configuration can be passed via environment variables too - they don't need to be in this `.env` file.
+
+6. Run the program in the same directory:
+
+    ```
+    steam-hour-farmer
+    ```
+
+When the bot starts, it will request a Steam Guard code via email or the mobile application. When you start playing on another machine, the bot will be kicked from its session, requiring a re-login, with a new Steam Guard code.
+
+This can be remedied by using the Steam Shared Secret, or disabling Steam Guard.
+
+Note that the playtime might seem to be the same when looking from another client - it can take a couple hours for Steam to refresh it sometimes.

index.js

@@ -0,0 +1,116 @@
+#!/usr/bin/env node
+"use strict";
+
+const readline = require("readline");
+const util = require("util");
+const Steam = require("steam-user");
+const TOTP = require("steam-totp");
+
+console.log(`Documentation: https://github.com/tacheometry/steam-hour-farmer`);
+
+require("dotenv").config();
+let { USERNAME, PASSWORD, PERSONA, GAMES, SHARED_SECRET } = process.env;
+{
+	PERSONA = parseInt(PERSONA);
+	const shouldExist = (name) => {
+		if (!process.env[name]) {
+			console.error(
+				`Environment variable "${name}" should be provided, but it is undefined.`
+			);
+			process.exit(1);
+		}
+	};
+
+	shouldExist("USERNAME");
+	shouldExist("PASSWORD");
+	shouldExist("GAMES");
+}
+
+const SHOULD_PLAY = GAMES.split(",").map((n) => parseInt(n));
+if (SHOULD_PLAY.length === 0)
+	console.warn("Could not find any games to play. Maybe this is a mistake?");
+
+const readlineInterface = readline.createInterface({
+	input: process.stdin,
+	output: process.stdout,
+});
+const consoleQuestion = util
+	.promisify(readlineInterface.question)
+	.bind(readlineInterface);
+
+const getTOTP = () => TOTP.generateAuthCode(SHARED_SECRET);
+
+const User = new Steam({
+	machineIdType: Steam.EMachineIDType.PersistentRandom,
+	dataDirectory: "SteamData",
+});
+
+const logOn = () => {
+	User.logOn({
+		accountName: USERNAME,
+		password: PASSWORD,
+		rememberPassword: true,
+		clientOS: Steam.EOSType.Windows10,
+		twoFactorCode: SHARED_SECRET
+			? TOTP.generateAuthCode(SHARED_SECRET)
+			: undefined,
+		autoRelogin: true,
+	});
+};
+
+const panic = (message = "Exiting...") => {
+	console.error(message);
+	process.exit(1);
+};
+
+let playingOnOtherSession = false;
+let currentNotification;
+const refreshGames = () => {
+	let notification;
+	if (playingOnOtherSession) {
+		notification = "Farming is paused.";
+	} else {
+		User.gamesPlayed(SHOULD_PLAY);
+		notification = "Farming...";
+	}
+	if (currentNotification !== notification) {
+		currentNotification = notification;
+		console.log(notification);
+	}
+};
+
+User.on("steamGuard", async (domain, callback) => {
+	if (SHARED_SECRET) return callback(getTOTP());
+	const manualCode = await consoleQuestion(
+		`Enter Steam Guard code` +
+			(domain ? ` for email at ${domain}` : "") +
+			": "
+	);
+	callback(manualCode);
+});
+
+User.on("playingState", (blocked, app) => {
+	playingOnOtherSession = blocked;
+	refreshGames();
+});
+
+User.on("loggedOn", () => {
+	console.log(`Successfully logged in to Steam with ID ${User.steamID}`);
+	if (PERSONA !== undefined) User.setPersona(PERSONA);
+
+	// Allow time to receive the playingState event to see if playing on another session if that's the case
+	setTimeout(refreshGames, 5000);
+});
+
+User.on("error", (e) => {
+	if (e.eresult === Steam.EResult.LoggedInElsewhere) {
+		console.log("Got kicked by other Steam session. Logging in again...");
+		logOn();
+		return;
+	}
+	panic(`Got an error from Steam: "${e.message}".`);
+});
+
+logOn();
+
+setInterval(refreshGames, 20 * 1000);