Giter Club home page Giter Club logo

pk-rpc's Introduction

PluralKit RPC

A rich presence client for RPC users.

This program will get your currently fronting system member and show it in your Discord status. Make sure you run the program on the same machine as your Discord client in order for it to work.

How to use

  1. Make sure you have nodejs installed on your machine
  2. Download this repo
  3. Install dependencies with npm install in the root folder, using your preferred terminal
  4. Open the right run.* for your OS, or use node index to run the program
    • Windows: run.bat
    • Mac/Linux: use chmod 755 run.sh, then open run.sh

Caveats

This app won't work if your fronters are privated. In order for the app to see your fronters, it'd need your app token. If you'd like to make modifications in order for the program to accept a token, feel free- however, this app focuses on using already public information, given that you'll be using this to broadcast who's fronting in your Discord status.

Also, due to RPC requiring pre-loaded assets in order to use icons, you can't use your members' avatars with this program as-is. If you'd like to be able to use icons for your sysmates, you'll have to make your own application here and upload avatar assets in the rich presence area, making sure that icons match your headmates' and system IDs. After that, replace the clientId in config.json with your application's client ID.
All that said, you'll still only be able to use one image for the current fronters, so whoever is registered first will have their image used.

Another caveat is that this program may not update immediately. It runs on a clock cycle that updates every few seconds, so if you switch and don't see immediate changes, please be patient.

Support

If you need help with this, feel free to DM us @ (GS)#6969 on Discord or join our bot support server here

If you'd like to support us, the devs, you can buy us a Ko-Fi here or consider becoming a Patron here.

pk-rpc's People

Contributors

greysdawn avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.