From 484d7e59e999eab58a6eb0fc59753158e37c896f Mon Sep 17 00:00:00 2001 From: just n Date: Sat, 13 Dec 2025 19:15:03 +0000 Subject: [PATCH] Update README.md --- README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6a8bdcf..2ee61a1 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,26 @@ 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 I do not remember most details about dependencies but I will try to make an install guide. ## 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 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 -### Manual Start +## Manual Start ```bash # Ensure you are in your python environment python3 xmpp_radio_bot.py ``` - - ## 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. \ No newline at end of file +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. \ No newline at end of file