Add initial Discord Game SDK Integration (#1031)

This is just Rich Presence & Join features for now.

* Add Discord Game SDK library

* Add shared part of discord game sdk integration

* Add client part of discord game sdk integration

* Add server part of discord game sdk integration

* Resolve conflicts created by 4244ec5

* Make changes/Correct mistakes according to reviews

* Move DISCORD_CLIENT_ID to CDiscordManager.cpp

* discord: change SetLargeImage asset key

* discord: change neutral activity message

* discord: add start timestamp to main menu

* discord: use time(&time_t)

* addendum to 1ef02be

* Minor style improvements

* Run format document/selection on changed files

* Remove unnecessary null check

* Add discord game sdk library

Also allow it through .gitignore

* Avoid code duplication and fix grammar when setting discord state

* Move UpdateDiscordState to CClientGame and avoid code duplication

* Addendum 009190e

* Disallow space character on setDiscordJoinParams
This avoids messup on argument parser

* update vendor

* Join secret is no longer used on argument parser

* Fix a minor mistake

* Use luaL_error

Also disallow to use party max than the max players value

* update out of date dll

* Add discord download script

* Link correct library

Also do not download discord again when it is already up to date

* Add discord dll to installer

* Update DISCORD_BASEURL

Co-authored-by: Qais Patankar <[email protected]>
Co-authored-by: Marek Kulik <[email protected]>

Author: 3 people

Client/core/CClientVariables.cpp

@@ -46,7 +46,7 @@ CConnectManager::~CConnectManager()
     g_pConnectManager = NULL;
 }
 
-bool CConnectManager::Connect(const char* szHost, unsigned short usPort, const char* szNick, const char* szPassword, bool bNotifyServerBrowser)
+bool CConnectManager::Connect(const char* szHost, unsigned short usPort, const char* szNick, const char* szPassword, bool bNotifyServerBrowser, const char* szSecret)
 {
     assert(szHost);
     assert(szNick);
@@ -100,6 +100,11 @@ bool CConnectManager::Connect(const char* szHost, unsigned short usPort, const c
     m_usPort = usPort;
     m_bSave = true;
 
+    if (szSecret)
+        m_strDiscordSecretJoin = szSecret;
+    else
+        m_strDiscordSecretJoin.clear();
+
     m_strLastHost = m_strHost;
     m_usLastPort = m_usPort;
     m_strLastPassword = m_strPassword;
@@ -489,3 +494,10 @@ void CConnectManager::OpenServerFirewall(in_addr Address, ushort usHttpPort, boo
         g_pCore->GetNetwork()->GetHTTPDownloadManager(EDownloadMode::CONNECT_TCP_SEND)->QueueFile(strDummyUrl, NULL, NULL, NULL, options);
     }
 }
+
+SString CConnectManager::GetJoinSecret()
+{
+    SString dummy = m_strDiscordSecretJoin;
+    m_strDiscordSecretJoin.clear();
+    return dummy;
+}

Client/core/CConnectManager.cpp

@@ -21,7 +21,7 @@ class CConnectManager
     CConnectManager();
     ~CConnectManager();
 
-    bool Connect(const char* szHost, unsigned short usPort, const char* szNick, const char* szPassword, bool bNotifyServerBrowser = false);
+    bool Connect(const char* szHost, unsigned short usPort, const char* szNick, const char* szPassword, bool bNotifyServerBrowser = false, const char* szSecret = nullptr);
     bool Reconnect(const char* szHost, unsigned short usPort, const char* szPassword, bool bSave = true);
 
     bool Abort();
@@ -34,6 +34,8 @@ class CConnectManager
 
     static bool StaticProcessPacket(unsigned char ucPacketID, class NetBitStreamInterface& bitStream);
 
+    SString GetJoinSecret();
+
     std::string    m_strLastHost;
     unsigned short m_usLastPort;
     std::string    m_strLastPassword;
@@ -52,6 +54,7 @@ class CConnectManager
     bool           m_bSave;
     time_t         m_tConnectStarted;
     bool           m_bHasTriedSecondConnect;
+    SString        m_strDiscordSecretJoin;
 
     GUI_CALLBACK* m_pOnCancelClick;
 

Client/core/CConnectManager.h

@@ -21,6 +21,7 @@
 #include "CModelCacheManager.h"
 #include "detours/include/detours.h"
 #include <ServerBrowser/CServerCache.h>
+#include "CDiscordManager.h"
 
 using SharedUtil::CalcMTASAPath;
 using namespace std;
@@ -34,7 +35,7 @@ SString       g_strJingleBells;
 template <>
 CCore* CSingleton<CCore>::m_pSingleton = NULL;
 
-CCore::CCore()
+CCore::CCore() : m_DiscordManager(new CDiscordManager())
 {
     // Initialize the global pointer
     g_pCore = this;
@@ -565,6 +566,9 @@ void CCore::SetConnected(bool bConnected)
 {
     m_pLocalGUI->GetMainMenu()->SetIsIngame(bConnected);
     UpdateIsWindowMinimized();            // Force update of stuff
+
+    if (bConnected) m_DiscordManager->RegisterPlay(true);
+    else ResetDiscordRichPresence();
 }
 
 bool CCore::IsConnected()
@@ -779,6 +783,7 @@ void CCore::ApplyHooks2()
             CCore::GetSingleton().CreateMultiplayer();
             CCore::GetSingleton().CreateXML();
             CCore::GetSingleton().CreateGUI();
+            CCore::GetSingleton().ResetDiscordRichPresence();
         }
     }
 }
@@ -1980,6 +1985,28 @@ uint CCore::GetMaxStreamingMemory()
     return m_fMaxStreamingMemory;
 }
 
+//
+// ResetDiscordRichPresence
+//
+void CCore::ResetDiscordRichPresence()
+{
+    time_t currentTime;
+    time(&currentTime);
+
+    // Set default parameters
+    SDiscordActivity activity;
+    activity.m_details = "In Main Menu";
+    activity.m_startTimestamp = currentTime;
+
+    m_DiscordManager->UpdateActivity(activity, [](EDiscordRes res) {
+        if (res == DiscordRes_Ok)
+            WriteDebugEvent("[DISCORD]: Rich presence default parameters reset.");
+        else
+            WriteErrorEvent("[DISCORD]: Unable to reset rich presence default parameters.");
+    });
+    m_DiscordManager->RegisterPlay(false);
+}
+
 //
 // OnCrashAverted
 //

Client/core/CCore.cpp

@@ -83,25 +83,26 @@ class CCore : public CCoreInterface, public CSingleton<CCore>
     ~CCore();
 
     // Subsystems (query)
-    eCoreVersion            GetVersion();
-    CConsoleInterface*      GetConsole();
-    CCommandsInterface*     GetCommands();
-    CConnectManager*        GetConnectManager() { return m_pConnectManager; };
-    CGame*                  GetGame();
-    CGUI*                   GetGUI();
-    CGraphicsInterface*     GetGraphics();
-    CModManagerInterface*   GetModManager();
-    CMultiplayer*           GetMultiplayer();
-    CNet*                   GetNetwork();
-    CXML*                   GetXML() { return m_pXML; };
-    CXMLNode*               GetConfig();
-    CClientVariables*       GetCVars() { return &m_ClientVariables; };
-    CKeyBindsInterface*     GetKeyBinds();
-    CMouseControl*          GetMouseControl() { return m_pMouseControl; };
-    CLocalGUI*              GetLocalGUI();
-    CLocalizationInterface* GetLocalization() { return g_pLocalization; };
-    CWebCoreInterface*      GetWebCore();
-    CTrayIconInterface*     GetTrayIcon() { return m_pTrayIcon; };
+    eCoreVersion              GetVersion();
+    CConsoleInterface*        GetConsole();
+    CCommandsInterface*       GetCommands();
+    CConnectManager*          GetConnectManager() { return m_pConnectManager; };
+    CGame*                    GetGame();
+    CGUI*                     GetGUI();
+    CGraphicsInterface*       GetGraphics();
+    CModManagerInterface*     GetModManager();
+    CMultiplayer*             GetMultiplayer();
+    CNet*                     GetNetwork();
+    CXML*                     GetXML() { return m_pXML; };
+    CXMLNode*                 GetConfig();
+    CClientVariables*         GetCVars() { return &m_ClientVariables; };
+    CKeyBindsInterface*       GetKeyBinds();
+    CMouseControl*            GetMouseControl() { return m_pMouseControl; };
+    CLocalGUI*                GetLocalGUI();
+    CLocalizationInterface*   GetLocalization() { return g_pLocalization; };
+    CWebCoreInterface*        GetWebCore();
+    CTrayIconInterface*       GetTrayIcon() { return m_pTrayIcon; };
+    CDiscordManagerInterface* GetDiscordManager() { return reinterpret_cast<CDiscordManagerInterface*>(m_DiscordManager.get()); }
 
     void SaveConfig(bool bWaitUntilFinished = false);
 
@@ -226,6 +227,8 @@ class CCore : public CCoreInterface, public CSingleton<CCore>
     uint GetMinStreamingMemory();
     uint GetMaxStreamingMemory();
 
+    void ResetDiscordRichPresence();
+
     SString GetConnectCommandFromURI(const char* szURI);
     void    GetConnectParametersFromURI(const char* szURI, std::string& strHost, unsigned short& usPort, std::string& strNick, std::string& strPassword);
     bool    bScreenShot;
@@ -296,6 +299,8 @@ class CCore : public CCoreInterface, public CSingleton<CCore>
     CWebCoreInterface* m_pWebCore = nullptr;
     CTrayIcon*         m_pTrayIcon;
 
+    std::unique_ptr<class CDiscordManager> m_DiscordManager;
+
     // Hook interfaces.
     CMessageLoopHook*        m_pMessageLoopHook;
     CDirectInputHookManager* m_pDirectInputHookManager;