SteamIdler

KO | EN

gitlite — search

#python #machine-learning #flutter #android #docker #ios #hacktoberfest #git #github #python3 #javascript #typescript

★ 29 Open GitHub ↗

Light weight multi account steam idler, perfect for boosting playtime

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

STEAMIDLER V2


 Light weight multi account steam idler


 <a href="https://discord.com/invite/vE8qKNV">
 <img src="https://discord.com/api/guilds/98834803738054656/embed.png" alt="Discord sercver"/>
 </a>
<a href="https://github.com/DoctorMcKay/node-steam-user">
 <img src="https://img.shields.io/badge/Steam-user-blue.svg" alt="Steam user badge"/>
</a>
<a href="https://github.com/ZixeSea/SteamIdler">
 <img src="https://img.shields.io/badge/Version-2.0.0-green.svg" alt="Version Badge"/>
</a>
<a href="https://github.com/ZixeSea/SteamIdler/blob/master/LICENSE.md">
 <img src="https://img.shields.io/badge/License-MIT-green.svg" alt="Version Badge"/>
</a>

## Contributors

- **ZixeSea** - github: [ZixeSea](https://github.com/ZixeSea)
- **Danial** - github: [RedSparr0w](https://github.com/RedSparr0w)

## The project

This project has been created in _2019_ for me to easily run a **steam idler 24/7** in the background while using **almost no resources**. this project has been reworked in _2022_ adding a lot of new options like the "**staticIdler**" and "**dynamicIdler**" idlers. The only thing that was missing was **multi account support**. This has been added in the rewrite from _2023_ and now known as SteamIdler V2.

## Requirements

- `git` command line ([Windows](https://git-scm.com/download/win)|[Linux](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)|[MacOS](https://git-scm.com/download/mac)) installed
- `node` version 14.0.0 or higher ([get here](https://nodejs.org))

> If you have 2AF on for you steam account, you need to provide it while the program is starting. A message will appear about it.

## Download code

Run the following command in a CMD/terminal at the location where you want to download it:

```
git clone https://github.com/ZixeSea/SteamIdler.git
```

> Remember to go in to the config folder and chnage/add a config file (for example: **`src/config/account1.js`**). The name of the config file doesn't matter but every account should have it's own config file.

## Dependencies

- [steam-user](https://www.npmjs.com/package/steam-user) - Used to interface with Steam.
- [asciiart-logo](https://www.npmjs.com/package/asciiart-logo) - Used to create a splash screen in the console.
- [colors](https://www.npmjs.com/package/colors) - Used to color and style console output.
- [console-table-printer](https://www.npmjs.com/package/console-table-printer) - Used to create a table in the console.
- [time-stamp](https://www.npmjs.com/package/time-stamp) - Used to format timestamps.
- [steam-totp](https://github.com/DoctorMcKay/node-steam-totp) - Used to generate Steam auth codes.

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/ZixeSea/SteamIdler/blob/master/LICENSE.md) file for details (deleting and/or modifying the license file after forking isn't allowed).

---

# Table of contents

1. **[Prepare linux](#prepare-linux)**  
   1.1 [Update server](#update-server)
   1.2 [Install node.js](#install-nodejs)
2. **[Prepare windows](#prepare-windows)**  
   2.1 [Get node.js](#get-nodejs)
3. **[Account config](#account-config)**  
   3.1 [Information](#information)
   3.2 [Add config](#add-config)
4. **[Run idler](#run-idler)**  
   4.1 [Install dependencies](#install-dependencies)
   4.2 [Start program](#start-program)

---

# Prepare linux

> Everything in this section is based on a host system running **Ubuntu 18.04/20.04/22.04**. Most if not all information can be used for other versions of Ubuntu (or dabian based distro's) as well, but it may require slight changes.

## Update server

```
sudo apt update && sudo apt upgrade -y
```

## Install node.js

```
curl -sL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt install -y nodejs

sudo npm i npm@9.6.1 -g
```

> The versions mentioned above can be outdated, always check [(this page)](https://nodejs.org/en/) for the most recent LTS version of node.js and check [(this page)](https://github.com/npm/cli/tags) for the most recent version of NPM. Installing outdated versions can create problems or security risks.

---

# Prepare windows

> Everything in this section is based on a host system running **Windows 10/11**. Most if not all information can be used for other versions of Windows as well, but it may require slight changes.

## Get node.js

Installing **Node.js** on windows is really easy, they have an installer for it and you can download it on their website (so it's simply clicking "next" and "ok").

**Download link:** https://nodejs.org/en

---

# Account config

## Information

You can find the config file(s) in the config folder (`src/config`), every account that should idle also needs it's own config file. The name of the config file doesn't matter.

**- idlerSettings** 
`enabled` | Boolean | Turn idler on or off 
`parallelGameIdle` | Number | Amount of games playing at the same time (max is 32) 
`idleTime` | Number | Number of min to idle for before switching games (0 means randomized number) 
`alwaysIdleList` | Array | Games that will always be idled, example: [730, 570, 440] 
`skipBannedGames` | Boolean | If "true" it won't idle games you're banned in (except if it's in "alwaysIdleList") 
`skipFreeGames` | Boolean | If "true" it won't idle free to play games (except if it's in "alwaysIdleList") 
`blacklistGames` | Array | List of games not to idle, example: [730, 570, 440] (except if it's in "alwaysIdleList")

## Add config

If you want to add another account, created a new **.js** file (name doesn't matter) in the config folder (`src/config`) and copy this in the file. Don't forget the add the necessary account information and settings.

```
module.exports = {
  account: {
    username: 'username',
    password: 'password',
    statusInvisible: false,
    shared_secret: ''
  },
  idlerSettings: {
    enabled: true,
    parallelGameIdle: 32,
    idleTime: 0,
    alwaysIdleList: [],
    skipBannedGames: false,
    skipFreeGames: false,
    blacklistGames: []
  }
};
```

---

# Run idler

## Install dependencies

The program needs to get the required dependencies to work (see [dependencies](#dependencies)), you do this with the command below. Keep in mind that you need to run this in the folder `SteamIdler` in a CMD/terminal.

```
npm i
```

## Start program

Starting/running the program is the same for linux and windows, you can use the default node.js start command listed here. Keep in mind that you need to run this in the folder `SteamIdler` in a CMD/terminal.

```
node .
```

---

SteamIdler

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README