From acf11d25f209e3a8f43310f1ce0f38355ebc4c9e Mon Sep 17 00:00:00 2001 From: Ben Carter Date: Wed, 11 Dec 2024 15:41:36 -0500 Subject: [PATCH] Added information about the data channel used for client to server communication. --- src/MythicPlus.h | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/src/MythicPlus.h b/src/MythicPlus.h index 335173f..e35a51c 100644 --- a/src/MythicPlus.h +++ b/src/MythicPlus.h @@ -15,6 +15,31 @@ #include #include +/** + * In order to allow communication from client UIs without modifying mod-eluna directly to support + * this mods functionality the following custom chat channel below is for all MP UI Client interactions. + * + * It uses a very basic plaintext encoding of messages: + * -- Group Action Calls + * g:groupId:action:input1:input2:input3... + * -- Player Action Calls + * p:playerGuid:action:input1:input2:input3... + * i.e) p:5793:UpgradeAdvancement:0:10:2 (For player 5793 call UpgradeAdvancement for Strength to rank 10, using dice cost level 2) + * + * -- World Action Calls + * w:action:input1:input2... + */ +inline const std::string_view MP_DATA_CHAT_CHANNEL = "MPEx"; + +/** + * Main Class for the mod responsible for controls related to scaling instances, + * handling logic related to setting up instances for MythicPlus to work. + * + * MpDataStore is heavily used as well for storing data in memory and interactions with + * database storage. + * + * This is a singleton instance that can be accessed through sMythicPlus. + */ class MythicPlus { public: