Mirrored world enhancement (HarbourMasters#1569)

* Mirrored world PoC

* invert culling for health meter and A button action

* A few more fixes

* Fix for item equip animations

* Fix for pause triforce

* Mirror scenes with static backgrounds

* mirror minimap for mirror world

* mirror dungeon maps and icons on the pause menu

* mirror overworld map and icons on the pause menu

* mirror debug world movement

* mirror shops cursor and movement

* use flip flag

* Reverse crouch stab x axis for mirror mode

* use invert culling command and clean up culling logic

* Move mirror mode handler to mods and support random modes

* Small cvar tweaks

* mirror billboard score numbers and fix gyro horse mirrored inputs

---------

Co-authored-by: Adam Bird <archez39@me.com>

Author: garrettjoecox

soh/include/z64.h

@@ -203,6 +203,7 @@ typedef struct {
     /* 0x0060 */ Mtx    projection;
     /* 0x00A0 */ Mtx    viewing;
     /* 0x00E0 */ Mtx*   projectionPtr;
+    /* 0x00E0 */ Mtx*   projectionFlippedPtr;
     /* 0x00E4 */ Mtx*   viewingPtr;
     /* 0x00E8 */ Vec3f  distortionOrientation;
     /* 0x00F4 */ Vec3f  distortionScale;

soh/soh/Enhancements/enhancementTypes.h

@@ -11,6 +11,13 @@ typedef enum {
     BUNNY_HOOD_FAST
 } BunnyHoodMode;
 
+typedef enum {
+    MIRRORED_WORLD_OFF,
+    MIRRORED_WORLD_ALWAYS,
+    MIRRORED_WORLD_RANDOM,
+    MIRRORED_WORLD_RANDOM_SEEDED,
+} MirroredWorldMode;
+
 typedef enum {
     FASTFILE_1,
     FASTFILE_2,

soh/soh/Enhancements/mods.cpp

@@ -4,6 +4,7 @@
 #include "tts/tts.h"
 #include "soh/Enhancements/boss-rush/BossRushTypes.h"
 #include "soh/Enhancements/enhancementTypes.h"
+#include "soh/Enhancements/randomizer/3drando/random.hpp"
 
 extern "C" {
 #include <z64.h>
@@ -550,6 +551,29 @@ void RegisterMenuPathFix() {
     });
 }
 
+void UpdateMirrorModeState(int32_t sceneNum) {
+    if (CVarGetInteger("gMirroredWorldMode", MIRRORED_WORLD_OFF) == MIRRORED_WORLD_RANDOM_SEEDED) {
+        uint32_t seed = sceneNum + (gSaveContext.n64ddFlag ? (gSaveContext.seedIcons[0] + gSaveContext.seedIcons[1] + gSaveContext.seedIcons[2] + gSaveContext.seedIcons[3] + gSaveContext.seedIcons[4]) : gSaveContext.sohStats.fileCreatedAt);
+        Random_Init(seed);
+    }
+
+    uint8_t randomNumber = Random(0, 2);
+    if (
+        CVarGetInteger("gMirroredWorldMode", MIRRORED_WORLD_OFF) == MIRRORED_WORLD_ALWAYS ||
+        CVarGetInteger("gMirroredWorldMode", MIRRORED_WORLD_OFF) > MIRRORED_WORLD_ALWAYS && randomNumber == 1
+    ) {
+        CVarSetInteger("gMirroredWorld", 1);
+    } else {
+        CVarClear("gMirroredWorld");
+    }
+}
+
+void RegisterMirrorModeHandler() {
+    GameInteractor::Instance->RegisterGameHook<GameInteractor::OnSceneInit>([](int32_t sceneNum) {
+        UpdateMirrorModeState(sceneNum);
+    });
+}
+
 void InitMods() {
     RegisterTTS();
     RegisterInfiniteMoney();
@@ -571,4 +595,5 @@ void InitMods() {
     RegisterHyperEnemies();
     RegisterBonkDamage();
     RegisterMenuPathFix();
+    RegisterMirrorModeHandler();
 }

soh/soh/Enhancements/mods.h

@@ -8,6 +8,7 @@ extern "C" {
 #endif
 
 void UpdateDirtPathFixState(int32_t sceneNum);
+void UpdateMirrorModeState(int32_t sceneNum);
 void InitMods();
 
 #ifdef __cplusplus

soh/soh/SohMenuBar.cpp

@@ -62,6 +62,7 @@ std::string GetWindowButtonText(const char* text, bool menuOpen) {
 
     static const char* chestStyleMatchesContentsOptions[4] = { "Disabled", "Both", "Texture Only", "Size Only" };
     static const char* bunnyHoodOptions[3] = { "Disabled", "Faster Run & Longer Jump", "Faster Run" };
+    static const char* mirroredWorldModes[4] = { "Disabled", "Always", "Random", "Random (Seeded)" };
     static const char* allPowers[9] = {
                         "Vanilla (1x)",
                         "Double (2x)",
@@ -1015,6 +1016,19 @@ void DrawEnhancementsMenu() {
         UIWidgets::Spacer(0);
 
         if (ImGui::BeginMenu("Extra Modes")) {
+            UIWidgets::PaddedText("Mirrored World Mode", true, false);
+            if (UIWidgets::EnhancementCombobox("gMirroredWorldMode", mirroredWorldModes, MIRRORED_WORLD_OFF) && gPlayState != NULL) {
+                UpdateMirrorModeState(gPlayState->sceneNum);
+            }
+            UIWidgets::Tooltip(
+                "Mirrors the world horizontally\n\n"
+                "- Always: Always mirror the world\n"
+                "- Random: Randomly decide to mirror the world on each scene change\n"
+                "- Random (Seeded): Scenes are mirrored based on the current randomizer seed/file\n"
+            );
+
+            UIWidgets::Spacer(0);
+
             UIWidgets::PaddedEnhancementCheckbox("Ivan the Fairy (Coop Mode)", "gIvanCoopModeEnabled", true, false);
             UIWidgets::Tooltip("Enables Ivan the Fairy upon the next map change. Player 2 can control Ivan and "
                                 "press the C-Buttons to use items and mess with Player 1!");

soh/src/code/audio_synthesis.c

@@ -653,7 +653,11 @@ Acmd* AudioSynth_DoOneAudioUpdate(s16* aiBuf, s32 aiBufLen, Acmd* cmd, s32 updat
     }
 
     updateIndex = aiBufLen * 2;
-    aInterleave(cmd++, DMEM_TEMP, DMEM_LEFT_CH, DMEM_RIGHT_CH, updateIndex);
+    if (CVarGetInteger("gMirroredWorld", 0)) {
+        aInterleave(cmd++, DMEM_TEMP, DMEM_RIGHT_CH, DMEM_LEFT_CH, updateIndex);
+    } else {
+        aInterleave(cmd++, DMEM_TEMP, DMEM_LEFT_CH, DMEM_RIGHT_CH, updateIndex);
+    }
     aSaveBuffer(cmd++, DMEM_TEMP, aiBuf, updateIndex * 2);
 
     return cmd;

soh/src/code/z_camera.c

@@ -1487,8 +1487,9 @@ s32 Camera_Free(Camera* camera) {
 
     f32 newCamX = -D_8015BD7C->state.input[0].cur.right_stick_x * 10.0f * (CVarGetFloat("gThirdPersonCameraSensitivityX", 1.0f));
     f32 newCamY = D_8015BD7C->state.input[0].cur.right_stick_y * 10.0f * (CVarGetFloat("gThirdPersonCameraSensitivityY", 1.0f));
+    bool invertXAxis = (CVarGetInteger("gInvertXAxis", 0) && !CVarGetInteger("gMirroredWorld", 0)) || (!CVarGetInteger("gInvertXAxis", 0) && CVarGetInteger("gMirroredWorld", 0));
 
-    camera->play->camX += newCamX * (CVarGetInteger("gInvertXAxis", 0) ? -1 : 1);
+    camera->play->camX += newCamX * (invertXAxis ? -1 : 1);
     camera->play->camY += newCamY * (CVarGetInteger("gInvertYAxis", 1) ? 1 : -1);
 
     if (camera->play->camY > 0x32A4) {

soh/src/code/z_lib.c

@@ -201,6 +201,10 @@ void func_80077D10(f32* arg0, s16* arg1, Input* input) {
     f32 relX = input->rel.stick_x;
     f32 relY = input->rel.stick_y;
 
+    if (CVarGetInteger("gMirroredWorld", 0)) {
+        relX = -input->rel.stick_x;
+    }
+
     *arg0 = sqrtf(SQ(relX) + SQ(relY));
     *arg0 = (60.0f < *arg0) ? 60.0f : *arg0;