Fork of https://github.com/zigg/fediplay that updates youtube-dl so it runs again
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Leonie 8c5e4e9539 Updated README.md 7 months ago
fediplay refactor, add debug prints 10 months ago
.env use click for CLI 1 year ago
.gitignore ignore IntelliJ artifacts 1 year ago
LICENSE.md add license and requirements 1 year ago
Pipfile Updated fediplay (now works with Solus, new youtube-dl) 7 months ago
Pipfile.lock Updated fediplay (now works with Solus, new youtube-dl) 7 months ago
README.md Updated README.md 7 months ago
setup.py use appdirs to store secrets 1 year ago
test_fediplay.py refactor and rename secret files 1 year ago

README.md

fediplay

This is a fork of zigg’s fediplay on GitHub that updates everything and makes fediplay usable again

A Mastodon client that automatically plays your friends’ music as they toot links to it.

What’s new in 2.2

If you’ve been using fediplay before, the all-new version 2.2 will be a little different!

  • You now specify the instance you want to stream from on the command line, instead of setting it in the environment. fediplay has been upgraded with the power of Click to give it a more modern command-line interface.

  • We use appdirs to keep downloaded music files in your operating system’s user cache directory.

  • We use keyring to store your client credentials and access token, securely if your operating system supports it. If you already have .secret files from an earlier version, we’ll migrate them automatically for you.

Be sure to follow all the instructions, including re-running pipenv install to update the installed dependencies.

Getting started

fediplay comes configured to use ffplay from FFmpeg 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.

  • On Windows, ffplay is part of the Scoop ffmpeg package.

Use pipenv install from Pipenv to install the Python dependencies and set up the fediplay script inside the virtual environment.

You can use the fediplay script with either pipenv run fediplay or by entering the Pipenv shell with pipenv shell and just running fediplay.

Registering and logging in

To register fediplay to your instance, use fediplay register example.com.

To log in to your instance, use fediplay login example.com.

Streaming

Use fediplay stream example.com to start the stream. You’ll need to log in the first time.

Toots that include the hashtag #fediplay and have as their first link something that 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.

Since version 2.2, thanks to @bbonf, if there’s a recent #fediplay toot in your timeline, it’ll be pulled up and played before the stream starts. Great if you just missed a song before starting your stream!

Filtering

Since version 2.2, you can also, thanks to @Jenkyrados, specify users to filter! Just add them to the command line after the server name, e.g. fediplay stream example.com @user @[email protected].