-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9b2ec3b
commit 96269ab
Showing
1 changed file
with
48 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,56 @@ | ||
| # Elite-Bot-Music | ||
| # Elite Music | ||
| Elite Music is a feature-packed Discord Music Bot built on top of discord.js & using the latest discord-player package. | ||
|
|
||
| This is an old Music Bot that I worked on, which was under development for my Elite Bot verified public bot... until crackdown of music functionality by Discord over the past year :/ | ||
| ## Features | ||
| - Wide range of commands | ||
| - Easy to setup and edit | ||
| - Slash commands (djs v14) | ||
| - Support for various streaming platforms | ||
| - Wide range of audio filters | ||
| - Awesome playback UI | ||
| - And much more! | ||
|
|
||
| I will probably update this with Discord-Player 6.1.1 at some point soon:tm: and make it much better because this code is very shitty as it was rushed and then wasted as Discord disliked music on EB... so it's kinda been lying here totally useless for ages 💤 | ||
| 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. | ||
|
|
||
| Anyways whilst you are here feel free to check out Elite Bot! | ||
| # 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 v17.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. Head over to the [FFmpeg Download website](https://ffmpeg.org/download.html), select your OS and download the appropriate package. Alternatively, you can use `npm I ffmpeg-static` when setting up the bot to use the binaries, although this is **NOT** recommended. | ||
|
|
||
| - [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. | ||
|
|
||
| ## 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. | ||
|
|
||
| #### 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. | ||
|
|
||
| #### Download using Git | ||
| An alternative way to download the repository is through the usage of [Git](https://git-scm.com/). If you do not have Git installed, please use the basic download method. Git users can run the command `git clone https://github.com/ThatGuyJacobee/Elite-Bot-Music/tree/main` to automatically clone the repository to a new folder. | ||
|
|
||
| #### 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. | ||
| 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. | ||
|
|
||
| ## 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. | ||
|
|
||
| ## 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! | ||
|
|
||
| Check the bot out via the dedicated documentation website or top.gg today! 🚀 | ||
| - https://elite-bot.com | ||
| - https://top.gg/bot/723275350922100840 | ||
|
|
||
| --- | ||
| # License | ||
| ## License | ||
| [Apache © ThatGuyJacobee](./LICENSE.md) |