jakzo-SpeedrunTools icon

SpeedrunTools

Utilities for Boneworks speedrunning.

Last updated 2 months ago
Total downloads 8573
Total rating 2 
Categories Code Mods
Dependency string jakzo-SpeedrunTools-2.5.0
Dependants 0 other packages depend on this package

README

Features

  • Speedrun mode
    • Enabling this mode will disable practice features and temporarily alter the save state so that a run will meet the leaderboard submission rules
    • There are various modes depending on what type of speedrun you are performing:
      • Normal
        • Activate with CTRL + S or by pressing A + B on both controllers
        • In this mode the save state will be reset every time you leave the main menu and start a new game
      • Newgame+
        • Activate with CTRL + N
        • In this mode the save state will be updated to have everything unlocked
      • 100%
        • Activate with CTRL + H
        • In this mode the save state will be reset only when initially enabled
        • Activating this will also reset all Steam achievements (so that the reclamation bin in Zombie Warehouse must be unlocked during the run)
    • Deactivate any mode with any of the activation hotkeys while in the main menu
    • Preferences like height and turn settings are maintained through save state resets and loads
    • Deactivate speedrun mode to restore your original save state
    • You must disable all other mods before enabling any speedrun mode
    • You can tell that a speedrun mode is enabled based on the text added to the loading screen (Steam game version only)
      • Includes mod version and approximate run time to make splicing harder (don't worry if the time does not match LiveSplit exactly)
  • Make boss claw always patrol to the area near the finish in Streets
    • Boss claw cabin appears green when this feature is on, so that you're aware RNG is being manipulated
  • Teleport to a chosen location to practice parts of a level again
    • Pressing B on both controllers at the same time sets the teleport point to the position you are currently standing at
    • Clicking the right controller thumbstick teleports you to the set point
    • Clicking A and B on the left controller at the same time resets the level
      • Useful for situations like in Museum when you teleport back to retry valve flying and need the valve to be back at its starting location
  • Blindfold (Steam game version only)
    • For practicing and performing blindfolded runs
    • To blindfold yourself, press CTRL + B on the keyboard (game window must be focused)
      • If you do this during the main menu it will activate "blindfolded speedrun mode" where it will reset your save each time before starting a new game
    • This will make the VR headset display pitch black but the game window will still show the game (for spectating or to see where you are while practicing)
  • Gripless
    • For practicing and performing gripless runs (where triggers/finger grips on controllers do nothing and you cannot pick things up)
    • To enable, press CTRL + G on the keyboard (game window must be focused)
      • If you do this during the main menu it will activate "gripless speedrun mode" where it will reset your save each time before starting a new game
    • This will make the controller trigger/finger buttons do nothing in the game so you cannot grab any objects
  • One controller
    • Only one controller can be used and inputs from the other will be ignored
    • Ford's arm will also be removed
    • The menu button will still work even on the disabled controller
    • To enable, press CTRL + O on the keyboard (game window must be focused)
      • This will switch from off -> only left controller -> only right controller -> off -> ...
      • If you do this during the main menu it will activate "one-controller gripless speedrun mode" where it will reset your save each time before starting a new game
  • Armless
    • Removes both of Ford's arms
    • To enable, press CTRL + A on the keyboard (game window must be focused)
      • If you do this during the main menu it will activate "armless speedrun mode" where it will reset your save each time before starting a new game

Installation

  • Make sure Melon Loader is installed in Boneworks
  • Download the SpeedrunTools mod from Thunderstore (click on "Manual Download")
  • Open the downloaded .zip file and extract Mods/SpeedrunTools.dll into BONEWORKS/Mods/SpeedrunTools.dll
    • You can usually find your BONEWORKS directory at C:\Program Files (x86)\Steam\steamapps\common\BONEWORKS\BONEWORKS

Configuration

You can change some things (like where the boss claw moves to) by using MelonPreferencesManager:

  • Install MelonPreferencesManager (download the IL2CPP version)
  • Open the menu in-game using F5 to change config options

Most settings require restarting the level to take effect.

Links

Changelog

2.5.0

Allow PhysicsTickFixer mod to be used in runs.

2.4.2

Fixes logger error on startup.

2.4.1

Fixes logger error on startup.

2.4.0

Added support for sending data to the Boneworks 100% run status LiveSplit component.

2.3.3

Removed unintended hotkey of right thumbstick disabling gripping.

2.3.2

Fix fantasy arena state not being reset. Also reset achievements when activating 100% mode (so that reclaimation bin must be activated during the run).

2.3.1

LootDropBugfix is now an allowed mod for speedruns.

2.3.0

Added one controller and armless modes. Also added replays as a dev feature that can be enabled via preferences. Various other undocumented dev features have also been added.

2.2.2

Fixed load when controllers are missing.

2.2.1

Fix gripless on index controllers.

2.2.0

Gripless mode.

2.1.0

Show timer and version during loading screens. Blindfolded speedrun mode.

2.0.1

Reset save when leaving main menu instead of entering so that save resetting lag is not counted by live split. Also keep preferences when leaving speedrun mode.

2.0.0

Speedrun mode. Removed save reset feature.

1.3.2

Fix issue with hotkeys crashing the mod. Also make the blindfold not be briefly disabled at the start of levels.

1.3.1

Fix release missing blindfold feature.

1.3.0

Blindfold.

1.2.1

Added save reset instructions to readme.

1.2.0

Save resetting. Hotkeys should also now work in the Oculus version of the game.

1.1.0

Teleportation and level resetting.

1.0.0

Initial release with removal of boss claw RNG.