Version 2.14.1

Merge pull request #227

.eslintrc.json

@@ -1,4 +1,9 @@
 {
+    /* 
+        3urobeat's EsLint Config. Requires eslint & eslint-plugin-jsdoc to be installed as devDependencies.
+        https://github.com/3urobeat
+    */
+
     "env": {
         "commonjs": true,
         "es6": true,

README.md

@@ -8,7 +8,7 @@
 <div align="center">
 
 [![YouTube](https://img.shields.io/badge/YouTube-Tutorial-red)](https://youtu.be/8J78rC9Z28U)
-[![nodejs](https://img.shields.io/badge/node.js-v14-brightgreen)](https://nodejs.org/)
+[![nodejs](https://img.shields.io/badge/node.js-v16-brightgreen)](https://nodejs.org/)
 [![Star](https://img.shields.io/badge/-Give%20this%20repo%20a%20star!-yellow)](https://github.com/3urobeat/steam-comment-service-bot)
 [![Steam Group](https://img.shields.io/badge/Steam%20Group-Join!-blue)](https://steamcommunity.com/groups/3urobeatGroup)
 [![Donate](https://img.shields.io/badge/Donate-%241-orange)](https://github.com/sponsors/3urobeat)
@@ -18,7 +18,7 @@
 
 <p align="center">
   <a href="#introduction">Introduction</a> •
-  <a href="#setup--config-guide">Setup & Config Guide</a> •
+  <a href="#setup-config-guide">Setup & Configuration Guide</a> •
   <a href="#the-wiki">Wiki</a> •
   <a href="#questions-bugs-issues--betas">Get Help</a> •
   <a href="#license">License</a>
@@ -28,9 +28,12 @@
 
 &nbsp;
 
-## **Introduction**  
+<a id="introduction"></a>
+
+## ✨ **Introduction**  
 <img align="right" width="200" height="200" src="https://3urobeat.com/comment-bot/mesh.png">  
 
+**Features:**
 * Request profile, group, screenshot, artwork, guide or discussion comments directly from the Steam Chat
 * Manage hundreds of Steam accounts with ease and control them from **one** terminal and Steam Chat
 * No need of having a Steam Client installed - perfect for hosting on a server
@@ -46,21 +49,19 @@ If you would like to rather follow a video than these written instructions, clic
 
 &nbsp;
 
-## Setup & Config Guide:
+<a id="setup-config-guide"></a>
+
+## 🚀 Setup & Configuration Guide:
 Follow the Wiki's [**Setup Guide by clicking here**](./docs/wiki/setup_guide.md) to get started!  
 This process is pretty simple and should not take you long!  
 
-**Disclaimer!**  
-> I, 3urobeat (the developer), am not responsible and cannot be held liable for any action the operator/user of this bot uses it for.  
-> By using this application you agree to not misuse it!  
-
 &nbsp;
 
-## Additional Information: <a href="https://youtu.be/8J78rC9Z28U?t=339" target="_blank"><img align="right" src="https://img.shields.io/badge/YouTube-Tutorial%20section-red"></a>
+## 💡 Additional Information: <a href="https://youtu.be/8J78rC9Z28U?t=339" target="_blank"><img align="right" src="https://img.shields.io/badge/YouTube-Tutorial%20section-red"></a>
 <div align="center">
 
 [![Sponsor](https://img.shields.io/badge/Sponsor-%241-orange)](https://github.com/sponsors/3urobeat) ![Star](https://img.shields.io/github/stars/3urobeat/steam-comment-service-bot)  
-> If you like this project please consider donating a dollar by clicking on the **Sponsor** badge and by giving this repository a **Star** at the top!  
+> If you like this project please consider donating a dollar by clicking on the **Sponsor** badge and by giving this repository a **Star** at the top! Thank you so much!  
 
 </div>
 
@@ -90,4 +91,4 @@ When using this project as a whole you are only allowed to edit the config files
 #### **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 which this project heavily depends on!  
 
-Thank you so much to every single one who donated a dollar or two; there are now too many names to list them one by one! ❤️  
+Thank you so much to every single one who donated a dollar or two; there are now too many names to list them one by one! ❤️  

docs/dev/bot/bot.md

@@ -10,4 +10,11 @@ The bot object itself handles events for this specific account (e.g. chat messag
  
 
 Every function and object property is documented with JsDocs in the implementation file.  
-Please check them out using your IntelliSense or by clicking the button in the top right corner of this page.
+Please check them out using your IntelliSense or by clicking the button in the top right corner of this page.
+
+ 
+
+### index
+Each bot account gets an index assigned during the first login.  
+The index property must match to the index of the corresponding entry inside the `data.logininfo` array.  
+Should you want to modify the account order during runtime, you must also make the same change in the logininfo array.

docs/dev/dataManager/dataManager.md

@@ -15,6 +15,11 @@ Please check them out using your IntelliSense or by clicking the button in the t
 
  
 
+### logininfo
+Array of objects storing the login information of every bot account.  
+The index property must match to the index of the corresponding bot account.  
+Should you want to modify the account order during runtime, you must also make the same change in this array.
+
 ### lang
 Object storing all supported languages and their strings used for responding to a user.
 

docs/wiki/changelogs/CHANGELOG_v2.14.md

@@ -5,6 +5,7 @@
 
 **Current**  
 - [2.14.0](#2.14.0)
+- [2.14.1](#2.14.1)
 
  
 
@@ -225,4 +226,41 @@ If you are using a `customlang.json`, make sure to read the language string chan
 
 </details>
 
-&nbsp;
+Commit: [b4072cf](https://github.com/3urobeat/steam-comment-service-bot/commit/b4072cf)
+
+&nbsp;
+
+<a id="2.14.1"></a>
+
+## **2023-12-28, Version 2.14.1**
+**Additions:**
+- Added logging of username in friendMessage event
+- Added logging of friend relationship status in friendMessage and steamChatInteraction handlers
+- Added [official discord plugin](https://github.com/3urobeat/steam-comment-bot-discord-plugin) to default package set
+- Added a few emojis to the README.md to visually break up the wall of text
+- Added a deprecation warning to `logininfo.json` import; please use `accounts.txt`
+
+**Fixes:**
+- Fixed data integrity check failing when using an absolute path [#217](https://github.com/3urobeat/steam-comment-service-bot/issues/217) by forcing working dir to `__dirname` in `start.js`
+- Fixed two dependency errors on initial start caused by outdated node.js version
+- Fixed `downloadUpdate()` deleting ratingHistory & userSetting database contents (whoops, sorry!)
+- Fixed plugin config not being updated when plugin data directory of previously installed plugin has been deleted
+- Fixed TypeError and missing license detected when null was provided in `config.json` `childaccplayinggames`
+- Fixed comments not allowed on friendsonly profiles
+  - Profile visibility is now handled better in general
+- Fixed dataImport not resolving language correctly on restore
+
+**Changes:**
+- **Bumped minimum supported node.js version to v16.0.0!**
+  - This fixes the two aforementioned dependency issues on initial start
+- Improved how logininfo object is accessed during login and clarified index -> accountName association in wiki
+- Failed follow request now inserts user into `ratingHistory.db` anyway because enum 2 is also used for a duplicate request
+- Simplified inserting user into `lastcomment.db` database on friend request accept
+- Improved language string `failedcmdnothingfound` to include all request types; russian translation update by [@sashascurtu](https://github.com/sashascurtu)
+- Ignored `package-lock.json` in dataIntegrity check system
+- Removed a few unnecessary last iteration checks when nothing async was happening
+- Made `aggregatePluginConfig()` private
+- Updated every file header to ISO date and update copyright date
+- Wiki: Improved `unfriendtime` config key explanation
+- Updated dependencies
+- Minor other changes

docs/wiki/config_doc.md

@@ -20,11 +20,11 @@ This is the full documentation to customize your `config.json`.
 | maxRequests | Number | Defines how many comments/likes/favs a normal user can request from your bot. Will automatically use accounts multiple times if it is greater than the amount of accounts logged in. |
 | maxOwnerRequests | Number | Defines how many comments/likes/favs owners can request (every user in the ownerid list below). Will automatically use accounts multiple times if it is greater than the amount of accounts logged in. |
 | randomizeAccounts | true or false | Defines if the order of accounts used to comment should be randomized. Default: false |
-| unfriendtime | Days | Number of days the bot will wait before unfriending someone who hasn't requested a comment in that time period except the owner. Set to 0 to disable. |
+| unfriendtime | Days | Amount of days after which the bot will unfriend an inactive user (activity is measured using when they last started a request). Does not unfriend owners. Set to 0 to disable. |
 | playinggames | `["custom game", game id, game id, ...]` | This custom text will be shown on your profile as the name of a game you are playing. The bot will play the set game ids. Don't provide a string to disable the custom game text. |
 | childaccplayinggames | `["custom game", game id, game id, ...]` <br><br> or <br><br> `[{ "myacc1": ["Specific Game", 730], "myacc25": [] }, "General Game", 440]` | Same behaviour as playinggames but sets the status and games for all child accounts.<br>Use the second syntax to set specific games for specific child accounts.<br>Replace "myacc1" etc. with the username of the corresponding account.<br><br>This example will display "Specific Game" game & idle CS2 only for account "myacc1", idle nothing for account "myacc25" and display "General Game" & idle TF2 for all other accounts. |
 | yourgroup | "url to group" | Advertise your group with the !group command. Leave it empty (like this: "") to disable the command. |
 | botsgroupid | "url to group" | All bot accounts will join this group. Disable this feature by leaving the brackets empty (like this: ""). |
 | acceptgroupinvites | true or false | Defines if the bots will accept group invites from other users. A group invite from the main bot will always be accepted. |
 | owner | "url to profile" | Advertise your own profile with the !owner command. Leave it empty (like this: "") to disable the command. |
-| ownerid | ["profile link or id1", "id2"] | Sets these users as owners. Needs to be set to use the bot. You can set profile links or ids like in the example to have multiple owners. |
+| ownerid | ["profile link or id1", "id2"] | Sets these users as owners. Needs to be set to use the bot. You can set profile links or ids like in the example to have multiple owners. |

docs/wiki/setup_guide.md

@@ -30,7 +30,7 @@ Every headline on this page also contains a YouTube badge which will take you to
 Click here: [Download](https://github.com/3urobeat/steam-comment-service-bot/archive/master.zip)  
 Extract the zip and open the `steam-comment-service-bot` folder.  
 
-You need to have at least node.js version 14.15.0 installed: [Download](https://nodejs.org)  
+You need to have at least node.js version 16.0.0 installed: [Download](https://nodejs.org)  
 If you already have node installed, check the version number by running `node --version` in your console or terminal.  
 If you need a tutorial for this specific node part, [click here.](https://youtu.be/8J78rC9Z28U?t=60)