Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eritislami/evobot
🤖 EvoBot is a Discord Music Bot built with TypeScript + Discord.js, includes Docker builds & localization in 20+ languages
https://github.com/eritislami/evobot
command-handler discord discord-bot discord-js discord-music-bot discordjs docker typescript
Last synced: 4 days ago
JSON representation
🤖 EvoBot is a Discord Music Bot built with TypeScript + Discord.js, includes Docker builds & localization in 20+ languages
- Host: GitHub
- URL: https://github.com/eritislami/evobot
- Owner: eritislami
- License: mit
- Created: 2019-05-15T14:19:37.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-05T04:46:25.000Z (4 months ago)
- Last Synced: 2024-12-31T13:07:13.503Z (11 days ago)
- Topics: command-handler, discord, discord-bot, discord-js, discord-music-bot, discordjs, docker, typescript
- Language: TypeScript
- Homepage:
- Size: 1.28 MB
- Stars: 1,854
- Watchers: 54
- Forks: 2,010
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - eritislami/evobot - 🤖 EvoBot is a Discord Music Bot built with TypeScript + Discord.js, includes Docker builds & localization in 20+ languages (TypeScript)
- awesome-discord - Evobot
- awesome-discord - Evobot
README
[](http://commitizen.github.io/cz-cli/)
# 🤖 EvoBot (Discord Music Bot)
> EvoBot is a Discord Music Bot built with TypeScript, discord.js & uses Command Handler from [discordjs.guide](https://discordjs.guide)
## Requirements
1. Discord Bot Token **[Guide](https://discordjs.guide/preparations/setting-up-a-bot-application.html#creating-your-bot)**
1.1. Enable 'Message Content Intent' in Discord Developer Portal
2. Node.js 16.11.0 or newer
## 🚀 Getting Started
```sh
git clone https://github.com/eritislami/evobot.git
cd evobot
npm install
```
After installation finishes follow configuration instructions then run `npm run start` to start the bot.
## ⚙️ Configuration
Copy or Rename `config.json.example` to `config.json` and fill out the values:
⚠️ **Note: Never commit or share your token or api keys publicly** ⚠️
```json
{
"TOKEN": "",
"MAX_PLAYLIST_SIZE": 10,
"PRUNING": false,
"LOCALE": "en",
"DEFAULT_VOLUME": 100,
"STAY_TIME": 30
}
```
## 🐬 Docker Configuration
For those who would prefer to use our [Docker container](https://hub.docker.com/repository/docker/eritislami/evobot), you may provide values from `config.json` as environment variables.
```shell
docker run -e "TOKEN=" eritislami/evobot
```
## 📝 Features & Commands
- 🎶 Play music from YouTube via url
`/play https://www.youtube.com/watch?v=GLvohMXgcBo`
- 🔎 Play music from YouTube via search query
`/play under the bridge red hot chili peppers`
- 🔎 Search and select music to play
`/search Pearl Jam`
- 📃 Play youtube playlists via url
`/playlist https://www.youtube.com/watch?v=YlUKcNNmywk&list=PL5RNCwK3GIO13SR_o57bGJCEmqFAwq82c`
- 🔎 Play youtube playlists via search query
`/playlist linkin park meteora`
- Now Playing (/nowplaying)
- Queue system (/queue)
- Loop / Repeat (/loop)
- Shuffle (/shuffle)
- Volume control (/volume)
- Lyrics (/lyrics)
- Pause (/pause)
- Resume (/resume)
- Skip (/skip)
- Skip to song # in queue (/skipto)
- Move a song in the queue (/move)
- Remove song # from queue (/remove)
- Show ping to Discord API (/ping)
- Show bot uptime (/uptime)
- Toggle pruning of bot messages (/pruning)
- Help (/help)
- Command Handler from [discordjs.guide](https://discordjs.guide/)
- Media Controls via Buttons
## 🌎 Locales
Currently available locales are:
- English (en)
- Arabic (ar)
- Brazilian Portuguese (pt_br)
- Bulgarian (bg)
- Romanian (ro)
- Czech (cs)
- Dutch (nl)
- French (fr)
- German (de)
- Greek (el)
- Indonesian (id)
- Italian (it)
- Japanese (ja)
- Korean (ko)
- Minionese (mi)
- Persian (fa)
- Polish (pl)
- Russian (ru)
- Simplified Chinese (zh_cn)
- Singaporean Mandarin (zh_sg)
- Spanish (es)
- Swedish (sv)
- Traditional Chinese (zh_tw)
- Thai (th)
- Turkish (tr)
- Ukrainian (uk)
- Vietnamese (vi)
- Check [Contributing](#-contributing) if you wish to help add more languages!
- For languages please use [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) two letter format
## 🤝 Contributing
1. [Fork the repository](https://github.com/eritislami/evobot/fork)
2. Clone your fork: `git clone https://github.com/your-username/evobot.git`
3. Create your feature branch: `git checkout -b my-new-feature`
4. Stage changes `git add .`
5. Commit your changes: `cz` OR `npm run commit` do not use `git commit`
6. Push to the branch: `git push origin my-new-feature`
7. Submit a pull request