Merge branch 'master' into master
This commit is contained in:
49
README.md
49
README.md
@@ -8,38 +8,38 @@ If you need help with this project, to get support faster you can join the help
|
||||
### ⚡ Installation
|
||||
|
||||
Well, let's start by downloading the code.
|
||||
Go to the folder `config` then the file `config.json`.
|
||||
Go to the folder `config` then the file `bot.js`.
|
||||
For the bot to be able to start, please complete the file with your credentials as follows :
|
||||
|
||||
- For emojis
|
||||
|
||||
```js
|
||||
{
|
||||
"game": "GAME",
|
||||
"prefix": "PREFIX",
|
||||
"token_bot": "TOKEN"
|
||||
emojis: {
|
||||
off: ':x:',
|
||||
error: ':warning:',
|
||||
queue: ':bar_chart:',
|
||||
music: ':musical_note:',
|
||||
success: ':white_check_mark:',
|
||||
}
|
||||
```
|
||||
|
||||
Reminder :
|
||||
- For configuration
|
||||
|
||||
- `game`, the status of the bot.
|
||||
```js
|
||||
discord: {
|
||||
token: 'TOKEN',
|
||||
prefix: 'PREFIX',
|
||||
activity: 'ACTIVITY',
|
||||
}
|
||||
```
|
||||
|
||||
- `token`, the token of the bot available on the [Discord Developers](https://discordapp.com/developers/applications) section.
|
||||
- `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:"
|
||||
}
|
||||
```
|
||||
- `activity`, the activity of the bot.
|
||||
|
||||
In the console, type `npm install` to install all dependencies.
|
||||
|
||||
To start the bot :
|
||||
- To start the bot :
|
||||
|
||||
```
|
||||
#With Node
|
||||
@@ -55,11 +55,12 @@ All you have to do is turn on your bot !
|
||||
### 🎵 Music commands
|
||||
|
||||
```
|
||||
play <name>, play music in a voice channel.
|
||||
play <name/URL>, play music in a voice channel.
|
||||
search <name>, open a panel to choose a music and then play it.
|
||||
pause, pause the current music.
|
||||
resume, puts the current music back on.
|
||||
queue, see the next songs.
|
||||
clear-queue, delete the next music.
|
||||
clear-queue, remove music in the queue.
|
||||
shuffle, to mix the queue.
|
||||
nowplaying, see music in progress.
|
||||
loop, to enable or disable the repeat function.
|
||||
@@ -82,4 +83,4 @@ debug, see number of voice connections.
|
||||
|
||||
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).
|
||||
This is used with [discord.js](https://www.npmjs.com/package/discord.js) and [discord-player](https://www.npmjs.com/package/discord-player).
|
||||
Reference in New Issue
Block a user