Update documentation for new credential application

alexemanuelol · Sep 12, 2024 · 2321b9e · 2321b9e
1 parent 70d1ab3
commit 2321b9e
Show file tree

Hide file tree

Showing 11 changed files with 30 additions and 38 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -1,3 +1,2 @@
 docs/
-node_modules/
-src/credentialApplication/node_modules/
+node_modules/
diff --git a/README.md b/README.md
@@ -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 credential application`. Download it [here](https://github.com/alexemanuelol/rustplusplus-credential-application/releases/download/v1.2.0/rustplusplus-1.2.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**

diff --git a/docs/commands.md b/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,27 +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` | &nbsp; | Add FCM Credentials. | &nbsp;
-&nbsp; | `keys_private_key` | Keys Private Key. | `True`
-&nbsp; | `keys_public_key` | Keys Public Key. | `True`
-&nbsp; | `keys_auth_secret` | Keys Auth Secret. | `True`
-&nbsp; | `fcm_token` | FCM Token. | `True`
-&nbsp; | `fcm_push_set` | FCM Push Set. | `True`
-&nbsp; | `gcm_token` | GCM Token. | `True`
-&nbsp; | `gcm_android_id` | FCM Android ID. | `True`
+`add` | &nbsp; | Add Credentials. | &nbsp;
+&nbsp; | `gcm_android_id` | GCM Android ID. | `True`
 &nbsp; | `gcm_security_token` | GCM Security Token. | `True`
-&nbsp; | `gcm_app_id` | GCM App ID. | `True`
 &nbsp; | `steam_id` | Steam ID. | `True`
 &nbsp; | `issued_date` | Issued date of the credentials. | `True`
 &nbsp; | `expire_date` | Expire date of the credentials. | `True`
 &nbsp; | `hoster` | Should be hoster. | `False`
-`remove` | &nbsp; | Remove FCM Credentials. | &nbsp;
+`remove` | &nbsp; | Remove Credentials. | &nbsp;
 &nbsp; | `steam_id` | Steam ID. | `False`
-`show` | &nbsp; | Show all registered FCM Credentials. | &nbsp;
+`show` | &nbsp; | Show all registered Credentials. | &nbsp;
 `set_hoster` | &nbsp; | Set the hoster. | &nbsp;
 &nbsp; | `steam_id` | Steam ID. | `False`
 

diff --git a/docs/credentials.md b/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 credential application](https://github.com/alexemanuelol/rustplusplus-credential-application/releases/download/v1.2.0/rustplusplus-1.2.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

diff --git a/docs/credentials_web_version.md b/docs/credentials_web_version.md
@@ -1,23 +1,23 @@
-# FCM Credentials Documentation (Web Version)
+# Credentials Documentation (Web Version)
 
-> To be able to use an instance of the bot properly, you need to set up your FCM 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.
+> 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 FCM Credentials
+## 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.**
@@ -27,7 +27,7 @@
 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)
@@ -40,9 +40,9 @@
 
    ![Teammates Paired with Server](images/bot_setup/teammates_paired.png)
 
-## Why are FCM Credentials Necessary?
+## Why are Credentials Necessary?
 
-FCM Credentials are necessary to enable the following features:
+Credentials are necessary to enable the following features:
 
 * Server Pairing Notifications
 * Smart Devices Pairing Notifications

diff --git a/docs/discord_text_channels.md b/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>

diff --git a/docs/documentation.md b/docs/documentation.md
@@ -4,7 +4,7 @@
 
 * [**Installation**](installation.md)
 * [**Discord Bot Setup**](discord_bot_setup.md)
-* [**FCM Credentials**](credentials.md) OR [**FCM Credentials(WebVersion)**](credentials_web_version.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)

diff --git a/docs/full_list_features.md b/docs/full_list_features.md
@@ -6,7 +6,7 @@
 - **/blacklist** - Blacklist a user from using the bot.
 - **/cctv** - Get cctv camera codes for monuments.
 - **/craft** - Display the cost to craft an item.
-- **/credentials** - Setup FCM-Credentials.
+- **/credentials** - Setup Credentials.
 - **/decay** - Display the decay time of an item.
 - **/help** - Get help message.
 - **/item** - Get the details of an item.

diff --git a/docs/pair_and_connect_to_server.md b/docs/pair_and_connect_to_server.md
@@ -1,6 +1,6 @@
 # Pair and Connect to a Server
 
-1. Make sure that you've setup the FCM Credentials and that the bot is currently running (`npm start run`).
+1. Make sure that you've setup the Credentials and that the bot is currently running (`npm start run`).
 2. Login to the Rust server you want to play.
 3. Click `ESC` and then on `Rust+`.
 4. Click `PAIR WITH SERVER`.

diff --git a/docs/smart_devices.md b/docs/smart_devices.md
@@ -1,6 +1,6 @@
 # Smart Devices
 
-> Smart Devices is an umbrella term for three different devices, `Smart Switches`, `Smart Alarms` and `Storage Monitors`. To pair a Smart Device with rustplusplus, make sure you've [setup the FCM-Credentials](credentials.md). When the FCM-Credentials are setup, you just need a `wire tool` and start pairing like you would with the [Rust+ Companion App](https://rust.facepunch.com/companion). Once you've paired your Smart Devices, they should appear in their respective Discord Text-Channel (`switches`, `alarms` or `storagemonitors`).
+> Smart Devices is an umbrella term for three different devices, `Smart Switches`, `Smart Alarms` and `Storage Monitors`. To pair a Smart Device with rustplusplus, make sure you've [setup the Credentials](credentials.md). When the Credentials are setup, you just need a `wire tool` and start pairing like you would with the [Rust+ Companion App](https://rust.facepunch.com/companion). Once you've paired your Smart Devices, they should appear in their respective Discord Text-Channel (`switches`, `alarms` or `storagemonitors`).
 <br>
 
 It is possible to change the display image for all the different Smart Devices by running the corresponding Slash Command. The Slash Commands to change Smart Device images is `/switch`, `/alarm` and `/storagemonitor`.

diff --git a/src/discordTools/discordButtons.js b/src/discordTools/discordButtons.js
@@ -516,7 +516,7 @@ module.exports = {
                 module.exports.getButton({
                     style: Discord.ButtonStyle.Link,
                     label: 'CREDENTIALS',
-                    url: 'https://github.com/alexemanuelol/rustplusplus-Credential-Application/releases/v1.2.0'
+                    url: 'https://github.com/alexemanuelol/rustplusplus-Credential-Application/releases/v1.4.0'
                 })
             )];
     },