VLC-RPC is a Discord-rich presence integration for the VLC media player. This fork of PigPog's VLC Discord RPC adds automatic album art.
Join our community on Discord.
- Features
- Installation
- Configuration
- Limitations
- Known Bugs
- Nightly Builds
- Development
- License
- Contact
- Displays currently playing media in Discord
- Automatic album art display
- Easy to configure
You can install VLC-RPC by downloading a prebuilt archive or by building the project yourself.
- Download the latest release for your platform.
- Unzip the downloaded file.
- Launch
start.bat(on Windows) orstart.sh(on Linux). - Play media in the VLC window that opens.
- Clone the repository:
git clone https://github.com/greendoescode/vlc-rpc.git - Navigate to the cloned repository directory:
cd vlc-rpc - Launch
start.bat(on Windows) orstart.sh(on Linux). - Alternatively, install the dependencies with:
npm install
Configuration is done by editing the config/config.js file. This file is created when first starting VLC-RPC.
Each option in the configuration file is explained by a comment above it. For advanced features, see ADVANCED.md.
- When running multiple concurrent instances, only the first-opened instance of VLC will have a rich presence.
- This program does NOT allow you to stream media to others.
If you find any bugs, please report them in the Issues or on Discord.
Nightly builds are posted as "Pre-releases" after every commit. These nightly builds may add features but with minimal implementations. Using these builds can help us diagnose issues while giving you early access to new features. Click here to get the latest nightly builds.
This repository uses "conventional commits" from this commit forward. Here's a rundown on what they are and how to use them properly.
If you'd like to help out, you can clean up the code and help set up automatic testing of builds.
This project is licensed under the MIT License. See the LICENSE file for details.
For any questions or support, join our Discord community.