CyranIndustries-Sprint_Toggle icon

Sprint Toggle

Turns sprinting into a toggle instead of a hold.

Last updated 3 months ago
Total downloads 15714
Total rating 5 
Categories Misc BepInEx Client-side Tweaks & Quality Of Life
Dependency string CyranIndustries-Sprint_Toggle-1.0.3
Dependants 33 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2100

README

Toggle Sprint

This mod allows you to toggle sprinting by pressing the sprint keybind. The sprint will toggle off automatically if you stop moving or press the sprint keybind again.

By default the mod will display a small running symbol under the top left UI cluster when sprint is toggled on and hide it once sprint toggles off again. This can be disabled in the configuration file.

WARNING

The current version is compatible with version v45 - v60 of the game. If you're still running version 40, use mod version 1.0.1 instead.

The UI element may not work with other UI mods. If the mod crashes or breaks, try disabling the UI element in the configuration.

Configuration

[General]

Enabled

default true

Enables or disables the mod completely.

AlwaysToggleSprint

default false

Make the sprint toggle active always. This disables the automatic cancellation of the sprint toggle when you stop moving as well.

[UI]

Enabled

default true

Make the UI display a running symbol when sprint is toggled on. Disabling this config entry will stop

Note

Hopefully in a later update these settings will be toggable in game as well as through the config.

Changelog

1.0.3

  • update: Updated compatibility to v60

1.0.2 - You Can't Stop the Disco

  • update: Updated compatiblity to v45
  • feature: Display an icon on screen when sprint toggle is activated with configuration available.

1.0.1

  • feature: Add configuration options to enable and disable the toggle sprint.
  • feature: Add configuration option to allow for toggle sprint to work always instead of only when the player is moving.
  • bugfix: Sprint toggle would turn off if the player's motion was too small. This would cancel the sprint toggle too eagerly and presented an issue for controller players.
  • bugfix: If sprint was held down and then the player began moving, sprint toggle would not activate and the player would not sprint. Now, if the sprint toggle is off but the sprint button is held down, the player will sprint and the sprint will lock in as expected.

1.0.0

  • Initial Release