Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fichtefoll/discordrp-mpris
Discord Rich Presence through media players providing the mpris2 dbus interface
https://github.com/fichtefoll/discordrp-mpris
cmus discord discord-rich-presence hacktoberfest mpd mpris mpv vlc-media-player
Last synced: 3 months ago
JSON representation
Discord Rich Presence through media players providing the mpris2 dbus interface
- Host: GitHub
- URL: https://github.com/fichtefoll/discordrp-mpris
- Owner: FichteFoll
- License: mit
- Created: 2018-04-17T01:24:26.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-05-09T23:41:31.000Z (over 1 year ago)
- Last Synced: 2024-10-13T01:10:01.813Z (3 months ago)
- Topics: cmus, discord, discord-rich-presence, hacktoberfest, mpd, mpris, mpv, vlc-media-player
- Language: Python
- Homepage:
- Size: 107 KB
- Stars: 86
- Watchers: 5
- Forks: 19
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Discord Rich Presence through mpris
| User Modal | Popout Modal |
| ------------------- | --------------------- |
| ![][img-user-modal] | ![][img-popout-modal] |
discordrp-mpris provides Rich Presence to Discord clients
based on music or other media that you are playing
and that is exposed through the [mpris2][] D-Bus interface.
Thus, it only works on systems where D-Bus is available
and *not* on Windows.
discordrp-mpris is intended to run in the background
alongside your local Discord client
and your media player(s).
Multiple media players are supported
and the ones with active playback are prioritized.
The most recently active player will then be followed
until it is no longer playing
and a different player starts playback.
This project is in *beta* stage.
## Installation & Usage
Requirements:
- Python 3.6 or higher
### Recommended
- **Arch Linux**: [AUR](https://aur.archlinux.org/packages/discordrp-mpris-git/)
```sh
systemctl --user enable discordrp-mpris.service --now
```
### Manual
```sh
pip install git+https://github.com/FichteFoll/discordrp-mpris.git
# Usage
discordrp-mpris
```
You might also want to use `pip install --user` instead.
### pipenv
Requires [pipenv][].
```sh
git clone https://github.com/FichteFoll/discordrp-mpris.git
cd discordrp-mpris
pipenv install
# Usage
pipenv run python -m discordrp-mpris
```
## Media Players
The following media players are known to be supported:
- [Clementine][]
- [Strawberry][]
- [cmus][]
- [KDE Plasma integration][plasma-integration] (supports various browsers)
- [Lollypop][]
- [Media Player Classic Qute Theater][mpc-qt] (newer than 18.03 or 2018-06-20)
- [Media Player Daemon][mpd] (through [mpDris2][])
- [Mozilla Firefox][]
(does not support `Position` attribute; [upstream ticket][firefox-bug])
- [mpv][] (through [mpv-mpris][])
- [SMPlayer][]
- [VLC Media Player][vlc]
Icons are available for:
- Clementine
- Lollypop
- Media Player Daemon
- Media Player Classic Qute Theater
- Mozilla Firefox
- mpv
- SMPlayer
- VLC Media Player
When no player icon is available,
the playback state is used as the large icon.
The following players are **not** supported:
- Spotify
(conflicts with its own Rich Presence, #4)
- [mps-youtube][]
(doesn't implement introspectable DBus properties,
mps-youtube/mps-youtube#839)
## Configuration
Configuration may be provided in a `config.toml` file
using the [TOML][] format
and located in the folders `$XDG_CONFIG_HOME/discordrp-mpris`
or `$HOME/.config/discordrp-mpris`.
For available options, see the [default `config.toml`][default-config].
[img-user-modal]: https://user-images.githubusercontent.com/931051/39368449-e0da4afa-4a39-11e8-8909-2d3b2383ad9f.png
[img-popout-modal]: https://user-images.githubusercontent.com/931051/39368450-e0fb03da-4a39-11e8-8fc3-d6910f097243.png
[mpris2]: https://specifications.freedesktop.org/mpris-spec/2.2/
[pipenv]: https://docs.pipenv.org/
[Clementine]: https://www.clementine-player.org/
[Strawberry]: https://www.strawberrymusicplayer.org/
[cmus]: https://cmus.github.io/
[plasma-integration]: https://community.kde.org/Plasma/Browser_Integration
[Lollypop]: https://wiki.gnome.org/Apps/Lollypop
[mpc-qt]: https://github.com/cmdrkotori/mpc-qt
[mpd]: https://musicpd.org/
[mpDris2]: https://github.com/eonpatapon/mpDris2
[mpv]: https://mpv.io/
[mpv-mpris]: https://github.com/hoyon/mpv-mpris
[vlc]: https://www.videolan.org/vlc/
[mps-youtube]: https://github.com/mps-youtube/mps-youtube
[SMPlayer]: https://www.smplayer.info/
[TOML]: https://github.com/toml-lang/toml
[default-config]: discordrp_mpris/config/config.toml
[firefox-bug]: https://bugzilla.mozilla.org/show_bug.cgi?id=1659199
[Mozilla Firefox]: https://www.mozilla.org/en-US/firefox/new/