Skip to content

Port Cvar_Prefix.h and ConfigUpdater from SoH #1339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
Glought wants to merge 37 commits into
base: develop
Choose a base branch
from
Open

Port Cvar_Prefix.h and ConfigUpdater from SoH #1339

Glought wants to merge 37 commits into from

Conversation

@Glought
Copy link
Contributor

@Glought Glought commented Nov 12, 2025 •
edited by github-actions bot
Loading

I have port over Cvar_Prefix.h from SoH.

While working on my other PR #1325 I saw inconsistency with the Cvar naming

Example
In BenMenu.cpp:

AddWidget(path, "Fix Console Crashes", WIDGET_CVAR_CHECKBOX)
        .CVar("gEnhancements.Fixes.ConsoleCrashes")
AddWidget(path, "Fix Ammo Count Color", WIDGET_CVAR_CHECKBOX)'
        .CVar("gFixes.FixAmmoCountEnvColor")'
AddWidget(path, "Popout Gfx Debugger", WIDGET_WINDOW_BUTTON)'
        .CVar("gOpenWindows.GfxDebugger")'
AddWidget(path, "Popout Hook Debugger", WIDGET_WINDOW_BUTTON)'
        .CVar("gWindows.HookDebugger")`

I thought I'll help by implementing how its done in SoH.

CVAR MACRO Prefix Notes
CVAR_RANDOMIZER "gRando." Added
CVAR_RANDOMIZER_ENHANCEMENT "gRando.Enhancement." (Future use)
CVAR_RANDOMIZER_SETTING "gRando.Setting." (Future use)
CVAR_COSMETIC "gCosmetics."
CVAR_AUDIO "gAudioEditor."
CVAR_CHEAT "gCheats."
CVAR_ENHANCEMENT "gEnhancements."
CVAR_SETTING "gSettings."
CVAR_WINDOW "gOpenWindows."
CVAR_TRACKER "gTrackers."
CVAR_TRACKER_ITEM "gTrackers.ItemTracker."
CVAR_TRACKER_CHECK "gTrackers.CheckTracker."
CVAR_TRACKER_ENTRANCE "gTracker.EntraceTracker." (Future use)
CVAR_TRACKER_TIMESPLITS "gTrackers.TimeSplitsTracker."
CVAR_DEVELOPER_TOOLS "gDeveloperTools."
CVAR_GENERAL "gGeneral." (Future use)
CVAR_REMOTE "gRemote." (Future use)
CVAR_REMOTE_CROWD_CONTROL "gRemote.CrowdControl." (Future use)
CVAR_REMOTE_SAIL "gRemote.Sail." (Future use)
CVAR_GAMEPLAY_STATS "gGameplayStats." (Future use)
CVAR_TIME_DISPLAY "gTimeDisplay." (Future use)
CVAR_INPUT_VIEWER "gInputViewer."

With this lines like
Before:

AddWidget(path, "Fix Console Crashes", WIDGET_CVAR_CHECKBOX)
        .CVar("gEnhancements.Fixes.ConsoleCrashes")
AddWidget(path, "Fix Ammo Count Color", WIDGET_CVAR_CHECKBOX)'
        .CVar("gFixes.FixAmmoCountEnvColor")

After

AddWidget(path, "Fix Console Crashes", WIDGET_CVAR_CHECKBOX)
        .CVar(CVAR_ENHANCEMENT("Fixes.ConsoleCrashes"))
AddWidget(path, "Fix Ammo Count Color", WIDGET_CVAR_CHECKBOX)'
        .CVar(CVAR_ENHANCEMENT("Fixes.FixAmmoCountEnvColor")'

Moved Cvars:

I have reorganized CVars

Cvar Cvar Macro Expansion
"ItemTracker" CVAR_TRACKER_ITEM(*) "gTracker.ItemTracker.*"
"gRando.CheckTracker" CVAR_TRACKER_CHECK(*) "gTracker.CheckTracker.*"
"gSettings.TimeSplits" CVAR_TRACKER_TIMESPLITS(*) "gTracker.TimeSplitsTracker.*"
"gMatchRefreshRate" CVAR_SETTING("Graphics.MatchRefreshRate") "gSettings.Graphics.gMatchRefreshRate"
"gInterpolationFPS" CVAR_SETTING("Graphics.InterpolationFPS") "gSettings.Graphics.InterpolationFPS"
"gNotifications" CVAR_SETTING("Notifications.*") "gSettings.Notifications.*"
"gSettings.AdvancedResolution" CVAR_SETTING("Graphics.AdvancedResolution.*") "gSettings.Graphics.AdvancedResolution.*"
"gDisplayOverlay" CVAR_SETTING("DisplayOverlay.*") "gSettings.DisplayOverlay.*"
"gEventLog" CVAR_DEVELOPER_TOOLS("EventLog.*") "gDeveloperTools.EventLog.*"
"gCollisionViewer" CVAR_DEVELOPER_TOOLS("CollisionViewer.*") "gDeveloperTools.CollisionViewer.*"
"gModes" CVAR_ENHANCEMENT("Modes.*") "gEnhancements.Modes.*"
"gFixes" CVAR_ENHANCEMENT("Fixes.*") "gEnhancements.Fixes.*"
"gWindows" gOpenWindows("*") "gOpenWindows.*"

Configuration Migration

To make this as seamless I have ported over ConfigUpdater from SoH.
I have set it up to Migrate the Cvars I moved.

Here is a "2ship2harkinian.json" file for testing it has everything enabled.
2ship2harkinian.json

Build Artifacts

@Glought Glought force-pushed the cvar_prefixes branch 2 times, most recently from 9995571 to 46f4802 Compare November 13, 2025 13:41
@Glought Glought changed the title Ported Cvar_Prefix.h and ConfigUpdater from SoH Port Cvar_Prefix.h and ConfigUpdater from SoH Nov 14, 2025
@Glought Glought force-pushed the cvar_prefixes branch 4 times, most recently from 45fedd6 to c3a10dc Compare November 27, 2025 22:06
@Eblo Eblo mentioned this pull request Nov 29, 2025
Open
Glought added 22 commits December 27, 2025 01:01
@Glought
Ported "cvar_prefixes.h" Header file from SoH.
2b5cb77 
Added "CVAR_PREFIX_GAMEPLAY_STATS" and "CVAR_PREFIX_TIME_DISPLAY" to
"2ship-cvars.cmake"
@Glought
Changed code that uses "gCosmetics." to the "CVAR_COSMETIC" macro.
cac6fee
@Glought
Removed Redundant "CVAR_AUDIO" macro.
c455b41 
Added Include "Cvar_Prefixes.h"  to "AudioCollection.cpp" and
"AudioEditor.cpp"
@Glought
Changed code that uses "gCheats." to the "CVAR_CHEAT" macro.
389fb8b
@Glought
Changed code that uses "gEnhancements." to the "CVAR_ENHANCEMENT" macro.
f483af2
@Glought
Changed code that uses "gSettings." to the "CVAR_SETTING" macro.
0fa4f1b
@Glought
Changed code that uses "gWindows." to the "CVAR_WINDOW" macro.
a6fefa1 
Changed code that uses "gOpenWindows." to the "CVAR_WINDOW" macro.
@Glought
Changed code that uses "gDeveloperTools." to the "CVAR_DEVELOPER_TOOL…
cb409e2 
…S" macro.
@Glought
Added "CVAR_PREFIX_RANDOMIZER" macro to "2ship-cvars.cmake"
3dc939f 
 Removed "CVAR_PREFIX_RANDOMIZER_ENHANCEMENT" macro.
 Removed "CVAR_PREFIX_RANDOMIZER_SETTING" macro.
Added "CVAR_RANDOMIZER" macro to "cvar_prefixes.h"
 Kept "CVAR_RANDOMIZER_ENHANCEMENT" and "CVAR_RANDOMIZER_SETTING" macros
 for future use.
Changed code that uses "gRando." to the "CVAR_RANDOMIZER" macro.
@Glought
Removed "CFG_TRACKER_ITEM" macro in "ItemTracker.cpp".
8761b84 
Changed lines that used "CFG_TRACKER_ITEM" to the "CVAR_TRACKER_ITEM"
macro.
@Glought
Changed code that used the "CVAR_RANDOMIZER" macro to the
1cf60fe 
"CVAR_TRACKER_CHECK" macro in "CheckTracker.cpp".
@Glought
Changed code that uses "gModes." to the "CVAR_ENHANCEMENT("Modes.*")"
1132591 
macro.
@Glought
Changed code that uses "gFixes" to the "CVAR_ENHANCEMENT("Fixes.*")"
acdffbb 
macro.
@Glought
Updated PresetManager to reflect changes to "gFixes", "gModes",
2744f92 
"gWindows", and "ItemTracker"
Added "gTrackers" to "defaultsPresetJ" and "TagMap".
@Glought
Changed Code the uses "CVAR_PREFIX_ADVANCED_RESOLUTION" to
e3b5634 
the "CVAR_SETTING("Graphics.AdvancedResolution.*") macro.
@Glought
Ran Clang Format
dabe5b0
@Glought
Changed code that uses "gCollisionViewer." to the "CVAR_DEVELOPER_TOO…
90a61c8 
…LS("CollisionViewer.*")" macro.
@Glought
Changed code that uses "gEventLog." to the "CVAR_DEVELOPER_TOOLS("Eve…
5ec0ed9 
…ntLog.*")" macro.
@Glought
Added "#include "2s2h/cvar_prefixes.h"" to all files that uses a
25db9cc 
Cvar_Prefix macro
Added a Include guard to "cvar_prefixes.h"
@Glought
Added "CVAR_TRACKER_TIMESPLITS" macro.
ca58f76 
Changed code that uses "CVAR_SETTING("TimeSplits.*)" macro to use the
"CVAR_TRACKER_TIMESPLITS" macro.
@Glought
Changed code that used "gNotifications." to use the
1e1925b 
"CVAR_SETTING("Notifications.*)" macro
@Glought
Changed code the used "gDisplayOverlay." to use the
fd382fa 
"CVAR_SETTING("DisplayOverlay.*)" macro.
Glought added 15 commits December 27, 2025 01:17
@Glought
Changed code that used "gInterpolationFPS" to use the
a49691d 
"CVAR_SETTING("Graphics.InterpolationFPS")" macro.
@Glought
Changed code that used "gMatchRefreshRate" to use the
5732ba6 
"CVAR_SETTING("Graphics.MatchRefreshRate")" macro.
@Glought
Ran Clang Format
f5650f4
@Glought
Updated PresetManager to reflect changes to "gCollisionViewer",
c04e966 
"gEventLog", and "gNotifications".
@Glought
Ported "ConfigUpdater" from SoH.
0427dcc
@Glought
Changed code that used "gAudioEditor.*" to use the
0d31dc8 
"CVAR_AUDIO("*")" macro.
@Glought
Changed code that used "gEnhancements.*" to use the
8273e48 
"CVAR_ENHANCEMENT("*")" macro.
@Glought
Changed code that used "gDeveloperTools.*" to use the
983d232 
"CVAR_DEVELOPER_TOOLS("*")" macro.
@Glought
Changed code that used "gSettings.ItemTracker.*" to use the
20a62d1 
"CVAR_TRACKER_ITEM("*")" macro.
@Glought
Changed code that used "gWindows.*" to use the
3694bb8 
"CVAR_WINDOW("*")" macro.
@Glought
Changed code that used "gSettings.*" to use the
518994d 
"CVAR_SETTING("*")" macro.
@Glought
Add "#define CVAR_INPUT_VIEWER(var) "gInputViewer." var" to
97ac85d 
"cvar_prefixes.h"
Add #include "2s2h/cvar_prefixes.h" to to files that uses a
Cvar_Prefix macro.
@Glought
Ran Clang Format
49f3fb0
@Glought
Updated the new CVARs from the latest Commits as of 12-3-25 to use the
2027043 
CVAR_PREFIXES.
@Glought
Updated the new CVARs from the latest Commits as of 12-27-25 to use the
245c6dc 
CVAR_PREFIXES.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@Glought