fediplug/README.md

21 lines
908 B
Markdown
Raw Normal View History

2017-12-29 01:38:54 +01:00
# fediplay
A Mastodon client that automatically plays your friends' music as they toot links to it.
2018-01-21 18:06:07 +01:00
## Getting started
You'll need `ffplay` from [FFmpeg](https://ffmpeg.org/) to actually play music. On macOS, `ffplay` is part of the Homebrew ffmpeg package, but you need to build it with `brew install ffmpeg --with-sdl2`.
2017-12-29 01:38:54 +01:00
Edit `stream.py` so it points to your Mastodon instance.
2017-12-29 01:38:54 +01:00
Use `pipenv install --dev` from [Pipenv](https://docs.pipenv.org/) to install the Python dependencies and set up the package with a `stream` executable.
2018-01-21 18:06:07 +01:00
## Streaming
Use `pipenv run stream` to start the stream. You'll need to log in the first time.
2017-12-29 01:38:54 +01:00
Toots that include the hashtag #fediplay and have as their first link something that [youtube-dl](https://rg3.github.io/youtube-dl/) can play, will!
If new #fediplay toots come in while music is playing, they'll be downloaded immediately and queued to be played later.
2018-01-21 18:06:07 +01:00