Skip to content

Commit

Permalink
Fixed incoherent patch naming, added example MM settings patch.
Browse files Browse the repository at this point in the history
  • Loading branch information
gotmachine committed Jul 14, 2022
1 parent 7cebd0e commit 65fc06a
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 4 deletions.
10 changes: 10 additions & 0 deletions GameData/KSPCommunityFixes/Extras/KSPCF_UserSettings.cfg.extra
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
// If you want to disable some KSPCF patches or customize your configuration,
// copy this file in your GameData folder and replace "PatchName" with the
// patch(s) you want to disable (add new lines to disable multiple patches).
// To see the full list of patch names, look at the Settings.cfg file or in
// the readme.

@KSP_COMMUNITY_FIXES:FINAL
{
@PatchName = false
}
6 changes: 4 additions & 2 deletions GameData/KSPCommunityFixes/Settings.cfg
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// You can set specific patches to false to disable them
// You can set specific patches to false to disable them.
// It is recommended to do so using a ModuleManager patch.
// See the KSPCF_UserSettings.cfg.extra file in the "Extras" folder for an example.

KSP_COMMUNITY_FIXES
{
Expand Down Expand Up @@ -196,7 +198,7 @@ KSP_COMMUNITY_FIXES

// Disable the update of orbit lines and markers in flight when the map view isn't shown. Provides
// decent performance gains in games having a large amount of celestial bodies and/or vessels.
DisableMapOrbitsInFlight = true
DisableMapUpdateInFlight = true
// Fix a bunch of managed memory leaks, mainly by proactively removing GameEvents delegates
// originating from destroyed UnityEngine.Object instances. Will log detected leaks and memory
Expand Down
2 changes: 1 addition & 1 deletion KSPCommunityFixes/Performance/DisableMapUpdateInFlight.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

namespace KSPCommunityFixes.Performance
{
class DisableMapOrbitsInFlight : BasePatch
class DisableMapUpdateInFlight : BasePatch
{
protected override Version VersionMin => new Version(1, 8, 0);

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ User options are available from the "ESC" in-game settings menu :<br/><img src="
- **PQSUpdateNoMemoryAlloc** [KSP 1.11.0 - 1.12.3]<br/> Prevent huge memory allocations and resulting occasional stutter on PQS creation happening when moving around near a body surface.
- [**MemoryLeaks**](https://github.com/KSPModdingLibs/KSPCommunityFixes/issues/49) [KSP 1.12.0 - 1.12.3]<br/>Fix a bunch of managed memory leaks, mainly by proactively removing `GameEvents` delegates originating from destroyed `UnityEngine.Object` instances on scene switches. Will log detected leaks and memory usage. Also see`Settings.cfg` to enable advanced logging options that can be useful to hunt down memory leaks in mods.
- [**ProgressTrackingSpeedBoost**](https://github.com/KSPModdingLibs/KSPCommunityFixes/pull/57) [KSP 1.12.0 - 1.12.3]<br/>Remove unused ProgressTracking update handlers. Provides a very noticeable performance uplift in career games having a large amount of celestial bodies and/or vessels.
- [**DisableMapOrbitsInFlight**](https://github.com/KSPModdingLibs/KSPCommunityFixes/issues/59) [KSP 1.8.0 - 1.12.3]<br/>Disable the update of orbit lines and markers in flight when the map view isn't shown. Provides decent performance gains in games having a large amount of celestial bodies and/or vessels.
- [**DisableMapUpdateInFlight**](https://github.com/KSPModdingLibs/KSPCommunityFixes/issues/59) [KSP 1.8.0 - 1.12.3]<br/>Disable the update of orbit lines and markers in flight when the map view isn't shown. Provides decent performance gains in games having a large amount of celestial bodies and/or vessels.
- [**CommNetThrottling**](https://github.com/KSPModdingLibs/KSPCommunityFixes/issues/56) [KSP 1.12.0 - 1.12.3]<br/>Disabled by default, you can enable it with a MM patch. Prevent full CommNet network updates from happening every frame, but instead to happen at a regular real-world time interval of 5 seconds while in flight. Enabling this can provide a decent performance uplift in games having an large amount of celestial bodies and/or vessels, but has a detrimental impact on the precision of the simulation and can potentially cause issues with mods relying on the stock behavior.

#### API and modding tools
Expand Down

0 comments on commit 65fc06a

Please sign in to comment.