⚡ feat (release 🤖): Stelle v3.1.1 🎉(#28)

* 📦Updated dependencies.
* ✉️ Added the function to resume players when a node is down.
* 📨 Updated markdown files.
    * 🏮 Also updated the application.yml example.
    * 🏮 Also added the `FAQ` section.
* 🐐 Some code changes.

Author: EvilG-MC

.env.example

@@ -11,9 +11,11 @@
 #
 
 # The Discord application token.
+# Replace the 'the-knave-was-there' with your own token.
 TOKEN = "the-knave-was-there"
 
 # The MongoDB database URL.
+# Remove the text and replace it with your own database URL.
 DATABASE_URL = "mongodb+srv://ganyu:supremacy@liyue/dbname?retryWrites=true&w=majority"
 
 #

FAQ.md

@@ -1,3 +1,28 @@
 ## 🔎 FAQ
 
-> WIP
+* Something is missing? Please let me know.
+
+---
+
+### 🔎 Q: I'm getting: `Error: 401: Unauthorized 0`
+![Q](https://i.imgur.com/QnpxyTb.png)
+* R: Make sure you filled the `.env` file with a valid discord token.
+
+---
+
+### 🔎 Q: I'm getting: `Error: Missing Access 50001`
+![Q](https://i.imgur.com/pxEf72k.png)
+* R1: If you already changed the IDs in the config, please rebuild the code.
+* R2. Go to [`Configuration.ts`](/src/structures/utils/data/Configuration.ts) and change the `guildIds` array,
+
+---
+
+### 🔎 Q: I'm getting the prisma error: `Error: P1013`
+![Q](https://i.imgur.com/LzVyd0y.png)
+* R: Make sure you **followed** the example database url format. (or you can see it [here](https://www.prisma.io/docs/orm/overview/databases/mongodb#connection-details))
+
+---
+
+### 🔎 Q: I'm getting the MongoDB error: `Server selection timeout: No available servers.`
+![Q](https://i.imgur.com/X0QsqbJ.png)
+* R: You need to **WHITELIST** your IP in order to access your mongodb cluster.

INSTALLATION.md

@@ -16,17 +16,69 @@ cd stelle-music
 pnpm i
 ```
 
+###  📋 Database
+* Stelle uses Prisma ORM to manage the database.
+
+When prisma is installed the first time (or update prisma) prisma needs to generate the types to work.
+
+1. Run `pnpm prisma generate` to generate the types
+
+This also applies when you make changes in the [schema](/prisma/schema.prisma), you need to generate the new types.
+
+> [!NOTE]
+> You can execute also `pnpm prisma db push` to synchronize the database.<br/>
+> This needs to be executed when you make changes in the [schema](/prisma/schema.prisma) (It's not mandatory, but I recommend it.)
+
+
+###  📋 Environment Variables
+* Stelle needs some environment variables to work.
+
+1. Copy the `.env.example` file. (localed in the root of the project)
+2. Rename the file to: `.env`.
+3. Fill the required variables. ([available variables](/.env.example))
+
+> [!IMPORTANT]
+> You need to follow the `DATABASE_URL` example url format.<br/>
+> You can learn more about the prisma url format [here](https://www.prisma.io/docs/orm/overview/databases/mongodb#connection-details)
+
 ###  📋 Configuration
 * Stelle has a configuration to save a specific data.
 
-> 1. Go to [the configuration](/src/structures/utils/data/Configuration.ts#L17-L22)
+> 1. Go to [the configuration](/src/structures/utils/data/Configuration.ts#L18-L23)
 > 2. Replace the IDs with your IDs.
 
 > Example:
 ```js
 guildIds: [
-    "123", // Example Guild
-    "456", // Example Guild 2
+    "123", // Example guild id
+    "456", // Another example guild id
+    ...
+];
+```
+
+---
+
+* Don't forget to change the channel ids.
+> 1. Go to [the configuration](/src/structures/utils/data/Configuration.ts#L39-L42)
+> 2. Replace the IDs with your IDs.
+
+```js
+channels: {
+    guildsId: "1234", // Example channel id
+    errorsId: "45678", // Another example channel id
+}
+```
+
+---
+
+* Don't forget to change the user ids.
+> 1. Go to [the configuration](/src/structures/utils/data/Configuration.ts#L15-L17)
+> 2. Replace the IDs with your IDs.
+
+```js
+developerIds: [
+    "1234", // Example user id
+    "5678", // Another example user id
     ...
 ];
 ```
@@ -37,25 +89,18 @@ guildIds: [
 Run the bot in `Javascript`
 
 ```bash
-#This is necessary for typescript.
-pnpm prisma generate #Generate types for prisma.
-
-#Or you can do it step-by-step
-pnpm clean #Will re-create the dist folder
-pnpm start #Will start the bot
+pnpm clean # Will re-create the dist folder
+pnpm start # Will start the bot
 ```
 
 Run the bot in `Typescript`
 
 ```bash
-#This is necessary for typescript.
-pnpm prisma generate #Generate types for prisma.
-
-#And run it!
+# Run it!
 pnpm dev
 
 ``` 
 
 ### 🔎 Looking for a lavalink node?
-> Stelle needs a [`Lavalink node`](https://github.com/lavalink-devs/Lavalink) to play music.
+> Stelle needs a [`Lavalink node`](https://github.com/lavalink-devs/Lavalink) to play music.<br/>
 > See [self hosting a node](/LAVALINK.md) for more.

README.md

@@ -20,9 +20,10 @@ She has been created with the following technologies:
 
 ## ⚙️ Minimum Requeriments
 
-- [PNPM v9.2x](pnpm.io/installation)
-- [NodeJS v.20.14x](https://nodejs.org/en/download/prebuilt-installer)
+- [PNPM v9.15.0x](pnpm.io/installation)
+- [NodeJS v.22.11.0x](https://nodejs.org/en/download/prebuilt-installer)
 - [Visual Studio Code](https://code.visualstudio.com)
+- [MongoDB Database](https://www.mongodb.com/) (You can create a _free*_ mongodb cluster)
 
 See the the [how to install](/INSTALLATION.md) for more.