Skip to content

Latest commit

 

History

History
102 lines (78 loc) · 6.1 KB

README.md

File metadata and controls

102 lines (78 loc) · 6.1 KB
Raw

Harmonoid Music Bot

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

Website

💜 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 -p Plays or adds a track to queue from YouTube Music.
-playYT -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 -j Jumps to specific track in the queue based on its position.
-delete -d Removes track from the queue from the given position.
-clear -c Clears the queue.

🧰 Utility Commands

Command Aliases Action
-lyrics -l Shows lyrics of a track.
-lyricsSend -ls Sends lyrics of a track in a TXT file.
-changeChannel -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:

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

⭐ Acknowledgements