Add support for the new fields in RPC activities

Made possible by discord/discord-api-docs#7674

Author: Jxyme

README.md

@@ -37,7 +37,7 @@ Beautify your Discord profile with a customisable Rich Presence, now with custom
 
 1. Download the latest `Source code (zip)` under `Assets` from the [releases page](https://github.com/Jxyme/simple-discord-rpc/releases/latest) on GitHub.
 
-2. Extract `Source code (zip)` to your Desktop, then open the folder: `simple-discord-rpc-2.0.0`.
+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.
 
@@ -103,8 +103,10 @@ Countdown to an hour from now (the time will start from the moment you run `simp
   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,
   }
 }
 ```
@@ -119,8 +121,10 @@ Countdown to an hour from now (the time will start from the moment you run `simp
   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,
   }
 }
 ```
@@ -258,7 +262,9 @@ module.exports = {
   applicationId: '1327713183372284027',
   activity: {
     details: 'Amber Broos',
+    detailsUrl: undefined,
     state: 'Next: NERVO',
+    stateUrl: undefined,
     party: {
       partySize: undefined,
       partyMax: undefined,
@@ -270,8 +276,10 @@ module.exports = {
     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: {
@@ -283,7 +291,8 @@ module.exports = {
         url: 'https://www.instagram.com/p/DA6NNcvuOx-',
       },
     },
-    type: 3,
+    type: 3, // Watching: 3
+    statusDisplayType: 0, // Application Name: 0
   },
   connection: {
     maxRetries: 7,

config.js

@@ -9,7 +9,9 @@ module.exports = {
   applicationId: '', // your developer application id
   activity: {
     details: undefined,
+    detailsUrl: undefined,
     state: undefined,
+    stateUrl: undefined,
     party: {
       partySize: undefined,
       partyMax: undefined,
@@ -21,8 +23,10 @@ module.exports = {
     assets: {
       largeImageKey: undefined,
       largeImageText: undefined,
+      largeImageUrl: undefined,
       smallImageKey: undefined,
       smallImageText: undefined,
+      smallImageUrl: undefined,
     },
     buttons: {
       primary: {
@@ -35,6 +39,7 @@ module.exports = {
       },
     },
     type: 0, // Playing: 0, Listening to: 2, Watching: 3, or Competing in: 5
+    statusDisplayType: 0, // Application Name: 0, State: 1, or Details: 2
   },
   connection: {
     maxRetries: 7, // number of retries to establish a connection with Discord (default: 7)

package-lock.json

@@ -17,7 +17,7 @@
     "format": "prettier --write ."
   },
   "dependencies": {
-    "@xhayper/discord-rpc": "^1.2.0",
+    "@xhayper/discord-rpc": "^1.3.0",
     "joi": "^17.13.3"
   },
   "devDependencies": {

package.json

@@ -25,18 +25,23 @@ const sanitiseActivity = () => {
   })
   const sanitisedActivity = {
     details: activity.details,
+    detailsUrl: activity.detailsUrl,
     state: activity.state,
+    stateUrl: activity.stateUrl,
     partySize: activity.party.partySize,
     partyMax: activity.party.partyMax,
     startTimestamp: activity.timestamps.startTimestamp,
     endTimestamp: activity.timestamps.endTimestamp,
     largeImageKey: activity.assets.largeImageKey,
     largeImageText: activity.assets.largeImageText,
+    largeImageUrl: activity.assets.largeImageUrl,
     smallImageKey: activity.assets.smallImageKey,
     smallImageText: activity.assets.smallImageText,
+    smallImageUrl: activity.assets.smallImageUrl,
     buttons: buttons.length ? buttons : undefined,
     instance: false,
     type: activity.type,
+    statusDisplayType: activity.statusDisplayType ?? 0,
   }
   logger.info(`Attempting to update ${client.user?.username}'s Rich Presence.`)
   updateActivity(sanitisedActivity)

src/index.js

@@ -4,7 +4,15 @@ module.exports = Joi.object({
   applicationId: Joi.string().regex(/^\d+$/).label('Application ID').required(),
   activity: Joi.object({
     details: Joi.string().min(2).max(128).label('Details'),
+    detailsUrl: Joi.string()
+      .uri({ scheme: ['http', 'https'] })
+      .max(512)
+      .label('Details Url'),
     state: Joi.string().min(2).max(128).label('State'),
+    stateUrl: Joi.string()
+      .uri({ scheme: ['http', 'https'] })
+      .max(512)
+      .label('State Url'),
     party: Joi.object({
       partySize: Joi.number().min(1).label('Party Size'),
       partyMax: Joi.number().min(Joi.ref('partySize')).label('Party Max'),
@@ -16,8 +24,16 @@ module.exports = Joi.object({
     assets: Joi.object({
       largeImageKey: Joi.string().min(1).max(256).label('Large Image Key'),
       largeImageText: Joi.string().min(2).max(128).label('Large Image Text'),
+      largeImageUrl: Joi.string()
+        .uri({ scheme: ['http', 'https'] })
+        .max(512)
+        .label('Large Image Url'),
       smallImageKey: Joi.string().min(1).max(256).label('Small Image Key'),
       smallImageText: Joi.string().min(2).max(128).label('Small Image Text'),
+      smallImageUrl: Joi.string()
+        .uri({ scheme: ['http', 'https'] })
+        .max(512)
+        .label('Small Image Url'),
     }),
     buttons: Joi.object({
       primary: Joi.object({
@@ -51,7 +67,8 @@ module.exports = Joi.object({
         return value
       }),
     }),
-    type: Joi.number().valid(0, 2, 3, 5).label('Type').required(),
+    type: Joi.number().valid(0, 2, 3, 5).label('Activity Type').required(),
+    statusDisplayType: Joi.number().valid(0, 1, 2).label('Status Display Type'),
   }),
   connection: Joi.object({
     maxRetries: Joi.number().min(0).label('Maximum Retries').required(),