(v1.2) Plex Optional Feature & Improvements

+ New Plex feature which allows the user to use their own Plex Media Server to stream music from. This brings alight the /plex command. If a query returns more than one item during the /plex play command, a search prompt will appear to allow you to pick the exact song or playlist, otherwise, it will directly play the song.
+ A bunch of bug fixes including issues with sending non-ephemeral replies for queries which were not found and more...
+ Switched any remaining code using ENVs to use the client.config object which is loaded at bot launch.
+ Removed unnecessary constants from loading.
+ Deps bumps.

.env.example

@@ -7,10 +7,6 @@ OWNER_ID=360815761662541824
 EMBED_COLOUR='#FF0000'
 PRESENCE='/help | elite-bot.com'
 
-# DJ MODE SETTINGS
-ENABLE_DJMODE=false
-DJ_ROLE=514885071438872604
-
 # MUSIC PLAYBACK BEHAVIOUR SETTINGS
 LEAVE_ON_EMPTY=true
 LEAVE_ON_EMPTY_COOLDOWN=300000
@@ -23,4 +19,15 @@ LEAVE_ON_STOP_COOLDOWN=300000
 
 SELF_DEAFEN=true
 DEFAULT_VOLUME=50
-SMOOTH_VOLUME=true
+SMOOTH_VOLUME=true
+
+### ADDITIONAL FEATURES SETTINGS
+
+# DJ MODE SETTINGS
+ENABLE_DJMODE=false
+DJ_ROLE=123456789987654321
+
+# PLEX MEDIA SERVER SETTINGS
+ENABLE_PLEX=false
+PLEX_SERVER='http://YOUR_IPADDRESS:32400'
+PLEX_AUTHTOKEN='YOUR_AUTH_TOKEN'

README.md

@@ -8,22 +8,23 @@ Elite Music is a feature-packed Discord Music Bot built on top of [discord.js](h
 - Support for various streaming platforms
 - Wide range of audio filters
 - Awesome playback UI
+- Additional features including plex media server support.
 - And much more!
 
-Elite Music was originally a part of my verified Discord bot... [Elite Bot](https://elite-bot.com/), but the music section had to be removed due to verification issues. Therefore, in a win situation, I decided to open-source the bot's music code in this repository. And even better, I decided to re-write the entire bot to improve the feature set and overall quality of the code.
+Elite Music was originally a part of my verified Discord bot... [Elite Bot](https://elite-bot.com/), but the music section had to be removed due to verification issues. Therefore, in a win situation, I decided to open-source the bot's music code in this repository. And even better, I decided to rewrite the entire bot to improve the code's feature set and overall quality.
 
 # Installation 🔌
 ## Prerequisites 🛂
 In order for the bot to function correctly, there are a few prerequisites that you must have on your system.
 
 - [NodeJS](https://nodejs.org/en) - For the bot to function, it must be running in a NodeJS environment running on v16.9.0 or higher. It is highly recommended that you download the LTS build which is available for your OS to remain on the latest stable version. Head over to the [NodeJS Download website](https://nodejs.org/en/download) to download and install an appropriate version.
 
-- [FFmpeg](https://ffmpeg.org/) or Avconv - You will require either of these for transcoding. It is recommended to use FFmpeg. By default, the bot comes with the `ffmpeg-static` binaries as a dependancy which allows the bot to work out of the box. Alternatively, you may decide to set your own ffmpeg binaries. In this case, head over to the [FFmpeg Download website](https://ffmpeg.org/download.html), select your OS and download the appropriate package. You can then place `FFMPEG_PATH` as a new option into your .ENV file stating the custom path to your custom FFmpeg binaries.
+- [FFmpeg](https://ffmpeg.org/) or Avconv - You will require either of these for transcoding. It is recommended to use FFmpeg. By default, the bot comes with the `ffmpeg-static` binaries as a dependency which allows the bot to work out of the box. Alternatively, you may decide to set your own ffmpeg binaries. In this case, head over to the [FFmpeg Download website](https://ffmpeg.org/download.html), select your OS and download the appropriate package. You can then place `FFMPEG_PATH` as a new option into your `.ENV` file stating the custom path to your custom FFmpeg binaries.
 
-- [Discord Bot Account](https://discord.com/developers/applications) - You must register a bot on the Discord Developer site to gain access to a token to run the bot. Head over to the [Developer website](https://discord.com/developers/applications) and click on `New Application` button. Provide a name and press `Create`. Next on the left-hand menu, select the `Bot` section and press `Add Bot` alongside the confirmation. Finally, press `Reset Token` and finally copy the token and keep it safe. This is what you will have to place into your .ENV file for the bot to function.
+- [Discord Bot Account](https://discord.com/developers/applications) - You must register a bot on the Discord Developer site to access a token to run the bot. Head over to the [Developer website](https://discord.com/developers/applications) and click on `New Application` button. Provide a name and press `Create`. Next on the left-hand menu, select the `Bot` section and press `Add Bot` alongside the confirmation. Finally, press `Reset Token` and finally copy the token and keep it safe. This is what you will have to place into your `.ENV` file for the bot to function.
 
 ## Setup 🔧
-The first step is to clone the repository or download it manually as a folder to host it directly. The Git option is recommended for more advanced users and for users which already have it installed.
+The first step is to clone the repository or download it manually as a folder to host it directly. The Git option is recommended for more advanced users and for users who already have it installed.
 
 #### Basic download
 Head over to the download page and download the .zip source code. Next, using a tool such as [7-Zip](https://www.7-zip.org/), extract the files from the .zip folder. You can now move on to the following steps.
@@ -34,18 +35,38 @@ An alternative way to download the repository is through the usage of [Git](http
 #### Continuing the Setup
 Now that you have downloaded the repository, you can continue with the following steps.
 
-1. Open a new command/shell/terminal window within your new folder. You should be able to right-click and open windows terminal/command prompt if on windows.
+1. Open a new command/shell/terminal window within your new folder. You should be able to right-click and open the Windows terminal/command prompt if on Windows.
 2. Run the command `npm install` to download all of the module dependencies.
 3. Rename the file `.env.example` to simply `.env`. Once down, edit the `.env` file with the configuration options that you would like!
 4. Finally, run your bot using `node .` within a command/shell/terminal window. The bot should now become online and provide a success message if everything was configured correctly. 🎉
 5. (Optional) If you are editing the code, you can use `npm run dev` within your IDE to activate nodemon, which will automatically restart the bot on any change which is ideal for development.
 
 Of course, you need to add your bot to your server now in order to use it. Follow this [useful guide](https://discordjs.guide/preparations/adding-your-bot-to-servers.html#bot-invite-links) from the discord.js Guide which explains how to do this with great detail if you need help understanding how to do this.
 
+## Optional Features ✅
+You may decide to want to enable additional optional features for your bot. Follow the appropriate sub-heading to learn how to set up and enable the selected feature!
+
+If you are missing the relevant option in your environmental (`.env`) file, make sure to check the latest [`.env.sample` file](https://github.com/ThatGuyJacobee/Elite-Music/blob/main/.env.example) to ensure you are on the latest version.
+
+Once you have followed the appropriate steps for the optional feature that you want to enable, you should start the bot and ensure that the configuration option returns as `true` when the configuration loads. If the feature still shows as disabled, this suggests that you have a configuration error. Follow the error logs that are provided in your console to resolve this. If you are still having trouble with your issue, feel free to create an issue on the [repository](https://github.com/ThatGuyJacobee/Elite-Music/issues/new) or join the [Support Discord server](https://discord.elitegami.ng).
+
+### Plex Media Server playback
+The Plex optional feature when enabled, allows you to stream music directly from your Plex Media Server through the /plex command. In order to enable the Plex feature, you must go into your `.env` file and set up the configuration to your own Plex Media Server.
+
+1. Firstly, set `ENABLE_PLEX` to `true`.
+2. Next, you must provide a direct URL to your Plex Media Center. The default port that Plex Media Server runs on is `32400`. You can test that your `PLEX_SERVER` URL is correct, by pasting it into any web browser, and it should load successfully with a login page.
+3. Finally, you must place your plex authentication token into the `PLEX_AUTHTOKEN` field. You can do this by browsing the XML file for a library item. Please follow the [official Plex Support article](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/) to access your token. Once you have access to it, place it into your .env file.
+
+### DJ Mode
+Elite Music comes with a DJ Mode optional feature, which locks down the use of commands and interactions to members who have the specified DJ Role.
+
+1. Firstly, set `ENABLE_DJMODE` to `true`.
+2. Now create a role on your server which you wish to be used as the DJ Role. Copy the ID of the role and place it into the `DJ_ROLE` field.
+
 ## Support 🆘
 Need help setting up the bot or experiencing some trouble? Feel free to head over to the [Support Discord server](https://discord.elitegami.ng) and let me know!
 
-Found a bug or issue with the latest build? Feel free to open an issue on this repository! I will respond as soon as possible.
+Found a bug or issue with the latest build? Feel free to open an issue on this [repository](https://github.com/ThatGuyJacobee/Elite-Music/issues/new)! I will respond as soon as possible.
 
 ## Elite Bot - Verified Multi-Purpose Bot 💪
 Looking for a multi-purpose Discord Bot for your server? Look no further, check out Elite Bot to fulfil all of your server needs including moderation, logging, external server status and much more!

commands/music/audiofilter.js

@@ -1,7 +1,7 @@
 require("dotenv").config();
 const { SlashCommandBuilder } = require("@discordjs/builders");
-const { EmbedBuilder, PermissionFlagsBits } = require("discord.js");
-const { Player, QueryType } = require('discord-player');
+const { EmbedBuilder } = require("discord.js");
+const { Player } = require('discord-player');
 
 module.exports = {
     data: new SlashCommandBuilder()
@@ -52,12 +52,12 @@ module.exports = {
         ),
     async execute(interaction) {
         const filter = interaction.options.getString("filter");
-        if (process.env.ENABLE_DJMODE == true) {
-            if (!interaction.member.roles.cache.has(process.env.DJ_ROLE)) return interaction.reply({ content: `❌ | DJ Mode is active! You must have the DJ role <@&${process.env.DJ_ROLE}> to use any music commands!`, ephemeral: true });
+        if (client.config.enableDjMode) {
+            if (!interaction.member.roles.cache.has(client.config.djRole)) return interaction.reply({ content: `❌ | DJ Mode is active! You must have the DJ role <@&${client.config.djRole}> to use any music commands!`, ephemeral: true });
         }
 
-        if (!interaction.member.voice.channelId) return await interaction.followUp({ content: "❌ | You are not in a voice channel!", ephemeral: true });
-        if (interaction.guild.members.me.voice.channelId && interaction.member.voice.channelId !== interaction.guild.members.me.voice.channelId) return await interaction.followUp({ content: "❌ | You are not in my voice channel!", ephemeral: true });
+        if (!interaction.member.voice.channelId) return await interaction.reply({ content: "❌ | You are not in a voice channel!", ephemeral: true });
+        if (interaction.guild.members.me.voice.channelId && interaction.member.voice.channelId !== interaction.guild.members.me.voice.channelId) return await interaction.reply({ content: "❌ | You are not in my voice channel!", ephemeral: true });
 
         const player = Player.singleton();
         var queue = player.nodes.get(interaction.guild.id);

commands/music/back.js

@@ -1,19 +1,19 @@
 require("dotenv").config();
 const { SlashCommandBuilder } = require("@discordjs/builders");
-const { EmbedBuilder, PermissionFlagsBits } = require("discord.js");
-const { Player, QueryType } = require('discord-player');
+const { EmbedBuilder } = require("discord.js");
+const { Player } = require('discord-player');
 
 module.exports = {
     data: new SlashCommandBuilder()
         .setName("back")
         .setDescription("Play the previous song!"),
     async execute(interaction) {
-        if (process.env.ENABLE_DJMODE == true) {
-            if (!interaction.member.roles.cache.has(process.env.DJ_ROLE)) return interaction.reply({ content: `❌ | DJ Mode is active! You must have the DJ role <@&${process.env.DJ_ROLE}> to use any music commands!`, ephemeral: true });
+        if (client.config.enableDjMode) {
+            if (!interaction.member.roles.cache.has(client.config.djRole)) return interaction.reply({ content: `❌ | DJ Mode is active! You must have the DJ role <@&${client.config.djRole}> to use any music commands!`, ephemeral: true });
         }
 
-        if (!interaction.member.voice.channelId) return await interaction.followUp({ content: "❌ | You are not in a voice channel!", ephemeral: true });
-        if (interaction.guild.members.me.voice.channelId && interaction.member.voice.channelId !== interaction.guild.members.me.voice.channelId) return await interaction.followUp({ content: "❌ | You are not in my voice channel!", ephemeral: true });
+        if (!interaction.member.voice.channelId) return await interaction.reply({ content: "❌ | You are not in a voice channel!", ephemeral: true });
+        if (interaction.guild.members.me.voice.channelId && interaction.member.voice.channelId !== interaction.guild.members.me.voice.channelId) return await interaction.reply({ content: "❌ | You are not in my voice channel!", ephemeral: true });
 
         const player = Player.singleton();
         var queue = player.nodes.get(interaction.guild.id);
@@ -27,7 +27,7 @@ module.exports = {
         .setThumbnail(interaction.guild.iconURL({dynamic: true}))
         .setColor(process.env.EMBED_COLOUR)
         .setTitle(`Playing previous song ⏮️`)
-        .setDescription(`Returning next to the previous song ${previousTracks[0].title} ([Link](${previousTracks[0].url}))!`)
+        .setDescription(`Returning next to the previous song ${previousTracks[0].title} ${previousTracks[0].queryType != 'arbitrary' ? `([Link](${previousTracks[0].url}))` : ''}!`)
         .setTimestamp()
         .setFooter({ text: `Requested by: ${interaction.user.tag}` })
 

commands/music/clearqueue.js

@@ -1,19 +1,19 @@
 require("dotenv").config();
 const { SlashCommandBuilder } = require("@discordjs/builders");
-const { EmbedBuilder, PermissionFlagsBits } = require("discord.js");
-const { Player, QueryType } = require('discord-player');
+const { EmbedBuilder } = require("discord.js");
+const { Player } = require('discord-player');
 
 module.exports = {
     data: new SlashCommandBuilder()
         .setName("clearqueue")
         .setDescription("Clear the current music queue!"),
     async execute(interaction) {
-        if (process.env.ENABLE_DJMODE == true) {
-            if (!interaction.member.roles.cache.has(process.env.DJ_ROLE)) return interaction.reply({ content: `❌ | DJ Mode is active! You must have the DJ role <@&${process.env.DJ_ROLE}> to use any music commands!`, ephemeral: true });
+        if (client.config.enableDjMode) {
+            if (!interaction.member.roles.cache.has(client.config.djRole)) return interaction.reply({ content: `❌ | DJ Mode is active! You must have the DJ role <@&${client.config.djRole}> to use any music commands!`, ephemeral: true });
         }
 
-        if (!interaction.member.voice.channelId) return await interaction.followUp({ content: "❌ | You are not in a voice channel!", ephemeral: true });
-        if (interaction.guild.members.me.voice.channelId && interaction.member.voice.channelId !== interaction.guild.members.me.voice.channelId) return await interaction.followUp({ content: "❌ | You are not in my voice channel!", ephemeral: true });
+        if (!interaction.member.voice.channelId) return await interaction.reply({ content: "❌ | You are not in a voice channel!", ephemeral: true });
+        if (interaction.guild.members.me.voice.channelId && interaction.member.voice.channelId !== interaction.guild.members.me.voice.channelId) return await interaction.reply({ content: "❌ | You are not in my voice channel!", ephemeral: true });
 
         const player = Player.singleton();
         var queue = player.nodes.get(interaction.guild.id);

commands/music/jumpqueue.js

@@ -1,7 +1,7 @@
 require("dotenv").config();
 const { SlashCommandBuilder } = require("@discordjs/builders");
-const { EmbedBuilder, PermissionFlagsBits } = require("discord.js");
-const { Player, QueryType } = require('discord-player');
+const { EmbedBuilder } = require("discord.js");
+const { Player } = require('discord-player');
 
 module.exports = {
     data: new SlashCommandBuilder()
@@ -13,12 +13,12 @@ module.exports = {
             .setRequired(true)
         ),
     async execute(interaction) {
-        if (process.env.ENABLE_DJMODE == true) {
-            if (!interaction.member.roles.cache.has(process.env.DJ_ROLE)) return interaction.reply({ content: `❌ | DJ Mode is active! You must have the DJ role <@&${process.env.DJ_ROLE}> to use any music commands!`, ephemeral: true });
+        if (client.config.enableDjMode) {
+            if (!interaction.member.roles.cache.has(client.config.djRole)) return interaction.reply({ content: `❌ | DJ Mode is active! You must have the DJ role <@&${client.config.djRole}> to use any music commands!`, ephemeral: true });
         }
 
-        if (!interaction.member.voice.channelId) return await interaction.followUp({ content: "❌ | You are not in a voice channel!", ephemeral: true });
-        if (interaction.guild.members.me.voice.channelId && interaction.member.voice.channelId !== interaction.guild.members.me.voice.channelId) return await interaction.followUp({ content: "❌ | You are not in my voice channel!", ephemeral: true });
+        if (!interaction.member.voice.channelId) return await interaction.reply({ content: "❌ | You are not in a voice channel!", ephemeral: true });
+        if (interaction.guild.members.me.voice.channelId && interaction.member.voice.channelId !== interaction.guild.members.me.voice.channelId) return await interaction.reply({ content: "❌ | You are not in my voice channel!", ephemeral: true });
 
         const player = Player.singleton();
         var queue = player.nodes.get(interaction.guild.id);
@@ -33,7 +33,7 @@ module.exports = {
         .setThumbnail(interaction.guild.iconURL({dynamic: true}))
         .setColor(process.env.EMBED_COLOUR)
         .setTitle(`Jumped to song ⏭️`)
-        .setDescription(`Now playing: ${queuedTracks[trackIndex].title} ([Link](${queuedTracks[trackIndex].url}))!`)
+        .setDescription(`Now playing: ${queuedTracks[trackIndex].title} ${queuedTracks[trackIndex].queryType != 'arbitrary' ? `([Link](${queuedTracks[trackIndex].url}))` : ''}!`)
         .setTimestamp()
         .setFooter({ text: `Requested by: ${interaction.user.tag}` })