Allow custom FPS values for each GameSpeed index #2092
+124
−176
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,97 +1,115 @@ | ||
| #include <Phobos.h> | ||
| #include <Utilities/Macro.h> | ||
| #include <algorithm> | ||
| #include <SessionClass.h> | ||
| #include <GameOptionsClass.h> | ||
|
|
||
| DEFINE_HOOK(0x69BAE7, SessionClass_Resume_CampaignGameSpeed, 0xA) | ||
| { | ||
| GameOptionsClass::Instance.GameSpeed = Phobos::Config::CampaignDefaultGameSpeed; | ||
| return 0x69BAF1; | ||
| } | ||
|
|
||
| // For custom game speeds: | ||
| // Add to rulesmd.ini under [General]: | ||
| // EnableCustomFPS=yes ; Enable/disable custom FPS | ||
| // CustomGameSpeedFPS.0=120 ; Per-speed FPS. 0 = vanilla. Vanilla: 0=60, 1=45, 2=30, 3=20, 4=15, 5=12, 6=10 | ||
| // | ||
| // -Each speed slot with a non-zero CustomGameSpeedFPS.N runs at that target FPS | ||
| // -Slots with 0 (or unset) use vanilla FPS for that position | ||
| // -Practical max is ~1000 FPS (timeGetTime() resolution) | ||
|
|
||
| // Queue_AI_Multiplayer | ||
| // Patch v26 to INT_MAX disables the 60fps cap on multiplayer. | ||
| DEFINE_PATCH(0x647C28, 0xBE, 0xFF, 0xFF, 0xFF, 0x7F); // mov esi, INT_MAX | ||
|
|
||
| // Queue_AI_Multiplayer | ||
| // Override the GameSpeed-to-fps calculation in multiplayer. | ||
| DEFINE_HOOK(0x647C4D, Queue_AI_Multiplayer_CustomFPSCalculation, 0x1F) | ||
| { | ||
| int gameSpeed = GameOptionsClass::Instance.GameSpeed; | ||
| int calculatedFPS; | ||
|
|
||
| if (Phobos::Misc::EnableCustomFPS && Phobos::Misc::CustomGameSpeedFPS[gameSpeed] > 0) | ||
| { | ||
| calculatedFPS = Phobos::Misc::CustomGameSpeedFPS[gameSpeed]; | ||
| } | ||
| else if (gameSpeed == 0) | ||
| { | ||
| // Vanilla: GameSpeed 0 = 60 FPS | ||
| calculatedFPS = 60; | ||
| } | ||
| else if (gameSpeed == 1) | ||
| { | ||
| // Vanilla: GameSpeed 1 = 45 FPS | ||
| calculatedFPS = 45; | ||
| } | ||
| else | ||
| { | ||
| // Vanilla: GameSpeed 2+ = 60 / GameSpeed | ||
| calculatedFPS = 60 / gameSpeed; | ||
| } | ||
|
|
||
| R->EAX(calculatedFPS); | ||
|
|
||
| return 0x647C6C; | ||
| } | ||
|
|
||
| // Hook MainLoop skirmish/campaign FPS calculation | ||
| // The normal route FrameTimer.TimeLeft rounds to 0 for >60 FPS (tick-based timeGetTime >> 4), | ||
| // NetworkFrameTimer (ms-based timeGetTime) provides the frame timing that SyncDelay's NetworkFrameTimer loop uses. | ||
| // We need to set up NetworkFrameTimer like multiplayer mode does for >60 FPS support. | ||
| DEFINE_HOOK(0x55D7B6, MainLoop_SkirmishFPSFix, 0xC) | ||
| { | ||
| const DWORD timerValue = R->ECX(); | ||
| const int gameSpeed = R->ESI(); | ||
|
|
||
| const bool shouldUseCustomFPS = Phobos::Misc::EnableCustomFPS | ||
| && Phobos::Misc::CustomGameSpeedFPS[gameSpeed] > 0 | ||
| && (SessionClass::IsSkirmish() || SessionClass::IsCampaign()); | ||
|
|
||
| if (!shouldUseCustomFPS) | ||
| { | ||
| // Use vanilla behavior | ||
| Unsorted::GameFrameTimer.CurrentTime = timerValue; | ||
|
Check failure on line 74 in src/Misc/Hooks.Gamespeed.cpp
|
||
| Unsorted::GameFrameTimer.TimeLeft = gameSpeed; | ||
|
Check failure on line 75 in src/Misc/Hooks.Gamespeed.cpp
|
||
| return 0x55D7C2; | ||
| } | ||
|
|
||
| const int customFPS = Phobos::Misc::CustomGameSpeedFPS[gameSpeed]; | ||
|
|
||
| // calc frame timings | ||
| const int targetFrameDelayTicks = 60 / customFPS; | ||
| const int targetFrameTimeMs = std::max(1, 1000 / customFPS); // 1ms floor = ~1000 FPS ceiling | ||
|
|
||
| const DWORD currentTime = timeGetTime(); | ||
|
|
||
| // just in case | ||
| Unsorted::GameFrameTimer.CurrentTime = timerValue; | ||
|
Check failure on line 88 in src/Misc/Hooks.Gamespeed.cpp
|
||
| Unsorted::GameFrameTimer.TimeLeft = targetFrameDelayTicks; | ||
|
Check failure on line 89 in src/Misc/Hooks.Gamespeed.cpp
|
||
|
|
||
| // SyncDelay compares elapsed time since CurrentTime against TimeLeft. | ||
| Unsorted::NetworkFrameTimer.StartTime = currentTime; | ||
|
Check failure on line 92 in src/Misc/Hooks.Gamespeed.cpp
|
||
| Unsorted::NetworkFrameTimer.CurrentTime = currentTime; | ||
| Unsorted::NetworkFrameTimer.TimeLeft = targetFrameTimeMs; | ||
|
|
||
| // "Requested FPS" | ||
| SessionClass::Instance.DesiredFrameRate = customFPS; | ||
|
|
||
| return 0x55D7C2; // Past the two MOVs we replaced | ||
| } | ||
|
|
||
| // SyncDelay | ||
| // Redirect skirmish/campaign to the NetworkFrameTimer path | ||
| DEFINE_HOOK(0x55E1B6, SyncDelay_RedirectSkirmishToNetworkFrameTimer, 0x6) | ||
| { | ||
| if (SessionClass::IsSkirmish() || SessionClass::IsCampaign()) | ||
| { | ||
| if (Phobos::Misc::EnableCustomFPS && Phobos::Misc::CustomGameSpeedFPS[GameOptionsClass::Instance.GameSpeed] > 0) | ||
| return 0x55E1BC; // Custom FPS: use NetworkFrameTimer path like multiplayer | ||
|
|
||
| return 0x55E2B4; // Vanilla FrameTimer path | ||
| } | ||
|
|
||
| return 0x55E1BC; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should add migration entries to docs and the migration script (see FIXME entries)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
b1e580f
Sorry, not seeing any FIXME?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ctrl+F in migration script (see Phobos Supplementaries repo)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. Phobos-developers/PhobosSupplementaries#14