Skip to content

Latest commit

 

History

History
174 lines (113 loc) · 4.39 KB

README.md

File metadata and controls

174 lines (113 loc) · 4.39 KB
Raw

🎶 Real Music Bot 2.1 🎶

Control your speakers with Telegram and play music from YouTube Music

What is it?

If you've ever used Discord, you've probably heard of music bots that play music for you. All you had to do was just type "-p <track_name>" to listen to your favorite song. I also liked it, so I made the real one!
This script works as a service and allows you to play music on speakers from YouTube Music and control playback using Telegram. It uses an awesome MPV media player as a backend.

To be clear, this is not a regular music bot. It plays music directly on the connected speakers, not in voice chat or audio messages.

Features

  • Search for music simply by sending a title...

Screenshot

  • ...or link to a YouTube video

Screenshot

  • Use the search provided by @vid bot

Screenshot

  • Fully working queue

Screenshot

  • Turn on your favorite radio

Screenshot

  • Search for song lyrics

Screenshot

  • Protect the bot from unauthorized users

Screenshot

List of available commands:

  • /s - Skip the currently playing song
  • /stop - Stop playback and clear the queue
  • /q - Show current queue
  • /p - Pause playback
  • /v - Show current volume
  • /v +10 - Change current volume
  • /v 50 - Set volume
  • /r - Search for radio
  • /l - Search for lyrics

Installation

Make sure you have Python 3.7+ installed

1. Install packages

Linux
$ sudo apt install mpv
$ pip3 install https://github.com/raitonoberu/realmusicbot/archive/master.zip
Windows
pip install https://github.com/raitonoberu/realmusicbot/archive/master.zip

2. Change settings

Before running, you must configure your bot by editing the file ~/.config/realmusicbot.ini:

Linux
$ nano ~/.config/realmusicbot.ini
Windows
notepad %USERPROFILE%\.config\realmusicbot.ini

2.1 Set your bot token

How do I create a bot?

TOKEN=yourtoken

2.2 Configure additional features (optional)

# Whether to process messages simultaneously
THREADED=true

# Select YouTube ITAG code
# - 251 is the highest quality
# - More here: https://gist.github.com/sidneys/7095afe4da4ae58694d128b1034e01e2
ITAG=251

# Bot privatization (HIGHLY RECOMMENDED)
# - Get your User ID using tg @userinfobot and add it to the list
# - https://t.me/userinfobot
# - If you leave it empty, everyone can use the bot
# - example: 123456789,987641234
ALLOWED_IDS=

3. Run your bot

There are two ways to run Real Music Bot. It's recommended to run it in a terminal first to make sure that it works.

3.1 Running in a terminal

$ realmusicbot

Press Ctrl+C to close.

3.2 Running as a service (Linux only)

$ systemctl --user start realmusicbot
$ systemctl --user enable realmusicbot

Check logs:

$ journalctl | grep realmusicbot

Uninstallation

Linux
$ systemctl --user stop realmusicbot
$ systemctl --user disable realmusicbot
$ sudo rm ~/.config/systemd/user/realmusicbot.service
$ sudo rm -r ~/.config/realmusicbot.ini
$ pip3 uninstall realmusicbot
Windows
where realmusicbot | python -c "import os;os.remove(os.path.dirname(input())+r'\mpv-2.dll')"
del /f "%USERPROFILE%\.config\realmusicbot.ini"
pip uninstall realmusicbot

License

GPLv3, see LICENSE for additional info.

TODO

  • Localization
  • Passing params to MPV