Rewrite MQ DC Logic

CMakeLists.txt

@@ -11,6 +11,37 @@ include(CMake/lus-cvars.cmake)
 set(PROJECT_BUILD_NAME "MacReady Golf" CACHE STRING "" FORCE)
 set(PROJECT_TEAM "github.com/harbourmasters" CACHE STRING "" FORCE)
 
+execute_process(
+ COMMAND git branch --show-current
+ WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+ OUTPUT_VARIABLE GIT_BRANCH
+ OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+
+set(CMAKE_PROJECT_GIT_BRANCH "${GIT_BRANCH}" CACHE STRING "Git branch" FORCE)
+
+execute_process(
+ COMMAND git rev-parse HEAD
+ WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+ OUTPUT_VARIABLE GIT_COMMIT_HASH
+ OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+
+set(CMAKE_PROJECT_GIT_COMMIT_HASH "${GIT_COMMIT_HASH}" CACHE STRING "Git commit hash" FORCE)
+
+execute_process(
+ COMMAND git describe --tags --abbrev=0 --exact-match HEAD
+ WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
+ OUTPUT_VARIABLE GIT_COMMIT_TAG
+ OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+
+if(NOT GIT_COMMIT_TAG)
+ set(GIT_COMMIT_TAG "" CACHE STRING "Git commit tag" FORCE)
+endif()
+
+set(CMAKE_PROJECT_GIT_COMMIT_TAG "${GIT_COMMIT_TAG}" CACHE STRING "Git commit tag" FORCE)
+
 set_property(DIRECTORY ${CMAKE_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT soh)
 add_compile_options($<$<CXX_COMPILER_ID:MSVC>:/MP>)
 add_compile_options($<$<CXX_COMPILER_ID:MSVC>:/utf-8>)

docs/BUILDING.md

@@ -6,20 +6,17 @@ Requires:
  * At least 8GB of RAM (machines with 4GB have seen complier failures)
  * Visual Studio 2022 Community Edition with the C++ feature set
  * One of the Windows SDKs that comes with Visual Studio, for example the current Windows 10 version 10.0.19041.0
- * The `MSVC v142 - VS 2019 C++ build tools` component of Visual Studio
+ * The `MSVC v143 - VS 2022 C++ build tools` component of Visual Studio
  * Python 3 (can be installed manually or as part of Visual Studio)
  * Git (can be installed manually or as part of Visual Studio)
  * Cmake (can be installed via chocolatey or manually)
 
 During installation, check the "Desktop development with C++" feature set:
 
 ![image](https://user-images.githubusercontent.com/30329717/183511274-d11aceea-7900-46ec-acb6-3f2cc110021a.png)
-Doing so should also check one of the Windows SDKs by default. Then, in the installation details in the right-hand column, make sure you also check the v142 toolset. 
+Doing so should also check one of the Windows SDKs by default. Then, in the installation details in the right-hand column, make sure you also check the v143 toolset. This is often done by default.
 
-You can also find the v142 toolset by searching through the individual components tab: 
-
-![image](https://user-images.githubusercontent.com/30329717/183521169-ead6a73b-a1bf-4e99-aab8-441746d8f08e.png)
-While you're there, you can also install Python 3 and Git if needed.
+It is recommended that you install Python and Git standalone, the install process in VS Installer has given some issues in the past.
 
 1. Clone the Ship of Harkinian repository
 
@@ -33,9 +30,7 @@ _Note: Instructions assume using powershell_
 cd Shipwright
 
 # Setup cmake project
-& 'C:\Program Files\CMake\bin\cmake' -S . -B "build/x64" -G "Visual Studio 17 2022" -T v142 -A x64 # -DCMAKE_BUILD_TYPE:STRING=Release (if you're packaging)
-# or for VS2019
-& 'C:\Program Files\CMake\bin\cmake' -S . -B "build/x64" -G "Visual Studio 16 2019" -T v142 -A x64
+& 'C:\Program Files\CMake\bin\cmake' -S . -B "build/x64" -G "Visual Studio 17 2022" -T v143 -A x64 # -DCMAKE_BUILD_TYPE:STRING=Release (if you're packaging)
 # Extract assets & generate OTR (run this anytime you need to regenerate OTR)
 & 'C:\Program Files\CMake\bin\cmake.exe' --build .\build\x64 --target ExtractAssets # --config Release (if you're packaging)
 # Compile project
@@ -60,9 +55,7 @@ With the cmake build system you have two options for working on the project:
 To develop using Visual Studio you only need to use cmake to generate the solution file:
 ```powershell
 # Generates Ship.sln at `build/x64` for Visual Studio 2022
-& 'C:\Program Files\CMake\bin\cmake' -S . -B "build/x64" -G "Visual Studio 17 2022" -T v142 -A x64
-# or for Visual Studio 2019
-& 'C:\Program Files\CMake\bin\cmake' -S . -B "build/x64" -G "Visual Studio 16 2019" -T v142 -A x64
+& 'C:\Program Files\CMake\bin\cmake' -S . -B "build/x64" -G "Visual Studio 17 2022" -T v143 -A x64
 ```
 
 #### Visual Studio Code or another editor

soh/include/variables.h

@@ -49,7 +49,10 @@ extern "C"
  extern u16 gBuildVersionMajor;
  extern u16 gBuildVersionMinor;
  extern u16 gBuildVersionPatch;
- extern u8 gBuildTeam[];
+ extern u8 gGitBranch[];
+ extern u8 gGitCommitHash[];
+ extern u8 gGitCommitTag[];
+ extern u8 gBuildTeam[];
  extern u8 gBuildDate[];
  extern u8 gBuildMakeOption[];
  extern OSMesgQueue gPiMgrCmdQ;

soh/include/z64save.h

@@ -68,6 +68,7 @@ typedef enum { // Pre-existing IDs for save sections in base code
  SECTION_ID_STATS,
  SECTION_ID_ENTRANCES,
  SECTION_ID_SCENES,
+ SECTION_ID_TRACKER_DATA,
  SECTION_ID_MAX
 } SaveFuncIDs;
 
@@ -279,7 +280,6 @@ typedef struct {
  /* */ u8 pendingIceTrapCount;
  /* */ SohStats sohStats;
  /* */ FaroresWindData backupFW;
- /* */ RandomizerCheckTrackerData checkTrackerData[RC_MAX];
  // #endregion
  // #region SOH [Randomizer]
  // Upstream TODO: Move these to their own struct or name to more obviously specific to Randomizer

soh/soh/CrashHandlerExt.cpp

@@ -69,6 +69,8 @@ extern "C" void CrashHandler_PrintSohData(char* buffer, size_t* pos) {
  char intCharBuffer[16];
  append_line(buffer, pos, "Build Information:");
  WRITE_VAR_LINE(buffer, pos, "Game Version: ", (const char*)gBuildVersion);
+ WRITE_VAR_LINE(buffer, pos, "Git Branch: ", (const char*)gGitBranch);
+ WRITE_VAR_LINE(buffer, pos, "Git Commit: ", (const char*)gGitCommitHash);
  WRITE_VAR_LINE(buffer, pos, "Build Date: ", (const char*)gBuildDate);
 
  if (gPlayState != nullptr) {

soh/soh/Enhancements/TimeSavers/FasterHeavyBlockLift.cpp

@@ -0,0 +1,58 @@
+#include "soh/Enhancements/game-interactor/GameInteractor.h"
+#include "soh/Enhancements/game-interactor/GameInteractor_Hooks.h"
+#include "soh/OTRGlobals.h"
+#include "spdlog/spdlog.h"
+
+extern "C" {
+ #include "z64save.h"
+ #include "macros.h"
+ #include "variables.h"
+ #include "functions.h"
+ extern PlayState* gPlayState;
+ extern SaveContext gSaveContext;
+}
+
+/**
+ * This primarily handles speeding up the heavy block lifts (OGC and in the Fire Trial) but also handles skipping
+ * the one point cutscene since the two options are so similar in what they do.
+ */
+void FasterHeavyBlockLift_Register() {
+ REGISTER_VB_SHOULD(VB_PLAY_ONEPOINT_ACTOR_CS, {
+ Actor* actor = static_cast<Actor*>(opt);
+
+ if (
+ actor->id == ACTOR_BG_HEAVY_BLOCK && 
+ (CVarGetInteger(CVAR_ENHANCEMENT("FasterHeavyBlockLift"), 0) || CVarGetInteger(CVAR_ENHANCEMENT("TimeSavers.SkipCutscene.OnePoint"), IS_RANDO))
+ ) {
+ *should = false;
+ }
+ });
+
+ REGISTER_VB_SHOULD(VB_FREEZE_LINK_FOR_BLOCK_THROW, {
+ if (CVarGetInteger(CVAR_ENHANCEMENT("FasterHeavyBlockLift"), 0) || CVarGetInteger(CVAR_ENHANCEMENT("TimeSavers.SkipCutscene.OnePoint"), IS_RANDO)) {
+ *should = false;
+ }
+ });
+
+ REGISTER_VB_SHOULD(VB_PLAY_THROW_ANIMATION, {
+ Player *player = GET_PLAYER(gPlayState);
+ Actor* interactRangeActor = player->interactRangeActor;
+ s32 interactActorId = interactRangeActor->id;
+ LinkAnimationHeader* anim = static_cast<LinkAnimationHeader*>(opt);
+
+ // Same actor is used for small and large silver rocks, use actor params to identify large ones
+ bool isLargeSilverRock = interactActorId == ACTOR_EN_ISHI && interactRangeActor->params & 1 == 1;
+ if (CVarGetInteger(CVAR_ENHANCEMENT("FasterHeavyBlockLift"), 0) && (isLargeSilverRock || interactActorId == ACTOR_BG_HEAVY_BLOCK)) {
+ *should = false;
+ LinkAnimation_PlayOnceSetSpeed(gPlayState, &player->skelAnime, anim, 5.0f);
+ }
+ });
+
+ REGISTER_VB_SHOULD(VB_MOVE_THROWN_ACTOR, {
+ if (CVarGetInteger(CVAR_ENHANCEMENT("FasterHeavyBlockLift"), 0)) {
+ Actor* heldActor = static_cast<Actor*>(opt);
+
+ heldActor->shape.rot.x -= 3510;
+ }
+ });
+}

soh/soh/Enhancements/TimeSavers/SkipCutscene/Story/SkipBlueWarp.cpp

@@ -19,19 +19,19 @@ extern "C" {
  */
 void SkipBlueWarp_ShouldPlayTransitionCS(GIVanillaBehavior _, bool* should, void* opt) {
  if (CVarGetInteger(CVAR_ENHANCEMENT("TimeSavers.SkipCutscene.Story"), IS_RANDO)) {
- uint8_t isBlueWarp = 0;
+ uint8_t isBlueWarpCutscene = 0;
  // Deku Tree Blue warp
  if (gSaveContext.entranceIndex == ENTR_KOKIRI_FOREST_0 && gSaveContext.cutsceneIndex == 0xFFF1) {
  gSaveContext.entranceIndex = ENTR_KOKIRI_FOREST_11;
- isBlueWarp = 1;
+ isBlueWarpCutscene = 1;
  // Dodongo's Cavern Blue warp
  } else if (gSaveContext.entranceIndex == ENTR_DEATH_MOUNTAIN_TRAIL_0 && gSaveContext.cutsceneIndex == 0xFFF1) {
  gSaveContext.entranceIndex = ENTR_DEATH_MOUNTAIN_TRAIL_5;
- isBlueWarp = 1;
+ isBlueWarpCutscene = 1;
  // Jabu Jabu's Blue warp
  } else if (gSaveContext.entranceIndex == ENTR_ZORAS_FOUNTAIN_0 && gSaveContext.cutsceneIndex == 0xFFF0) {
  gSaveContext.entranceIndex = ENTR_ZORAS_FOUNTAIN_0;
- isBlueWarp = 1;
+ isBlueWarpCutscene = 1;
  // Forest Temple Blue warp
  } else if (gSaveContext.entranceIndex == ENTR_CHAMBER_OF_THE_SAGES_0 && gSaveContext.cutsceneIndex == 0x0 && gSaveContext.chamberCutsceneNum == CHAMBER_CS_FOREST) {
  // Normally set in the blue warp cutscene
@@ -43,44 +43,45 @@ void SkipBlueWarp_ShouldPlayTransitionCS(GIVanillaBehavior _, bool* should, void
  gSaveContext.entranceIndex = ENTR_KOKIRI_FOREST_12;
  }
 
- isBlueWarp = 1;
+ isBlueWarpCutscene = 1;
  // Fire Temple Blue warp
  } else if (gSaveContext.entranceIndex == ENTR_KAKARIKO_VILLAGE_0 && gSaveContext.cutsceneIndex == 0xFFF3) {
  // Normally set in the blue warp cutscene
  Flags_SetEventChkInf(EVENTCHKINF_DEATH_MOUNTAIN_ERUPTED);
 
  gSaveContext.entranceIndex = ENTR_DEATH_MOUNTAIN_CRATER_5;
- isBlueWarp = 1;
+ isBlueWarpCutscene = 1;
  // Water Temple Blue warp
  } else if (gSaveContext.entranceIndex == ENTR_CHAMBER_OF_THE_SAGES_0 && gSaveContext.cutsceneIndex == 0x0 && gSaveContext.chamberCutsceneNum == CHAMBER_CS_WATER) {
  // Normally set in the blue warp cutscene
  gSaveContext.dayTime = gSaveContext.skyboxTime = 0x4800;
  Flags_SetEventChkInf(EVENTCHKINF_RAISED_LAKE_HYLIA_WATER);
 
  gSaveContext.entranceIndex = ENTR_LAKE_HYLIA_9;
- isBlueWarp = 1;
+ isBlueWarpCutscene = 1;
  // Spirit Temple Blue warp
  } else if (gSaveContext.entranceIndex == ENTR_CHAMBER_OF_THE_SAGES_0 && gSaveContext.cutsceneIndex == 0x0 && gSaveContext.chamberCutsceneNum == CHAMBER_CS_SPIRIT) {
  gSaveContext.entranceIndex = ENTR_DESERT_COLOSSUS_8;
- isBlueWarp = 1;
+ isBlueWarpCutscene = 1;
  // Shadow Temple Blue warp
  } else if (gSaveContext.entranceIndex == ENTR_CHAMBER_OF_THE_SAGES_0 && gSaveContext.cutsceneIndex == 0x0 && gSaveContext.chamberCutsceneNum == CHAMBER_CS_SHADOW) {
  gSaveContext.entranceIndex = ENTR_GRAVEYARD_8;
- isBlueWarp = 1;
+ isBlueWarpCutscene = 1;
  }
 
- if (isBlueWarp) {
+ if (isBlueWarpCutscene) {
  if (gSaveContext.entranceIndex != ENTR_LAKE_HYLIA_9) {
  // Normally set in the blue warp cutscene
  gSaveContext.dayTime = gSaveContext.skyboxTime = 0x8000;
  }
 
  *should = false;
  gSaveContext.cutsceneIndex = 0;
+ }
 
-  if (IS_RANDO && (RAND_GET_OPTION(RSK_SHUFFLE_DUNGEON_ENTRANCES) != RO_DUNGEON_ENTRANCE_SHUFFLE_OFF || RAND_GET_OPTION(RSK_SHUFFLE_BOSS_ENTRANCES) != RO_BOSS_ROOM_ENTRANCE_SHUFFLE_OFF)) {
-  Entrance_OverrideBlueWarp();
- }
+ // This is outside the above condition because we want to handle both first and following visits to the blue warp
+ if (IS_RANDO && (RAND_GET_OPTION(RSK_SHUFFLE_DUNGEON_ENTRANCES) != RO_DUNGEON_ENTRANCE_SHUFFLE_OFF || RAND_GET_OPTION(RSK_SHUFFLE_BOSS_ENTRANCES) != RO_BOSS_ROOM_ENTRANCE_SHUFFLE_OFF)) {
+ Entrance_OverrideBlueWarp();
  }
  }
 }

soh/soh/Enhancements/TimeSavers/TimeSavers.cpp

@@ -11,4 +11,5 @@ void TimeSavers_Register() {
  SkipIntro_Register();
  // SkipMiscInteractions
  MoveMidoInKokiriForest_Register();
+ FasterHeavyBlockLift_Register();
 }

soh/soh/Enhancements/TimeSavers/TimeSavers.h

@@ -13,5 +13,6 @@ void TimeSavers_Register();
  void SkipIntro_Register();
 // SkipMiscInteractions
  void MoveMidoInKokiriForest_Register();
+void FasterHeavyBlockLift_Register();
 
 #endif // TIME_SAVERS_H

soh/soh/Enhancements/audio/AudioEditor.cpp

@@ -424,12 +424,6 @@ void AudioEditor::InitElement() {
 void AudioEditor::DrawElement() {
  AudioCollection::Instance->InitializeShufflePool();
 
- ImGui::SetNextWindowSize(ImVec2(820, 630), ImGuiCond_FirstUseEver);
- if (!ImGui::Begin("Audio Editor", &mIsVisible)) {
- ImGui::End();
- return;
- }
-
  float buttonSegments = ImGui::GetContentRegionAvail().x / 4;
  if (ImGui::Button("Randomize All Groups", ImVec2(buttonSegments, 30.0f))) {
  AudioEditor_RandomizeAll();
@@ -700,7 +694,6 @@ void AudioEditor::DrawElement() {
 
  ImGui::EndTabBar();
  }
- ImGui::End();
 }
 
 std::vector<SeqType> allTypes = { SEQ_BGM_WORLD, SEQ_BGM_EVENT, SEQ_BGM_BATTLE, SEQ_OCARINA, SEQ_FANFARE, SEQ_INSTRUMENT, SEQ_SFX, SEQ_VOICE };