peakSplitStats

A speedrunning timer for Peak, with many built in features! Designed for casual speedrunners as a client-side only mod to help visualize your current pace and keep track of past times automatically. Also includes a base MonoBehavior for other modders that would like to display their own info within this mod!

Features

• Very Customizable
• Automatic Splits
• Saves Runtimes to use for Green/Red/Gold splits.
• Categorizes runs to only display relevant records.
• Resumes times when restarting quicksave.
• Edited End Screen to Display the run's final pace.
• Extra info for current height and distance from next campfire/peak.
• Option to edit the current ascent text to display run category info.
• Supports the Terrain Randomiser for run categorization.
• Supports custom runs and miniruns.
• Generalized components for other modders looking to add custom info to display.

Screenshots

Modder Info

If you'd like to add a custom component, please look into the BaseUIComponent abstract class and the InfoComponent class for documentation and how to implement your own custom UI element within SplitStats. An example plugin that adds a simple InfoComponent is provided in the ExampleUIAddon directory of this repository. Once you've properly made your component, add it into SplitStats using SplitStats.AddCustomStat(InfoComponentTemplate addonTemplate) or SplitStats.AddCustomComponent(BaseUIComponent newComponent), depending on how you chose to implement your UI element.

The results displayed from the example addon:

Changelog

1.0.0

• Initial Release

1.0.1

• Bugfix for modders: CreateBaseUIComponent<T>() no longer requires a parent transform to be specified. Components added via SplitsStatsPlugin.AddCustomComponent() are now automatically reparented to the correct UI gameObject based on the component's UIComponentPosition.

1.0.2

• Bugfix: Pace text no longer can be triggered if the general "Enable Pace/Intervals" config setting is set to false. Previously if the triggers were set, they would still work and enable the pace text even if the general setting was disabled.

1.0.3

• Bugfix: Missing icon image files no longer crash the plugin, moved images into the plugin's root folder to prevent the image files from not being found when installing the plugin using R2ModMan

1.0.4

• Bugfix: Terrain Randomiser soft dependency was implemented incorrectly and led to plugin crashes if Terrain Randomiser isn't installed, should be fixed now.

1.1.0

• New Feature: Now includes an option to use the average run for pace/interval times instead of the record run.

1.1.1

• Bugfix: Patches now all use postfix instead of prefix to avoid potential conflicts.

1.2.0

• New Feature: The position of the timer and extra stats can now be moved in the config in case they overlap another mod's UI elements.
• Bugfix: The extra stats will no longer overlap over the ascent display and instead moves out of the way. This can be disabled in the config in case of users that want to move it somewhere else.

1.2.1

• Bugfix: Recompiled to fix an error caused by the roots update.

1.2.2

• Bugfix: Now compatible with TerrainRandomiser 1.0.0

1.2.3

• Bugfix: "Show Distance From Campfire" no longer causes lag while in the Kiln.
• Bugfix: TerrainRandomiser integration fixed so it gets the correct mapSettings based on if the player is the host or not.

1.3.0

Updated to work with Peak v1.60.

• New Feature: Custom runs or loading saved runs do not count as valid runs and their times are not saved. The general timer will still be displayed for these runs, but not segment timers.
• New Feature: An attempt counter can now be displayed. The attempt number displayed is based on the number of saved runs and the plugin's run categorization settings.
• Bugfix: Timers/Info components were not properly arranged on screen during setup and their icons were not properly centered. This has been fixed.
• Misc: Harmony patches no longer patch Update methods, which are called every frame. This mainly stops console spam and is a slight optimization.

1.4.0

Updated to work with v2.4.b (The Final Ascent Update)

New Features

• Segment timer for Nadir added. The timer by default will remain hidden until Nadir is entered during a run or the run is for ascent 8, but it can be configured to always appear for all runs.
• Timing info can be reloaded when loading from a quicksave.
• The segment timers and segment paces can now show on custom runs. Pace times are disabled for custom runs by default, but can be enabled in the config to display the pace of normal runs or display the pace per the configured category settings.
• Times earned during custom runs and miniruns are now saved. A new category setting for custom runs have been provided so their run times can be distinguished from normal runs and custom runs with different settings for pace times.
• The timer during custom miniruns can now show a pace timer for the gold-split/personal best time as specified in the config file's category and pace/interval settings.
• Added new toggleable info displays for the best run time, average run time, current biome's gold-split/personal best time, current biome's average time, and best of segments time.
• The main timer now can display the sum of best segments as a gold-split.
• Added unique icons for each biome instead of shared icons per segment. If you'd like the timer not to reveal biomes ahead of time during a run, shared icons and font colors can be enabled in the config file.
• Added option to hide segment timers intially and reveal them as the run progresses, for essentially the same purpose as the shared icons.

Changes

• Runs now start when the player's eyes open instead of the timing used by the game. If you'd like to use the in-game timing, a new option has been provided to enable it.
• The kiln/citadel segment timer no longer ends when triggering the "Peak" title text, the segment now ends when the end cutscene triggers or the player enters Nadir.

Bugfixes

• More debug print logs added for troubleshooting since I'd like it to be easier to maintain when I inevitably make mistakes. If the logs get spammed and lag the game, that is not intentional and it probably means I broke something.
• Saved run times now correctly log whether they were timed using IGT or real time (previously all runs were marked as IGT even if real time was used). Reaching the end screen no longer replaces the saved final time with the IGT instead of real time as configured.
• Runs are now correctly categorized by IGT/real time, runs timed using different timing methods no longer affect the pace calculations of each other.
• Average run pace targets are now calculated and displayed correctly. For individual biomes, the pace timer will be based on deviation from the player's average biome time across all saved runs and gold splits show personal best times as usual.
• The timer shown for Biome4 miniruns no longer stops after finishing the caldera/gloom.
• Errors from attempting to access segment timers when they don't exist have been addressed.

Optimizations

• Campfire display now caches positions after referencing the current segment's campfire object for the first time in a run instead of continuously referencing the object every frame.
• Campfire display now finds the peak flag more efficiently once the kiln/citadel is reached.
• The biome segment timer campfire trigger no longer loops through all five segment timers when only up to two are started/stopped per trigger. This does not apply when jumping to specific biomes via commands or entering Nadir with scout's honor.