Mtasa-blue: Discord Rich Presence

[EstebanQ33]

It would be good to know which server my friends are on, and to be able to enter through discord, and know the played time.

[botder]

I tried implementing Discord Rich Presence, but Discord would still show the presence after quitting the game sometimes. Please use Feature request issue template next time.

[Wolfee-J]

You gotta send a signal that tells discord the game has ended when the client disconnects / game closes.

[humenius]

Is there still something going on or is there a possibility to contribute to solving this issue?

[FernandoMTA]

PLEASE implement Discord Rich Presence for MTA! It would be amazing. Definitely worth coding.

[humenius]

PLEASE implement Discord Rich Presence for MTA! It would be amazing. Definitely worth coding.

Well, in case there's not much movement and as it hasn't high priority, I'd like to take a look at it. Can't say any ETA right now.

[qaisjp]

Go for it! Might be worth expanding on or taking a look at https://github.com/botder/mtasa-blue/tree/feature/discord-richpresence

It's also worth sharing your ideas here before implementing them.

[humenius]

Go for it! Might be worth expanding on or taking a look at https://github.com/botder/mtasa-blue/tree/feature/discord-richpresence

It's also worth sharing your ideas here before implementing them.

Sure. Gotta take a look at the repo you've provided. Sorry in advance for my lacking experience in c++. Just in case you can take a look at it and suggest any improvements.

[humenius]

Go for it! Might be worth expanding on or taking a look at https://github.com/botder/mtasa-blue/tree/feature/discord-richpresence

It's also worth sharing your ideas here before implementing them.

@qaisjp
Can I simply merge their branch to my fork?

[qaisjp]

Can I simply merge their branch to my fork?

@dopauthor: not exactly merging:

# Pull botder's branch into your own local repository
git fetch https://github.com/botder/mtasa-blue feature/discord-richpresence:feature/discord-richpresence

# Checkout the feature branch
git checkout feature/discord-richpresence

# Push that up to your own
git push

For help with pushing to your own fork (the final step), please read this page.

[humenius]

Do I need any additional extension in order to solve these CMake errors?

Also, in core/CDiscordRichPresence.cpp

void CDiscordRichPresence::SetServerPresence(bool bOutdatedServer)
{
    if (bOutdatedServer)
    {
        // TODO: Read server name and player limit from server query protocol
    }

    m_PresenceState = ePresenceState::ON_SERVER;
    m_tPresenceTime = std::time(nullptr);
    UpdatePresence();
}

At TODO, isn't just using the last host and port and retrieving the server infomation through CServerBrowser enough?

[humenius]

Any updates on this one or is this issue rather in the "backlog"?

[qaisjp]

I do not know why you are getting this error. Are you using Visual Studio or VS Code?

At TODO, isn't just using the last host and port and retrieving the server infomation through CServerBrowser enough?

As for your TODO, at the moment I do not know the best way to retrieve this information. Your suggestion might work, but this might also be synced to the client. Maybe there's a client command that pulls out this information (something like sinfo maybe)?

[humenius]

I do not know why you are getting this error. Are you using Visual Studio or VS Code?

At TODO, isn't just using the last host and port and retrieving the server infomation through CServerBrowser enough?

As for your TODO, at the moment I do not know the best way to retrieve this information. Your suggestion might work, but this might also be synced to the client. Maybe there's a client command that pulls out this information (something like sinfo maybe)?

I was using Visual Studio. Could possibly be that some stuff of it is on an other directory as I do not have much space left on my main drive.

[patrikjuvonen]

How are you trying to build MTA?
Also did you install some form of CMake with Visual Studio?
Curl should not contain CMakeLists.txt anymore so you must have an outdated branch or outdated local version. Try pulling the latest master into your branch.

[humenius]

How are you trying to build MTA?

I haven't build anything yet. I just simply opened the project with Visual Studio.

Also did you install some form of CMake with Visual Studio?

I'm not sure about CMake, because I haven't seen any options or anything during the installation where I could select it.

Curl should not contain _CMakeLists.txt_ anymore so you must have an outdated branch or outdated local version. Try pulling the latest master into your branch.

I actually merged the latest master to my branch. Maybe I have to try that again.

//EDIT: Also, are there any must-have packages? I even get errors when compiling the project which seem like that for some reason the included libraries aren't recognized.

[mehrangta]

Is it gonna be added ?

[qaisjp]

It's in the Backlog, so it's something we would _like_ to implement - we plan to include it in the future. It's not an urgent feature nor something that is guaranteed to happen.

[humenius]

It's in the Backlog which means that this feature hasn't got a high priority. I'm also kind of waiting for an answer and I can't do anything, as the whole stuff won't build even though I have installed the dependencies listes on the wiki.

---

From: Mehran UX [e-mail]
Sent: Friday, May 10, 2019 8:10:18 AM
To: multitheftauto/mtasa-blue
Cc: dopauthor; Mention
Subject: Re: [multitheftauto/mtasa-blue] Discord Rich Presence (#721)

Is it gonna be added ?

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHubhttps://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fmultitheftauto%2Fmtasa-blue%2Fissues%2F721%23issuecomment-491168842&data=02%7C01%7C%7C5958680060244fac626608d6d50e2ebf%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636930654216636469&sdata=MBJpVoFCC%2Ftokey7KGFtDv%2BZQ3Hj4ygImB5bLwBcFhE%3D&reserved=0, or mute the threadhttps://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FABYIHYPWZRSBUI2HCONY7NDPUUGUVANCNFSM4GHT65XQ&data=02%7C01%7C%7C5958680060244fac626608d6d50e2ebf%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C636930654216646474&sdata=qnQBbMbfo8xSA9wwiQvgbwsa8m0RmSe3q0tIe59WCII%3D&reserved=0.

[qaisjp]

Please can you join Discord and share your build issues in #development? We're happy to help you out there.

If you would prefer not to use Discord, feel free to open an issue describing your actions + errors, and we will try to lend you a hand.

[humenius]

Sure. I completely forgot about Discord. I'll join it as soon as I can.

Thanks!

[humenius]

So appearently, my compiling problems just disappeared and everything seems working fine.
I just updated from VS 2017 to 2019 and seems it did the job.

I do not know why you are getting this error. Are you using Visual Studio or VS Code?

At TODO, isn't just using the last host and port and retrieving the server infomation through CServerBrowser enough?

As for your TODO, at the moment I do not know the best way to retrieve this information. Your suggestion might work, but this might also be synced to the client. Maybe there's a client command that pulls out this information (something like sinfo maybe)?

As far as I remember, using the command sinfo doesn't display the server host name.

About using CServerBrowser: If somebody connects to a server, is the server item added to the recent list even if connection was not successful? Perhaps you could iterate through the recent list and look up for the CServerListItem which matches with the address of the server we're trying to get the server name from.
But it doesn't really seem like an elegant solution as if your recent list is very huge, it will take up time to get the server name.

[0x416c69]

Just so you know, I'm implementing it (well, it's done actually and will make PR at any moment)

Edit: I didn't notice that branch when I was making it and what I made is different, scripters are allowed to change parameters and it's unlike that branch, it's totally different.

[qaisjp]

That's great to hear, @0x416c69! Are you on the [MTA Discord] as well?

scripters are allowed to change parameters

Sounds good, but we may have to be a little careful here for a couple of reasons, one of which is that our client_id would end up being used and we can't moderate server scripts.

I look forward to your PR so we can discuss your work. In the future I'd recommend you to speak with us first — the last thing we want is you working on features and it not being accepted!

[botder]

IMO, servers shouldn't be able to display any text they want in my Discord presence text.

[0x416c69]

Yes. and I already announced it on #development

Is there a reason why scripters should not control discord rich presence? Is there any terms about it on discord to violate by rpc texts? We can also allow them to have their own client_id which is already done by some other mods. (But I don't recommend this because scripters can go entirely incognito and some people won't find out it's even MTA:SA unless we take "details" and set it to Multi Theft Auto everytime they update the parameters)

As MTA:SA is highly scriptable I think it's best to let scripters control _some texts_, what I think is scripters should be able to configure these parameters:

Images are controlled by MTA, also the Rich Presence Text cannot be set.

Also you should know that there is more to Discord Game SDK but I haven't implemented it all.

Edit: @botder How about some user settings to 1. disallow certain servers from controlling your Discord Rich Presence (Something like user blacklist) 2. just disallow every server and use MTA's default 3. just disable the whole system?
Also instead of making a blacklist we can make a whitelist so the server asks the user to allow changing rich presence?

[humenius]

Any chance that you're allowed to view the changes you made before PR or is it private?

[0x416c69]

@humenius local repo, not yet pushed

[humenius]

Ah, okay. Well, I was trying to do something there too but well, it sort of went into background. Gotta look for something else then to work on.

[qaisjp]

I think initially it would be good to have basic MTA rich presence and then we can iterate / see where to go from there.

What do you have in mind for the "joinSecret" feature?

Note that spectate will not be possible (esp. during our first iteration) because it requires special approval from Discord, and there are a couple Discord rules there.

Obviously we wouldn't want servers to _abuse_ the details/state feature—maybe sometime in the future we could an approval process for servers, but there does not seem to be a consensus right now.

[0x416c69]

Discord users can click "Join" on the invitation. Their game will then launch, and the joinGame() callback will fire in their client with the inviting player's joinSecret. The client should reverse hash or otherwise unencrypt this secret and match the players together.

Well there should be a client-sided function which allows scripters to set joinSecret containing some data that they need in order to handle clients who is invited by a user (or clicked on Join button of that user in Discord), joinSecret should be internally combined with ip address to connect when MTA:SA launches, this can be useful for some scripters who got groups or party or sections in their server, for example a PUBG server can use it to invite users and when they accept his invite or join him the server will find out which team the invited player should be joined to using that joinSecret.

Yes, I'm aware that spectate feature needs approval which is not that hard to achieve though. My friend got his game approved easily and fast but as this is a modification and not an entirely a game I'm not sure about it but I implemented it anyways.

Alright then, I'll revert those features and will make a PR of a basic rich presence just like how it's done in https://github.com/botder/mtasa-blue/tree/feature/discord-richpresence

Edit: I need your approval before merging that joinSecret feature thing, it will require an event and a function in client side.

[0x416c69]

That basic rich presence implementation, there's an issue with backward compatibility on server.
MTA:SA does not share players slot (maxPlayers) within clients, I've handled server name with querying server within join (Which made me to clean up CServerListItem and making a new class called CQueryReceiver) but there is no way to receive maxPlayers for only once, it's modifiable using setMaxPlayers and there are couple of ways to handle this:

1. Query the server every 15sec and receive data from there which is NOT RECOMMENDED
2. RakPeer::GetMaximumNumberOfPeers from netc.dll (It's possible from the client right? I'm not sure I didn't test it)
3. Check the server version, if it's updated enough it won't query the server every 15sec and instead server will notify the client for maxPlayers update, else query every 15sec.

Second way is the best way if it's possible.

[qaisjp]

The joinSecret feature seems good, and I give preliminary approval (I like the idea), but we need more information about the event and function

Yes, I'm aware that spectate feature needs approval which is not that hard to achieve though. My friend got his game approved easily and fast but as this is a modification and not an entirely a game I'm not sure about it but I implemented it anyways.

Okay. I'll get in touch with Discord. In this case I would rather we ask for permission from Discord rather than forgiveness. It may be that we need to introduce a second approval layer (so that only certain servers can use the spectate feature).

That basic rich presence implementation, there's an issue with backward compatibility on server. [...]

I think the best solution is to just:

• make the server send this max player information to the client on connect/join
• make setMaxPlayers resend this information

This would make it possible to implement getMaxPlayers client side. We could maybe get this simple feature (getMaxPlayers) in before 1.5.7, which is just around the corner.

For "new" clients connecting to "old" servers (i.e. connecting to servers that don't send the max player information), we could just omit partySize and partyMax?

[0x416c69]

The event should be simple: onClientDiscordJoin(secretData) and the function: setJoinInfo(secretData, partySize, partyMax)

partySize and partyMax should be controlled by joining/inviting feature and player count is what I'm putting in "state" parameter, but yeah we can omit it.

[qaisjp]

Can you elaborate on why onClientDiscordJoin(secretData) should be a _client_ event?

I'm thinking only the server needs to know (and server scripts can trigger events to clients as necessary).

[0x416c69]

It shouldn't have to be a client event, but it's going through client, we can do shared events or just server but yeah in any way client needs to communicate with server about this secretData.

[qaisjp]

but it's going through client

is client here the user in the sidebar, or the user that has clicked "join game"?

[0x416c69]

The user that has clicked "join game".
Also partyID needs to be set.
https://discordapp.com/developers/docs/game-sdk/activities#activity-action-field-requirements-requirements

[qaisjp]

I was thinking that the MTA client will decode this secret data to decide which server to join, and the remaining data will be sent to the server, accessible via onPlayerJoin (_and/or_ onPlayerConnect).

What are your thoughts on that?

[0x416c69]

Yeah, that's perfect.

I'll get onto it then.

[qaisjp]

Done in #1031.