Version 2.15.3

Merge pull request #255

.gitignore

@@ -2,6 +2,5 @@
 
 node_modules
 backup
-comment-service-bot.code-workspace
 output.txt
 plugins/*

accounts.txt

@@ -1 +1 @@
-//Comment: This file is used to provide your bot accounts in the form of username:password. Read the instructions here: https://github.com/3urobeat/steam-comment-service-bot#accounts
+//Comment: Provide login information in the form of username:password. Read instructions here: https://github.com/3urobeat/steam-comment-service-bot/blob/master/docs/wiki/setup_guide.md#accounts

advancedconfig.json

@@ -24,6 +24,7 @@
     "retryFailedComments": false,
     "retryFailedCommentsDelay": 300000,
     "retryFailedCommentsAttempts": 1,
+    "commentsIpCooldownPenalty": 300000,
     "lastQuotesSize": 5,
     "dummy3": "------------------- Debug Settings: -------------------",
     "enableevalcmd": false,

docs/wiki/adding_proxies.md

@@ -3,9 +3,16 @@
 
  
 
-If you are using 10+ accounts I encourage you to use proxies.  
-It drastically reduces the amount of requests on one IP by equally spreading all accounts onto different IPs, allowing you to comment more and faster, reducing the chance of an IP ban.  
-
+## Why should I use proxies?
+Proxies are without a question the most effective and best way to improve the amount of accounts you can use to comment simultaneously.  
+
+If you are using 10+ accounts, I strongly encourage you to think about using proxies.  
+It drastically reduces the amount of requests on one IP by equally spreading all accounts onto different IPs.  
+This allows you to comment more and faster by reducing the chance of an IP ban.  
+
+ 
+
+## Adding proxies
 Adding proxies is quite simple:  
 - Create a `proxies.txt` file in the bot folder  
 - Open the file with a text editor  
@@ -14,10 +21,11 @@ Adding proxies is quite simple:
 
 Your proxies must be provided in this format: `http://user:[email protected]:8081`  
 
-If you are using webshare.io and are too lazy to convert the proxy file download yourself like me, then check out my quick and dirty [conversion script](https://github.com/3urobeat/webshare-proxies-file-converter).  
+If you are using webshare.io then check out my quick and dirty [conversion script](https://github.com/3urobeat/webshare-proxies-file-converter).  
+It reformats the export to the format which this bot uses.
 
 The bot will automatically spread all your bot accounts over all available proxies.  
 By default the bot will also use your own IP. If you'd like to disable this and only use proxies, set `useLocalIP` in the `advancedconfig.json` to `false`.
 
 Please note that Steam might block some proxy providers.  
-I personally have no experience where to buy working proxies so I sadly can't make any recommendations.  
+I'm paying just $1/month for 33 proxies. I'd be comfortable using these up to 100 accounts.

docs/wiki/advancedconfig_doc.md

@@ -36,6 +36,7 @@ This is the full documentation to customize your `advancedconfig.json`.
 | retryFailedComments | true or false | If the bot should retry comments that failed in a comment request. Default: false |
 | retryFailedCommentsDelay | Number in ms | Time the bot will wait before retrying the failed comments. Default: 300000 (5 minutes) |
 | retryFailedCommentsAttempts | Number | How often the bot should retry a failed comment. Default: 1 |
+| commentsIpCooldownPenalty | Number | Time in ms to add to cooldown of bot accounts participating in a comment request which experienced an IP Cooldown error (e.g. HTTP 429). **Disabling is not recommended as it might prolong the cooldown.** Default: 300000 (5 minutes) |
 | lastQuotesSize | Number | Amount (minus 1) of different quotes that need to be selected in between before a quote can be used again. Default: 5 |
 |   | | |
 | enableevalcmd | true or false | The eval command allows the botowner to run javascript code from the steam chat. **Warning: This can harm your machine! Leave it to false if you don't know what you are doing!** Default: false |

docs/wiki/changelogs/CHANGELOG_v2.15.md

@@ -7,6 +7,7 @@
 - [2.15.0](#2.15.0)
 - [2.15.1](#2.15.1)
 - [2.15.2](#2.15.2)
+- [2.15.3](#2.15.3)
 
  
 
@@ -196,3 +197,39 @@ Commit: [a8a04eb](https://github.com/3urobeat/steam-comment-service-bot/commit/a
 - Updated hostname check
 - Updated dependencies
 - Minor other changes
+
+Commit: [df92d84](https://github.com/3urobeat/steam-comment-service-bot/commit/df92d84)
+
+ 
+
+<a id="2.15.3"></a>
+
+## **2024-08-13, Version 2.15.3**
+**Additions:**
+- Added a few new default quotes
+- Added note about escaping newline in quotes to setup guide
+- Added commentsIpCooldownPenalty setting to advancedconfig [#250](https://github.com/3urobeat/steam-comment-service-bot/issues/250)
+- Added VsCodium project file to remote repository to store command for starting debug session 
+- Rest-API Plugin: Added support for subscribing to PluginSystem events. See the Pull Request [#10](https://github.com/DerDeathraven/steam-comment-bot-rest-api/pull/10) for more info.
+
+**Fixes:**
+- Fixed IP cooldown error penalty in comment requests stacking when using proxies [#250](https://github.com/3urobeat/steam-comment-service-bot/issues/250)
+- Fixed all proxies failed detection in comment processes triggering too soon, leading to aborted request with functioning proxies still left
+- Fixed Unhandled Rejection error when logging proxy used to login when proxy provided in proxies.txt did not include 'http://' [#248](https://github.com/3urobeat/steam-comment-service-bot/issues/248)
+- Fixed SteamCommunity requests failing when using proxies not preceded by 'http://' [#248](https://github.com/3urobeat/steam-comment-service-bot/issues/248)
+- Fixed proxy switcher logging suppressed messages during startup
+- Fixed proxy error on initial login causing a softlock
+- Fixed friend commands not prefixing success messages with `/me`
+- Fixed intentionally escaped newline characters in quotes getting 'activated'
+- Docs: Fixed broken link in setup guide
+- Docs: Fixed broken link in accounts.txt comment
+- Docs: Fixed missing reference to unload function in plugin documentation
+- Discord Plugin: Fixed registerCommands failing when a command does not provide any args and added a check to avoid an Unhandled Rejection when using an outdated node.js version
+
+**Changes:**
+- Drastically reduced complexity of getting bot accountName by making it a top-layer property
+- Refactored unfriendCheck handler
+- Docs: Reworked adding proxies page
+- Removed docs directory from file checksum check
+- Updated dependencies
+- Minor other changes

docs/wiki/creating_plugins.md

@@ -100,6 +100,14 @@ If a session was started by logging in using a QrCode instead of a password, the
 
 To check from your plugin if the Steam Guard Code/QrCode request has been resolved, wait for the statusUpdate event to announce a change.
 
+**Unload function:**  
+The unload function is being called before the plugin object is deleted or the bot exits.  
+
+Please make sure to store any pending data and stop any running instances (for example like a webserver).  
+This ensures that your plugin supports reloading (using the '!reload' command) and does not create duplicate instances or other weird behavior.
+
+If this function is not implemented, a warning will be emitted upon load.
+
  
 
 <a id="logging"></a>

docs/wiki/setup_guide.md

@@ -108,10 +108,12 @@ For now you can ignore all the other settings, however if you'd like to customiz
   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.).  
+  You can also set 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`  
+
+  > Note: If your comment contains `\n` that should not get converted to a line break, you need to escape the backslash like this: `\\n`
 </details>
   
 &nbsp;
@@ -138,4 +140,4 @@ You can see all commands and their usage [here in the wiki](./commands_doc.md).
 
 ## That's it! 🎉
 Congrats, you've successfully set up the bot!  
-Head back to the README by [clicking here](../..#setup--config-guide)!
+Head back to the README by [clicking here](../..#setup-config-guide)!