|
1 | | -# vlc-rpc |
2 | | -  |
| 1 | +# VLC-RPC |
3 | 2 |
|
4 | | -Discord-rich presence for VLC media player. |
5 | | -This is a fork of [PigPogs](https://github.com/Pigpog/vlc-discord-rpc) VLC RPC, adding automatic album art. |
| 3 | +  |
| 4 | + |
| 5 | +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. |
6 | 6 |
|
7 | 7 |  |
8 | 8 |
|
9 | | -Join us on [Discord](https://discord.gg/CHegxjdFCD). |
| 9 | +Join our community on [Discord](https://discord.gg/CHegxjdFCD). |
10 | 10 |
|
11 | | -## Installation |
| 11 | +## Table of Contents |
12 | 12 |
|
13 | | -Your options are either to download a prebuilt archive or build the project yourself. |
| 13 | +- [Features](#features) |
| 14 | +- [Installation](#installation) |
| 15 | + - [Common Requirements](#common-requirements) |
| 16 | + - [Using Prebuilt Release](#using-prebuilt-release) |
| 17 | + - [Using Manual Build](#using-manual-build) |
| 18 | +- [Configuration](#configuration) |
| 19 | +- [Limitations](#limitations) |
| 20 | +- [Known Bugs](#known-bugs) |
| 21 | +- [Nightly Builds](#nightly-builds) |
| 22 | +- [Development](#development) |
| 23 | +- [License](#license) |
| 24 | +- [Contact](#contact) |
14 | 25 |
|
15 | | -#### Common requirements |
| 26 | +## Features |
16 | 27 |
|
17 | | -- [VLC](https://www.videolan.org/index.html) |
18 | | -- [Discord desktop client](https://discord.com/) |
| 28 | +- Displays currently playing media in Discord |
| 29 | +- Automatic album art display |
| 30 | +- Easy to configure |
19 | 31 |
|
20 | | -### Using Prebuilt release |
| 32 | +## Installation |
21 | 33 |
|
22 | | -#### Steps |
| 34 | +You can install VLC-RPC by downloading a prebuilt archive or by building the project yourself. |
| 35 | + |
| 36 | +### Common Requirements |
23 | 37 |
|
24 | | - 1. [Download the latest release for your platform](https://github.com/GreenDiscord/vlc-rpc/releases) |
25 | | - 2. Unzip the file |
26 | | - 3. Launch the `start.bat` (on Windows) or `start.sh` (on Linux) |
27 | | - 4. Play media in the VLC window that opens |
| 38 | +- [VLC Media Player](https://www.videolan.org/index.html) |
| 39 | +- [Discord Desktop Client](https://discord.com/) |
28 | 40 |
|
29 | | -### Using Manual build |
| 41 | +### Using Prebuilt Release |
30 | 42 |
|
31 | | -#### Additional requirements |
| 43 | +1. [Download the latest release for your platform](https://github.com/GreenDiscord/vlc-rpc/releases). |
| 44 | +2. Unzip the downloaded file. |
| 45 | +3. Launch `start.bat` (on Windows) or `start.sh` (on Linux). |
| 46 | +4. Play media in the VLC window that opens. |
32 | 47 |
|
33 | | -- [Node.JS and NPM](https://nodejs.org/en/) |
| 48 | +### Using Manual Build |
| 49 | + |
| 50 | +#### Additional Requirements |
| 51 | + |
| 52 | +- [Node.js and NPM](https://nodejs.org/en/) |
34 | 53 |
|
35 | 54 | #### Steps |
36 | | - 1. `git clone` this repo. |
37 | | - 2. Navigate to where you cloned the repo and then either: |
38 | | - 3. Launch the `start.bat` (on Windows) or `start.sh` (on Linux) |
39 | | - 4. Or install the dependencies with `npm install` |
40 | 55 |
|
41 | | -## Configuration |
| 56 | +1. Clone the repository: |
| 57 | + `git clone https://github.com/GreenDiscord/vlc-rpc.git` |
| 58 | +2. Navigate to the cloned repository directory: |
| 59 | + `cd vlc-rpc` |
| 60 | +3. Launch `start.bat` (on Windows) or `start.sh` (on Linux). |
| 61 | +4. Alternatively, install the dependencies with: |
| 62 | + `npm install` |
42 | 63 |
|
43 | | -Configuration is done by editing the `config/config.js` file. |
44 | | -This file is created when first starting vlc-rpc. |
| 64 | +## Configuration |
45 | 65 |
|
46 | | -Each option is explained in a comment above. |
| 66 | +Configuration is done by editing the `config/config.js` file. This file is created when first starting VLC-RPC. |
47 | 67 |
|
48 | | -For advanced features, see [ADVANCED.md](./advanced.md). |
| 68 | +Each option in the configuration file is explained by a comment above it. For advanced features, see [ADVANCED.md](./advanced.md). |
49 | 69 |
|
50 | 70 | ## Limitations |
51 | | - - When running multiple concurrent instances, only the first-opened instance of VLC will have a rich presence |
52 | | - - This program does NOT allow you to stream media to others |
| 71 | + |
| 72 | +- When running multiple concurrent instances, only the first-opened instance of VLC will have a rich presence. |
| 73 | +- This program does NOT allow you to stream media to others. |
53 | 74 |
|
54 | 75 | ## Known Bugs |
55 | | -If you find any bugs, please report them in [Issues](https://github.com/GreenDiscord/vlc-rpc/issues) or the [Discord](https://discord.gg/CHegxjdFCD) |
| 76 | + |
| 77 | +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). |
56 | 78 |
|
57 | 79 | ## Nightly Builds |
58 | | -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. |
59 | 80 |
|
60 | | -## Development |
61 | | -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. |
| 81 | +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. |
| 82 | + |
| 83 | +## Development |
| 84 | + |
| 85 | +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. |
62 | 86 |
|
63 | 87 | If you'd like to help out, you can clean up the code and help set up automatic testing of builds. |
64 | | - |
| 88 | + |
| 89 | +## License |
| 90 | + |
| 91 | +This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details. |
| 92 | + |
| 93 | +## Contact |
| 94 | + |
| 95 | +For any questions or support, join our [Discord community](https://discord.gg/CHegxjdFCD). |
0 commit comments