diff --git a/README.md b/README.md new file mode 100644 index 0000000..a41476b --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +
+ + + +# `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) + +
+ +# 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. + +--- + +
Made with ponies and love!
+
GNU GPL © Ryze 2023
\ No newline at end of file diff --git a/img/mpv_logo.png b/img/mpv_logo.png new file mode 100644 index 0000000..d71e2d3 Binary files /dev/null and b/img/mpv_logo.png differ diff --git a/img/rich_presence.png b/img/rich_presence.png new file mode 100644 index 0000000..e912b59 Binary files /dev/null and b/img/rich_presence.png differ