fediplug/README.md

25 lines
1,011 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
2018-03-06 00:53:08 +01:00
fediplay comes configured to use `ffplay` from [FFmpeg](https://ffmpeg.org/) to actually play music.
- On macOS, `ffplay` is part of the [Homebrew](https://brew.sh/) `ffmpeg` package, but you need to build it with `brew install ffmpeg --with-sdl2`.
- On Windows, `ffplay` is part of the [Scoop](http://scoop.sh/) `ffmpeg` package.
2017-12-29 01:38:54 +01:00
2018-01-25 03:07:51 +01:00
Edit `.env` and set `FEDIPLAY_API_BASE_URL` to your Mastodon instance.
2017-12-29 01:38:54 +01:00
2018-01-25 02:49:30 +01:00
Use `pipenv install` from [Pipenv](https://docs.pipenv.org/) to install the Python dependencies.
2018-01-21 18:06:07 +01:00
## Streaming
2018-01-25 02:49:30 +01:00
Use `pipenv run python -m fediplay` 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