Skip to content

SpoiledUnknown/Richcord-Presence

Repository files navigation

Richcord Presence - Discord RPC

License: MIT Docs Passing

Richord Presence

Table Of Content:

  1. Description
  2. Installation
    1. Method 1
    2. Method 2
  3. Setting up the dev environment
  4. Creating custom client
  5. How to use

Description:

An advance discord rich presence software that allows a lot of customisation and control in hand of user without over complicating things.

Installation:

Note: Method 2 requires the NodeJS installed in pc if not avaibale install from here.

Method 1:

  • Download the executable from here.
    • Double click the exe file.
    • Go through the simple prompts.
  • Note: in some cases the exe file might not work in that case use bellow provided steps -
    • Open terminal (non-admin)
    • drag and drop the exe file to the ternimal window
    • press enter.

Method 2:

  • Clone the repo, or download the source code from here.
  • Open the ternimal at the location of the source code
  • Use cd "path/to/inside/of/source-code/", to access the source code.
  • Run npm install.
  • Run npm run start or node index.js

How To Setup Dev Environment:

  • Install NodeJs from here.
  • Clone the repo, or download the source code from here.
  • Open it using VS Code or any other Code Editor/IDE.
  • Open console (in vs code press ctrl + `).
  • Run npm install

Custom Client Setup:

Go to the Discord Dev Portal

  1. Click on tthe New Application button. Step 1
  2. A new dailogue box appears.
  3. Enter the name of the application (This shows as the app name in discord status)
  4. Agree the terms of service.
  5. Click on create Step 2
  6. Click on Rich Presence Step 3
  7. Scroll a little and click on Add Images
    • Note: You can only add images more than 512x512 (1024x1024 is recommended).
    • Note: You can add upto 300 images. Step 4
  8. Write the name of the asset.
    • Note: You can't change the name once the asset is saved. If you want to change then delete and reupload the asset.
    • Note: Remember the name you gave to the assets as they will have to write it as is while running the app
  9. Click on Save Changes and wait for changes to be saved. Step 5
  10. Now again click on General Information.
  11. Scroll down a little bit to copy your client id. Step 6
  12. Click on Copy. Step 7

The client setup is done, now you can just paste the client id when prompted.

How To Use:

  1. The app first asks the Client ID, which we have created using above provided method.
  2. You then have to provide a detail message. This message will be shown on detail area in discord
  3. Then you have to provide a status for your app.
  4. Then provide the Large Image Key, the name of the asset uploaded in custom client setup.
  5. Then provide a message for Large Image.
  6. Same step for small image, write the name of small image asset.
  7. and again a message for small image.
  8. Then write the label for first button.
  9. Then give a URL for the first button.
  10. Follow the above 2 steps for second button as well
  11. And lastly tell whether you want the timestamps to be shown or not.

Example

You are all done, now enjoy the Richcord by flexing on your virtual friends since you most likely don't have any irl friends.