Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zeriodev/music-bot

A complete code to download for a cool Discord music bot !
https://github.com/zeriodev/music-bot

discord discord-bot discord-js ffmpeg music nodejs

Last synced: about 9 hours ago
JSON representation

A complete code to download for a cool Discord music bot !

Host: GitHub
URL: https://github.com/zeriodev/music-bot
Owner: ZerioDev
License: gpl-3.0
Created: 2020-02-01T19:37:17.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-08-03T17:48:31.000Z (about 2 months ago)
Last Synced: 2024-09-24T11:03:13.164Z (about 13 hours ago)
Topics: discord, discord-bot, discord-js, ffmpeg, music, nodejs
Language: JavaScript
Homepage: https://discord.gg/5cGSYV8ZZj
Size: 382 KB
Stars: 879
Watchers: 32
Forks: 1,073
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Music-bot

A complete code to download for a music bot 🎧

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).

*If you don't have any development knowledge, it is recommended to join the Discord support server to get help.*

### ⚡ Configuration

Important!!! In order to work you need to rename `.env.example` to `.env`

Open the configuration file located in the main folder `config.js`.

```js

const process = require('process');

module.exports = {

    app: {

        token: process.env.DISCORD_TOKEN || 'xxx',

        playing: 'by the Community ❤️',

        global: true,

        guild: process.env.GUILD_ID || 'xxx',

        extraMessages: false,

        loopMessage: false,

        lang: 'en',

        enableEmojis: false,

    },

    emojis:{

        'back': '⏪',

        'skip': '⏩',

        'ResumePause': '⏯️',

        'savetrack': '💾',

        'volumeUp': '🔊',

        'volumeDown': '🔉',

        'loop': '🔁',

    },

    opt: {

        DJ: {

            enabled: false,

            roleName: '',

            commands: []

        },

        Translate_Timeout: 10000,

        maxVol: 100,

        spotifyBridge: true,

        volume: 75,

        leaveOnEmpty: true,

        leaveOnEmptyCooldown: 30000,

        leaveOnEnd: true,

        leaveOnEndCooldown: 30000,

        discordPlayer: {

            ytdlOptions: {

                quality: 'highestaudio',

                highWaterMark: 1 << 25

            }

        }

    }

};

```

Basic configuration

- `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

- `app/global`, whether the commands will work on all servers or just one (if global they might take up to an hour to show up)

- `app/guild`, the guild the slash command will be loaded to (this only applies if global is set to false)

- `app/extraMessages` will increase the amount of bot spam, while you get more infomation (not recommended) 

- `app/lang` will change the bot client language [__**See below for supported language codes**__]

- `app/Translate_Timeout` will set the time limit the bot has to create the translation succesfully. If the time is out, only the original english version will be printed. Set to `none` if you want to disable it (No Timeout). 

- `app/enableEmojis` will change the player buttons with emojis if set to true. `false` will replace them by basic english words

- `opt/loopMessage`, if the message that a music is played should be sent when it is looped

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 (only change if you know what you are doing)

- `opt/maxVol`, the maximum volume that users can define

- `opt/spotifyBridge`, takes spotify songs/playlists and searches it on youtube and plays it (highly recommended)

- `opt/volume`, is the defaul volume the queue will start at

- `opt/leaveOnEmpty`, if the bot will leave when the queue is empty

- `opt/leaveOnEmptyCooldown`, the cooldown before the bot leaves when the queue is empty

- `opt/leaveOnEnd`,  if the bot will leave on finishing the queue

- `opt/leaveOnEndCooldown`, the cooldown before the bot leaves on finishing the queue

- `opt/discordPlayer`, options used by discord-player

### 📑 Installation

To use the project correctly you will need some tools.

WARNING: You MUST use Node.js version `v18.20.2`, otherwise, you will encounter major compatibility issues.

[FFmpeg](https://www.ffmpeg.org) to process audio

[Node JS](https://nodejs.org/en/) (`v18.20.2`) for environment

[yarn](https://yarnpkg.com/getting-started/usage) for package management

Without forgetting of course the code editor, we recommend [visual studio code](https://code.visualstudio.com/) 

Now in your terminal run the following commands assuming you are in the same directory as the project.

`yarn install` (or `npm install` **not recommended** as it might not work)

`node .` (or `node main.js`)

and Done, your bot should be running!

Realized with ❤️ by the Community.

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.

### ❗supported languages: 

| Code | Language | Code | Language | Code | Language |

| ---- | -------- | ---- | -------- | ---- | -------- |

| `af` | Afrikaans | `bn` | Bengali | `da` | Danish |

| `sq` | Albanian | `bg` | Bulgarian | `nl` | Dutch |

| `ar` | Arabic | `ca` | Catalan | `en` | English |

| `hy` | Armenian | `hr` | Croatian | `et` | Estonian |

| `eu` | Basque | `cs` | Czech | `fi` | Finnish |

| `be` | Belarusian | `cy` | Welsh | `fr` | French |

| `bs` | Bosnian | `de` | German | `ga` | Irish |

| `ja` | Japanese | `jv` | Javanese | `ka` | Georgian |

| `kn` | Kannada | `kk` | Kazakh | `km` | Khmer |

| `ko` | Korean | `ku` | Kurdish | `ky` | Kyrgyz |

| `la` | Latin | `lb` | Luxembourgish | `lo` | Lao |

| `lt` | Lithuanian | `lv` | Latvian | `mg` | Malagasy |

| `mi` | Maori | `mk` | Macedonian | `ml` | Malayalam |

| `mn` | Mongolian | `mr` | Marathi | `ms` | Malay |

| `mt` | Maltese | `my` | Burmese | `ne` | Nepali |

| `no` | Norwegian | `ny` | Chichewa | `pa` | Punjabi |

| `pl` | Polish | `ps` | Pashto | `pt` | Portuguese |

| `ro` | Romanian | `ru` | Russian | `sd` | Sindhi |

| `si` | Sinhalese | `sk` | Slovak | `sl` | Slovenian |

| `sm` | Samoan | `sn` | Shona | `so` | Somali |

| `sq` | Albanian | `sr` | Serbian | `st` | Sesotho |

| `su` | Sundanese | `sv` | Swedish | `sw` | Swahili |

| `ta` | Tamil | `te` | Telugu | `th` | Thai |

| `tr` | Turkish | `uk` | Ukrainian | `ur` | Urdu |

| `vi` | Vietnamese | `xh` | Xhosa | `yi` | Yiddish |

| `zu` | Zulu | `id` | Indonesian | | |

### 📝 ToDo 

-  [ ] Vote to skip command https://github.com/ZerioDev/Music-bot/issues/187