Update README.md
This commit is contained in:
52
README.md
52
README.md
@@ -2,9 +2,25 @@
|
|||||||
|
|
||||||
Experimental music bot for xmpp similar to discord music bots
|
Experimental music bot for xmpp similar to discord music bots
|
||||||
|
|
||||||
|
# Working Status
|
||||||
|
|
||||||
|
- Conversations: Works
|
||||||
|
|
||||||
|
- Cheogram: Likely to work
|
||||||
|
|
||||||
|
- Monocles chat: Works
|
||||||
|
|
||||||
|
- Monal: Works
|
||||||
|
|
||||||
|
- Dino: Does not work
|
||||||
|
|
||||||
|
- Movim: Works but sometimes buggy (?)
|
||||||
|
|
||||||
|
- Siskin: Did not tested yet
|
||||||
|
|
||||||
# Features
|
# Features
|
||||||
|
|
||||||
- Calling the bot over any xmpp client supporting WebRTC calls
|
- Calling the bot over any xmpp clients supporting calls
|
||||||
|
|
||||||
- Shuffle playlist
|
- Shuffle playlist
|
||||||
|
|
||||||
@@ -18,7 +34,29 @@ Experimental music bot for xmpp similar to discord music bots
|
|||||||
|
|
||||||
# TODO
|
# TODO
|
||||||
|
|
||||||
# List future ideas and bugs to fix here
|
- Fix a bug where if bandwith is exhausted song switches without any command
|
||||||
|
|
||||||
|
- Change the User Agent of bot to a less suspicious one
|
||||||
|
|
||||||
|
- Fix the memory management
|
||||||
|
|
||||||
|
- Add Dino call support
|
||||||
|
|
||||||
|
- Test Movim more extensively
|
||||||
|
|
||||||
|
- Add non-YT search options without the need to copy paste links
|
||||||
|
|
||||||
|
- Add Alastor references
|
||||||
|
|
||||||
|
- Allow to prefer low latency over quality
|
||||||
|
|
||||||
|
- Test IPv6 streaming support
|
||||||
|
|
||||||
|
- Extend search results to 10-15 instead of 5
|
||||||
|
|
||||||
|
- Option to search locally instead of playing the song
|
||||||
|
|
||||||
|
- Try if video calls have sound and blank visuals as a bug
|
||||||
|
|
||||||
# How to install
|
# How to install
|
||||||
|
|
||||||
@@ -68,4 +106,12 @@ python3 xmpp_radio_bot.py -c config.ini
|
|||||||
|
|
||||||
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.
|
Inside the DMs with the bot (or inside the bot control muc configured) type "!help" to see how can the bot used.
|
||||||
|
|
||||||
|
# Changelog
|
||||||
|
|
||||||
|
- v0.1 Absolute Solver
|
||||||
|
Main testing version
|
||||||
|
|
||||||
|
- v0.2 Branded Pens!
|
||||||
|
Future version
|
||||||
Reference in New Issue
Block a user