mpv-rpc/README.md

50 lines
1.8 KiB
Markdown
Raw Normal View History

2023-02-08 20:30:18 +01:00
<div align="center">
2023-02-08 20:13:30 +01:00
<img align="center" src="./img/mpv_logo.png">
# `MPV Discord Rich Presence`
**Discord Rich Presence integration for MPV player written in Rust**
[![Release](https://img.shields.io/github/v/release/ryze312/mpv-rpc)](https://github.com/ryze312/mpv-rpc/releases)
[![Downloads](https://img.shields.io/github/downloads/ryze312/mpv-rpc/total)](https://github.com/ryze312/mpv-rpc/releases)
[![Last commit](https://img.shields.io/github/last-commit/ryze312/mpv-rpc)](https://github.com/ryze312/mpv-rpc/commits/master)
[![Issues](https://img.shields.io/github/issues/ryze312/mpv-rpc)](https://github.com/ryze312/mpv-rpc/issues)
[![License](https://img.shields.io/github/license/ryze312/mpv-rpc)](./LICENSE)
![Rich presence](./img/rich_presence.png)
2023-02-08 20:30:18 +01:00
</div>
2023-02-08 20:13:30 +01:00
# Features
- Simple installation configuration using JSON
- Ability to toggle activity using keybinding (default - D)
- Displays current file name and timestamps
2023-02-08 20:31:16 +01:00
- Displays track metadata (artist, title, album, track number)
2023-02-08 20:13:30 +01:00
- Displays cover art from MusicBrainz archive
- Rusty! 🦀
# Installation
*Only Linux is supported at the moment, see MPV docs, regarding C plugins*
2023-02-08 20:55:35 +01:00
1. Download [latest release](https://github.com/ryze312/mpv-rpc/releases/latest) and unzip it
2023-02-08 20:13:30 +01:00
2. Run the installer script
3. Keybindings can be changed in input.conf
4. Done!
# Why?
- Alternative solutions either require third-party dependencies or were unreliable in my experience
- Furthermore, none of them allow automatic pulling of cover art!
- Learning and gaining experience in Rust!
# Contributing
All issues and pull requests are welcome! Feel free to open an issue if you've got an idea or a problem. You can open a pull request if you are able to implement it yourself.
---
2023-02-08 20:30:18 +01:00
<p align="center">
<sub><strong>
Made with ponies and love!
<br/>
GNU GPL © Ryze 2023
</strong></sub>
</p>