Feature/Fix: Implement Atomic Write Pattern for Instance File Integrity

.dockerignore

@@ -1,3 +1,2 @@
 docs/
-node_modules/
-src/credentialApplication/node_modules/
+node_modules/

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,26 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: 'bug'
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - Hosting OS:
+ - Node Version (node -v):
+ - NPM Version (npm -v):
+ - Bot Version (git log -1):

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: 'enhancement'
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/docker-publish.yml

@@ -30,13 +30,13 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       # Login against a Docker registry except on PR
       # https://github.com/docker/login-action
       - name: Log into registry ${{ env.REGISTRY }}
         if: github.event_name != 'pull_request'
-        uses: docker/login-action@28218f9b04b4f3f62068d7b6ce6ca5b26e35336c
+        uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
@@ -46,14 +46,14 @@ jobs:
       # https://github.com/docker/metadata-action
       - name: Extract Docker metadata
         id: meta
-        uses: docker/metadata-action@98669ae865ea3cffbcbaa878cf57c20bbf1c6c38
+        uses: docker/metadata-action@v5
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
 
       # Build and push Docker image with Buildx (don't push on PR)
       # https://github.com/docker/build-push-action
       - name: Build and push Docker image
-        uses: docker/build-push-action@ad44023a93711e3deb337508980b4b5e9bcdc5dc
+        uses: docker/build-push-action@v6
         with:
           context: .
           push: ${{ github.event_name != 'pull_request' }}

.github/workflows/lint.yml

@@ -1,19 +1,19 @@
-on:
-  push:
-  pull_request:
-
-jobs:
-  lint:
-    name: Lint - Node ${{ matrix.node }}
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node: [ 14, 16, 18 ]
-    steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-node@v3
-      with:
-        node-version: ${{ matrix.node }}
-        cache: 'npm'
-    - run: npm install
-    - run: npm test
+on:
+  push:
+  pull_request:
+
+jobs:
+  lint:
+    name: Lint - Node ${{ matrix.node }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: [ 22 ]
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node }}
+        cache: 'npm'
+    - run: npm install
+    - run: npm test

FAQ.md

@@ -0,0 +1,61 @@
+# Frequently Asked Questions
+- [When I run 'npm install' I get an error](#when-i-run-npm-install-i-get-an-error)
+- [I've added the credentials but when I pair I get no notification](#credentials-added-but-no-pair-notification)
+- [The bot keep resetting channel permissions after restart](#bot-reset-channel-permissions)
+- [Im getting 'ERROR: {"code":"DisallowedIntents"}' when trying to start the bot](#disallowed-intents)
+- [Im getting 'ERROR: {"code": "TokenInvalid"}' when trying to start the bot](#token-invalid)
+- [Im getting 'ERROR: SyntaxError: Unexpected token '', ""... is not valid JSON' or 'ERROR: SyntaxError: Unexpected token in JSON at position 0' when trying to start the bot](#unexpected-token-invalid-json)
+- [When trying to get my credentials from the app, it's completely empty](#credential-app-empty)
+
+<a name="when-i-run-npm-install-i-get-an-error"></a>
+## When I run 'npm install' I get an error
+
+If you're getting the error below, try running `npm i -g npm`. This should allow you to successfully do `npm install` afterwards.
+![npm install error](docs/images/faq/npm-install-error.png)
+
+
+<a name="credentials-added-but-no-pair-notification"></a>
+## I've added the credentials but when I pair I get no notification
+
+If you're having trouble getting a pair notifications (server/smart device), several things can be causing this. It's possible that the credentials you are currently using have been outdated, when generating credentials, they usually last for two weeks, so you can try to re-generate them through the [rustplusplus credential application](https://github.com/alexemanuelol/rustplusplus-credential-application) or the [rustplusplus website](https://rustplusplus-credentials.netlify.app/).
+
+If you're still not getting any notifications and you are simultaneously using the rust companion app and are successfully getting pairing notifications there, this could be the issue. While it's possible to run both apps at the same time, it's not recommended. The reason for this is that using the same steam account credentials in different places makes the notifications a bit unstable, some notifications might still get through. In the scenario of trying to pair a server or a smart device, you can just try doing several attempts of pairing and eventually it will get through.
+
+
+<a name="bot-reset-channel-permissions"></a>
+## The bot keep resetting channel permissions after restart
+
+This is intentional. While this might change in the future, the current solution for this is to use the /role command to set a specific role that will be allowed to view the channels.
+
+
+<a name="disallowed-intents"></a>
+## Im getting 'ERROR: {"code":"DisallowedIntents"}' when trying to start the bot
+
+![DisallowedIntents](docs/images/faq/disallowedintents.png)
+
+If you're getting this error it's because you missed a step in the setup guide (Step 9). Kick the bot from your discord server and go [here](https://github.com/alexemanuelol/rustplusplus/blob/master/docs/discord_bot_setup.md) and follow the guide from step 9.
+
+
+<a name="token-invalid"></a>
+## Im getting 'ERROR: {"code": "TokenInvalid"}' when trying to start the bot
+
+![TokenInvalid](docs/images/faq/token_invalid.png)
+
+This happens when the token you placed in the config file is invalid. There have been cases where people clone the repository with git and also download the zip of the repository, ending having two separate repositories of the bot. The problem that have occured for these people is that they've placed the token in one respository and tried running the other one. So make sure that you are trying to start the correct bot that have the config setup with the token.
+
+
+<a name="unexpected-token-invalid-json"></a>
+## Im getting 'ERROR: SyntaxError: Unexpected token '', ""... is not valid JSON' when trying to start the bot
+
+![Unexpected token in json 1](docs/images/faq/unexpected_token_invalid_json.png)
+![Unexpected token in json 2](docs/images/faq/unexpected_token_invalid_json_at_pos_0.png)
+
+This occurs for some people when their PC crash, there is still no solution for this but I hope to solve this in the future. Meanwhile you can follow the [issue on GitHub](https://github.com/alexemanuelol/rustplusplus/issues/309) for updates. Current solution to be able to continue is to remove your instance file and let the bot create a new one when you start the bot next time.
+
+
+<a name="credential-app-empty"></a>
+## When trying to get my credentials from the app, it's completely empty
+
+If the rustplusplus credential application looks like the image below after you've logged in with your steam details this might be because of where you live or something else blocking you from generating. The solution for you would be to try it on the [rustplusplus website](https://rustplusplus-credentials.netlify.app/) instead.
+
+![credential app empty](docs/images/faq/empty-credential-app.png)

README.md

@@ -3,7 +3,7 @@
 </p>
 
 <p align="center">
-<a href="https://discord.gg/vcrKbKVAbc"><img src="https://img.shields.io/badge/Discord-Alexemanuelol%238259-%237289DA?style=flat&logo=discord" alt="discord"/></a>
+<a href="https://discord.gg/vcrKbKVAbc"><img src="https://img.shields.io/badge/Discord-Alexemanuel-%237289DA?style=flat&logo=discord" alt="discord"/></a>
 <a href="https://www.reddit.com/user/Alexemanuelol"><img src="https://img.shields.io/badge/Reddit-Alexemanuelol-FF4500?style=flat&logo=reddit" alt="reddit"/></a>
 <a href="https://ko-fi.com/alexemanuelol"><img src="https://img.shields.io/badge/Donate%20a%20Coffee-alexemanuelol-yellow?style=flat&logo=buy-me-a-coffee" alt="donate on ko-fi"/></a>
 
@@ -46,7 +46,7 @@ A NodeJS Discord Bot that uses the [rustplus.js](https://github.com/liamcottle/r
 
 ## **Credentials**
 
-> You can get your credentials by running the `rustplusplus FCM Credential Application`. Download it [here](https://github.com/alexemanuelol/rustplusplus-Credential-Application/releases/download/v1.1.0/rustPlusPlus-1.1.0-win-x64.exe)
+> You can get your credentials by running the `rustplusplus credential application`. Download it [here](https://github.com/alexemanuelol/rustplusplus-credential-application/releases/download/v1.4.0/rustplusplus-1.4.0-win-x64.exe)
 
 
 ## **How to run the bot**

docs/commands.md

@@ -14,7 +14,7 @@ Slash Command | Description
 [**/blacklist**](commands.md#blacklist) | Blacklist a user from using the bot.
 [**/cctv**](commands.md#cctv) | Posts CCTV codes for a monument.
 [**/craft**](commands.md#craft) | Display the cost to craft an item.
-[**/credentials**](commands.md#credentials) | Set/Clear the FCM Credentials for the user account.
+[**/credentials**](commands.md#credentials) | Set/Clear the Credentials for the user account.
 [**/decay**](commands.md#decay) | Display the decay time of an item.
 [**/help**](commands.md#help) | Display help message.
 [**/item**](commands.md#item) | Get the details of an item.
@@ -105,25 +105,20 @@ Subcommand | Options | Description | Required
 
 ## **/credentials**
 
-> **Add/Remove the FCM Credentials for the user account.**
+> **Add/Remove the Credentials for the user account.**
 
 Subcommand | Options | Description | Required
 ---------- | ------- | ----------- | --------
-`add` |   | Add FCM Credentials. |  
-  | `keys_private_key` | Keys Private Key. | `True`
-  | `keys_public_key` | Keys Public Key. | `True`
-  | `keys_auth_secret` | Keys Auth Secret. | `True`
-  | `fcm_token` | FCM Token. | `True`
-  | `fcm_push_set` | FCM Push Set. | `True`
-  | `gcm_token` | GCM Token. | `True`
-  | `gcm_android_id` | FCM Android ID. | `True`
+`add` |   | Add Credentials. |  
+  | `gcm_android_id` | GCM Android ID. | `True`
   | `gcm_security_token` | GCM Security Token. | `True`
-  | `gcm_app_id` | GCM App ID. | `True`
   | `steam_id` | Steam ID. | `True`
+  | `issued_date` | Issued date of the credentials. | `True`
+  | `expire_date` | Expire date of the credentials. | `True`
   | `hoster` | Should be hoster. | `False`
-`remove` |   | Remove FCM Credentials. |  
+`remove` |   | Remove Credentials. |  
   | `steam_id` | Steam ID. | `False`
-`show` |   | Show all registered FCM Credentials. |  
+`show` |   | Show all registered Credentials. |  
 `set_hoster` |   | Set the hoster. |  
   | `steam_id` | Steam ID. | `False`
 
@@ -385,6 +380,7 @@ In-Game Command | Description
 [**unmute**](commands.md#unmute) | Unmute the bot from the In-Game Team Chat.
 [**upkeep**](commands.md#upkeep) | Get the upkeep time of all connected tool cupboard monitors.
 [**uptime**](commands.md#uptime-ingame) | Display uptime of the bot and server.
+[**vendor**](commands.md#vendor) | Get information about the Traveling Vendor (Current Location, Time since last vendor)
 [**wipe**](commands.md#wipe) | Get the time since it was wiped.
 
 
@@ -720,6 +716,14 @@ Subcommand | Description | Required
 ![In-Game Command uptime Image](images/ingame_commands/uptime_ingame.png)
 
 
+## **vendor**
+
+> **Get information about the Traveling Vendor (Current Location, Time since last Traveling Vendor).**
+<br>Command: `!vendor`
+
+![In-Game Command vendor Image](images/ingame_commands/vendor_ingame.png)
+
+
 ## **wipe**
 
 > **Get the time since it was wiped.**

docs/credentials.md

@@ -1,13 +1,13 @@
-# FCM Credentials Documentation
+# Credentials Documentation
 
-> To be able to use an instance of the bot properly, you want to setup your FCM Credentials. Adding these credentials makes it possible for you to pair with servers as well as connecting to them.
+> To be able to use an instance of the bot properly, you want to setup your Credentials. Adding these credentials makes it possible for you to pair with servers as well as connecting to them.
 
-## Retrieving FCM Credentials
+## Retrieving Credentials
 
-* Download and install the [rustplusplus FCM Credential Application](https://github.com/alexemanuelol/rustplusplus-Credential-Application/releases/download/v1.1.0/rustPlusPlus-1.1.0-win-x64.exe)
+* Download and install the [rustplusplus credential application](https://github.com/alexemanuelol/rustplusplus-credential-application/releases/download/v1.4.0/rustplusplus-1.4.0-win-x64.exe)
 * Once downloaded and installed, open it and press the button `Connect with Rust+`.
 
-![rustplusplus FCM Credential Application Image](images/bot_setup/fcm_credential_application_connect.png)
+![rustplusplus Credential Application Image](images/bot_setup/fcm_credential_application_connect.png)
 
 * Another window will pop up where you need to login with your Steam Account.
 
@@ -20,15 +20,15 @@
 
 * Paste the Slash command in your Discord Server Text Channel. Which Text Channel you run the Slash Command is not important, as long as the bot has access to it.
 
-![FCM Credentials discord Image](images/bot_setup/credentials_discord.png)
+![Credentials discord Image](images/bot_setup/credentials_discord.png)
 
 * This process is the same for the owner of the bot as well as any teammate that want to register their credentials (mainly for the purpose to extend the usage of the leader command). Once a teammate have registered their credentials, they just need to go inside the game and pair with the server. Which teammates that have paired with the server can be seen in the information channel, they should have the P icon beside their name, see below:
 
 ![Teammates Paired with Server](images/bot_setup/teammates_paired.png)
 
-## Why is FCM Credentials necessary?
+## Why is Credentials necessary?
 
-FCM Credentials are necessary in order to get the following:
+Credentials are necessary in order to get the following:
 
 * Server Pairing Notifications
 * Smart Devices Pairing Notifications

docs/credentials_web_version.md

@@ -0,0 +1,58 @@
+# Credentials Documentation (Web Version)
+
+> To be able to use an instance of the bot properly, you need to set up your Credentials. Adding these credentials makes it possible for you to pair with servers as well as connecting to them. Note that unlike the previous .exe version, the web version requires Chrome or Firefox browsers.
+
+## **❗️Before You Start**
+> Make sure you are using **`Chrome or Firefox browsers`** before starting the credential setup process.
+> This is because the web version uses browser extensions to simplify the process, which is more lightweight and convenient compared to the relatively heavy .exe application.
+
+## Retrieving Credentials
+
+1. **First, navigate to the [rustplusplus-credentials page](https://rustplusplus-credentials.netlify.app/).**
+
+2. **Click the Install Extension button located at the top right corner of the page to install the extension, then refresh the page. (After installation, the Log In button should be visible)**
+
+> [rustPlusPlus-Credentials Chrome Extension](https://chromewebstore.google.com/detail/rustplusplus-credential-a/ooahmkklkanfgfmphpknpcgdpdcoikhe)
+
+> [rustPlusPlus-Credentials Firefox Extension](https://addons.mozilla.org/en-US/firefox/addon/rustplusplus-credential-app)
+
+   ![rustplusplus Click Install Extension Image](images/bot_setup/click_install_extension.png)
+
+   ![rustplusplus After Click Install Extension Image](images/bot_setup/after_click_install_extension.png)
+
+3. **Click the Log In button to proceed with the Steam login.**
+
+   ![Steam Account login Image](images/bot_setup/steam_login_web.png)
+
+4. **After logging in, you will be redirected to the display page where the slash command will be shown `/credentials add ....`**
+
+   ![rustplusplus Display Page](images/bot_setup/rustplusplus_display_page.png)
+
+5. **Click `Copy` to copy the Slash Command.**
+
+   ![Credentials copy Image](images/bot_setup/click_copy_to_clipboard.png)
+
+6. **Paste the Slash Command in your Discord Server Text Channel. The specific Text Channel does not matter, as long as the bot has access to it.**
+
+   ![FCM Credentials discord Image](images/bot_setup/credentials_discord.png)
+
+7. **This process is the same for the owner of the bot as well as any teammate that wants to register their credentials (mainly to extend the usage of the leader command). Once a teammate has registered their credentials, they need to go inside the game and pair with the server. Teammates paired with the server can be seen in the information channel, indicated by the P icon beside their name, as shown below:**
+
+   ![Teammates Paired with Server](images/bot_setup/teammates_paired.png)
+
+## Why are Credentials Necessary?
+
+Credentials are necessary to enable the following features:
+
+* Server Pairing Notifications
+* Smart Devices Pairing Notifications
+* Smart Alarm Notifications
+* Player Offline Death Notifications
+* Teammate Login Notifications
+* Facepunch News
+
+Without these, the bot would not operate properly.
+
+> **Note**: This process requires Chrome or Firefox browsers for the web version. Ensure your browser is up to date for the best experience.
+
+> Rust Companion API returns a refreshed Steam Auth Token which expires after 2 weeks. You can visit the [rustplusplus-credentials display page](https://rustplusplus-credentials.netlify.app/display) at any time to check how much time is left on your token.

docs/discord_text_channels.md

@@ -52,7 +52,7 @@
 
 ## Servers Channel
 
-> The Server Channel lists all the paired Rust Servers. Given that you have setup your FCM Credentials properly, once you pair a Rust Server In-Game via `ESC -> Rust+ -> Pair With Server`, it should automatically appear in the `servers` channel. From there you can decide which server you want the bot to connect to by clicking the `CONNECT` button for that server.
+> The Server Channel lists all the paired Rust Servers. Given that you have setup your Credentials properly, once you pair a Rust Server In-Game via `ESC -> Rust+ -> Pair With Server`, it should automatically appear in the `servers` channel. From there you can decide which server you want the bot to connect to by clicking the `CONNECT` button for that server.
 
 The server embed displays a bunch of information. The title of the embed is the name of the server. The Battlemetrics Id is also displayed as well as if the server is streamer mode or not. The Description of the embed is basically the description of the Rust Server. Here you can also find the connect information that could be found in `information` channel. You can also see who is the hoster of the bot for the server.
 <br>

docs/documentation.md

@@ -4,7 +4,7 @@
 
 * [**Installation**](installation.md)
 * [**Discord Bot Setup**](discord_bot_setup.md)
-* [**FCM Credentials**](credentials.md)
+* [**Credentials**](credentials.md) OR [**Credentials(WebVersion)**](credentials_web_version.md)
 * [**Pair & Connect Server**](pair_and_connect_to_server.md)
 * [**Commands**](commands.md)
 * [**Discord Text Channels**](discord_text_channels.md)