This mod is a tool intended to be used for practicing speedruns or testing theories.
This mod has multiple features that can be useful for messing around with the game or giving you the chance to practice individual parts.
In the main menu you can go to Settings->Mods->Speedrun Mod->Practice to play specific parts of the game to practice them.
These parts will automatically restart when you reach the end.
In the main menu you can go to Settings->Mods->Speedrun Mod->Refresh Rate to configure a reported refresh rate target.
Using refresh rate above 540 Hz will invalidate the run.
The mod also shows periodic refresh-rate notifications in-game.
In the main menu you can go to Settings->Mods->Speedrun Mod->Overlay to configure and inspect the debug overlay.
By default the overlay toggle hotkey is F4 (configurable in the overlay menu).
- When pressing the start with a clean slate button the achievements will also be reset if this mod is enabled.
- When toggling
skipdialoguethe mod will remember the state of this toggle. Meaning when you restart the game you will keep this toggle in the state that you had before you quit the game.
| Shortcut | Name | Description |
|---|---|---|
| Alt + O | Toggle Triggers | This toggle will change whether or not you can see in game triggers. |
| Alt + L | Toggle Running | Toggle whether or not you are allowed to run. |
| F1 (configurable) | Target FPS toggle | In-game: switch between your configured target FPS and your previous FPS. Rebind under FPS settings. |
| F2 (configurable) | Uncap FPS toggle | In-game: switch between uncapped FPS with VSync disabled and your previous FPS/VSync settings. Rebind under FPS settings. |
| F4 (configurable) | Overlay toggle | In-game: toggle overlay on/off. Rebind under Overlay settings. |
Before you can install this mod you need to have BepInEx with Il2Cpp support installed, this can be downloaded on their Bleeding Edge download page.
You then need to extract the zip file to your game directory.
Then you can download the most recent version on github through the releases section and put this dll file in the plugin folder.
You can find this folder at MiSide/BepInEx/plugins.
Thanks for being interested in contributing to this mod!
To setup your dev environment make sure to clone this repository and copy the interop files from your BepInEx folder (should be in MiSide/BepInEx/interop) to the Dependencies folder.
Then download the most recent version from the MenuLib and also place this dll file in the Dependencies folder.
You can find some good first issues over here, feel free to ask for help although I won't teach you how to code.
You can clean, build, and copy mod DLLs to your game/plugin folder with dotnet commands. Copy step runs only when you pass DeployOutputDir.
Default deploy flow:
dotnet clean -c Release
dotnet build -c Release -p:DeployOutputDir=/path/to/MiSide/BepInEx/pluginsBy default this deploys:
SliceCraft.SpeedrunMod.dllSliceCraft.MenuLib.dll
To deploy different files, pass DeployAssemblies as comma-separated list:
dotnet clean -c Release
dotnet build -c Release \
-p:DeployOutputDir=/path/to/MiSide/BepInEx/plugins \
-p:DeployAssemblies="SliceCraft.SpeedrunMod.dll,SliceCraft.MenuLib.dll"