https://github.com/greendoescode/vlc-rpc
Discord rich presence for VLC media player. This is a fork of PigPogs VLC RPC, adding automatic album art.
https://github.com/greendoescode/vlc-rpc
discord discord-presence rpc vlc vlc-media-player vlc-rpc
Last synced: 7 months ago
JSON representation
Discord rich presence for VLC media player. This is a fork of PigPogs VLC RPC, adding automatic album art.
- Host: GitHub
- URL: https://github.com/greendoescode/vlc-rpc
- Owner: greendoescode
- License: mit
- Created: 2022-10-21T09:55:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-08-20T11:03:10.000Z (7 months ago)
- Last Synced: 2025-08-20T11:39:01.432Z (7 months ago)
- Topics: discord, discord-presence, rpc, vlc, vlc-media-player, vlc-rpc
- Language: JavaScript
- Homepage:
- Size: 2.39 MB
- Stars: 39
- Watchers: 3
- Forks: 5
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# VLC-RPC
 
VLC-RPC is a Discord-rich presence integration for the VLC media player. This fork of [PigPog's VLC Discord RPC](https://github.com/Pigpog/vlc-discord-rpc) adds automatic album art.
Join our community on [Discord](https://discord.gg/CHegxjdFCD).
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Common Requirements](#common-requirements)
- [Using Prebuilt Release](#using-prebuilt-release)
- [Using Manual Build](#using-manual-build)
- [Configuration](#configuration)
- [Limitations](#limitations)
- [Known Bugs](#known-bugs)
- [Nightly Builds](#nightly-builds)
- [Development](#development)
- [License](#license)
- [Contact](#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](https://www.videolan.org/index.html)
- [Discord Desktop Client](https://discord.com/)
### Using Prebuilt Release
1. [Download the latest release for your platform](https://github.com/GreenDiscord/vlc-rpc/releases).
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](https://nodejs.org/en/)
#### 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](./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](https://github.com/greendoescode/vlc-rpc/issues) or on [Discord](https://discord.gg/CHegxjdFCD).
## 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](https://github.com/greendoescode/vlc-rpc/releases/tag/nightly) to get the latest nightly builds.
## Development
This repository uses "conventional commits" from this commit forward. [Here's a rundown](https://dev.to/jordharr/an-introduction-to-conventional-commits-bd4) 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](./LICENSE) file for details.
## Contact
For any questions or support, join our [Discord community](https://discord.gg/CHegxjdFCD).