73 lines
2.1 KiB
Markdown
73 lines
2.1 KiB
Markdown
<img align="left" style="width:128px" src="https://github.com/gractwo/assets/blob/master/logo.svg" />
|
|
|
|
# gractwo/legacy-musicbot
|
|
|
|
The software in this repository is a derivative of ZerioDev's [Music-bot](https://github.com/ZerioDev/Music-bot) codebase adjusted to our needs.
|
|
|
|
As per GPL v3.0, we state that changes to the codebase can be most easily found by checking the repo's commit history - these are mostly small adjustments the original codebase's author expected.
|
|
|
|
---
|
|
|
|
---
|
|
|
|
### ⚡ Configuration
|
|
|
|
Open the configuration file located in the main folder `config.js`.
|
|
|
|
```js
|
|
module.exports = {
|
|
app: {
|
|
px: 'XXX',
|
|
token: 'XXX',
|
|
playing: 'by Zerio ❤️'
|
|
},
|
|
|
|
opt: {
|
|
DJ: {
|
|
enabled: false,
|
|
roleName: 'XXX',
|
|
commands: []
|
|
},
|
|
maxVol: 100,
|
|
loopMessage: false,
|
|
discordPlayer: {}
|
|
}
|
|
};
|
|
```
|
|
|
|
Basic configuration
|
|
|
|
- `app/px`, the prefix that will be set to use the bot
|
|
- `app/token`, the token of the bot available on the [Discord Developers](https://discordapp.com/developers/applications) section
|
|
- `app/playing`, the activity of the bot
|
|
|
|
DJ mode configuration
|
|
|
|
- `opt/DJ/enabled`, whether the DJ mode should be activated or not
|
|
- `opt/DJ/roleName`, the name of the DJ role to be used
|
|
- `opt/DJ/commands`, the list of commands limited to members with the DJ role
|
|
|
|
Advanced configuration
|
|
|
|
- `opt/maxVol`, the maximum volume that users can define
|
|
- `opt/loopMessage`, if the message that a music is played should be sent when it is looped
|
|
- `opt/discordPlayer`, options used by discord-player
|
|
|
|
### 📑 Installation
|
|
|
|
To use the project correctly you will need some tools.
|
|
|
|
[FFmpeg](https://www.ffmpeg.org) to process audio
|
|
|
|
[Node JS](https://nodejs.org/en/) (v16) for environment
|
|
|
|
Without forgetting of course the code editor ^^
|
|
|
|
Realized with ❤️ by [ZerioDev](https://github.com/ZerioDev).
|
|
|
|
Please do not withdraw the license and keep the credits on this project.
|
|
|
|
To have full access to the project and to be able to withdraw the credits a small donation is accepted.
|
|
|
|
Fuckup count: 1
|