-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Update readme to be more comprehensive
- Loading branch information
1 parent
5c4755d
commit 9ecaec1
Showing
1 changed file
with
66 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,95 @@ | ||
| # vlc-rpc | ||
|   | ||
| # VLC-RPC | ||
|
|
||
| Discord-rich presence for VLC media player. | ||
| This is a fork of [PigPogs](https://github.com/Pigpog/vlc-discord-rpc) VLC RPC, adding automatic album art. | ||
|   | ||
|
|
||
| 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 us on [Discord](https://discord.gg/CHegxjdFCD). | ||
| Join our community on [Discord](https://discord.gg/CHegxjdFCD). | ||
|
|
||
| ## Installation | ||
| ## Table of Contents | ||
|
|
||
| Your options are either to download a prebuilt archive or build the project yourself. | ||
| - [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) | ||
|
|
||
| #### Common requirements | ||
| ## Features | ||
|
|
||
| - [VLC](https://www.videolan.org/index.html) | ||
| - [Discord desktop client](https://discord.com/) | ||
| - Displays currently playing media in Discord | ||
| - Automatic album art display | ||
| - Easy to configure | ||
|
|
||
| ### Using Prebuilt release | ||
| ## Installation | ||
|
|
||
| #### Steps | ||
| You can install VLC-RPC by downloading a prebuilt archive or by building the project yourself. | ||
|
|
||
| ### Common Requirements | ||
|
|
||
| 1. [Download the latest release for your platform](https://github.com/GreenDiscord/vlc-rpc/releases) | ||
| 2. Unzip the file | ||
| 3. Launch the `start.bat` (on Windows) or `start.sh` (on Linux) | ||
| 4. Play media in the VLC window that opens | ||
| - [VLC Media Player](https://www.videolan.org/index.html) | ||
| - [Discord Desktop Client](https://discord.com/) | ||
|
|
||
| ### Using Manual build | ||
| ### Using Prebuilt Release | ||
|
|
||
| #### Additional requirements | ||
| 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. | ||
|
|
||
| - [Node.JS and NPM](https://nodejs.org/en/) | ||
| ### Using Manual Build | ||
|
|
||
| #### Additional Requirements | ||
|
|
||
| - [Node.js and NPM](https://nodejs.org/en/) | ||
|
|
||
| #### Steps | ||
| 1. `git clone` this repo. | ||
| 2. Navigate to where you cloned the repo and then either: | ||
| 3. Launch the `start.bat` (on Windows) or `start.sh` (on Linux) | ||
| 4. Or install the dependencies with `npm install` | ||
|
|
||
| ## Configuration | ||
| 1. Clone the repository: | ||
| `git clone https://github.com/GreenDiscord/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 is done by editing the `config/config.js` file. | ||
| This file is created when first starting vlc-rpc. | ||
| ## Configuration | ||
|
|
||
| Each option is explained in a comment above. | ||
| Configuration is done by editing the `config/config.js` file. This file is created when first starting VLC-RPC. | ||
|
|
||
| For advanced features, see [ADVANCED.md](./advanced.md). | ||
| 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 | ||
|
|
||
| - 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 [Issues](https://github.com/GreenDiscord/vlc-rpc/issues) or the [Discord](https://discord.gg/CHegxjdFCD) | ||
|
|
||
| If you find any bugs, please report them in the [Issues](https://github.com/GreenDiscord/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 minimal implementations of them. Using these builds can help us diagnose issues while giving you more, [Click Here](https://github.com/GreenDiscord/vlc-rpc/releases/tag/nightly) to get the latest nightly builds. | ||
|
|
||
| ## Development | ||
| This repo from this commit forward will be using "conventional commits", [Here's](https://dev.to/jordharr/an-introduction-to-conventional-commits-bd4) a rundown on what they are and how to use them properly. | ||
| 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/GreenDiscord/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). |