smartfridge/armcord
1
1
Fork 0
mirror of https://github.com/smartfrigde/armcord.git synced 2024-08-14 23:56:58 +00:00
Code Issues Projects Releases Wiki Activity
armcord/src/arrpc
History
smartfrigde feff5db827 add replugged to arrpc allow list
2023-08-02 12:19:41 +02:00
..
src add replugged to arrpc allow list 2023-08-02 12:19:41 +02:00
changelog.md Update arrpc to 3.0.0 (#284) 2022-12-10 09:40:14 +00:00
LICENSE Add experimental arrpc 2022-11-19 23:15:05 +01:00
package.json Update arrpc to 3.0.0 (#284) 2022-12-10 09:40:14 +00:00
README.md Update arrpc to 3.0.0 (#284) 2022-12-10 09:40:14 +00:00

README.md

arRPC
License: MIT GitHub Sponsors

An open implementation of Discord's local RPC servers

Allowing RPC where it was otherwise impossible, like Discord Web and custom clients


arRPC is an open source implementation of Discord's half-documented local RPC servers for their desktop client. This open source implementation purely in NodeJS allows it to be used in many places where it is otherwise impossible to do: Discord web and alternative clients like ArmCord/etc. It opens a simple bridge WebSocket server which messages the JSON of exactly what to dispatch with in the client with no extra processing needed, allowing small and simple mods or plugins. arRPC is experimental and a work in progress, so expect bugs, etc.


Rich Presence (RPC) is the name for how some apps can talk to Discord desktop on your PC via localhost servers to display detailed info about the app's state. This usually works via parts of Discord desktop natively doing things + parts of Discord web interpreting that and setting it as your status. arRPC is an open source implementation of the local RPC servers on your PC, allowing apps to talk to it thinking it was just normal Discord. It can then send that info to apps which usually don't get RPC, like Discord Web, ArmCord, etc. which can then set that as your status. This would otherwise not be possible, as web apps/browsers/etc can't just use Discord's already existing code and version.

  • App with Discord RPC
  • Discord Desktop's native server arRPC
  • Discord Web's setting mod/plugin

Usage

Server (REQUIRED)

  1. Have latest (>=18) Node installed
  2. Clone GitHub repo
  3. npm install
  4. Run server with node src

Web

No Mods

  1. Get the arRPC server running
  2. With Discord open, run the content of examples/bridge_mod.js in Console (Ctrl+Shift+I).

Vencord

  1. Get the arRPC server running
  2. Just enable the WebRichPresence (arRPC) Vencord plugin!

Custom Clients

ArmCord

ArmCord has arRPC specially integrated, just enable the option in it's settings (server not required)!

Webcord

  1. Get the arRPC server running
  2. Disable the Use built-in Content Security Policy option in Advanced settings: image
  3. With Webcord open, run the content of examples/bridge_mod.js in the DevTools Console (Ctrl+Shift+I).

Then just use apps with Discord RPC like normal and they should work!


Supported

Transports

  • WebSocket Server
    • JSON
    • Erlpack
  • HTTP Server
  • IPC
  • Process Scanning

Commands

  • DISPATCH
  • SET_ACTIVITY
  • INVITE_BROWSER
  • GUILD_TEMPLATE_BROWSER
  • DEEP_LINK