Implement Discord Social SDK to display rich presence for the user. Enabled by default, includes option to disable.

Author: Koi-3088

3rdParty/discord_social_sdk/cdiscord.h

@@ -16,6 +16,10 @@ set(CMAKE_AUTOMOC ON)
 set(CMAKE_AUTORCC ON)
 set(CMAKE_AUTOUIC ON)
 
+# Set root dir for convenience
+set(PROJECT_ROOT_DIR "${CMAKE_SOURCE_DIR}/..")
+get_filename_component(PROJECT_ROOT_DIR "${CMAKE_SOURCE_DIR}/.." ABSOLUTE)
+
 add_custom_target(build-time-make-directory ALL
     COMMAND ${CMAKE_COMMAND} -E make_directory Assembly/)
 
@@ -732,6 +736,8 @@ file(GLOB MAIN_SOURCES
     Source/Integrations/DiscordWebhookSettings.h
     Source/Integrations/DppIntegration/DppClient.cpp
     Source/Integrations/DppIntegration/DppClient.h
+    Source/Integrations/DiscordSocial/DiscordSocial.cpp
+    Source/Integrations/DiscordSocial/DiscordSocial.h
     Source/Integrations/DppIntegration/DppCommandHandler.cpp
     Source/Integrations/DppIntegration/DppCommandHandler.h
     Source/Integrations/DppIntegration/DppUtility.cpp
@@ -2450,12 +2456,17 @@ if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/../../Internal/SerialPrograms/Internal0.
     target_sources(SerialPrograms PRIVATE ../../Internal/SerialPrograms/Internal1.cpp)
 endif()
 
-#extract opencv_world4110d.dll from archive on Windows Debug builds
+#extract opencv_world4110d.dll from archive on Windows Debug build, extract Discord Social SDK
 if (WIN32)
     file(ARCHIVE_EXTRACT
       INPUT ${CMAKE_CURRENT_SOURCE_DIR}/../3rdPartyBinaries/opencv_world4110d.zip
       DESTINATION ${CMAKE_CURRENT_SOURCE_DIR}/../3rdPartyBinaries/
     )
+
+    file(ARCHIVE_EXTRACT
+      INPUT ${CMAKE_CURRENT_SOURCE_DIR}/../3rdPartyBinaries/discord_social_sdk.zip
+      DESTINATION ${CMAKE_CURRENT_SOURCE_DIR}/../3rdPartyBinaries/
+    )
 endif()
 
 #add include directory
@@ -2504,29 +2515,44 @@ if (WIN32)
 
     add_library(dpp_lib IMPORTED UNKNOWN)
     set_target_properties(dpp_lib PROPERTIES
-        IMPORTED_LOCATION_RELEASE ${CMAKE_CURRENT_SOURCE_DIR}/../3rdPartyBinaries/dpp.lib
-        IMPORTED_LOCATION_DEBUG ${CMAKE_CURRENT_SOURCE_DIR}/../3rdPartyBinaries/dppd.lib)
+        IMPORTED_LOCATION_RELEASE   ${CMAKE_CURRENT_SOURCE_DIR}/../3rdPartyBinaries/dpp.lib
+        IMPORTED_LOCATION_DEBUG     ${CMAKE_CURRENT_SOURCE_DIR}/../3rdPartyBinaries/dppd.lib)
     set_target_properties(dpp_lib PROPERTIES
         MAP_IMPORTED_CONFIG_DEBUG           DEBUG
         MAP_IMPORTED_CONFIG_RELEASE         RELEASE
         MAP_IMPORTED_CONFIG_RELWITHDEBINFO  RELEASE
         MAP_IMPORTED_CONFIG_MINSIZEREL      RELEASE
     )
 
+    add_library(discord_lib IMPORTED UNKNOWN)
+    target_include_directories(SerialPrograms SYSTEM PRIVATE ../3rdParty/discord_social_sdk/)
+    set_target_properties(discord_lib PROPERTIES
+        IMPORTED_LOCATION_RELEASE   ${CMAKE_CURRENT_SOURCE_DIR}/../3rdPartyBinaries/discord_social_sdk/lib/release/discord_partner_sdk.lib
+        IMPORTED_LOCATION_DEBUG     ${CMAKE_CURRENT_SOURCE_DIR}/../3rdPartyBinaries/discord_social_sdk/lib/debug/discord_partner_sdk.lib)
+    set_target_properties(discord_lib PROPERTIES
+        MAP_IMPORTED_CONFIG_DEBUG           DEBUG
+        MAP_IMPORTED_CONFIG_RELEASE         RELEASE
+        MAP_IMPORTED_CONFIG_RELWITHDEBINFO  RELEASE
+        MAP_IMPORTED_CONFIG_MINSIZEREL      RELEASE
+    )
+
     target_link_libraries(
         SerialPrograms PRIVATE
         tesseractPA.lib
         OpenCV_lib
         ONNX_lib
         ONNX_Providers_lib
         dpp_lib
+        discord_lib
     )
+
     target_compile_definitions(
         SerialPrograms PRIVATE
         _CRT_SECURE_NO_WARNINGS
         _DISABLE_CONSTEXPR_MUTEX_CONSTRUCTOR
         PA_TESSERACT
         PA_DPP
+        PA_SOCIAL_SDK
     )
 
     target_compile_options(SerialPrograms PRIVATE /FAs /FaAssembly/ /MP /W4 /WX /external:anglebrackets /external:W0 /utf-8)
@@ -2771,6 +2797,16 @@ file(GLOB MY_DLLS
   "../3rdPartyBinaries/*.dll"
 )
 file(COPY ${MY_DLLS} DESTINATION ${CMAKE_CURRENT_BINARY_DIR})
+
+# Copy discord_social_sdk DLL based on build type
+add_custom_command(
+    TARGET SerialPrograms
+    POST_BUILD
+    COMMAND ${CMAKE_COMMAND} -E copy
+        $<IF:$<CONFIG:Debug>,"${PROJECT_ROOT_DIR}/3rdPartyBinaries/discord_social_sdk/bin/debug/discord_partner_sdk.dll","${PROJECT_ROOT_DIR}/3rdPartyBinaries/discord_social_sdk/bin/release/discord_partner_sdk.dll">
+        $<TARGET_FILE_DIR:SerialPrograms>/Binaries64/discord_partner_sdk.dll
+    COMMENT "Copying Discord SDK DLL to Binaries64"
+)
 endif()
 
 if (QT_MAJOR GREATER_EQUAL 6)

3rdParty/discord_social_sdk/discordpp.h

@@ -157,6 +157,11 @@ GlobalSettings::GlobalSettings()
             "online documentation"
         ) + ")</font>"
     )
+    , RICH_PRESENCE(
+        "<b>Enable Rich Presence:</b><br>Will display program activity and status under your Discord user.",
+        LockMode::UNLOCK_WHILE_RUNNING,
+        true
+    )
     , ALL_STATS(
         "<b>All Stats:</b><br>Include all-time stats for notifications.",
         LockMode::UNLOCK_WHILE_RUNNING,
@@ -223,6 +228,7 @@ GlobalSettings::GlobalSettings()
 #endif
 
     PA_ADD_STATIC(m_discord_settings);
+    PA_ADD_OPTION(RICH_PRESENCE);
     PA_ADD_OPTION(ALL_STATS);
     PA_ADD_OPTION(DISCORD);
 

3rdPartyBinaries/discord_social_sdk.zip

@@ -103,6 +103,7 @@ class GlobalSettings : public BatchOption, private ConfigOption::Listener{
     Pimpl<SleepSuppressOptions> SLEEP_SUPPRESS;
 
     SectionDividerOption m_discord_settings;
+    BooleanCheckBoxOption RICH_PRESENCE;
     BooleanCheckBoxOption ALL_STATS;
     Pimpl<Integration::DiscordSettingsOption> DISCORD;
 

SerialPrograms/CMakeLists.txt

@@ -5,6 +5,7 @@
 //#include <QTextStream>
 #include <QMessageBox>
 #include <Integrations/DppIntegration/DppClient.h>
+#include <Integrations/DiscordSocial/DiscordSocial.h>
 #include "Common/Cpp/Exceptions.h"
 #include "Common/Cpp/ImageResolution.h"
 #include "PersistentSettings.h"
@@ -115,6 +116,12 @@ int main(int argc, char *argv[]){
         discord_settings.on_config_value_changed(nullptr);
     }
 
+    if (GlobalSettings::instance().RICH_PRESENCE){
+#ifdef PA_SOCIAL_SDK
+        Integration::DiscordSocialSDK::DiscordSocial::instance().run();
+#endif
+    }
+
     set_working_directory();
 
     //  Run this asynchronously to we don't block startup.

SerialPrograms/Source/CommonFramework/GlobalSettingsPanel.cpp

@@ -0,0 +1,170 @@
+#ifdef PA_SOCIAL_SDK
+#define DISCORDPP_IMPLEMENTATION
+
+#include <thread>
+#include "DiscordSocial.h"
+#include "CommonFramework/Logging/Logger.h"
+#include "Integrations/ProgramTracker.h"
+#include "../../CommonFramework/GlobalSettingsPanel.h"
+
+using namespace discordpp;
+namespace PokemonAutomation{
+namespace Integration{
+namespace DiscordSocialSDK{
+
+DiscordSocial& DiscordSocial::instance(){
+    static DiscordSocial instance;
+    return instance;
+}
+
+void DiscordSocial::run(){
+    m_client = std::make_shared<Client>();
+    if (!m_client){
+        log("Failed to initialize DiscordSocialSDK.", "run()", LoggingSeverity::Error);
+        m_client.reset();
+        return;
+    }
+
+    m_client->SetApplicationId(m_app_id);
+    m_client->AddLogCallback([&](auto message, auto severity){
+        log(message, "Internal", severity);
+    }, m_log_level);
+
+    std::thread(&DiscordSocial::thread_loop, this).detach();
+}
+
+void DiscordSocial::thread_loop(){
+    log("Starting Discord Rich Presence update thread...", "thread_loop()", LoggingSeverity::Info);
+    m_running.store(true, std::memory_order_release);
+    m_activity = create_activity();
+    m_client->UpdateRichPresence(m_activity, [&](ClientResult result){
+        if (!result.Successful()){
+            log("Rich Presence initial update failed.", "thread_loop()", LoggingSeverity::Warning);
+        }
+    });
+
+    while (m_running.load(std::memory_order_relaxed)){
+        try{
+            if (!m_running.load(std::memory_order_relaxed) || !GlobalSettings::instance().RICH_PRESENCE){
+                break;
+            }
+
+            RunCallbacks();
+            update_rich_presence();
+            std::this_thread::sleep_for(std::chrono::seconds(1));
+        }catch (const std::exception& e){
+            log("Exception: " + std::string(e.what()), "thread_loop()", LoggingSeverity::Error);
+            break;
+        }
+    }
+
+    log("Discord Rich Presence update thread exiting...", "thread_loop()", LoggingSeverity::Info);
+    m_running.store(false, std::memory_order_release);
+    m_client.reset();
+}
+
+void DiscordSocial::update_rich_presence(){
+    try{
+        std::string details = m_activity.Details().value();
+        std::string state = m_activity.State().value();
+
+        discordpp::ActivityAssets assets{};
+        assets.SetLargeImage("rotom");
+        assets.SetLargeText("Pok\u00E9mon Automation");
+
+        for (const auto& item : ProgramTracker::instance().all_programs()){
+            switch (item.second.state) {
+                case ProgramState::RUNNING:{
+                    assets.SetSmallImage("running");
+                    assets.SetSmallText("Running");
+                    state = "Running"; 
+                    m_activity.SetAssets(assets); break;
+                }
+                case ProgramState::STOPPED:{
+                    assets.SetSmallImage("stopped");
+                    assets.SetSmallText("Stopped");
+                    state = "Stopped";
+                    m_activity.SetAssets(assets); break;
+                }
+                default: {
+                    assets.SetSmallImage("idle");
+                    assets.SetSmallText("Idle");
+                    state = "Idle";
+                    m_activity.SetAssets(assets); break;
+                }
+            }
+
+            if (item.second.program_name != details){
+                details = item.second.program_name;
+            }
+
+            m_timestamps.SetStart(std::chrono::duration_cast<std::chrono::seconds>(item.second.start_time.time_since_epoch()).count());
+        }
+
+        m_activity.SetTimestamps(m_timestamps);
+        m_activity.SetDetails(details);
+        m_activity.SetState(state);
+        m_client->UpdateRichPresence(m_activity, [&](ClientResult result){
+            if (!result.Successful()){
+                log("Rich Presence update failed.", "update_rp()", LoggingSeverity::Warning);
+            }
+        });
+    }catch (const std::exception& e){
+        log("Exception: " + std::string(e.what()), "update_rp()", LoggingSeverity::Error);
+        m_running.store(false, std::memory_order_release);
+    }
+}
+
+Logger& DiscordSocial::logger(){
+    static TaggedLogger logger(global_logger_raw(), "DiscordSocialSDK");
+    return logger;
+}
+
+void DiscordSocial::log(const std::string& message, const std::string& identity, const LoggingSeverity& severity){
+    if (severity < m_log_level){
+        return;
+    }
+
+    std::string log = identity + ": " + message;
+    Color color;
+    switch (severity){
+        case LoggingSeverity::Verbose: color = COLOR_GRAY; break;
+        case LoggingSeverity::Info: color = COLOR_CYAN; break;
+        case LoggingSeverity::Warning: color = COLOR_ORANGE; break;
+        case LoggingSeverity::Error: color = COLOR_MAGENTA; break;
+        default: color = COLOR_PURPLE; break;
+    };
+
+    logger().log(log, color);
+}
+
+Activity DiscordSocial::create_activity(){
+    Activity activity{};
+    activity.SetType(ActivityTypes::Playing);
+    activity.SetDetails("ComputerControl: Preparing to automate...");
+    activity.SetState("Idle");
+
+    ActivityButton button1{};
+    button1.SetLabel("Download from GitHub");
+    button1.SetUrl("https://github.com/PokemonAutomation/ComputerControl/releases/latest");
+    activity.AddButton(button1);
+
+    ActivityButton button2{};
+    button2.SetLabel("Join our Discord");
+    button2.SetUrl("https://discord.gg/pokemonautomation");
+    activity.AddButton(button2);
+
+    discordpp::ActivityAssets assets{};
+    assets.SetLargeImage("rotom");
+    assets.SetLargeText("Pok\u00E9mon Automation");
+    assets.SetSmallImage("idle");
+    assets.SetSmallText("Idle");
+    activity.Assets().emplace(assets);
+    return activity;
+}
+
+
+}
+}
+}
+#endif

SerialPrograms/Source/CommonFramework/GlobalSettingsPanel.h

@@ -0,0 +1,41 @@
+#pragma once
+#ifndef DISCORD_SOCIAL_H
+#define DISCORD_SOCIAL_H
+
+#include <atomic>
+#include <discord_social_sdk/discordpp.h>
+#include "Common/Cpp/AbstractLogger.h"
+
+namespace PokemonAutomation{
+namespace Integration{
+namespace DiscordSocialSDK{
+    class DiscordSocial{
+        public:
+            DiscordSocial() : m_running(false) {}
+            ~DiscordSocial(){
+                m_running.store(false, std::memory_order_release);
+                if (m_client) m_client.reset();
+            }
+
+            static DiscordSocial& instance();
+            void run();
+
+        private:
+            Logger& logger();
+            void log(const std::string& message, const std::string& identity, const discordpp::LoggingSeverity& severity);
+            discordpp::Activity create_activity();
+            void update_rich_presence();
+            void thread_loop();
+
+        private:
+            std::shared_ptr<discordpp::Client> m_client = nullptr;
+            std::atomic<bool> m_running;
+            const uint64_t m_app_id = 1406867596585865326;
+            discordpp::Activity m_activity;
+            discordpp::ActivityTimestamps m_timestamps{};
+            discordpp::LoggingSeverity m_log_level = discordpp::LoggingSeverity::Error;
+    };
+}
+}
+}
+#endif