diff --git a/README.md b/README.md index 9f2161a..af905c8 100644 --- a/README.md +++ b/README.md @@ -23,29 +23,32 @@ Rich Presence (RPC) is the name for how some apps can talk to Discord desktop on
-## Usage +## Installation +### Prerequirements +- [Latest source download from Releases](https://github.com/OpenAsar/arrpc/releases/latest) +- A modern version (**>=18**) of [Node.js](https://nodejs.org) must be installed. -### Server -Run `npx arrpc` in a terminal. Make sure you have a modern (>=18) version of [Node.js](https://nodejs.org) installed. +### Starting The Server +1. Download the source of this repo as zip. +2. In a terminal, inside the extracted folder, run `npm install`. +3. Run `npx arrpc` to start the server. +## Usage ### Web #### No Mods -1. Get [the arRPC server running](#server-required) +1. [Start the arRPC server](#starting-the-server) 2. With Discord open, run the content of [`examples/bridge_mod.js`](examples/bridge_mod.js) in Console (Ctrl+Shift+I). - #### Vencord -1. Get [the arRPC server running](#server-required) +1. [Start the arRPC server](#starting-the-server) 2. Just enable the `WebRichPresence (arRPC)` Vencord plugin! ### Custom Clients - -#### ArmCord, Vesktop +#### Vesktop / ArmCord These clients have arRPC specially integrated, just enable the option in its settings (server not required)! - #### Webcord -1. Get [the arRPC server running](#server-required) -2. Disable the `Use built-in Content Security Policy` option in Advanced settings: ![image](https://user-images.githubusercontent.com/19228318/202926723-93b772fc-f37d-47d4-81fd-b11c5d4051e8.png) -3. With Webcord open, run the content of [`examples/bridge_mod.js`](examples/bridge_mod.js) in the DevTools Console (Ctrl+Shift+I). +1. [Start the arRPC server](#starting-the-server) +2. Disable the `Use built-in Content Security Policy` option in Advanced settings: ![example](https://user-images.githubusercontent.com/19228318/202926723-93b772fc-f37d-47d4-81fd-b11c5d4051e8.png) +4. With Webcord open, run the content of [`examples/bridge_mod.js`](examples/bridge_mod.js) in the DevTools Console (Ctrl+Shift+I). ---