harmonoid-music-bot

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

harmonoid-music-bot

★ 10 Open GitHub ↗

🎵 Music bot for Discord. Supports lyrics, queues & plays using both YT Music & YouTube.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align='center'><a href='https://github.com/harmonoid/harmonoid-music-bot'>Harmonoid Music Bot</a></h1>
<h4 align='center'>🎵 Music bot for Discord. Supports lyrics, queues & plays using both YT Music & YouTube.</h4>
<p align='center'><a href='https://harmonoid.github.io/harmonoid-music-bot'>Website</a></p>

## 💜 Support

You may open a issue, and we will be happy to assist.

## 🎵 Invite

You have to self-deploy it - instructions down bellow.

## 🎹 Commands

### 🎵 Playback Commands

| Command                     | Aliases  | Action                                                                                    |
|-----------------------------|----------|-------------------------------------------------------------------------------------------|
| -play   <song name or link> | -p       | Plays or adds a track to queue from YouTube Music.                                        |
| -playYT <song name or link> | -py      | Plays or adds a track to queue from YouTube.                                              |
| -pause                      |          | Pauses playback.                                                                          |
| -resume                     |          | Resumes playback.                                                                         |
| -togglePlayback             | -pp      | Switches between pause & play states.                                                     |

### 📑 Queue Commands

| Command                 | Aliases  | Action                                                                                    |
|-------------------------|----------|-------------------------------------------------------------------------------------------|
| -queue                  | -q       | Displays the current queue.                                                               |
| -next                   | -n       | Jumps to next track in the queue.                                                         |
| -back                   | -b       | Jumps to previous track in the queue.                                                     |
| -jump   <position>      | -j       | Jumps to specific track in the queue based on its position.                               |
| -delete <position>      | -d       | Removes track from the queue from the given position.                                     |
| -clear                  | -c       | Clears the queue.                                                                         |
  
### 🧰 Utility Commands

| Command                             | Aliases  | Action                                                                                    |
|-------------------------------------|----------|-------------------------------------------------------------------------------------------|
| -lyrics     <song name>             | -l       | Shows lyrics of a track.                                                                  |
| -lyricsSend <song name>             | -ls      | Sends lyrics of a track in a TXT file.                                                    |
| -changeChannel <voice channel name> | -cc      | Changes voice channel where music should be played.                                       |

### 📖 Other Commands

| Command                             | Aliases  | Action                                                                                    |
|-------------------------------------|----------|-------------------------------------------------------------------------------------------|
| -status                             | -s       | Displays bot's statistics.                                                                |
| -about                              | -a       | Displays information about bot.                                                           |

## 🔐 Deploy Personally

You can deploy this bot on Heroku or on a self hosted machine.

### Personal deployment
Docker is recommended for personal deployment.

#### Docker (self-hosted machine)
If you have Docker installed, you can enter following commands:
```bash
sudo docker pull ghcr.io/mytja/harmonoid-music-bot:latest
sudo docker run -d -e DISCORD_TOKEN=<your discord bot token> ghcr.io/mytja/harmonoid-music-bot
```
You can view your running machines using `sudo docker ps`

Afterwards, you can see logs using `sudo docker logs <your docker container id>`.
Docker container ID can be obtained using `sudo docker ps`

#### Self-deploy on Ubuntu/Debian based distros
1. Get repository `git clone https://github.com/mytja/harmonoid-music-bot`
2. Change directory `cd harmonoid-music-bot`
3. Install Python dependencies `python3 -m pip install -r requirements.txt`
4. Install ffmpeg `sudo apt install ffmpeg`
5. Export environment variable `export DISCORD_TOKEN=<your discord bot token>`
6. Run a program `python3 main.py`

### Deploying to Heroku
- Create an account on Heroku if you don't have it yet
- Create an app
- Create a fork of our repo on GitHub & Deploy it on Heroku
- Get a Discord Bot Token from Discord
- Add a secret key called DISCORD_TOKEN with value of a discord token, you got earlier, to Heroku app
- Flip a toggle switch on main page of your app

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

## ⭐ Acknowledgements
- [sigmatics](https://github.com/sigma67) for [ytmusicapi](https://github.com/sigma67/ytmusicapi)
- [PyTube](https://github.com/pytube) for [PyTube](https://github.com/pytube/pytube)
- [Tin Tvrtković](https://github.com/Tinche) for [aiofiles](https://github.com/Tinche/aiofiles)
- [alexmercerind](https://github.com/alexmercerind) for [youtube-search-python](https://github.com/alexmercerind/youtube-search-python)
- [Danny](https://github.com/Rapptz) for [discord.py](https://github.com/Rapptz/discord.py)

harmonoid-music-bot

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README