A BepInEx plugin assisting speedrunners of the game Bug Fables. This plugin is a port of a modified version of the game's Assembly-CSharp.dll which was previously distributed for this purpose. The port offers the following advantages:
- It no longer requires the distribution of the game's Assembly-CSharp.dll which could lead to copyright issues
- Since the patches are done at runtime instead of being a static patch, it allows more liberty in configuration in conjunction with BepInEx's standardized configuration scheme
- Due to #1, the code can be distributed publically under a Git repository which allows better tracking of changes through time
This branch is only compatible with version 1.2 of the game. Please use the 1.0.5 branch if you must use this plugin with previous versions of the game.
If you already have a 1.x version of the old practice dll (one that came with an Assembly-CSharp.dll), you must uninstall it first.
If this is not done already, you first need to install the BepInEx loader into the game. To do so, download the latest release by getting the zip file marked "x64". Then, simply unzip it into the game's directory such as the BepInEx folder as well as the 3 provided files appears from the game's directory. If you are using Steam, this directory is by default located at C:\Program Files (x86)\Steam\steamapps\common\Bug Fables on Windows and at ~/.steam/steam/steamapps/common/Bug Fables on Linux. Once the files are placed, launch the game once for the installation to complete.
Once this is done, download the latest version of the plugin and unzip it into BepInEx/plugins from the game's directory. You should unzip it so the folder Speedrun-Practice with all the files from the zip appears directly under the plugins folder.
To verify the installation was performed correctly, launch the game and verify that the lower left corner of the title screen. It should display information about this plugin such as the version and the authors.
To uninstall the plugin, simply delete the BepInEx/plugins/Speedrun-Practice folder from the game's directory.
If you want to entirely remove BepInEx and all of its plugins, delete the following under the game's directory:
- The BepInEx folder
- The file changelog.txt
- The file doorstop_config.ini
- The file winhttp.dll
This plugin functions by adding features when pressing certain keys on the keyboard during gameplay. You can change the keybinds ingame in the settings menu under keybinds.
In the overworld:
- F1 - Show Player & Map Info
- F2 - Input Display (Keyboard Only atm)
- F3 - Heal Party
- F4 - Toggle Infinite Jump
- F5 - Toggle Speed (2x)
- F6 - Save Game
- F7 - Reload Save
- F8 - Go-to Main Menu
- F9 - Select previous position slot
- F10 - Select next position slot
- F11 - Save position in room
- F12 - Load position in room
- DEL - Toggle NoClip+Infinite Jump
- L-CTRL - Free Cam
- 1 - Exit IL Mode
- 2 - Map List (choose any map to tp to)
- 3 - Choose IL (choose IL to practice)
- 4 - Reset IL
- 5 - Toggle Ghost
- 6 - Undo Split
- 7 - Toggle Freeze Resistance
- 8 - Hide Timer IL
- 9 - Toggle "Perfect" RNG (list of enemies affected below)
Note: If you close or re-enter the main menu, you will lose your saved positions.
In battle:
- F3 - Instant Enemy Kill
- F4 - Instant Flee (w/o losing berries)
- F5 - Instant Retry during battle
Enemies Affected By Perfect RNG Toggle :
- Aria : Never Def up, always Vine attack
- VeGu : Never Stats up, always Slam on ground and Bomb in air, best rng roll on wait times for slam
- Scarlet : Always Atk up or Beams
- Ahoneynation : Always charges
- B33 : Always laser attack
- Astotheles : Always focuses Kabbu, always multi hits and hits 3 times
- Dune Scorpion : Always tail attack, best rng roll on wait times, focuses Vi
- Beast : Always Horns, focuses Vi
- Primal Weevil : Always Roar, Never Atk Up
- Ultimax Tank : Always Charges
- Ultimax : Always focuses Vi
- Deadlanders Gamma : Always laser attack
- Wasp King : Always axe throw
- ELK : Always Venus Bud when grounded, vines in the air
- Keys : Always Spin attack
By pressing 3 and choosing an IL, you can select any split you would like to practice. This will set your game state to whatever that split is. You can start the IL by either entering the next room or defeating the corresponding enemies with F3 (following the current glitchless route). After that, you follow the glitchless route to finish the IL.
You can check out your IL stats ingame by going into the Pause Menu Library (book icon) and pressing P. You can check out each golds/segment times there and your sum of best. You can edit the splits in the splits folder in BepInEx/splits
After completing any IL, you'll be able to race against your PB ghost. You can hide the ghost at any time by pressing 5 if its too annoying. Ghost data is going to be in BepInEx/ghostRecordings
You should be able to reset at any point even if there's a cutscene or in battle. In battle, make sure that no enemies is attacking and that nothing is happening. If you reset and theres something on screen (like an item bugged on the GUI), you can clean everything by pressing F8 and going back to the main menu.
This section is intended only for developers. You do not need to do this if you only want to use the plugin. Refer to the Installation instructions section for this purpose.
NOTE: For technical reasons, this project is configured to be built using .NET Framework 3.5. Please do not change the target Framework and make sure your environement supports this version of the .NET Framework.
This project is configured for Visual Studio 2019 (previous versions may work, but are untested). To build the project, you first need to place the required dlls into the Libs directory present on this repository. Refer to Libs/README.txt for more information on which dlls to place.
Once this is done, the project should build successfully. To improve convenience, you may want to set the output path to Bug Fables\BepInEx\plugins\Speedrun-Practice (where Bug Fables is the game's directory) in the project's configuration for ease of testing.
To debug the plugin, you will need the dnSpy program (download the file dnSpy-net472.zip). Once it's installed, you will need to download this modified version of mono.dll and place it at Mono/EmbedRuntime from the game's directory. You may want to backup or rename the original one that comes with the game in case you want to revert it.
With this done, you will now be able to debug the plugin with dnSpy. Open the Speedrun-Practice.dll file with dnSpy, click Start at the top, select Unity as the Debug Engine and select the game's executable in the Executable field (the file Bug Fables.exe) and finally, click OK. You may now place breakpoints, use watches in the Watch window and see all the output produced by the plugin and Unity in the Output window.
All contributions via pull requests are welcome as well as issue reports on this issue tracker. You may also request features with this issue tracker.
If you are planning to submit a pull request, do not share any substantial amount of code from the game as it can lead to copyright issues and thanks to Harmony + BepInEx, it can be avoided in almost all cases. Any pull requests that contains substantial amount of code from the game will be immediately denied if I judge it can be done without sharing the code.
This plugin was done by Lyght, Benjee, wataniyob, Wintar and aldelaro5 with the help of ArchaicEx.
This plugin is licensed under the MIT license which grants you the permission to freely use, modify and distribute this plugin as long as the original license and its copyright notice is still present. Refer to the MIT license for more information.
I would like to thank everyone from Moonsprout Games for making this amazing game as it brought inspiration to me and to everyone in the community it sparked.