calware / BetterChef

Fixes, buffs, and customization for Chef from RoR2
0 stars 0 forks source link

Better Chef

This mod intends to make Chef a much stronger, more viable survivor. We accomplished this by providing a variety of changes to Chef's base kit, along with a few minor additions to his skills; all of which is documented below. Further, much of Chef and his abilities have been outlined into a configuration file so that you can perfectly tweak Chef to your liking.

Note: this mod was originally based on the popular StormTweaks mod, and several features of StormTweaks have been included within BetterChef, including the changes to Dice and the ability for an oil trail to appear on the ground while using roll.

Notable changes include:

Showcase

Configuration

Below is each change more precisely, along with the section and variable name (which can be found in the configuration file for BetterChef) that allows you to modify the values for each change (or disable certain changes altogether).

You can find the configuration file for BetterChef within your BepInEx profile under the path <"BepInEx" folder path>/config/ror2.BetterChef.cfg.

Changes to Dice

Overview

Changes to Roll

Overview

Changes to Sear

Overview

Changes to Glaze

Overview

Comparisons to StormTweaks

Build Instructions

Visual Studio 2022 Community Edition with .NET standard 2.1 can be used to build this project.

Additionally, please note that two Risk of Rain 2 official game assemblies need to be included within this project in order to build it from source. These two files are named Decalicious.dll and Unity.Postprocessing.Runtime.dll. You can find these assemblies within your game's installation directory. Example paths for these assemblies can be found below.

Including these assemblies within the existing project directory at StormTweaks/StormTweaks (adjacent to Plugin.cs) should automatically include them within Visual Studio's build chain.

Known Bugs

Notes about Configuration Editor Mods

If you are using a mod to dynamically edit your mod configuration files while in-game, such as RiskOfOptions, know that it's not currently possible to dynamically enable/disable changes to Chef's skills without restarting the game.

Notes about Compatibility with StormTweaks

While our mod does appear to be compatible with StormTweaks, know the configuration of both mods will have a hand in how well they work together. For instance, both mods will place hooks on the game's functions to modify their behavior, so you wouldn't want to have both mods place these hooks for skills that only one should be modifying. A workflow we're seeing more regularly is to disable all changes to Chef from within StormTweaks while leaving all of the changes to Seeker/FalseSon. Note that many combinations are untested, and some mixed changes from both mods to Chef may be possible.

Acknowledgements