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.
• 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.
• 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.