VLC-RPC

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.

Table of Contents

• Features
• Installation
  • Common Requirements
  • Using Prebuilt Release
  • Using Manual Build
• Configuration
• Limitations
• Known Bugs
• Nightly Builds
• Development
• License
• Contact

Features

• Displays currently playing media in Discord
• Automatic album art display
• Easy to configure

Installation

You can install VLC-RPC by downloading a prebuilt archive or by building the project yourself.

Common Requirements

• VLC Media Player
• Discord Desktop Client

Using Prebuilt Release

1. Download the latest release for your platform.
2. Unzip the downloaded file.
3. Launch start.bat (on Windows) or start.sh (on Linux).
4. Play media in the VLC window that opens.

Using Manual Build

Additional Requirements

• Node.js and NPM

Steps

1. Clone the repository: git clone https://github.com/greendoescode/vlc-rpc.git
2. Navigate to the cloned repository directory: cd vlc-rpc
3. Launch start.bat (on Windows) or start.sh (on Linux).
4. Alternatively, install the dependencies with: npm install

Configuration

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.

Limitations

• 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.

Known Bugs

If you find any bugs, please report them in the Issues or on Discord.

Nightly Builds

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.

Development

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.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any questions or support, join our Discord community.