Merge pull request #240 from TwilitRealm/presets

First run config presets

files.cmake

@@ -1363,6 +1363,8 @@ set(DUSK_FILES
         src/dusk/imgui/ImGuiMenuEnhancements.hpp
         src/dusk/imgui/ImGuiPreLaunchWindow.cpp
         src/dusk/imgui/ImGuiPreLaunchWindow.hpp
+        src/dusk/imgui/ImGuiFirstRunPreset.hpp
+        src/dusk/imgui/ImGuiFirstRunPreset.cpp
         src/dusk/imgui/ImGuiProcessOverlay.cpp
         src/dusk/imgui/ImGuiCameraOverlay.cpp
         src/dusk/imgui/ImGuiHeapOverlay.cpp

include/dusk/settings.h

@@ -77,6 +77,7 @@ struct UserSettings {
         ConfigVar<std::string> graphicsBackend;
         ConfigVar<bool> skipPreLaunchUI;
         ConfigVar<bool> showPipelineCompilation;
+        ConfigVar<bool> wasPresetChosen;
     } backend;
 };
 

src/d/actor/d_a_title.cpp

@@ -18,6 +18,10 @@
 #include "JSystem/J2DGraph/J2DTextBox.h"
 #include "m_Do/m_Do_graphic.h"
 
+#if TARGET_PC
+#include <dusk/config.hpp>
+#endif
+
 class daTit_HIO_c : public JORReflexible {
 public:
     daTit_HIO_c();
@@ -152,6 +156,12 @@ int daTitle_c::createHeapCallBack(fopAc_ac_c* actor) {
 }
 
 int daTitle_c::Execute() {
+    #if TARGET_PC
+    if (!dusk::getSettings().backend.wasPresetChosen) {
+        return 0;
+    }
+    #endif
+
 #if PLATFORM_WII || PLATFORM_SHIELD
     mDoGph_gInf_c::resetDimming();
 #endif
@@ -370,6 +380,12 @@ int daTitle_c::getDemoPrm() {
 }
 
 int daTitle_c::Draw() {
+    #if TARGET_PC
+    if (!dusk::getSettings().backend.wasPresetChosen) {
+        return 0;
+    }
+    #endif
+
     J3DModelData* modelData = mpModel->getModelData();
     cMtx_trans(mpModel->getBaseTRMtx(), IREG_F(7), IREG_F(8), IREG_F(9) + -430.0f);
     mpModel->getBaseScale()->x = -1.0f;

src/d/d_s_play.cpp

@@ -39,7 +39,9 @@
 #include "JSystem/JKernel/JKRAram.h"
 #include "JSystem/JKernel/JKRAramArchive.h"
 
+#if TARGET_PC
 #include "dusk/memory.h"
+#endif
 
 #if DEBUG
 #include "d/d_s_menu.h"

src/dusk/imgui/ImGuiConsole.cpp

@@ -206,10 +206,6 @@ namespace dusk {
 
     void ImGuiConsole::PreDraw() {
         ZoneScoped;
-        if (dusk::IsGameLaunched && !m_isLaunchInitialized) {
-            m_toasts.emplace_back("Press F1 to toggle menu"s, 5.f);
-            m_isLaunchInitialized = true;
-        }
 
         UpdateSettings();
 
@@ -241,6 +237,18 @@ namespace dusk {
             m_preLaunchWindow.draw();
         }
 
+        if (!m_isLaunchInitialized && !getSettings().backend.wasPresetChosen) {
+            if (dusk::IsGameLaunched) {
+                m_firstRunPreset.draw();
+            }
+            return;
+        }
+
+        if (!m_isLaunchInitialized) {
+            m_toasts.emplace_back("Press F1 to toggle menu"s, 5.f);
+            m_isLaunchInitialized = true;
+        }
+
         m_menuGame.windowControllerConfig();
         m_menuGame.windowInputViewer();
         if (dusk::IsGameLaunched) {

src/dusk/imgui/ImGuiConsole.hpp

@@ -6,6 +6,7 @@
 #include <string>
 #include <string_view>
 
+#include "ImGuiFirstRunPreset.hpp"
 #include "ImGuiMenuEnhancements.hpp"
 #include "ImGuiMenuGame.hpp"
 #include "ImGuiMenuTools.hpp"
@@ -35,6 +36,7 @@ private:
     bool m_isLaunchInitialized = false;
     std::deque<Toast> m_toasts;
 
+    ImGuiFirstRunPreset m_firstRunPreset;
     ImGuiMenuGame m_menuGame;
     ImGuiMenuEnhancements m_menuEnhancements;
     ImGuiPreLaunchWindow m_preLaunchWindow;

src/dusk/imgui/ImGuiFirstRunPreset.cpp

@@ -0,0 +1,108 @@
+#include "ImGuiFirstRunPreset.hpp"
+
+#include "imgui.h"
+#include "ImGuiConsole.hpp"
+#include "ImGuiEngine.hpp"
+#include "dusk/settings.h"
+#include "dusk/config.hpp"
+
+namespace dusk {
+
+static void ApplyPresetStandard() {
+    auto& s = getSettings();
+    s.video.lockAspectRatio.setValue(true);
+}
+
+static void ApplyPresetHD() {
+    auto& s = getSettings();
+    s.game.hideTvSettingsScreen.setValue(true);
+    s.game.noReturnRupees.setValue(true);
+    s.game.disableRupeeCutscenes.setValue(true);
+    s.game.noSwordRecoil.setValue(true);
+    s.game.fastClimbing.setValue(true);
+    s.game.noMissClimbing.setValue(true);
+    s.game.fastTears.setValue(true);
+    s.game.biggerWallets.setValue(true);
+    s.game.invertCameraXAxis.setValue(true);
+}
+
+// =========================================================================
+
+void ImGuiFirstRunPreset::draw() {
+    const char* modalTitle = "Welcome to Dusk!";
+
+    if (m_done) return;
+
+    if (!m_opened) {
+        ImGui::OpenPopup(modalTitle);
+        m_opened = true;
+    }
+
+    const ImGuiViewport* viewport = ImGui::GetMainViewport();
+    ImGui::SetNextWindowPos(viewport->GetCenter(), ImGuiCond_Always, ImVec2(0.5f, 0.5f));
+    ImGui::SetNextWindowSize(ImVec2(800.0f * ImGuiScale(), 0.0f), ImGuiCond_Always);
+
+    if (!ImGui::BeginPopupModal(modalTitle, nullptr, ImGuiWindowFlags_AlwaysAutoResize | ImGuiWindowFlags_NoMove)) {
+        // force the user to actually pick one, and not just hit escape to skip the dialog
+        m_opened = false;
+        return;
+    }
+
+    ImGui::TextWrapped("Choose a preset to get started. You can change any setting later from the Enhancements menu.");
+    ImGui::Spacing();
+    ImGui::Separator();
+    ImGui::Spacing();
+
+    int chosen = -1;
+
+    if (ImGui::BeginTable("##presets", 3, ImGuiTableFlags_None)) {
+        ImGui::TableSetupColumn(nullptr, ImGuiTableColumnFlags_WidthStretch);
+        ImGui::TableSetupColumn(nullptr, ImGuiTableColumnFlags_WidthFixed, 16.0f * ImGuiScale());
+        ImGui::TableSetupColumn(nullptr, ImGuiTableColumnFlags_WidthStretch);
+
+
+        ImGui::TableNextRow();
+
+        ImGui::PushFont(ImGuiEngine::fontLarge);
+
+        ImGui::TableSetColumnIndex(0);
+        if (ImGui::Button("Standard##btn", ImVec2(ImGui::GetContentRegionAvail().x, 80.0f * ImGuiScale()))) {
+            chosen = 0;
+        }
+
+        ImGui::TableSetColumnIndex(2);
+        if (ImGui::Button("HD##btn", ImVec2(ImGui::GetContentRegionAvail().x, 80.0f * ImGuiScale()))) {
+            chosen = 1;
+        }
+
+        ImGui::PopFont();
+
+        ImGui::TableNextRow();
+
+        ImGui::TableSetColumnIndex(0);
+        ImGui::Spacing();
+        ImGui::TextWrapped("All enhancements disabled to match the GameCube version. Good for speedrunning or simple nostalgia!");
+
+        ImGui::TableSetColumnIndex(2);
+        ImGui::Spacing();
+        ImGui::TextWrapped("Some enhancements enabled to match the HD version. A good starting point for most players!");
+
+        ImGui::EndTable();
+    }
+
+    if (chosen >= 0) {
+        if (chosen == 0) ApplyPresetStandard();
+        if (chosen == 1) ApplyPresetHD();
+
+        getSettings().backend.wasPresetChosen.setValue(true);
+        config::Save();
+
+        m_done = true;
+
+        ImGui::CloseCurrentPopup();
+    }
+
+    ImGui::EndPopup();
+}
+
+}  // namespace dusk

src/dusk/imgui/ImGuiFirstRunPreset.hpp

@@ -0,0 +1,14 @@
+#pragma once
+
+namespace dusk {
+
+class ImGuiFirstRunPreset {
+public:
+    void draw();
+
+private:
+    bool m_opened = false;
+    bool m_done = false;
+};
+
+}  // namespace dusk

src/dusk/settings.cpp

@@ -57,14 +57,15 @@ UserSettings g_userSettings = {
         .restoreWiiGlitches {"game.restoreWiiGlitches", false},
 
         // Controls
-        .enableTurboKeybind {"game.enableTurboKeybind", true},
+        .enableTurboKeybind {"game.enableTurboKeybind", false},
     },
 
     .backend = {
         .isoPath {"backend.isoPath", ""},
         .graphicsBackend {"backend.graphicsBackend", "auto"},
         .skipPreLaunchUI {"backend.skipPreLaunchUI", false},
-        .showPipelineCompilation{"backend.showPipelineCompilation", false}
+        .showPipelineCompilation{"backend.showPipelineCompilation", false},
+        .wasPresetChosen{"backend.wasPresetChosen", false}
     }
 };
 
@@ -117,6 +118,7 @@ void registerSettings() {
     Register(g_userSettings.backend.graphicsBackend);
     Register(g_userSettings.backend.skipPreLaunchUI);
     Register(g_userSettings.backend.showPipelineCompilation);
+    Register(g_userSettings.backend.wasPresetChosen);
 }
 
 // Transient settings