simple-discord-rpc

Beautify your Discord profile with a customisable Rich Presence, now with custom buttons, and Activity Types.

Table of Contents

Getting Started

• Requirements
• Usage Instructions

Configuration File

• Timestamps
• Assets
• Buttons
• Types

Example

• Tomorrowland Brasil 2024

Getting Started

Requirements

Node.js

Discord Developer Application

Important

Discord must be open in the background, and logged-in on the same machine as simple-discord-rpc.

Discord Desktop Application

Usage Instructions

1. Download the latest Source code (zip) under Assets from the releases page on GitHub.

2. Extract Source code (zip) to your Desktop, then open the folder: simple-discord-rpc-X.X.X.

3. Open config.js in your chosen text editor, and modify the Rich Presence to your liking before saving.

4. Hold Shift + Right-click inside the folder and click Open in Terminal / Open PowerShell window here.

5. Run npm i for the first time, then run node . or node src/index.js to start-up simple-discord-rpc.

Configuration File

Timestamps

Convert a human-readable date to a unix timestamp using EpochConverter, or a Discord favourite: HammerTime.

Example

Time elapsed since 1735689600 (human-readable date: 01/01/2025 00:00:00 (GMT)).

{
  timestamps: {
    startTimestamp: 1735689600, // 470:59:05 at the time of writing this
    endTimestamp: undefined
  }
}

Tip

You can now write Javascript in the config.js file to specify the startTimestamp and endTimestamp.

Examples

Display your local time, converted to a hh:mm:ss (24 hour) format such as 12:01:00 (1 minute past midday).

{
  timestamps: {
    startTimestamp: new Date().setHours(0, 0, 0, 0), // time elapsed since midnight
    endTimestamp: undefined
  }
}

Countdown to an hour from now (the time will start from the moment you run simple-discord-rpc).

{
  timestamps: {
    startTimestamp: Date.now(), // now as a unix timestamp
    endTimestamp: Date.now() + 60 * 60 * 1000 // now + 1 hour in milliseconds
  }
}

Note

The activity type must be set to Listening (2), or Watching (3) when the endTimestamp is also provided.

Assets

Example

{
  assets: {
    largeImageKey: 'heart', // asset named 'heart' I uploaded via the Developer Portal
    largeImageText: '♥', // text displayed when hovering over the largeImageKey
    largeImageUrl: undefined, // url opened when clicking on the large image
    smallImageKey: undefined,
    smallImageText: undefined,
    smallImageUrl: undefined,
  }
}

Tip

You can now specify an external URL, as long as it meets the dimensions and size requirements for an asset.

Example

{
  assets: {
    largeImageKey: 'https://cdn.7tv.app/emote/01F6MQ33FG000FFJ97ZB8MWV52/4x.gif', // catJAM
    largeImageText: 'Meow', // text displayed when hovering over the largeImageKey
    largeImageUrl: 'https://7tv.app/emotes/01F6MQ33FG000FFJ97ZB8MWV52', // url opened when clicking on the large image
    smallImageKey: undefined,
    smallImageText: undefined,
    smallImageUrl: undefined,
  }
}

Buttons

Note

Buttons may not render on your end, but other users on Discord will be able to see and interact with them.

Example

{
  buttons: {
    primary: {
      label: 'GitHub',
      url: 'https://github.com/Jxyme/'
    },
    secondary: {
      label: undefined,
      url: undefined
    }
  }
}

Types

Note

The activity object is limited to a type of Playing (0), Listening (2), Watching (3), or Competing (5).

Playing (0)

{
  type: 0
}

Examples

Location	Field Name	Notes
First row below title	details
Second row below title	state	If provided with no partySize or partyMax
First badge in the last row below title	startTimestamp	Converted to a mm:ss format such as 12:01
Second badge in the last row below title	state	If provided with a partySize and partyMax
Second badge in the last row below title	partySize	In parenthesis next to the state, first number in the format (1 of 4)
Second badge in the last row below title	partyMax	In parenthesis next to the state, second number in the format (1 of 4)
First button at the bottom	buttons.primary	Button has the text buttons.primary.label and when clicked links to the url buttons.primary.url
Second button at the bottom	buttons.secondary	Button has the text buttons.secondary.label and when clicked links to the url buttons.secondary.url
Large image to the left of any content	largeImageKey	Four rows high, includes the title but not the bottom buttons
Small image to the left of any content	smallImageKey	Small icon inset on the bottom right of the largeImageKey

Listening (2)

{
  type: 2
}

Examples

Location	Field Name	Notes
First row below title	details
Second row below title	state
First badge in the last row below title	startTimestamp	Converted to a mm:ss format such as 12:01
Second badge in the last row below title	endTimestamp	If provided with startTimestamp, converted to a mm:ss format such as 12:01
First button at the bottom	buttons.primary	Button has the text buttons.primary.label and when clicked links to the url buttons.primary.url
Second button at the bottom	buttons.secondary	Button has the text buttons.secondary.label and when clicked links to the url buttons.secondary.url
Large image to the left of any content	largeImageKey	Four rows high, includes the title but not the bottom buttons
Small image to the left of any content	smallImageKey	Small icon inset on the bottom right of the largeImageKey

Watching (3)

{
  type: 3
}

Examples

Location	Field Name	Notes
First row below title	details
Second row below title	state
First badge in the last row below title	startTimestamp	Converted to a mm:ss format such as 12:01
Second badge in the last row below title	endTimestamp	If provided with startTimestamp, converted to a mm:ss format such as 12:01
First button at the bottom	buttons.primary	Button has the text buttons.primary.label and when clicked links to the url buttons.primary.url
Second button at the bottom	buttons.secondary	Button has the text buttons.secondary.label and when clicked links to the url buttons.secondary.url
Large image to the left of any content	largeImageKey	Four rows high, includes the title but not the bottom buttons
Small image to the left of any content	smallImageKey	Small icon inset on the bottom right of the largeImageKey

Competing (5)

{
  type: 5
}

Example

Location	Field Name	Notes
First row below title	details
Second row below title	state
First button at the bottom	buttons.primary	Button has the text buttons.primary.label and when clicked links to the url buttons.primary.url
Second button at the bottom	buttons.secondary	Button has the text buttons.secondary.label and when clicked links to the url buttons.secondary.url
Large image to the left of any content	largeImageKey	Four rows high, includes the title but not the bottom buttons
Small image to the left of any content	smallImageKey	Small icon inset on the bottom right of the largeImageKey

Warning

The layout may be subject to change without warning. Please keep this in mind when visiting at a later date.

Example

Tomorrowland Brasil 2024

config.js

module.exports = {
  applicationId: '1327713183372284027',
  activity: {
    details: 'Amber Broos',
    detailsUrl: undefined,
    state: 'Next: NERVO',
    stateUrl: undefined,
    party: {
      partySize: undefined,
      partyMax: undefined,
    },
    timestamps: {
      startTimestamp: new Date('2024-10-12 17:40:00').getTime(),
      endTimestamp: new Date('2024-10-12 18:40:00').getTime(),
    },
    assets: {
      largeImageKey: 'https://owr-schedule-cdn.tomorrowland.com/1585774431.jpg',
      largeImageText: 'Amber Broos',
      largeImageUrl: undefined,
      smallImageKey: 'https://owr-schedule-cdn.tomorrowland.com/1358567301.jpeg',
      smallImageText: 'NERVO',
      smallImageUrl: undefined,
    },
    buttons: {
      primary: {
        label: 'Live Stream',
        url: 'https://www.youtube.com/live/NC8P2lH_uYw',
      },
      secondary: {
        label: 'Stream Schedule',
        url: 'https://www.instagram.com/p/DA6NNcvuOx-',
      },
    },
    type: 3, // Watching: 3
    statusDisplayType: 0, // Application Name: 0
  },
  connection: {
    maxRetries: 7,
    retryInterval: 10,
  },
}

User Pop-out	User Profile