Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/angeloanan/mpc-discordrpc
Discord Rich Presence for Media Player Classic
https://github.com/angeloanan/mpc-discordrpc
discord discordrichpresence media-player mpc-hc nodejs richpresence
Last synced: 12 days ago
JSON representation
Discord Rich Presence for Media Player Classic
- Host: GitHub
- URL: https://github.com/angeloanan/mpc-discordrpc
- Owner: angeloanan
- License: mit
- Created: 2018-03-03T16:13:26.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T17:11:23.000Z (almost 2 years ago)
- Last Synced: 2024-10-24T21:36:42.666Z (20 days ago)
- Topics: discord, discordrichpresence, media-player, mpc-hc, nodejs, richpresence
- Language: JavaScript
- Homepage:
- Size: 631 KB
- Stars: 90
- Watchers: 8
- Forks: 13
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MPC-DiscordRPC
Discord Rich Presence for Media Player Classic (Home Cinema and Black Edition)
## How does this work?
This program simply fetches playback data from MPC-HC / MPC-BE Web Interface, and displays it in your Discord profile through their wonderful [Rich Presence](https://discordapp.com/rich-presence) API.
Please note that this only works with [Discord desktop client](https://discordapp.com/download), not with the web app.
## How to install
1. Open your Media Player Classic, go to `View > Options > Player > Web Interface` and enable `Listen on port:` option. The default port is `13579`, but if you have changed it, please edit the `config.js` file after you download the project.
2. Install [`Node.JS`](https://nodejs.org/en/download/current/) (we recommend using the latest version).
3. [Download this project as a .zip file](https://github.com/angeloanan/MPC-DiscordRPC/archive/master.zip), extract it and open a terminal window in the project directory. Otherwise, if you have [Git](https://git-scm.com/) installed, run:
```sh
git clone https://github.com/angeloanan/MPC-DiscordRPC.git && cd MPC-DiscordRPC
```
4. Install dependencies using:
```sh
npm i
```
> Note: You can safely ignore all peer and optional dependencies warnings as they are not required for the program to work.
5. Start the program using:
```sh
npm start
```
or via
```sh
node index.js
```
> Note: Using `npm start` will start the program as a background process so you don't need to keep a terminal window open in order to keep the script running. Thus, you may close your terminal window after running this command.
And voilà! It will now show in your Discord profile what you're watching/listening to on MPC.
If you started the program using `npm start` and need MPC-DiscordRPC to stop showing your playback info, just run:
```
npm stop
```
## How to update
1. Navigate to the directory where did you cloned/downloaded this project and open a terminal window.
2. Stop the program using:
```sh
npm stop
```
3. Update this project by [redownloading this project as a .zip file](https://github.com/angeloanan/MPC-DiscordRPC/archive/master.zip) and replacing the old files.
Otherwise, if you have Git installed, run:
```sh
git pull
```
4. Start the program again using:
```sh
npm start
```
Now you may close the terminal. The project is fully up to date!
## `config.js` options
#### `exports.port`
Default: `13579`
Port on which MPC Web Interface is running. See the [How to install](#how-to-install) section above to learn more.
#### `exports.ignoreBrackets`
Default: `true`
Whether to omit brackets `[]` and its content in filenames. Useful if you don't want to show on your profile those info tags that usually comes inside brackets in filenames, like `[1080p]`, `[Translator Group Name]`, etc. You can set it to `false` or remove this line to turn off this behavior.
#### `exports.ignoreFiletype`
Default: `false`
Whether to omit filetype. Useful if you don't want to show on your profile the type of the file that is currently open, for example `.mp4`, `.mkv`, `.flac`. You can set it to `true` to turn on this behavior.
#### `exports.replaceUnderscore`
Default: `true`
Whether to replace `_` with space. Useful if you have files like `Your_Favourite_Movie`. You can set it to `false` or remove this line to turn off this behavior.
#### `exports.replaceDots`
Default: `true`
Whether to replace dot (`.`) characters (except the file extension one) with spaces. This way, `Your.Favourite.Movie.mp4` will be displayed as `Your Favourite Movie.mp4`. You can set it to `false` or remove this line to turn off this behavior.
#### `exports.showRemainingTime`
Default: `false`
Whether to display the current file's remaining playback time while playing, instead of showing the elapsed time.