Incorporate LUS CMake CVar system (HarbourMasters#4093)

* Incorporate LUS CMake CVar system. Customize all LUS CMake CVars to align with plans for preset system. Swap "gOverlayFont" usage back to LUS CVar macro. * Change CMake sets to use the cache to allow for including LUS's file for the add_compile_defines and remove the duplication on SoH's side. * Move SoH CMake CVars to `soh-cvars.cmake` for clarity.
jbodner09 · May 1, 2024 · 715bf39 · 715bf39
1 parent 56fe449
commit 715bf39
Show file tree

Hide file tree

Showing 15 changed files with 113 additions and 61 deletions.
diff --git a/CMake/lus-cvars.cmake b/CMake/lus-cvars.cmake
@@ -0,0 +1,24 @@
+set(CVAR_VSYNC_ENABLED "${CVAR_PREFIX_SETTING}.VsyncEnabled" CACHE STRING "")
+set(CVAR_Z_FIGHTING_MODE "${CVAR_PREFIX_SETTING}.ZFightingMode" CACHE STRING "")
+set(CVAR_NEW_FILE_DROPPED "${CVAR_PREFIX_GENERAL}.NewFileDropped" CACHE STRING "")
+set(CVAR_DROPPED_FILE "${CVAR_PREFIX_GENERAL}.DroppedFile" CACHE STRING "")
+set(CVAR_INTERNAL_RESOLUTION "${CVAR_PREFIX_SETTING}.InternalResolution" CACHE STRING "")
+set(CVAR_MSAA_VALUE "${CVAR_PREFIX_SETTING}.MSAAValue" CACHE STRING "")
+set(CVAR_SDL_WINDOWED_FULLSCREEN "${CVAR_PREFIX_SETTING}.SdlWindowedFullscreen" CACHE STRING "")
+set(CVAR_TEXTURE_FILTER "${CVAR_PREFIX_SETTING}.TextureFilter" CACHE STRING "")
+set(CVAR_IMGUI_CONTROLLER_NAV "${CVAR_PREFIX_SETTING}.ControlNav" CACHE STRING "")
+set(CVAR_CONSOLE_WINDOW_OPEN "${CVAR_PREFIX_WINDOW}.Console" CACHE STRING "")
+set(CVAR_CONTROLLER_CONFIGURATION_WINDOW_OPEN "${CVAR_PREFIX_WINDOW}.ControllerConfiguration" CACHE STRING "")
+set(CVAR_CONTROLLER_DISCONNECTED_WINDOW_OPEN "${CVAR_PREFIX_WINDOW}.ControllerDisconnected" CACHE STRING "")
+set(CVAR_CONTROLLER_REORDERING_WINDOW_OPEN "${CVAR_PREFIX_WINDOW}.ControllerReordering" CACHE STRING "")
+set(CVAR_GFX_DEBUGGER_WINDOW_OPEN "${CVAR_PREFIX_WINDOW}.GfxDebugger" CACHE STRING "")
+set(CVAR_STATS_WINDOW_OPEN "${CVAR_PREFIX_WINDOW}.Stats" CACHE STRING "")
+set(CVAR_ENABLE_MULTI_VIEWPORTS "${CVAR_PREFIX_SETTING}.EnableMultiViewports" CACHE STRING "")
+set(CVAR_LOW_RES_MODE "${CVAR_PREFIX_SETTING}.LowResMode" CACHE STRING "")
+set(CVAR_SIMULATED_INPUT_LAG "${CVAR_PREFIX_SETTING}.SimulatedInputLag" CACHE STRING "")
+set(CVAR_ALT_ASSETS "${CVAR_PREFIX_ENHANCEMENT}.AltAssets" CACHE STRING "")
+set(CVAR_GAME_OVERLAY_FONT "${CVAR_PREFIX_SETTING}.OverlayFont" CACHE STRING "")
+set(CVAR_MENU_BAR_OPEN "${CVAR_PREFIX_SETTING}.OpenMenuBar" CACHE STRING "")
+set(CVAR_PREFIX_CONTROLLERS "${CVAR_PREFIX_SETTING}.Controllers" CACHE STRING "")
+set(CVAR_PREFIX_ADVANCED_RESOLUTION "${CVAR_PREFIX_SETTING}.AdvancedResolution" CACHE STRING "")
+include("libultraship/cmake/cvars.cmake")
diff --git a/CMake/soh-cvars.cmake b/CMake/soh-cvars.cmake
@@ -0,0 +1,26 @@
+set(CVAR_PREFIX_RANDOMIZER_ENHANCEMENT "gRandoEnhancements")
+set(CVAR_PREFIX_RANDOMIZER_SETTING "gRandoSettings")
+set(CVAR_PREFIX_COSMETIC "gCosmetics")
+set(CVAR_PREFIX_AUDIO "gAudioEditor")
+set(CVAR_PREFIX_CHEAT "gCheats")
+set(CVAR_PREFIX_ENHANCEMENT "gEnhancements")
+set(CVAR_PREFIX_SETTING "gSettings")
+set(CVAR_PREFIX_WINDOW "gOpenWindows")
+set(CVAR_PREFIX_TRACKER "gTrackers")
+set(CVAR_PREFIX_DEVELOPER_TOOLS "gDeveloperTools")
+set(CVAR_PREFIX_GENERAL "gGeneral")
+set(CVAR_PREFIX_REMOTE "gRemote")
+add_compile_definitions(
+	CVAR_PREFIX_RANDOMIZER_ENHANCEMENT="${CVAR_PREFIX_RANDOMIZER_ENHANCEMENT}"
+	CVAR_PREFIX_RANDOMIZER_SETTING="${CVAR_PREFIX_RANDOMIZER_SETTING}"
+	CVAR_PREFIX_COSMETIC="${CVAR_PREFIX_COSMETIC}"
+	CVAR_PREFIX_AUDIO="${CVAR_PREFIX_AUDIO}"
+	CVAR_PREFIX_CHEAT="${CVAR_PREFIX_CHEAT}"
+	CVAR_PREFIX_ENHANCEMENT="${CVAR_PREFIX_ENHANCEMENT}"
+	CVAR_PREFIX_SETTING="${CVAR_PREFIX_SETTING}"
+	CVAR_PREFIX_WINDOW="${CVAR_PREFIX_WINDOW}"
+	CVAR_PREFIX_TRACKER="${CVAR_PREFIX_TRACKER}"
+	CVAR_PREFIX_DEVELOPER_TOOLS="${CVAR_PREFIX_DEVELOPER_TOOLS}"
+	CVAR_PREFIX_GENERAL="${CVAR_PREFIX_GENERAL}"
+	CVAR_PREFIX_REMOTE="${CVAR_PREFIX_REMOTE}"
+)
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -6,6 +6,8 @@ set(CMAKE_CXX_STANDARD 20 CACHE STRING "The C++ standard to use")
 set(CMAKE_OSX_DEPLOYMENT_TARGET "10.15" CACHE STRING "Minimum OS X deployment version")
 
 project(Ship VERSION 8.0.5 LANGUAGES C CXX)
+include(CMake/soh-cvars.cmake)
+include(CMake/lus-cvars.cmake)
 set(PROJECT_BUILD_NAME "MacReady Foxtrot" CACHE STRING "")
 set(PROJECT_TEAM "github.com/harbourmasters" CACHE STRING "")
 

diff --git a/soh/soh/Enhancements/bootcommands.c b/soh/soh/Enhancements/bootcommands.c
@@ -29,7 +29,7 @@ void BootCommands_Init()
     CVarClear("gCheatEasyPauseBufferLastInputs");
     CVarClear("gCheatEasyPauseBufferTimer");
 #if defined(__SWITCH__) || defined(__WIIU__)
-    CVarRegisterInteger("gControlNav", 1); // always enable controller nav on switch/wii u
+    CVarRegisterInteger(CVAR_IMGUI_CONTROLLER_NAV, 1); // always enable controller nav on switch/wii u
 #endif
 }
 

diff --git a/soh/soh/Enhancements/mods.cpp b/soh/soh/Enhancements/mods.cpp
@@ -660,10 +660,10 @@ void UpdateDirtPathFixState(int32_t sceneNum) {
         case SCENE_HYRULE_FIELD:
         case SCENE_KOKIRI_FOREST:
         case SCENE_HYRULE_CASTLE:
-            CVarSetInteger("gZFightingMode", CVarGetInteger(CVAR_ENHANCEMENT("SceneSpecificDirtPathFix"), ZFIGHT_FIX_DISABLED));
+            CVarSetInteger(CVAR_Z_FIGHTING_MODE, CVarGetInteger(CVAR_ENHANCEMENT("SceneSpecificDirtPathFix"), ZFIGHT_FIX_DISABLED));
             return;
         default:
-            CVarClear("gZFightingMode");
+            CVarClear(CVAR_Z_FIGHTING_MODE);
     }
 }
 

diff --git a/soh/soh/Enhancements/presets.h b/soh/soh/Enhancements/presets.h
@@ -223,12 +223,12 @@ const std::vector<const char*> enhancementsCvars = {
     CVAR_ENHANCEMENT("DisableLOD"),
     CVAR_ENHANCEMENT("DisableDrawDistance"),
     CVAR_ENHANCEMENT("DisableKokiriDrawDistance"),
-    "gLowResMode",
+    CVAR_LOW_RES_MODE,
     CVAR_ENHANCEMENT("DrawLineupTick"),
     CVAR_ENHANCEMENT("QuickBongoKill"),
     CVAR_ENHANCEMENT("FirstPersonGauntlets"),
     CVAR_ENHANCEMENT("SceneSpecificDirtPathFix"),
-    "gZFightingMode",
+    CVAR_Z_FIGHTING_MODE,
     CVAR_ENHANCEMENT("AuthenticLogo"),
     CVAR_ENHANCEMENT("PauseLiveLinkRotationSpeed"),
     CVAR_ENHANCEMENT("BowReticle"),
@@ -282,7 +282,7 @@ const std::vector<const char*> enhancementsCvars = {
 };
 
 const std::vector<const char*> cheatCvars = {
-    "gConsoleEnabled",
+    CVAR_CONSOLE_WINDOW_OPEN,
     CVAR_WINDOW("ActorViewer"),
     CVAR_WINDOW("CollisionViewer"),
     CVAR_WINDOW("DLViewer"),
@@ -336,7 +336,7 @@ const std::vector<const char*> cheatCvars = {
     CVAR_CHEAT("NoFishDespawn"),
     CVAR_CHEAT("NoBugsDespawn"),
     "gWalkModifierDoesntChangeJump",
-    "gStatsEnabled",
+    CVAR_STATS_WINDOW_OPEN,
     CVAR_CHEAT("SaveStatesEnabled"),
     CVAR_CHEAT("SaveStatePromise"),
     CVAR_DEVELOPER_TOOLS("RegEditEnabled"),

diff --git a/soh/soh/Enhancements/resolution-editor/ResolutionEditor.cpp b/soh/soh/Enhancements/resolution-editor/ResolutionEditor.cpp
@@ -114,19 +114,19 @@ void AdvancedResolutionSettingsWindow::DrawElement() {
             // The original resolution slider (for convenience)
             const bool disabled_resolutionSlider = (CVarGetInteger("gAdvancedResolution.VerticalResolutionToggle", 0) &&
                                                     CVarGetInteger("gAdvancedResolution.Enabled", 0)) ||
-                                                   CVarGetInteger("gLowResMode", 0);
-            if (UIWidgets::EnhancementSliderFloat("Internal Resolution: %.1f%%", "##IMul", "gInternalResolution", 0.5f,
+                                                   CVarGetInteger(CVAR_LOW_RES_MODE, 0);
+            if (UIWidgets::EnhancementSliderFloat("Internal Resolution: %.1f%%", "##IMul", CVAR_INTERNAL_RESOLUTION, 0.5f,
                                                   2.0f, "", 1.0f, true, true, disabled_resolutionSlider)) {
                 Ship::Context::GetInstance()->GetWindow()->SetResolutionMultiplier(
-                    CVarGetFloat("gInternalResolution", 1));
+                    CVarGetFloat(CVAR_INTERNAL_RESOLUTION, 1));
             }
             UIWidgets::Tooltip("Multiplies your output resolution by the value entered.");
 
             // The original MSAA slider (also for convenience)
 #ifndef __WIIU__
-            if (UIWidgets::PaddedEnhancementSliderInt("MSAA: %d", "##IMSAA", "gMSAAValue", 1, 8, "", 1, true, true,
+            if (UIWidgets::PaddedEnhancementSliderInt("MSAA: %d", "##IMSAA", CVAR_MSAA_VALUE, 1, 8, "", 1, true, true,
                                                       false)) {
-                Ship::Context::GetInstance()->GetWindow()->SetMsaaLevel(CVarGetInteger("gMSAAValue", 1));
+                Ship::Context::GetInstance()->GetWindow()->SetMsaaLevel(CVarGetInteger(CVAR_MSAA_VALUE, 1));
             };
             UIWidgets::Tooltip(
                 "Activates multi-sample anti-aliasing when above 1x, up to 8x for 8 samples for every pixel.\n\n"
@@ -135,15 +135,15 @@ void AdvancedResolutionSettingsWindow::DrawElement() {
 #endif
 
             // N64 Mode toggle (again for convenience)
-            // UIWidgets::PaddedEnhancementCheckbox("(Enhancements>Graphics) N64 Mode", "gLowResMode", false, false, false, "", UIWidgets::CheckboxGraphics::Cross, false);
+            // UIWidgets::PaddedEnhancementCheckbox("(Enhancements>Graphics) N64 Mode", CVAR_LOW_RES_MODE, false, false, false, "", UIWidgets::CheckboxGraphics::Cross, false);
         }
 
         UIWidgets::PaddedSeparator(true, true, 3.0f, 3.0f);
         // Activator
         UIWidgets::PaddedEnhancementCheckbox("Enable advanced settings.", "gAdvancedResolution.Enabled", false, false,
                                              false, "", UIWidgets::CheckboxGraphics::Cross, false);
         // Error/Warning display
-        if (!CVarGetInteger("gLowResMode", 0)) {
+        if (!CVarGetInteger(CVAR_LOW_RES_MODE, 0)) {
             if (IsDroppingFrames()) { // Significant frame drop warning
                 ImGui::TextColored(messageColor[MESSAGE_WARNING],
                                    ICON_FA_EXCLAMATION_TRIANGLE " Significant frame rate (FPS) drops may be occuring.");
@@ -156,7 +156,7 @@ void AdvancedResolutionSettingsWindow::DrawElement() {
                                ICON_FA_QUESTION_CIRCLE " \"N64 Mode\" is overriding these settings.");
             ImGui::SameLine();
             if (ImGui::Button("Click to disable")) {
-                CVarSetInteger("gLowResMode", 0);
+                CVarSetInteger(CVAR_LOW_RES_MODE, 0);
                 CVarSave();
             }
         }

diff --git a/soh/soh/OTRGlobals.cpp b/soh/soh/OTRGlobals.cpp
@@ -318,13 +318,13 @@ OTRGlobals::OTRGlobals() {
     context->InitCrashHandler();
     context->InitConsole();
 
-    auto sohInputEditorWindow = std::make_shared<SohInputEditorWindow>("gControllerConfigurationEnabled", "Input Editor");
+    auto sohInputEditorWindow = std::make_shared<SohInputEditorWindow>(CVAR_CONTROLLER_CONFIGURATION_WINDOW_OPEN, "Input Editor");
     context->InitWindow({ sohInputEditorWindow });
 
     auto overlay = context->GetInstance()->GetWindow()->GetGui()->GetGameOverlay();
     overlay->LoadFont("Press Start 2P", "fonts/PressStart2P-Regular.ttf", 12.0f);
     overlay->LoadFont("Fipps", "fonts/Fipps-Regular.otf", 32.0f);
-    overlay->SetCurrentFont(CVarGetString("gOverlayFont", "Press Start 2P"));
+    overlay->SetCurrentFont(CVarGetString(CVAR_GAME_OVERLAY_FONT, "Press Start 2P"));
 
     context->InitAudio();
 
@@ -1330,13 +1330,13 @@ extern "C" void Graph_StartFrame() {
     }
 #endif
 
-    if (CVarGetInteger("gNewFileDropped", 0)) {
-        std::string filePath = SohUtils::Sanitize(CVarGetString("gDroppedFile", ""));
+    if (CVarGetInteger(CVAR_NEW_FILE_DROPPED, 0)) {
+        std::string filePath = SohUtils::Sanitize(CVarGetString(CVAR_DROPPED_FILE, ""));
         if (!filePath.empty()) {
             GameInteractor::Instance->ExecuteHooks<GameInteractor::OnFileDropped>(filePath);
         }
-        CVarClear("gNewFileDropped");
-        CVarClear("gDroppedFile");
+        CVarClear(CVAR_NEW_FILE_DROPPED);
+        CVarClear(CVAR_DROPPED_FILE);
     }
 
     OTRGlobals::Instance->context->GetWindow()->StartFrame();
@@ -1408,7 +1408,7 @@ extern "C" void Graph_ProcessGfxCommands(Gfx* commands) {
         ToggleAltAssetsAtEndOfFrame = false;
 
         // Actually update the CVar now before runing the alt asset update listeners
-        CVarSetInteger("gAltAssets", !CVarGetInteger("gAltAssets", 0));
+        CVarSetInteger(CVAR_ALT_ASSETS, !CVarGetInteger(CVAR_ALT_ASSETS, 0));
         gfx_texture_cache_clear();
         SOH::SkeletonPatcher::UpdateSkeletons();
         GameInteractor::Instance->ExecuteHooks<GameInteractor::OnAssetAltChange>();
@@ -1587,7 +1587,7 @@ extern "C" uint8_t ResourceMgr_FileAltExists(const char* filePath) {
 // Unloads a resource if an alternate version exists when alt assets are enabled
 // The resource is only removed from the internal cache to prevent it from used in the next resource lookup
 extern "C" void ResourceMgr_UnloadOriginalWhenAltExists(const char* resName) {
-    if (CVarGetInteger("gAltAssets", 0) && ResourceMgr_FileAltExists((char*) resName)) {
+    if (CVarGetInteger(CVAR_ALT_ASSETS, 0) && ResourceMgr_FileAltExists((char*) resName)) {
         ResourceMgr_UnloadResource((char*) resName);
     }
 }
@@ -1938,7 +1938,7 @@ extern "C" SkeletonHeader* ResourceMgr_LoadSkeletonByName(const char* path, Skel
         pathStr = pathStr.substr(sOtr.length());
     }
 
-    bool isAlt = CVarGetInteger("gAltAssets", 0);
+    bool isAlt = CVarGetInteger(CVAR_ALT_ASSETS, 0);
 
     if (isAlt) {
         pathStr = Ship::IResource::gAltAssetPrefix + pathStr;

diff --git a/soh/soh/OTRGlobals.h b/soh/soh/OTRGlobals.h
@@ -65,21 +65,21 @@ class OTRGlobals
 uint32_t IsGameMasterQuest();
 #endif
 
-#define CVAR_RANDOMIZER_ENHANCEMENT(var) "gRandoEnhancements." var
-#define CVAR_RANDOMIZER_SETTING(var) "gRandoSettings." var
-#define CVAR_COSMETIC(var) "gCosmetics." var
-#define CVAR_AUDIO(var) "gAudioEditor." var
-#define CVAR_CHEAT(var) "gCheats." var
-#define CVAR_ENHANCEMENT(var) "gEnhancements." var
-#define CVAR_SETTING(var) "gSettings." var
-#define CVAR_WINDOW(var) "gOpenWindows." var
-#define CVAR_TRACKER(var) "gTrackers." var
-#define CVAR_TRACKER_ITEM(var) CVAR_TRACKER("ItemTracker." var)
-#define CVAR_TRACKER_CHECK(var) CVAR_TRACKER("CheckTracker." var)
-#define CVAR_TRACKER_ENTRANCE(var) CVAR_TRACKER("EntranceTracker." var)
-#define CVAR_DEVELOPER_TOOLS(var) "gDeveloperTools." var
-#define CVAR_GENERAL(var) "gGeneral." var
-#define CVAR_REMOTE(var) "gRemote." var
+#define CVAR_RANDOMIZER_ENHANCEMENT(var) CVAR_PREFIX_RANDOMIZER_ENHANCEMENT "." var
+#define CVAR_RANDOMIZER_SETTING(var) CVAR_PREFIX_RANDOMIZER_SETTING "." var
+#define CVAR_COSMETIC(var) CVAR_PREFIX_COSMETIC "." var
+#define CVAR_AUDIO(var) CVAR_PREFIX_AUDIO "." var
+#define CVAR_CHEAT(var) CVAR_PREFIX_CHEAT "." var
+#define CVAR_ENHANCEMENT(var) CVAR_PREFIX_ENHANCEMENT "." var
+#define CVAR_SETTING(var) CVAR_PREFIX_SETTING "." var
+#define CVAR_WINDOW(var) CVAR_PREFIX_WINDOW "." var
+#define CVAR_TRACKER(var) CVAR_PREFIX_TRACKER "." var
+#define CVAR_TRACKER_ITEM(var) CVAR_TRACKER(".ItemTracker." var)
+#define CVAR_TRACKER_CHECK(var) CVAR_TRACKER(".CheckTracker." var)
+#define CVAR_TRACKER_ENTRANCE(var) CVAR_TRACKER(".EntranceTracker." var)
+#define CVAR_DEVELOPER_TOOLS(var) CVAR_PREFIX_DEVELOPER_TOOLS "." var
+#define CVAR_GENERAL(var) CVAR_PREFIX_GENERAL "." var
+#define CVAR_REMOTE(var) CVAR_PREFIX_REMOTE "." var
 
 #ifndef __cplusplus
     void InitOTR(void);

diff --git a/soh/soh/SohGui.cpp b/soh/soh/SohGui.cpp
@@ -139,7 +139,7 @@ namespace SohGui {
     void SetupGuiElements() {
         auto gui = Ship::Context::GetInstance()->GetWindow()->GetGui();
 
-        mSohMenuBar = std::make_shared<SohMenuBar>("gOpenMenuBar", CVarGetInteger("gOpenMenuBar", 0));
+        mSohMenuBar = std::make_shared<SohMenuBar>(CVAR_MENU_BAR_OPEN, CVarGetInteger(CVAR_MENU_BAR_OPEN, 0));
         gui->SetMenuBar(std::reinterpret_pointer_cast<Ship::GuiMenuBar>(mSohMenuBar));
 
         if (gui->GetMenuBar() && !gui->GetMenuBar()->IsVisible()) {