api and some settings

Author: FireMario211

.gitignore

@@ -1,6 +1,8 @@
 build-linux/
 build-android/
 build-armv8/
+test/build-linux
+test/compile_commands.json
 .cache/
 #libs/
 libs.old/

CMakeLists.txt

@@ -35,6 +35,7 @@ file(GLOB SOURCES
     src/Settings/*.cpp
     src/Utils/*.cpp
     src/Styles/*.cpp
+    include/*.cpp
 )
 
 # Set up the mod binary
@@ -70,6 +71,10 @@ if (CMAKE_HOST_SYSTEM_NAME STREQUAL "Linux" AND WIN32)
 elseif(${GEODE_TARGET_PLATFORM} STREQUAL "Win32")
   target_link_libraries(${PROJECT_NAME} opengl32 ws2_32 Crypt32 Wldap32 Normaliz)
 endif()
+if (WIN32)
+  # Disable annoying warnings
+  target_compile_definitions(${PROJECT_NAME} PRIVATE _CRT_SECURE_NO_WARNINGS)
+endif()
 
 # Set up dependencies, resources, link Geode
 setup_geode_mod(${PROJECT_NAME})

README.md

@@ -66,6 +66,43 @@ __**Join the Discord and Follow the instructions to Receive your In-Game Perks!*
 ### Moderator Info
 * You can view a description of either the Moderator, Elder Moderator, or other badges users have by clicking on the badge itself on the profile!
 
+## API Usage
+Incase you want to utilize GDUtils for your Geode Mod, you can do so by using it's events!
+
+### Events 
+- `RateEvent` - For other mods wanting to "notify" the user through GDUtils. (You shouldn't use this as a listener)
+- `OnRate` - For checking when GDUtils gives out a rate notification. (You should use this only as a listener)
+
+### Example Code (Pushing out a notification)
+```cpp
+EventData data = {
+    true, // demon
+    2, // starsum
+    6, // stars
+    1, // rate (0 = unrated, 1 = featured, 2 = epic, 3 = legendary, 4 = mythic)
+    EventType::Rate, // type of notification
+    "Custom Notification!", // notification title
+    "GJ_square02.png", // sprite (MUST BE VALID OR WILL CRASH!)
+    "Tidal Wave", // level name
+    "By OniLinkGD", // level creator
+    0, // coins
+    false, // whether coins are verified
+    false // if its platformer
+}; // Level ID is optional
+GDUtils::Events::RateEvent::emit(data);
+```
+
+### Example Code (Listening for notification events from GDUtils)
+```cpp
+$execute {
+    new EventListener<EventFilter<GDUtils::Events::OnRate>>(+[](GDUtils::Events::OnRate* e) {
+        log::info("A rate event with the title {}", e->getTitle()); // A rate event with the title Small Daily Chest available!
+        return ListenerResult::Propagate;
+    });
+}
+```
+View the `test` directory if you want to view an example mod using the API.
+
 ## Libraries Used
 - [Geode](https://github.com/geode-sdk/geode)
 - [socket.io-client-cpp](https://github.com/socketio/socket.io-client-cpp)

changelog.md

@@ -1,6 +1,10 @@
 # Changelog
+## <cj>v1.4.0-beta.6</c> <cb>(2025-01-24)</c>
+* <cg>Added</c> an <cp>API</c> for GDUtils events and notifications!
+* <cy>Fixed</c> scale for demon placement if too large.
+
 ## <cj>v1.4.0-beta.5</c> <cb>(2024-12-09)</c>
-* <cg>Added</c> <cj>Force</c>gauntlet designs.
+* <cg>Added</c> <cj>Force</c> gauntlet designs.
 * <cy>Updated</c> preview icons button position.
 * <cy>Fixed</c> gauntlets positions where they are less than 3.
 

include/RateEvent.hpp

@@ -0,0 +1,74 @@
+#pragma once 
+
+#include <Geode/loader/Event.hpp>
+#include "Types.hpp"
+
+namespace GDUtils::Events {
+    class RateEvent : public geode::Event {
+    protected:
+        EventData m_eventData;
+    public:
+        RateEvent(EventData data) : m_eventData(data) {};
+
+        EventType getEventType() const { return m_eventData.type; };
+        std::string getLevelName() const { return m_eventData.level_name; };
+        int getLevelID() const { return m_eventData.level_id; };
+        static void emit(EventData data) {
+            RateEvent(data).post();
+        };
+        EventData getData() const { return m_eventData; };
+        static EventType intToType(int type) {
+            switch (type) {
+                default:
+                    return EventType::NA;
+                case 0: // Rate
+                    return EventType::Rate;
+                case 1: // Daily
+                    return EventType::Daily;
+                case 2: // Weekly
+                    return EventType::Weekly;
+                case 3: // Small chest
+                    return EventType::smallChest;
+                case 4: // Large chest
+                    return EventType::largeChest;
+                case 5: // List
+                    return EventType::List;
+                case 6: // Event
+                    return EventType::Event;
+            }
+        }
+        static int typeToInt(EventType type) {
+            switch (type) {
+                case EventType::NA:
+                    return -1;
+                case EventType::Rate: // Rate
+                    return 0;
+                case EventType::Daily: // Daily
+                    return 1;
+                case EventType::Weekly: // Weekly
+                    return 2;
+                case EventType::smallChest: // Small chest
+                    return 3;
+                case EventType::largeChest: // Large chest
+                    return 4;
+                case EventType::List: // List
+                    return 5;
+                case EventType::Event: // Event
+                    return 6;
+            }
+        }
+    };
+
+    class OnRate : public geode::Event {
+    protected:
+        EventData m_eventData;
+    public:
+        OnRate(EventData data) : m_eventData(data) {};
+
+        std::string getTitle() const { return m_eventData.title; };
+        EventType getEventType() const { return m_eventData.type; };
+        std::string getLevelName() const { return m_eventData.level_name; };
+        int getLevelID() const { return m_eventData.level_id; };
+        EventData getData() const { return m_eventData; };
+    };
+}

include/Types.hpp

@@ -0,0 +1,29 @@
+#pragma once 
+
+#include <Geode/Geode.hpp>
+enum EventType {
+    Rate,
+    Daily,
+    Weekly,
+    Event,
+    smallChest,
+    largeChest,
+    List,
+    NA
+};
+
+struct EventData {
+    bool demon;
+    uint8_t starsum;
+    uint8_t stars;
+    uint8_t rate;
+    EventType type;
+    std::string title;
+    std::string sprite;
+    std::string level_name;
+    std::string level_creator;
+    uint8_t coins;
+    bool verified_coins;
+    bool platformer;
+    int level_id = -1;
+};

mod.json

@@ -1,6 +1,6 @@
 {
-    "geode": "4.0.1",
-    "version": "v1.4.0-beta.5",
+    "geode": "4.2.0",
+    "version": "v1.4.0-beta.6",
     "gd": {
         "win": "2.2074",
         "mac": "2.2074",
@@ -27,6 +27,9 @@
             "importance": "required"
         }
     ],
+    "api": {
+        "include": [ "include/*.hpp" ]
+    },
     "tags": [
         "online",
         "enhancement",
@@ -243,6 +246,12 @@
             "type": "bool",
             "default": true
         },
+        "eventLevelInfo": {
+            "name": "Event Level Info",
+            "description": "Adds an info button to show the current event information!",
+            "type": "bool",
+            "default": true
+        },
         "misc-section": {
             "name": "Miscellaneous",
             "description": "This category is for any other feature for <cy>GDUtils</c>.\nYou can choose whether to <cy>enable</c> or <cy>disable</c> some options if you do not want them.",

src/Notifications/EventsPush.cpp

@@ -79,6 +79,47 @@ const char* getDifficultyIcon(int stars) {
     }
 }
 
+sio::message::ptr eventToSio(EventData eventData) {
+    sio::message::ptr data = sio::object_message::create();
+    data->get_map()["coins"] = sio::int_message::create(eventData.coins);
+    data->get_map()["verified_coins"] = sio::int_message::create(eventData.verified_coins);
+    data->get_map()["platformer"] = sio::int_message::create(eventData.platformer);
+    data->get_map()["title"] = sio::string_message::create(eventData.title);
+    data->get_map()["demon"] = sio::int_message::create(eventData.demon);
+    data->get_map()["type"] = sio::int_message::create(GDUtils::Events::RateEvent::typeToInt(eventData.type));
+    data->get_map()["stars"] = sio::int_message::create(eventData.stars);
+    data->get_map()["starsum"] = sio::int_message::create(eventData.starsum);
+    data->get_map()["level_name"] = sio::string_message::create(eventData.level_name);
+    data->get_map()["level_creator"] = sio::string_message::create(eventData.level_creator);
+    data->get_map()["sprite"] = sio::string_message::create(eventData.sprite);
+    data->get_map()["rate"] = sio::int_message::create(eventData.rate);
+    if (eventData.level_id != -1) {
+        data->get_map()["level_id"] = sio::int_message::create(eventData.level_id);
+    }
+    return data;
+}
+
+EventData sioToEvent(sio::message::ptr const& data) {
+    auto map = data->get_map();
+    EventData eventData;
+    eventData.coins = map["coins"]->get_int();
+    eventData.verified_coins = map["verified_coins"]->get_int() == 1;
+    eventData.platformer = map["platformer"]->get_int();
+    eventData.title = map["title"]->get_string();
+    eventData.demon = map["demon"]->get_int() == 1;
+    eventData.type = GDUtils::Events::RateEvent::intToType(map["type"]->get_int());
+    eventData.stars = map["stars"]->get_int();
+    eventData.starsum = map["starsum"]->get_int();
+    eventData.level_name = map["level_name"]->get_string();
+    eventData.level_creator = map["level_creator"]->get_string();
+    eventData.sprite = map["sprite"]->get_string();
+    eventData.rate = map["rate"]->get_int();
+    if (map.find("level_id") != map.end()) {
+        eventData.level_id = map["level_id"]->get_int();
+    }
+    return eventData;
+}
+
 void EventsPush::destroySelf() {
     auto scene = CCDirector::sharedDirector()->getRunningScene();
     auto layer = reinterpret_cast<CCLayer*>(scene->getChildByTag(1932));
@@ -426,29 +467,7 @@ bool EventsPush::init(sio::message::ptr const& data) {
     bool smallChest = Mod::get()->template getSettingValue<bool>("smallChest");
     bool largeChest = Mod::get()->template getSettingValue<bool>("largeChest");
     bool list = Mod::get()->template getSettingValue<bool>("newListRate");
-    switch (type) {
-        case 0: // Rate
-            eventType = EventType::Rate;
-            break;
-        case 1: // Daily
-            eventType = EventType::Daily;
-            break;
-        case 2: // Weekly
-            eventType = EventType::Weekly;
-            break;
-        case 3: // Small chest
-            eventType = EventType::smallChest;
-            break;
-        case 4: // Large chest
-            eventType = EventType::largeChest;
-            break;
-        case 5: // List
-            eventType = EventType::List;
-            break;
-        case 6: // Event
-            eventType = EventType::Event;
-            break;
-    }
+    eventType = GDUtils::Events::RateEvent::intToType(type);
     if (type == 0 && !newRate) {
         EventsPush::eventCompletedCallback(scene);
         return true;
@@ -909,6 +928,7 @@ void EventsPush::processNextEvent(CCScene* self) {
         processingEvents = true;
 
         auto layer = EventsPush::create(data);
+        GDUtils::Events::OnRate(sioToEvent(data)).post();
         // Set a callback function that will be called when the event is completed
         //layer->setEventCompletedCallback(std::bind(&EventsPush::eventCompletedCallback, this));
         self->addChild(layer);
@@ -922,3 +942,12 @@ void EventsPush::eventCompletedCallback(CCScene* self) {
     // Process the next event (if any)
     EventsPush::processNextEvent(self);
 }
+
+$execute {
+    new EventListener<EventFilter<GDUtils::Events::RateEvent>>(+[](GDUtils::Events::RateEvent* e) {
+        if (auto scene = CCScene::get()) {
+            EventsPush::pushRateLevel(scene, eventToSio(e->getData()));
+        }
+        return ListenerResult::Stop;
+    });
+}

src/Notifications/EventsPush.h

@@ -1,18 +1,9 @@
 #pragma once
 #include <Geode/Geode.hpp>
 #include <Geode/loader/Mod.hpp>
+#include "../../include/RateEvent.hpp"
 #include "../includes.h"
 using namespace geode::prelude;
-enum EventType {
-    Rate,
-    Daily,
-    Weekly,
-    Event,
-    smallChest,
-    largeChest,
-    List,
-    NA
-};
 
 class EventsPush : public CCLayer {
     protected:

src/Styles/EventLevelInformation.cpp

@@ -12,6 +12,8 @@ class $modify(EventPage, DailyLevelPage) {
 
         if (type != GJTimedLevelType::Event) return true;
 
+        if (!Mod::get()->template getSettingValue<bool>("eventLevelInfo")) return true;
+
         auto infoSpr = CCSprite::createWithSpriteFrameName("info_btn.png"_spr);
         auto infoBtn = CCMenuItemSpriteExtra::create(infoSpr, this, menu_selector(EventPage::onInfo));
 
@@ -111,4 +113,4 @@ void EventLevelInformation::onDownloadFail() {
 void EventLevelInformation::fadeLoadingCircle() {
     if (loading_circle == nullptr) return;
     loading_circle->fadeAndRemove();
-};
+};