Update README.md

This commit is contained in:
2025-12-13 19:15:03 +00:00
parent eb0eb2d022
commit 484d7e59e9

View File

@@ -2,12 +2,26 @@
Experimental music bot for xmpp similar to discord music bots Experimental music bot for xmpp similar to discord music bots
# Features
- Calling the bot over any xmpp client supporting WebRTC calls
- Shuffle playlist
- Queue system
- Add new songs from links yt-dlp supports
- Search for songs
- Radio relaying (copies m3u8 or mp3 streams of real radios)
# How to install # How to install
I do not remember most details about dependencies but I will try to make an install guide. I do not remember most details about dependencies but I will try to make an install guide.
## Dependencies ## Dependencies
The bot highly relies on the ffmpeg binary for audio. Also having an up to date version of yt-dlp helps a lot.. The bot highly relies on the ffmpeg binary for audio. Also having an up to date version of yt-dlp helps a lot.
## Installation ## Installation
Clone the projects or just copy the scripts over. Clone the projects or just copy the scripts over.
@@ -40,14 +54,14 @@ Take a look at file named `config.ini` in the bot folder. Edit it (every config
## Run the Bot ## Run the Bot
### Manual Start ## Manual Start
```bash ```bash
# Ensure you are in your python environment # Ensure you are in your python environment
python3 xmpp_radio_bot.py python3 xmpp_radio_bot.py
``` ```
## Usage ## Usage
The bot mostly uses **OMEMO encrypted messages**. You may need to "Trust" the bot's fingerprint in your client (Gajim/Conversations/Dino) for commands to work if encryption is active. Plaintext works too but I do not check it mostly since OMEMO is good anyways. The bot mostly uses OMEMO encrypted messages. You may need to "Trust" the bot's fingerprint in your client (Gajim/Conversations/Dino) for commands to work if encryption is active. Plaintext works too but I do not check it mostly since OMEMO is good anyways.
Inside the DMs with the bot (or inside the bot control muc configured) type "!help" to see how can the bot used.