options reorganized

Author: BlueWitherer

CONTRIBUTING.md

@@ -6,6 +6,49 @@ You're free to fork our repository and [open a pull request](../../pulls/) if yo
 
 Before opening or marking your pull request as ready for review, please be sure to test your build and make sure it is stable and not conflicting with the upstream repository. Try not to diverge from our current code styling and practices in your fork.
 
+### Guidelines
+This section mainly covers contributions for new options to Horrible Menu. For other pull requests, we simply ask that you justify your changes in detail when opening your request.
+
+Every whole word in an option ID must be separated specifically by underscores (`_`), to keep things consistent!
+```txt
+your_option
+```
+
+Always define a `THIS_ID` macro in an option's source file to keep things consistent and maintainable in case things change.
+```cpp
+#define THIS_ID "your_option"
+```
+
+If you create your own option for the mod, we recommend adding your name to the end of the description with the following format.
+```txt
+created by {your preferred name}
+```
+Or, if it's someone else's idea, use this format.
+```txt
+suggested by {their preferred name}
+```
+
+> [!INFO]
+> Your credits in the in-game credits pop-up will be automatically added by our maintainers if deemed meaningful enough - at least one functional option should qualify. Please refrain from modifying that code! We'll make sure your contribution(s) is/are credited appropriately!
+
+Keep includes clean, make sure your IDE isn't configured to automatically add them, or things start to look messy!
+```cpp
+// Include internal utility headers
+#include <Utils.h>
+
+// Include Geode headers
+#include <Geode/Geode.hpp>
+
+// Whatever layer(s) are being hooked
+#include <Geode/modify/PlayerObject.hpp>
+
+// Include namespaces
+using namespace geode::prelude;
+using namespace horrible::prelude;
+
+// Then get to writing!
+```
+
 ## Reporting Issues
 If you found a bug or want to make a suggestion, you're welcome to [open an issue](../../issues/) describing your case. Please be sure to provide as many details as possible. If you're having issues with crashing, please always provide a crashlog.
 

src/hooks/PlayerObject/DoubleJump.cpp src/hooks/DoubleJump.cppsrc/hooks/PlayerObject/DoubleJump.cpp renamed to src/hooks/DoubleJump.cpp

@@ -23,14 +23,6 @@ class $modify(DoubleJumpPlayerObject, PlayerObject) {
         int m_jumps = 0;
     };
 
-    bool init(int player, int ship, GJBaseGameLayer* gameLayer, CCLayer* layer, bool playLayer) {
-        if (!PlayerObject::init(player, ship, gameLayer, layer, playLayer)) return false;
-
-        auto f = m_fields.self();
-
-        return true;
-    };
-
     bool pushButton(PlayerButton p0) {
         auto f = m_fields.self();
 

src/hooks/PlayLayer/Gambler.cpp src/hooks/Gambler.cppsrc/hooks/PlayLayer/Gambler.cpp renamed to src/hooks/Gambler.cpp

@@ -10,7 +10,7 @@ using namespace horrible::prelude;
 #define THIS_ID "gambler"
 
 static auto const o = Option::create(THIS_ID)
-                          ->setName("Gambler")
+                          ->setName("Ending Gamble")
                           ->setDescription("When reaching 95% in a level, you have a chance at randomly being blasted way far back.\n<cl>suggested by Timered</c>")
                           ->setCategory(category::misc)
                           ->setSillyTier(SillyTier::Medium)
@@ -39,15 +39,15 @@ class $modify(GamblerPlayLayer, PlayLayer) {
 
     // ensure that triggered is reset on level restart/full reset
     void fullReset() {
+        PlayLayer::fullReset();
         m_fields->triggered = false;
         log::debug("gambler full reset");
-        PlayLayer::fullReset();
     };
 
     void resetLevel() {
+        PlayLayer::resetLevel();
         m_fields->triggered = false;
         log::debug("gambler level reset");
-        PlayLayer::resetLevel();
     };
 
     void gamblerCheck(float) {
@@ -57,23 +57,30 @@ class $modify(GamblerPlayLayer, PlayLayer) {
         // detect the moment the player first reaches or crosses 95
         if (percentage == 95 && !f->triggered) {
             // roll a random number between 0 and 1
-            int roll = randng::fast() % 2;
+            int roll = randng::get(1);
 
             log::info("Gambler roll: {}", roll);
             if (roll == 0) {
                 log::info("Gambler lost the bet!");
 
+                sfx::play(sfx::file::pop);
+                Notification::create("Unlucky!", NotificationIcon::Error)->show();
+
                 // reverse the player
                 m_player1->reversePlayer(nullptr);
                 m_player1->m_gravity = 0.01f;  // reduce gravity to simulate a bounce
 
                 // force player to jump
-                GJBaseGameLayer::get()->handleButton(true, 1, true);
+                if (auto gjbgl = GJBaseGameLayer::get()) gjbgl->handleButton(true, 1, true);
 
                 f->triggered = true;
                 f->tricked = true;
             } else {
                 log::info("Gambler won the bet! instant win.");
+
+                sfx::play(sfx::file::good);
+                Notification::create("You got lucky this time...", NotificationIcon::Success)->show();
+
                 levelComplete();
                 f->triggered = true;
             };

src/hooks/PlayerObject/OnIce.cpp src/hooks/OnIce.cppsrc/hooks/PlayerObject/OnIce.cpp renamed to src/hooks/OnIce.cpp

@@ -31,16 +31,13 @@ class $modify(SleepyPlayerObject, PlayerObject) {
     bool init(int player, int ship, GJBaseGameLayer* gameLayer, CCLayer* layer, bool playLayer) {
         if (!PlayerObject::init(player, ship, gameLayer, layer, playLayer)) return false;
 
-        auto f = m_fields.self();
-
-        if (playLayer) scheduleOnce(schedule_selector(SleepyPlayerObject::asleep), randng::get(30.f, 5.f) * chanceToDelayPct(f->chance));
+        if (playLayer) scheduleOnce(schedule_selector(SleepyPlayerObject::asleep), randng::get(30.f, 5.f) * chanceToDelayPct(m_fields->chance));
 
         return true;
     };
 
     void startSleepTimer(float) {
-        auto f = m_fields.self();
-        scheduleOnce(schedule_selector(SleepyPlayerObject::wakeUpSchedule), randng::get(15.f, 3.f) * chanceToDelayPct(f->chance));
+        scheduleOnce(schedule_selector(SleepyPlayerObject::wakeUpSchedule), randng::get(15.f, 3.f) * chanceToDelayPct(m_fields->chance));
     };
 
     void wakeUpSchedule(float) {

src/hooks/PlayerObject/Sleepy.cpp src/hooks/Sleepy.cppsrc/hooks/PlayerObject/Sleepy.cpp renamed to src/hooks/Sleepy.cpp

@@ -10,9 +10,9 @@ using namespace horrible::prelude;
 #define THIS_ID "pauses"
 
 static auto const o = Option::create(THIS_ID)
-                          ->setName("Random Pauses")
+                          ->setName("Random Pause Chance")
                           ->setDescription("While playing a level, it will randomly pause itself.\n<cl>suggested by DragonixGD</c>")
-                          ->setCategory(category::randoms)
+                          ->setCategory(category::chances)
                           ->setSillyTier(SillyTier::Low)
                           ->autoRegister();
 

src/hooks/PlayerObject/Sticky.cpp src/hooks/Sticky.cppsrc/hooks/PlayerObject/Sticky.cpp renamed to src/hooks/Sticky.cpp

@@ -10,9 +10,9 @@ using namespace horrible::prelude;
 #define THIS_ID "random_mirror"
 
 static auto const o = Option::create(THIS_ID)
-                          ->setName("Random Mirror Portal")
+                          ->setName("Random Mirror Chance")
                           ->setDescription("Randomly activates a mirror portal while playing.\n<cl>suggested by TimeRed</c>")
-                          ->setCategory(category::randoms)
+                          ->setCategory(category::chances)
                           ->setSillyTier(SillyTier::Low)
                           ->autoRegister();