Skip to content

Commit

Permalink
Version 2.12
Browse files Browse the repository at this point in the history 
Merge pull request #120
  • Loading branch information
@3urobeat
3urobeat authored Jul 30, 2022
2 parents 54bd90b + a24e457 commit c8ed44a
Show file tree
Hide file tree
Showing 62 changed files with 3,873 additions and 2,628 deletions.
Binary file removed .github/img/mesh.png
View file
Binary file not shown.
Binary file removed .github/img/steamLogo.png
View file
Binary file not shown.
118 changes: 66 additions & 52 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center" markdown=1>
<p align="center"><img width=45% src="https://raw.githubusercontent.com/HerrEurobeat/steam-comment-service-bot/master/.github/img/steamLogo.png"></p>
<p align="center"><img width=45% src="https://3urobeat.com/comment-bot/steamLogo.png"></p>
<strong>Request multiple profile comments by texting a bot network!</strong>
<br>See how to set up the bot and customize it below.<br>
<p></p>
Expand All @@ -18,13 +18,13 @@
<a href="#download-">Download</a> •
<a href="#setup--configuration-">Setup & Config</a> •
<a href="#usage-">Usage</a> •
<a href="#additional-informations-">Additional information</a>
<a href="#additional-information-">Additional information</a>
</p>

![Showcase](https://drive.google.com/uc?export=view&id=1FAzvJBbYys9tGePCD8Gc2VEjg3gHIT7y)
![Showcase](https://3urobeat.com/comment-bot/showcase.gif)

## **Introduction**
<img align="right" width="200" height="200" src="https://raw.githubusercontent.com/HerrEurobeat/steam-comment-service-bot/master/.github/img/mesh.png">
<img align="right" width="200" height="200" src="https://3urobeat.com/comment-bot/mesh.png">

* Request many profile comments directly from the steam chat
* Easily host multiple steam accounts and control them from **one** console and chat with this bot cluster
Expand All @@ -33,9 +33,10 @@
* Advertise your group & automatically invite users to it
* Use proxies and requests comments via URL in your browser

You can see and test out my 24/7 hosted comment bot in action [by clicking here!](https://steamcommunity.com/id/3urobeatscommentbot)

If you would like to see a detailed tutorial in the form of a video, [click here!](https://www.youtube.com/watch?v=gmA-ccD05g4)
This written tutorial will also contain a video tutorial badge link for each specific part!
If you would like to see my 24/7 comment bot in action, [click here!](https://steamcommunity.com/id/3urobeatscommentbot)
This written tutorial also contains a video tutorial badge link for each specific part besides each header!

**Disclaimer!**
>I, the developer, am not responsible and cannot be held liable for any action the operator/user of this bot uses it for.
Expand All @@ -51,76 +52,88 @@ You need to have at least node.js version 14.15.0 installed: [Download](https://
To get your version number type `node --version` in your console or terminal.
If you need a tutorial for this specific node part, [click here.](https://youtu.be/gmA-ccD05g4?t=35)

## **Setup & Configuration:** [![YouTube](https://img.shields.io/badge/YouTube-Tutorial%20section-red)](https://youtu.be/gmA-ccD05g4?t=111)
Open a power shell/terminal in the `steam-comment-service-bot` folder and type `npm install`.

## **Setup & Configuration:** [![YouTube](https://img.shields.io/badge/YouTube-Tutorial%20section-red)](https://youtu.be/gmA-ccD05g4?t=111)
#### **Accounts**
You have two options to provide the login informations for your bot accounts.
You can either use the `accounts.txt` file to provide login informations in the `username:password:shared_secret` format (shared_secret is optional) or the `logininfo.json` file to provide them in an object notation.

To use the first method, open the `accounts.txt` file and provide your accounts in the `username:password:shared_secret` format, one account per line. If you don't want to use a shared_secret just leave it out and only provide the account in the `username:password` format. Be advised that as soon as you have provided at least one account in the `accounts.txt` file you can't use the `logininfo.json` file anymore.

To use the `logininfo.json` open the file with a text editor and fill out the usernames and passwords of each bot account you want to use, following the existing format.
If you have a shared_secret then you can add it there too, otherwise just leave the brackets empty.
You can add more accounts by extending the list ("bot4": ["username4", "password4", "shared_secret"], etc...). Make sure to **NOT** forget a comma after each line, **ONLY** the last line **MUST NOT** have a comma! (ignoring this will cause errors!)
Open the `accounts.txt` file and provide your accounts in the `username:password:shared_secret` format, one account per line.
If you don't want to use a shared_secret just leave it out and only provide the account in the `username:password` format.

Please make sure you know about limited/unlimited accounts. Your accounts also need to have E-Mail Steam Guard active.
You can read a detailed explanation [here in the wiki](https://github.com/HerrEurobeat/steam-comment-service-bot/wiki/Steam-limitations).

<details>
<summary>Another, optional method (not recommended for new users):</summary>

If you'd rather like to provide your accounts in an object notation (JSON), then delete the accounts.txt file and open the `logininfo.json` file.
Fill out the usernames and passwords of each bot account you want to use, following the existing format.
If you have a shared_secret then you can add it there too, otherwise just leave the brackets empty.
You can add more accounts by extending the list ("bot4": ["username4", "password4", "shared_secret"], etc...).

Make sure to **NOT** forget a comma after each line, **ONLY** the last line **MUST NOT** have a comma! (ignoring this will cause errors!)
</details>

#### **Config**
Open `config.json` with a text editor.
You need to provide the link to your steam profile at "owner" and the steam64 id of your profile at "ownerid".
If you don't know how to find your steam64id, open [SteamDB](https://steamdb.info/calculator/), search your profile and copy the ID located down below at SteamID.

A complete documentation of the `config.json` can be found in the [Wiki](https://github.com/HerrEurobeat/steam-comment-service-bot/wiki).
You need to provide the link to your steam profile at "owner" and the link or your steam64id of your profile at "ownerid", following the existing template.
Make sure to put your link and or ID inside the brackets, just like the template shows.

Set an amount of comments a normal user and the amount an owner is allowed to request from the bot.
This largely depends on how many accounts you use, the commentdelay set and if you use proxies.
I would recommend max 2 comments per account if you use no proxies and default settings, so if you use 5 accounts, try setting maxComments and maxOwnerComments to 10.

#### **Quotes**
Open `quotes.txt` with a text editor. You can add as many quotes as you want, line by line. **Don't leave an empty line anywhere in this file!** The file already has default comments set up.
The bot will choose a random quote for **every** comment. If you only provide one quote, the bot will only use that quote.
For now you can ignore all the other settings, however if you'd like to customize more values later on then check out the [complete config documentation](https://github.com/HerrEurobeat/steam-comment-service-bot/wiki).

<details>
<summary><strong>Custom Quotes</strong> (optional)</summary>

The bot comes with a default set of quotes which are randomly selected for each comment.
If you'd like to specify your own selection of quotes you can do so:

Open `quotes.txt` with a text editor. You can add as many quotes as you want, line by line.
Make sure to not leave a line empty as it can otherwise lead to errors.
The bot will choose a random quote for **every** comment. If you only provide one quote, the bot will only use that one for all comments.

You can also use comments that go over multiple lines (ASCII-Art, etc.).
To do that, just put a `\n` at the end of each line of the multi-line comment. Then move the next line of your comment behind the `\n` so that your multi line comment is **only one line** in your quotes.txt, with each line of the actual comment seperated by a `\n`.

You can also use comments that go over multiple lines (ASCII-Art, etc.).
To do that, just put a `\n` at the end of each line of the multi-line comment. Then move the next line of your comment behind the `\n` so that your multi line comment is **only one line** in your quotes.txt, with each line of the actual comment seperated by a `\n`.
Example: `My cool comment: \nline1\nline2\nline3`
> Example: `My cool comment: \nline1\nline2\nline3`
</details>
The bot(s) is/are now setup! Don't modify any of the other files.
&nbsp;

The bot is now ready! Don't modify any of the other files.

## **Usage:** [![YouTube](https://img.shields.io/badge/YouTube-Tutorial%20section-red)](https://youtu.be/gmA-ccD05g4?t=385)
Type `node start.js` in the power shell/terminal you opened earlier.
**Disclaimer:** Do not start the bot with a tool that restarts on changes (like nodemon etc)! Just use normal `node`.
Add the main bot (bot0 in logininfo.json) on steam and send him the message: `!help`
Open up a power shell/terminal in this folder and type `node start.js`.

> **Important Disclaimer:** Do not start the bot with a tool that restarts on changes (like nodemon etc)! Only use normal `node`.
To request a comment, simply type `!comment`!
If you have more than 1 account set up in `logininfo.json` you can specify how many comments you want.
Head over to your Steam client, add the main bot (the first account in your accounts.txt) as friend and send him the message `!help`.
It should respond with a list of commands available to you.

## **Additional informations:** [![YouTube](https://img.shields.io/badge/YouTube-Tutorial%20section-red)](https://youtu.be/gmA-ccD05g4?t=611)
To request a comment, simply type `!comment 1`!
You can see all commands and their usage [here in the wiki](https://github.com/HerrEurobeat/steam-comment-service-bot/wiki/Commands-documentation).

## **Additional Information:** [![YouTube](https://img.shields.io/badge/YouTube-Tutorial%20section-red)](https://youtu.be/gmA-ccD05g4?t=611)
Hey, if you like this project please consider donating a buck on my [PayPal!](https://paypal.me/3urobeat)
[![Donate](https://img.shields.io/badge/donate-%241-orange)](https://paypal.me/3urobeat)
If you like the work I put into this project, please give this repository a star!
![Star](https://img.shields.io/github/stars/HerrEurobeat/steam-comment-service-bot)

#### **Web (URL) Comment Requests**
To requests comment with an URL in your browser you need to turn the feature on.
Go into your `config.json` and set `enableurltocomment` to `true` and restart the bot.

Open localhost:3034 in your browser and follow the instructions there.
To request comments from outside your network you need to allow the port `3034` in your router settings and visit the server with your public ip address.
#### **The Wiki**
The Wiki of this repository holds a lot of valuable information, please [check it out](https://github.com/HerrEurobeat/steam-comment-service-bot/wiki)!
You can find pages there on how to add proxies to drastically increase the amount of possible comments, how to integrate the bot into your own application, adding your own language, documentation on errors, the config, advancedconfig and more.

#### **Bugs, Issues & Betas**
If you encountered a **bug**, you **need help** or wish a feature to be added, please open an [**issue!**](https://github.com/HerrEurobeat/steam-comment-service-bot/issues/new/choose)
If you are interested in beta builds of this project, visit the [beta-testing branch.](https://github.com/HerrEurobeat/steam-comment-service-bot/tree/beta-testing)
If you are interested in the active development progress, visit the [projects section.](https://github.com/HerrEurobeat/steam-comment-service-bot/projects)

#### **Errors & FAQ**
Please visit the [Wiki](https://github.com/HerrEurobeat/steam-comment-service-bot/wiki) for a detailed description of known steam errors and bot errors.

#### **Steam limitations**
Steam sadly has some strict restrictions for commenting.
Read all of them here: [Steam Support](https://support.steampowered.com/kb_article.php?ref=3330-IAGK-7663)
**Important**: If you use *limited accounts* (<$5 spend) the user will need to send all of these accounts a friend request before requesting a comment!
Please be also advised that in order to comment on a profile the accounts need to have at least **email steam guard** activated. There are generators out there that can directly generate accounts with steam guard.

#### **License**
As the **license** already stated: If you want to use code from this repository in your project, feel free to do that as long as you **include credit** to this repository!
If you are using this bot as a whole: You are allowed to change bot messages (for translation). You are **not** allowed to remove any credit to myself.
The code is distributed under the GPL-3.0 license.
If you want to use code from this repository in your project, feel free to do so as long as you **include a link** as a comment to the file in this repository!
If you are using this bot as a whole: You are only allowed to change the config files. You are **not** allowed to remove any credit to myself.

#### **Credits**
#### **Credits & Donations**
Thank you [DoctorMcKay](https://github.com/DoctorMcKay) for creating the [steam-user](https://github.com/DoctorMcKay/node-steam-user) and [steamcommunity](https://github.com/DoctorMcKay/node-steamcommunity) libraries!

Special thanks to [KNO7](https://steamcommunity.com/id/KN07Gaming/) for testing early beta versions, providing many ideas behind this project and donating 5€!
Expand All @@ -132,3 +145,4 @@ Thanks [dunderzutt](https://steamcommunity.com/id/Dunderzutt/) for donating 25
Thanks [Lujza](https://steamcommunity.com/id/7656119829563751) for donating ~4€ in TF2 keys!
Thanks [Orel](https://steamcommunity.com/id/ReloBOT/) for donating 4€!
Thanks [Ecstasyyy](https://steamcommunity.com/id/elrondnetwork/) for donating ~10€ in TF2 keys!
Thanks [Leezzy](https://steamcommunity.com/id/Leezzy) for donating ~6,50€ in CSGO items!
23 changes: 23 additions & 0 deletions advancedconfig.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"_disclaimer_": "This file includes only advanced settings! Please only use the 'config.json' for setup and ignore this file if you are new!",
"_help_": "Read the docs: https://github.com/HerrEurobeat/steam-comment-service-bot/wiki/Advanced-Config-Documentation",
"disableAutoUpdate": false,
"loginDelay": 2500,
"relogTimeout": 30000,
"maxLogOnRetries": 1,
"useLocalIP": true,
"acceptFriendRequests": true,
"setPrimaryGroup": false,
"commandCooldown": 12000,
"disableCommentCmd": false,
"retryFailedComments": false,
"retryFailedCommentsDelay": 300000,
"retryFailedCommentsAttempts": 1,
"lastQuotesSize": 5,
"enableevalcmd": false,
"enableurltocomment": false,
"printDebug": false,
"steamUserDebug": false,
"steamUserDebugVerbose": false,
"logAnimationSpeed": 250
}
8 changes: 2 additions & 6 deletions config.json
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
{
"_help_": "Read the docs: https://github.com/HerrEurobeat/steam-comment-service-bot/wiki/Config-documentation",
"disableautoupdate": false,
"commentdelay": 15000,
"allowcommentcmdusage": true,
"skipSteamGuard": false,
"commentcooldown": 5,
"globalcommentcooldown": 10,
"botaccountcooldown": 10,
"maxComments": 0,
"maxOwnerComments": 0,
"randomizeAccounts": false,
Expand All @@ -16,7 +14,5 @@
"botsgroup": "https://steamcommunity.com/groups/3urobeatGroup",
"acceptgroupinvites": true,
"owner": "https://steamcommunity.com/id/3urobeat",
"ownerid": ["76561198260031749"],
"enableevalcmd": false,
"enableurltocomment": false
"ownerid": ["76561198260031749"]
}
Loading

0 comments on commit c8ed44a

Please sign in to comment.