Rebase Dev onto original repo

README.md

@@ -1,6 +1,6 @@
 # Majora's Mask 3D Randomizer
 
-**Status: Work In Progress** - This is currently nowhere near playable - as it is just making the base code changes in order for an app to generate seeds.
+**Status: Work In Progress** - This repository contains all the base code patches for the Randomizer. This repository does not contain the actual application for generating seeds, but is required in order for the game to be randomized.
 
 This is an item randomizer for _The Legend of Zelda: Majora's Mask 3D_ for the Nintendo 3DS.
 
@@ -15,12 +15,12 @@ This is an item randomizer for _The Legend of Zelda: Majora's Mask 3D_ for the N
 
 ## Installation
 
-You can download the latest stable version of the randomizer ~~[here](https://github.com/phlexplexico/MM3DR/releases/latest)~~. You can use either the ```MM3DR.3dsx``` or ```MM3DR.cia``` files provided to generate randomizer patches.
+You can download the latest stable version of the randomizer [here](https://github.com/Z3DR/MM3D_Randomizer/releases/latest). You can use either the ```MM3D_Randomizer.3dsx``` or ```MM3D_Randomizer.cia``` files provided to generate randomizer patches.
 
-Please ensure that you are playing on the USA version of Majora's Mask 3D, as it is the only version supported by the randomizer. You can use either the cartridge version or the installed digital version. In all instructions below, if a directory doesn't exist, just create it.
+Please ensure that you are playing on the USA version of Majora's Mask 3D, as it is the only version supported by the randomizer. While it is not guaranteed, you may be able to play on different regions as well. Version 1.1 is also supported, but may take significantly longer to boot on the 3DS. You can use either the cartridge version or the installed digital version. In all instructions below, if a directory doesn't exist, just create it.
 
 ### On 3DS Console with Luma3DS
-On your SD card, copy ```MM3DR.3dsx``` to ```SD:/3ds/``` or copy ```MM3DR.cia``` to ```SD:/cias/```. When using the ```.3dsx``` file, you will need to launch the randomzier app through the homebrew menu every time you wish to launch it. When using the ```.cia``` file, you will need to install the file using the FBI app, so that the randomizer app appears directly on the 3DS home menu. Alternatively, if your 3DS is connected to the internet, you can use FBI to scan the QR code for either the ```.3dsx``` file or the ```.cia``` file, and the randomizer will be downloaded and installed automatically.
+On your SD card, copy ```MM3D_Randomizer.3dsx``` to ```SD:/3ds/``` or copy ```MM3D_Randomizer.cia``` to ```SD:/cias/```. When using the ```.3dsx``` file, you will need to launch the randomzier app through the homebrew menu every time you wish to launch it. When using the ```.cia``` file, you will need to install the file using the FBI app, so that the randomizer app appears directly on the 3DS home menu. Alternatively, if your 3DS is connected to the internet, you can use FBI to scan the QR code for either the ```.3dsx``` file or the ```.cia``` file, and the randomizer will be downloaded and installed automatically.
 
 Power on your 3DS while holding the SELECT key to launch the Luma3DS menu. Make sure that ```Enable game patching``` is turned on, then press START to save and launch the home menu. You only have to do this once.
 
@@ -29,7 +29,7 @@ To generate a playthrough, run Majora's Mask 3D Randomizer from the homebrew lau
 If the 3DS crashes when you launch the game, you probably need to update Luma3DS.
 
 ### On Citra
-Use Citra to launch ```MM3DR.3dsx```. Navigate the menus to choose the settings for your playthrough, and finish by selecting ```Generate Randomizer```. When prompted, make sure to select that you are playing on Citra emulator. After the app has finished, on the Citra window, click on ```File->Open Citra Folder```. From this folder, navigate to ```\sdmc\luma\titles\0004000000125500```, and you should find files called ```code.ips```, ```exheader.bin```, and a folder called ```romfs```. In the Citra window, right-click on the installed copy of Ocarina of Time 3D, and choose ```Open Mods Location```. (If you haven't installed OoT3D, you can go to ```File->Open Citra Folder``` and then open up ```\load\mods\0004000000125500```.) Copy ```code.ips```, ```exheader.bin```, and ```romfs``` into this folder. Now, launch Majora's Mask 3D and enjoy your playthrough!
+Use Citra to launch ```MM3D_Randomizer.3dsx```. Navigate the menus to choose the settings for your playthrough, and finish by selecting ```Generate Randomizer```. When prompted, make sure to select that you are playing on Citra emulator. After the app has finished, on the Citra window, click on ```File->Open Citra Folder```. From this folder, navigate to ```\sdmc\luma\titles\0004000000125500```, and you should find files called ```code.ips```, ```exheader.bin```, and a folder called ```romfs```. In the Citra window, right-click on the installed copy of Ocarina of Time 3D, and choose ```Open Mods Location```. (If you haven't installed OoT3D, you can go to ```File->Open Citra Folder``` and then open up ```\load\mods\0004000000125500```.) Copy ```code.ips```, ```exheader.bin```, and ```romfs``` into this folder. Now, launch Majora's Mask 3D and enjoy your playthrough!
 
 ### Save Files
 Right now, save files are shared between any playthroughs you create and the base game. This means that you are responsible for managing your own save files. If you are playing on a 3DS, check out [Checkpoint](https://github.com/FlagBrew/Checkpoint/releases), an easy-to-use homebrew save manager.
@@ -47,12 +47,11 @@ As a service to the player in this very long game, various tedious elements of t
 
 Please be sure to explore the many customizable settings which are available when using the app! There are many options which can alter the length or difficulty of each playthrough.
 
-Want to discuss the randomizer with others? Join our ~~[Discord server]()~~!
+Want to discuss the randomizer with others? Join our [Discord server](https://discord.gg/73ZNdjbfFp)!
 
 ### Getting Stuck
 
-~~With a game the size of _Majora's Mask 3D_, it's quite easy for players to get stuck in certain situations with no apparent path to progressing.
-Before reporting an issue, please make sure to check out the [the Logic wiki for the original OoT Randomizer](https://wiki.ootrandomizer.com/index.php?title=Logic), the information there will apply to MM3D in nearly every situation.~~
+Before reporting bugs, please check in the Discord to see if there is any apparent way of continuing.
 
 You may also find a map tracker helpful, as these allow you to see all checks which are available with your current items, and check which ones you've gotten already. Some recommended trackers are EmoTracker, although keep in mind these were designed for the original MM Randomizer so there may be some slight discrepancies.
 
@@ -65,9 +64,9 @@ Install the 3DS packages from [devkitPro](https://devkitpro.org/wiki/Getting_Sta
 A small portion of this project is done in python. If you decide to use the Msys2 console from devkitpro, you can install python using the command `pacman -S python` within Msys2.
 
 
-In the root folder, use ```make``` to build ```MM3DR.3dsx```. Use ```make debug=1``` for extra debugging features, including extra items when starting a new file. In the case of problems, try using a ```make clean```.
+In the root folder, use ```make``` to build ```basecode.ips```. Use ```make debug=1``` for extra debugging features, including extra items when starting a new file. In the case of problems, try using a ```make clean```.
 When making changes to any code in the `code` directory, you must use `make clean` before recompiling if you want your changes to be picked up.
-For faster compilation using multiple threads, you can use `make -j4` (in this example, the `4` is the number of threads being used).
+For faster compilation using multiple threads, you can use `make -j4` (in this example, the `4` is the number of threads being used, you can use `-j` to use all available threads).
 
 For quick debugging, you can create an environment variable named `citraPath` that links directly to your mods folder. For example, using WSL2 you could create a variable in your `.bashrc` as such:  
 `export citraPrint="/mnt/c/Users/User/AppData/Roaming/Citra/load/mods/0004000000125500/code.ips"`  
@@ -78,6 +77,8 @@ Alternatively, you can use `copyto="path/to/code.ips"` as a command line argumen
 make -j debug=1 copyto="/mnt/c/Users/User/AppData/Roaming/Citra/load/mods/0004000000125500/code.ips"
 ```
 
+The debug flag is very helpful, as it will always give the same item that you can check to ensure overrides are working properly, and do not have to generate a seed every time if you are trying to create a patch for the game.
+
 ## Reporting Bugs
 
 Let us know if you believe you have discovered a bug by posting in our Discord server, or by opening an issue. In the ~~[Discord]()~~, we have a list of currently known issues and fixes which are pending release, which we try to keep fairly up to date.

code/Makefile

@@ -33,7 +33,7 @@ include $(DEVKITARM)/3ds_rules
 #---------------------------------------------------------------------------------
 TARGET		:=	$(notdir $(CURDIR))
 BUILD		:=	build
-SOURCES		:=	source source/asm source/lib source/common source/game source/rnd
+SOURCES		:=	source source/asm source/lib source/common source/game source/rnd source/game/ui/screens
 DATA		:=	data
 INCLUDES	:=	include
 GRAPHICS	:=	gfx

code/include/game/actor.h

@@ -33,14 +33,18 @@ namespace game::act {
     DayTimer = 0x00F5,
     // Elegy of Emptiness statue
     ObjElegyStatue = 0x001F,
-    // En_Gm - Gorman Bros Race
+    // En_Im - Gorman Bros Race - Ingo
     EnIn = 0x004D,
     // Clear Tag (?)
     ClearTag = 0x0073,
+    // Gorman
+    EnGm = 0x0074,
     // En_Hs - Grog The Chicken Man
     EnHs = 0x0076,
     // Cursed Man Spider House
     EnSsh = 0x0090,
+    // Powder Keg Trial Goron
+    EnGo = 0x00D5,
     // [1] Deku Palace / Woodfall Temple moving platforms (after player lands on them)
     ObjRailLift = 0x00D8,
     // Shooting Gallery - Man
@@ -66,7 +70,7 @@ namespace game::act {
     // Npc For Curiosity Shop Owner
     NpcEnFsn = 0x0157,
     // Npc For Boat Photography
-    NpcSwampPhotographer = 0x0158,
+    EnShn = 0x0158,
     // NPC Postman
     NpcEnPm = 0x0166,
     // Goht
@@ -79,6 +83,8 @@ namespace game::act {
     EnMaYto = 0x01AF,
     // [7] Owl statue
     ObjOwlStatue = 0x01B2,
+    // Gabora
+    EnKgy = 0x018F,
     // [4] Old Lady from Bomb Shop
     NpcEnBaba = 0x01C5,
     // Granny
@@ -103,6 +109,8 @@ namespace game::act {
     NpcEnBjt = 0x020C,
     // [4] Bombers
     NpcBombers = 0x020F,
+    // Keaton
+    EnKitan = 0x021B,
     // [6] Sheikah Hint Stone (MM3D)
     NpcHintStone = 0x0241,
     // [6] New in MM3D. Shows up as sparkles and spawns an ice platform (actor 0x13E) when hit.
@@ -186,6 +194,21 @@ namespace game::act {
   };
   static_assert(sizeof(PosRot) == 0x14);
 
+  using ActorShadowFunc = void(Actor* self, void* lightMapper, GlobalContext* gctx);
+  struct ActorShape {
+    z3dVec3s rot;
+    s16 face;
+    float y_offset;
+    ActorShadowFunc* shadow_draw;
+    float shadow_scale;
+    u8 shadow_alpha;
+    u8 feet_floor_flags;
+    u8 field_16;
+    u8 field_17;
+    z3dVec3f feet_pos[2];
+  };
+  static_assert(sizeof(ActorShape) == 0x30);
+
   struct Actor {
     enum class Flag : u32 {
       Targetable = 0x1,
@@ -251,16 +274,7 @@ namespace game::act {
     DamageType damage_type;
     u8 field_BE;
     u8 field_BF;
-    // u16 field_C0;
-    // u16 angle;
-    z3dVec3s angle;
-    // u16 field_C4;
-    u8 gap_C6[2];
-    float field_C8;
-    u32 field_CC;
-    float field_D0;
-    u8 field_D4;
-    u8 gap_D5[27];
+    ActorShape actor_shape;
     z3dVec3f field_F0;
     u32 field_FC;
     z3dVec3f field_100;
@@ -317,14 +331,14 @@ namespace game::act {
 
   // Name courtesy of the OoT decomp project.
   struct DynaPolyActor : Actor {
-    u32 dyna_poly_id;
-    float field_1FC;
+    u32 bg_id;
+    float push_force;
     float field_200;
-    u16 field_204;
-    u8 field_206;
-    u32 dyna_poly_flags;
+    s16 y_rotation;
+    u32 transform_flags;
+    u8 interact_flags;
   };
-  static_assert(sizeof(DynaPolyActor) == 0x20C);
+  static_assert(sizeof(DynaPolyActor) == 0x210);
 
   struct DayTimerActor {
     Actor common_actor;

code/include/game/actors/boss/twinmold.h

@@ -0,0 +1,185 @@
+#ifndef _GAME_ACTORS_BOSS_TWINMOLD_H
+#define _GAME_ACTORS_BOSS_TWINMOLD_H
+#include <cstddef>
+
+#include "common/types.h"
+#include "common/utils.h"
+#include "game/actor.h"
+#include "game/collision.h"
+#include "z3d/z3DVec.h"
+
+namespace game {
+  class GlobalContext;
+}
+
+namespace game::act {
+
+  struct BossTwinmold : Actor {
+    // Probably incomplete.
+    enum class Status : u16 {
+      Buried = 0,
+      BlueRisingOutOfSand = 1,
+      // Also resets the hit counter.
+      RedBurrowingIntoSand = 3,
+
+      Flying = 4,
+      Unk6 = 6,
+      // The most commonly seen state for Blue Twinmold.
+      FlyingAimlessly = 7,
+
+      Unk8 = 8,
+      Unk9 = 9,
+
+      // These states are entered after receiving enough hits.
+      BlueStunnedByShootingEyes = 11,
+      BlueStunnedEyeOut = 12,
+      BlueStunnedBurrowingIntoSand = 13,
+
+      Stunned = 15,
+      StunnedAndOnGround = 16,
+
+      TauntingLink = 18,
+      AfterTaunting = 19,
+
+      // Only for Red Twinmold?
+      TauntingAndAttacking = 21,
+      AfterTauntingAndAttacking = 22,
+      FlyingAndAttacking = 23,
+
+      BeingGrabbedByLink = 24,
+      BeingChokedByLink = 25,
+
+      PreparingToRiseOutOfSand = 26,
+
+      // ?
+      AfterTaunting2 = 98,
+
+      Inactive = 100,
+      FirstTimeRisingOutOfSand = 102,
+
+      DyingStart = 200,
+      DyingExploding = 201,
+      DyingFallingToGround = 202,
+      DyingTouchedGround = 203,
+    };
+
+    void* resource;
+    Status status;
+    u16 some_status_change_countdown;
+    u16 field_200;
+    u16 field_202;
+    u16 frame_counter;
+    u16 field_206;
+    u16 field_208;
+    u16 field_20A;
+    u16 field_20C;
+    u8 gap_20E[14];
+    u16 field_21C;
+    u8 gap_21E[14];
+    z3dVec3f field_22C;
+    z3dVec3f field_238;
+    u8 gap244[1];
+    u8 field_245;
+    u8 gap246[3];
+    u8 gap_249[27];
+    float field_264;
+    float field_268;
+    signed int field_26C;
+    z3dVec3f field_270;
+    u8 gap27C[15748];
+    u32 field_4000;
+    u8 gap_4004[3448];
+    u32 field_4D7C;
+    u32 field_4D80;
+    u8 gap_4D84[56];
+    u32 status_anim;
+    u8 gap_4DC0[8];
+    float field_4DC8;
+    signed int field_4DCC;
+    u8 gap_4DD0[560];
+    u32 field_5000;
+    u8 gap_5004[3448];
+    z3dVec3f field_5D7C;
+    z3dVec3f field_5D88;
+    z3dVec3f field_5D94;
+    z3dVec3f field_5DA0;
+    u8 gap5DAC[120];
+    void (*field_5E24)(BossTwinmold*, GlobalContext*);
+    /// Points to Blue Twinmold for Red Twinmold, and vice versa.
+    BossTwinmold* other_twinmold_actor;
+    int field_5E2C;
+    u8 gap_5E30[12];
+    /// one for each segment of Twinmold's body,
+    /// starting at the head (0) and ending at the tail (13)
+    CollisionBodies<CollisionBodyCylinderCollection, 14> collision_1;
+    CollisionBodies<CollisionBodyCylinderCollection, 14> collision_main;
+    CollisionBodyCylinder collision_2;
+    u8 gap_6794[8];
+    u32 field_679C;
+    u16 field_67A0;
+    u8 gap_67A2[26];
+    float field_67BC;
+    u16 field_67C0;
+    signed int field_67C4;
+    u8 gap_67C8[44];
+    float field_67F4;
+    float field_67F8;
+    u8 gap_67FC[8];
+    int (*field_6804)(BossTwinmold*, GlobalContext*, act::Actor*);
+    u8 gap_6808[6136];
+    u32 field_8000;
+    u8 gap_8004[784];
+    char field_8314;
+    char field_8315;
+    char field_8316;
+    char field_8317;
+    u8 gap_8318[3304];
+    u32 field_9000;
+    u8 gap_9004[208];
+    char field_90D4;
+    __attribute__((aligned(4))) u8 field_90D8;
+    u8 gap_90D9[11];
+    u16 hit_counter;
+    u16 field_90E6;
+    u8 gap_90E8[12];
+    u32 field_90F4;
+    int field_90F8;
+    u8 gap_90FC[16];
+    u32 field_910C;
+    u32 field_9110;
+    u8 gap_9114[4];
+    u32 field_9118;
+    u8 gap_911C[8];
+    u32 field_9124;
+    u8 gap_9128[4];
+    float eye_scale;
+    float field_9130;
+    u8 gap_9134[8];
+    float field_913C;
+    u8 gap_9140[24];
+    z3dVec3f field_9158;
+    z3dVec3f field_9164;
+    u8 gap9170[36];
+    CollisionBodies<CollisionBodyCylinderCollection, 1> collision_eye;
+    CollisionBodies<CollisionBodyCylinderCollection, 1> collision_3;
+    u32 field_9274;
+    u8 gap_9278[308];
+    u32 field_93AC;
+    u8 gap_93B0[308];
+    CollisionBodies<CollisionBodyCylinderCollection, 1> collision_4;
+    CollisionBodies<CollisionBodyCylinderCollection, 1> collision_5;
+    z3dVec3f field_95C4;
+    u8 gap_95D0[8];
+    int field_95D8;
+    int field_95DC;
+    int field_95E0;
+    u8 gap_95E4[60];
+    int field_9620;
+    int field_9624;
+  };
+  static_assert(sizeof(BossTwinmold) == 0x9628);
+  static_assert(offsetof(BossTwinmold, other_twinmold_actor) == 0x5E28);
+  static_assert(offsetof(BossTwinmold, gap_93B0) == 0x93B0);
+
+}  // namespace game::act
+#endif