matrix-music-bot

A matrix / synapse chatbot written in Python.
git clone git://johnkubach.com:/srv/git/matrix-music-bot
Log | Files | Refs | README

README.md (858B)

      1 # Music Bot For Element Chat
      2 
      3 This bot grabs the title and any artist info from a youtube url.
      4 
      5 ## How to Run
      6 
      7 `python3 music.py`
      8 
      9 or
     10 
     11 `./music.py`
     12 
     13 ## Usage
     14 
     15 Once connected to a room, the bot will respond to a message that begins with either
     16 
     17 1. A youtube url.
     18 2. !song [query]
     19 
     20 if !song is used, music-bot will fetch the first youtube video relevant the the query. It is best to make the query descriptive, such as artist - title.
     21 
     22 ## Requirements
     23 
     24 All of the fields in config.ini must be populated in order to use the bot. To
     25 generate a last.fm api key, [look here](https://www.last.fm/api/authentication).
     26 
     27 ## Dependencies
     28 
     29 [matrix-client](https://github.com/matrix-org/matrix-python-sdk)
     30 
     31 [pylast](https://github.com/pylast/pylast)
     32 
     33 [youtube_title_parse](https://github.com/lttkgp/youtube_title_parse)
     34 
     35 [yt-dlp](https://github.com/ytdl-org/youtube-dl)
     36