Added README
This commit is contained in:
parent
9faef04412
commit
224bd8c8f4
3 changed files with 44 additions and 0 deletions
44
README.md
Normal file
44
README.md
Normal file
|
@ -0,0 +1,44 @@
|
|||
<center>
|
||||
|
||||
<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)
|
||||
|
||||
</center>
|
||||
|
||||
# Features
|
||||
- Simple installation configuration using JSON
|
||||
- Ability to toggle activity using keybinding (default - D)
|
||||
- Displays current file name and timestamps
|
||||
- Displays track metadata (artist, title, album)
|
||||
- Displays cover art from MusicBrainz archive
|
||||
- Rusty! 🦀
|
||||
|
||||
# Installation
|
||||
1. Download latest release and unzip it
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
<center><sub><strong>Made with ponies and love!</strong></sub></center>
|
||||
<center><sub><strong>GNU GPL © Ryze 2023</strong></sub></center>
|
BIN
img/mpv_logo.png
Normal file
BIN
img/mpv_logo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 10 KiB |
BIN
img/rich_presence.png
Normal file
BIN
img/rich_presence.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 59 KiB |
Loading…
Reference in a new issue