This repository has been archived on 2026-03-28. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
legacy-musicbot/README.md
2020-12-27 11:49:26 +01:00

86 lines
2.2 KiB
Markdown

# Music-bot
A complete code to download for a music bot. Using a module (discord-player) 🎧
Looking for a code for a music bot ? This fully open source code is made for your project !
If you need help with this project, to get support faster you can join the help server by just clicking [here](https://discord.gg/5cGSYV8ZZj).
### ⚡ Installation
Well, let's start by downloading the code.
Go to the folder `config` then the file `config.json`.
For the bot to be able to start, please complete the file with your credentials as follows :
```js
{
"game": "GAME",
"prefix": "PREFIX",
"token_bot": "TOKEN"
}
```
Reminder :
- `game`, the status of the bot.
- `prefix`, the prefix that will be set to use the bot.
- `token_bot`, the token of the bot available on the [Discord Developers](https://discordapp.com/developers/applications) section.
To customize the emojis go to the file `emojis.json`.
Emojis are already defined by default but you can modify them if you wish.
```js
{
"music": ":musical_note:",
"queue": ":bar_chart:",
"error": ":x:",
"success": ":white_check_mark:"
}
```
In the console, type `npm install` to install all dependencies.
To start the bot :
```
#With Node
node index.js
npm start #Indicated in package.json
#With pm2
pm2 start index.js --name "MusicBot"
```
All you have to do is turn on your bot !
### 🎵 Music commands
```
play <name>, play music in a voice channel.
pause, pause the current music.
resume, puts the current music back on.
queue, see the next songs.
clear-queue, delete the next music.
shuffle, to mix the queue.
nowplaying, see music in progress.
loop, to enable or disable the repeat function.
volume <1 - 100>, change the volume.
skip, skip to next music.
stop, stop all music.
filter <filter>, add / remove filter.
w-filters, see filters.
```
### 💡 General commands
```
ping, see the bot latency.
help, see the list of available commands.
debug, see number of voice connections.
```
### 🏓 Utilities (to change the code)
Find all the functions available on the official code [right here](https://github.com/Androz2091/discord-player).
This is used with [discord.js](https://www.npmjs.com/package/discord.js) and [discord-player](https://www.npmjs.com/package/discord-player).