Rando Alpha

mm/2s2h/BenGui/BenMenuBar.cpp

@@ -697,6 +697,7 @@ void DrawEnhancementsMenu() {
 
 void DrawCheatsMenu() {
     if (UIWidgets::BeginMenu("Cheats")) {
+        UIWidgets::CVarCheckbox("Rando", "gRando.Enabled");
         UIWidgets::CVarCheckbox("Infinite Health", "gCheats.InfiniteHealth");
         UIWidgets::CVarCheckbox("Infinite Magic", "gCheats.InfiniteMagic");
         UIWidgets::CVarCheckbox("Infinite Rupees", "gCheats.InfiniteRupees");

mm/2s2h/BenJsonConversions.hpp

@@ -20,16 +20,50 @@ void from_json(const json& j, DpadSaveInfo& dpadEquips) {
     }
 }
 
+void to_json(json& j, const RandoSaveInfoCheck& check) {
+    j = json{
+        { "item", check.item },
+        { "eligible", check.eligible },
+        { "obtained", check.obtained },
+    };
+}
+
+void from_json(const json& j, RandoSaveInfoCheck& check) {
+    j.at("item").get_to(check.item);
+    j.at("eligible").get_to(check.eligible);
+    j.at("obtained").get_to(check.obtained);
+}
+
+void to_json(json& j, const RandoSaveInfo& rando) {
+    j = json{
+        { "checks", rando.checks },
+    };
+}
+
+void from_json(const json& j, RandoSaveInfo& rando) {
+    j.at("checks").get_to(rando.checks);
+}
+
 void to_json(json& j, const ShipSaveInfo& shipSaveInfo) {
     j = json {
         { "dpadEquips", shipSaveInfo.dpadEquips },
         { "pauseSaveEntrance", shipSaveInfo.pauseSaveEntrance },
+        { "saveType", shipSaveInfo.saveType },
     };
+
+    if (shipSaveInfo.saveType == SAVETYPE_RANDO) {
+        j["rando"] = shipSaveInfo.rando;
+    }
 }
 
 void from_json(const json& j, ShipSaveInfo& shipSaveInfo) {
     j.at("dpadEquips").get_to(shipSaveInfo.dpadEquips);
     j.at("pauseSaveEntrance").get_to(shipSaveInfo.pauseSaveEntrance);
+    j.at("saveType").get_to(shipSaveInfo.saveType);
+
+    if (shipSaveInfo.saveType == SAVETYPE_RANDO) {
+        j.at("rando").get_to(shipSaveInfo.rando);
+    }
 }
 
 void to_json(json& j, const ItemEquips& itemEquips) {

mm/2s2h/BenPort.cpp

@@ -53,6 +53,7 @@ CrowdControl* CrowdControl::Instance;
 #include "2s2h/Enhancements/GfxPatcher/AuthenticGfxPatches.h"
 #include "2s2h/DeveloperTools/DebugConsole.h"
 #include "2s2h/DeveloperTools/DeveloperTools.h"
+#include "2s2h/Rando/Rando.h"
 #include "2s2h/SaveManager/SaveManager.h"
 
 // Resource Types/Factories
@@ -468,9 +469,11 @@ extern "C" void InitOTR() {
 
     OTRGlobals::Instance = new OTRGlobals();
     GameInteractor::Instance = new GameInteractor();
+    GameInteractor::Instance->Init();
     BenGui::SetupGuiElements();
     InitEnhancements();
     InitDeveloperTools();
+    Rando::Init();
     GfxPatcher_ApplyNecessaryAuthenticPatches();
     DebugConsole_Init();
 

mm/2s2h/CustomMessage/CustomMessage.cpp

@@ -0,0 +1,89 @@
+
+#include "CustomMessage.h"
+#include <libultraship/bridge.h>
+#include "2s2h/Enhancements/GameInteractor/GameInteractor.h"
+#include <map>
+
+extern "C" {
+#include "z64.h"
+extern PlayState* gPlayState;
+}
+
+static s32 activeMessageModId = -1;
+static s32 activeMessageTextId = -1;
+
+#define DEFINE_MESSAGE(textId, typePos, msg) { SHIP_TEXT_##textId, typePos, msg "\xBF" },
+
+MessageTableEntry shipMessagesTable[] = {
+#include "2s2h/CustomMessage/ShipMessages.h"
+    { 0xFFFF, 0, NULL },
+};
+
+#undef DEFINE_MESSAGE
+
+// Intended to be used in conjunction with GI's OnOpenText hook
+void CustomMessage_SetActiveMessage(s32 modId, s32 textId) {
+    activeMessageModId = modId;
+    activeMessageTextId = textId;
+}
+
+void CustomMessage_Replace(std::string* msg, const std::string& placeholder, const std::string& value) {
+    size_t pos = 0;
+    while ((pos = msg->find(placeholder, pos)) != std::string::npos) {
+        msg->replace(pos, placeholder.length(), value);
+        pos += value.length();
+    }
+}
+
+// Intended to be called in place of Message_StartTextbox within the source code when overriding messages
+extern "C" void CustomMessage_StartTextbox(PlayState* play, s32 modId, s32 textId, Actor* actor) {
+    activeMessageModId = modId;
+    activeMessageTextId = textId;
+    Message_StartTextbox(play, CUSTOM_MESSAGE_ID, actor);
+}
+
+// Intended to be called in place of Message_ContinueTextbox within the source code when overriding messages
+extern "C" void CustomMessage_ContinueTextbox(PlayState* play, s32 modId, s32 textId) {
+    activeMessageModId = modId;
+    activeMessageTextId = textId;
+    Message_ContinueTextbox(play, CUSTOM_MESSAGE_ID);
+}
+
+extern "C" void CustomMessage_HandleCustomMessage() {
+    if (activeMessageTextId == -1 || activeMessageModId == -1)
+        return;
+
+    // Currently we only support the ship mod
+    if (activeMessageModId != MOD_ID_SHIP)
+        return;
+
+    MessageContext* msgCtx = &gPlayState->msgCtx;
+    Font* font = &msgCtx->font;
+
+    MessageTableEntry* msgEntry = &shipMessagesTable[activeMessageTextId];
+    char buff[1280] = { 0 };
+
+    // Copy message metadata
+    memcpy(buff, msgEntry->segment, 11);
+
+    // Convert the rest of the message to a std::string
+    std::string msg = msgEntry->segment + 11;
+    // Allow the message to be modified by the game interactor
+    GameInteractor_ExecuteOnHandleCustomMessage(activeMessageModId, activeMessageTextId, &msg);
+
+    // If messaage is too long, truncate it and add the message end character
+    if (msg.length() > 1269) {
+        msg = msg.substr(0, 1268);
+        msg += '\xBF';
+    }
+
+    // Copy modified message to the buffer
+    memcpy(buff + 11, msg.c_str(), msg.length());
+
+    // Set the message length and copy the buffer to the real message buffer
+    msgCtx->msgLength = msg.length() + 11;
+    memcpy(&font->msgBuf, buff, msgCtx->msgLength);
+
+    activeMessageModId = -1;
+    activeMessageTextId = -1;
+}

mm/2s2h/CustomMessage/CustomMessage.h

@@ -0,0 +1,39 @@
+#ifndef CUSTOM_MESSAGE_H
+#define CUSTOM_MESSAGE_H
+
+#ifdef __cplusplus
+#include <string>
+
+extern "C" {
+#include "z64.h"
+#endif
+
+// Not really sure what the best ID is for this, but it needs to be between 0-255
+// because it's used as a u8 somewhere in the chain
+#define CUSTOM_MESSAGE_ID 0x004B
+
+typedef enum ModId {
+    MOD_ID_VANILLA = 0,
+    MOD_ID_SHIP = 1,
+} ModId;
+
+#define DEFINE_MESSAGE(textId, typePos, msg) SHIP_TEXT_##textId,
+
+typedef enum ShipTextId {
+#include "2s2h/CustomMessage/ShipMessages.h"
+    SHIP_TEXT_MAX,
+} ShipTextId;
+
+#undef DEFINE_MESSAGE
+
+void CustomMessage_StartTextbox(PlayState* play, s32 modId, s32 textId, Actor* actor);
+void CustomMessage_ContinueTextbox(PlayState* play, s32 modId, s32 textId);
+void CustomMessage_HandleCustomMessage();
+
+#ifdef __cplusplus
+};
+void CustomMessage_SetActiveMessage(s32 modId, s32 textId);
+void CustomMessage_Replace(std::string* msg, const std::string& placeholder, const std::string& value);
+#endif
+
+#endif

mm/2s2h/CustomMessage/ShipMessages.h

@@ -0,0 +1,13 @@
+// clang-format off
+DEFINE_MESSAGE(HELLO_WORLD, 0x00, "\x06\x00" "\xFE" "\xFF\xFF" "\xFF\xFF" "\xFF\xFF" "\xFF\xFF"
+"Hello World!\x11"
+"You have {{rupees}} rupee(s).\x11"
+"\x11"
+"                   - The Moon"
+)
+DEFINE_MESSAGE(GIVE_ITEM, 0x00, "\x02\x00" "\x0C" "\xFF\xFF" "\xFF\xFF" "\xFF\xFF" "\xFF\xFF"
+"You recieved a(n) {{item}}!"
+)
+DEFINE_MESSAGE(GIVE_ITEM_NO_STOP, 0x00, "\x02\x00" "\x0C" "\xFF\xFF" "\xFF\xFF" "\xFF\xFF" "\xFF\xFF"
+"{{item}}" "\x1C\x02\x10"
+)

mm/2s2h/DeveloperTools/EventLog.cpp

@@ -239,11 +239,11 @@ void RegisterEventLogHooks() {
         TrimEventLog();
     });
 
-    onOpenTextHookId = GameInteractor::Instance->RegisterGameHook<GameInteractor::OnOpenText>([](s16 textId) {
+    onOpenTextHookId = GameInteractor::Instance->RegisterGameHook<GameInteractor::OnOpenText>([](u16* textId) {
         eventLogEntries.insert(eventLogEntries.begin(), {
                                                             .timestamp = CurrentTime(),
                                                             .type = EVENT_LOG_ENTRY_TYPE_OPEN_TEXT,
-                                                            .meta = fmt::format("0x{:02x}", textId),
+                                                            .meta = fmt::format("0x{:02x}", *textId),
                                                         });
         TrimEventLog();
     });

mm/2s2h/Enhancements/Cheats/OverrideTextExample.cpp

@@ -0,0 +1,26 @@
+#include <libultraship/bridge.h>
+#include "Enhancements/GameInteractor/GameInteractor.h"
+#include "2s2h/CustomMessage/CustomMessage.h"
+
+extern "C" {
+extern SaveContext gSaveContext;
+}
+
+// This is not actually used, but it's a good example of how to override text
+// until we have good examples of usage. This will be deleted eventually.
+void RegisterOverrideTextExample() {
+    // Overrides the sign in south clock town message
+    GameInteractor::Instance->RegisterGameHookForID<GameInteractor::OnOpenText>(0x1C18, [](u16* textId) {
+        CustomMessage_SetActiveMessage(MOD_ID_SHIP, SHIP_TEXT_HELLO_WORLD);
+        *textId = CUSTOM_MESSAGE_ID;
+    });
+
+    GameInteractor::Instance->RegisterGameHook<GameInteractor::OnHandleCustomMessage>(
+        [](s32 modId, s32 textId, std::string* msg) {
+            if (modId != MOD_ID_SHIP || textId != SHIP_TEXT_HELLO_WORLD) {
+                return;
+            }
+
+            CustomMessage_Replace(msg, "{{rupees}}", std::to_string(gSaveContext.save.saveInfo.playerData.rupees));
+        });
+}

mm/2s2h/Enhancements/Cutscenes/Cutscenes.cpp

@@ -8,6 +8,7 @@ void RegisterCutscenes() {
 
     // StoryCutscenes
     RegisterSkipClockTowerOpen();
+    RegisterSkipLearningSongOfTime();
 
     RegisterHideTitleCards();
     RegisterSkipEntranceCutscenes();

mm/2s2h/Enhancements/Cutscenes/Cutscenes.h

@@ -10,6 +10,7 @@ void RegisterSkipTatlInterrupts();
 
 // StoryCutscenes
 void RegisterSkipClockTowerOpen();
+void RegisterSkipLearningSongOfTime();
 
 void RegisterHideTitleCards();
 void RegisterSkipEntranceCutscenes();

mm/2s2h/Enhancements/Cutscenes/StoryCutscenes/SkipLearningSongOfTime.cpp

@@ -0,0 +1,43 @@
+#include <libultraship/bridge.h>
+#include <spdlog/spdlog.h>
+#include "Enhancements/GameInteractor/GameInteractor.h"
+#include "Enhancements/FrameInterpolation/FrameInterpolation.h"
+
+extern "C" {
+#include "z64.h"
+#include "functions.h"
+#include "variables.h"
+#include "assets/objects/object_gi_melody/object_gi_melody.h"
+extern SaveContext gSaveContext;
+extern PlayState* gPlayState;
+}
+
+void RegisterSkipLearningSongOfTime() {
+    GameInteractor::Instance->RegisterGameHookForID<GameInteractor::ShouldVanillaBehavior>(
+        GI_VB_PLAY_TRANSITION_CS, [](GIVanillaBehavior _, bool* should, void* opt) {
+            // Cutscene that plays after picking up the Ocarina of Time.
+            if (gSaveContext.save.entrance == ENTRANCE(CUTSCENE, 0) && gSaveContext.save.cutsceneIndex == 0xFFF2 &&
+                CVarGetInteger("gEnhancements.Cutscenes.SkipStoryCutscenes", 0)) {
+                gSaveContext.save.playerForm = PLAYER_FORM_DEKU;
+                gSaveContext.save.entrance = ENTRANCE(CLOCK_TOWER_ROOFTOP, 1);
+                gSaveContext.save.cutsceneIndex = 0;
+                GameInteractor::Instance->events.emplace_back(
+                    GIEventGiveItem{ .showGetItemCutscene = true,
+                                     .getItemText = "You recieved the Song of Time",
+                                     .drawItem =
+                                         []() {
+                                             OPEN_DISPS(gPlayState->state.gfxCtx);
+
+                                             Gfx_SetupDL25_Xlu(gPlayState->state.gfxCtx);
+
+                                             gSPMatrix(POLY_XLU_DISP++, Matrix_NewMtx(gPlayState->state.gfxCtx),
+                                                       G_MTX_NOPUSH | G_MTX_LOAD | G_MTX_MODELVIEW);
+                                             gDPSetEnvColor(POLY_XLU_DISP++, 200, 255, 0, 255);
+                                             gSPDisplayList(POLY_XLU_DISP++, (Gfx*)gGiSongNoteDL);
+
+                                             CLOSE_DISPS(gPlayState->state.gfxCtx);
+                                         },
+                                     .giveItem = []() { SET_QUEST_ITEM(QUEST_SONG_TIME); } });
+            }
+        });
+}