Add Discord Rich Presence Support

TurboWarp / desktop

A better offline editor for Scratch 3.

https://desktop.turbowarp.org/

GNU General Public License v3.0

344 stars 71 forks source link

Add Discord Rich Presence Support #1000

Closed CubesterYT closed 1 month ago

CubesterYT commented 1 month ago

Adds support for Discord Rich Presence natively in TurboWarp Desktop.

https://github.com/TurboWarp/desktop/assets/78769806/66cab77a-8e14-4928-a43a-71014b69cc8f

At the moment, it's completely done, but here's some notes:

The Rich Presence uses a clientID, which I had to make to make this work. The Discord Developer Application I set up for it works perfectly for it, if you, Garbo, want to switch the client, then I can gladly give the steps to set it up, but as of now, it works as is.
I might be deciding on adding an option to not display that project title, as a sub dependent option to the Rich Presence option in settings, but I feel it too niche at the moment.

GarboMuffin commented 1 month ago

This will also need a privacy policy update

GarboMuffin commented 1 month ago

can you see if this still works for you after my changes

i dont see a reason to not put the project title there, as you should already be able to do effectively that by just registering it as a game in discord

CubesterYT commented 1 month ago

I've looked over the changes, it seems fine, and actually accomplishes some of the things I was trying to figure out as well, but I will test it soon.

LSPECTRONIZTAR commented 1 month ago

1000th pull request 🥳

CubesterYT commented 1 month ago

Okay, I've tested the changes so far, it's actually great, but I've come across some notable things:

The title of the Rich Presence simply says TurboWarp, unlike how I made it, which was titled as TurboWarp Desktop. The name is fetched from the registered app name from the developer app portal. It is fine as is, but it seems better to have Desktop in the name as well.
The Rich Presence updates quite slow, which makes sense, considering the 15 must have second delay, but it will look weird. One weird instance is the fact that the Rich Presence, if not within the refresh time, and the window closes, the Rich Presence lingers a bit till it updates itself, and removes. Forcing an update might work, but I won't know if that'll affect anything negatively.
There's an file you've added, which is called Rich Presence art, and seems to be unused? If it truly is, I'll remove it, if you allow.

GarboMuffin commented 1 month ago

The new file in art is useful if the discord application ever has to be recreated

The 15s delay is based on https://github.com/discord/discord-api-docs/blob/main/docs/rich_presence/How_To.md#updating-presence but from https://github.com/discord/discord-api-docs/blob/main/docs/game_sdk/Activities.md#updateactivity it sounds like we can afford to send it more often

CubesterYT commented 1 month ago

Alright, tested it, the smaller delay is perfectly fine now. I did some more brute force testing, It withstands against the previous issues. I'm guessing it's ready. I'll check everything one more time, in case something is missed.