DescriptionOverride
This is a mod utility to allow me to use the description field within the upgrade asset file.
About this mod Author’s original text
DescriptionOverride
A BepInEx mod utility for MycoPunk that allows using raw description text from upgrade asset files instead of processed TextBlocks.
Description
This client-side utility mod modifies how upgrade descriptions are displayed in MycoPunk by bypassing the game's TextBlock processing system and using the raw text from the serialized _description field in upgrade asset files. This is particularly useful for modders who want complete control over upgrade descriptions without GameObjects interfering with text formatting.
The mod patches the Upgrade.Description getter to return the raw serialized description when enabled, supporting both GearUpgrade and PlayerUpgrade types. It also includes configurable options for Hashetty font toggles and can be completely disabled if needed.
Getting Started
Dependencies
- MycoPunk (base game)
- BepInEx - Version 5.4.2403 or compatible
*.NET Framework 4.8
Building/Compiling
- Clone this repository
- Open the solution file in Visual Studio, Rider, or your preferred C# IDE
- Build the project in Release mode
Alternatively, use dotnet CLI:
dotnet build --configuration Release
Installing
Option 1: (Recommended)
- Download and install Mod Manager
- Search for "DescriptionOverride" under MycoPunk community
- Install and enable the mod
Option 2: Manual Installation
- Ensure BepInEx is installed for MycoPunk
- Copy DescriptionOverride.dll from the build folder
- Place it in /BepInEx/plugins/
- Launch the game
Executing program
Once installed, the mod works automatically. Upgrade descriptions will use raw text from asset files instead of processed TextBlocks.
Configuration
The mod can be configured through BepInEx Configuration Manager or by editing the config file:
General Settings:
- EnableDescriptionOverride: (Default: true) If enabled, uses the serialized _description field instead of TextBlocks
- EnableHashettyOverride: (Default: true) If enabled, applies Hashetty font toggles in descriptions
Usage
For Modders/Customizers:
- Modify the _description field in your upgrade asset files directly
- Raw text will be displayed as-is, preserving your formatting
- Use Hashetty font toggle codes if EnableHashettyOverride is enabled
For Players:
- The mod has no direct player-facing features
- It's a utility that affects how upgrade descriptions are rendered in the game
Help
- Descriptions look different? This mod intentionally changes how descriptions are processed - raw text from assets is used instead of TextBlocks
- Configuration not working? Changes require a game restart to take effect
- Conflicts with other mods? This mod patches Upgrade.Description getter. Other mods modifying text processing may interfere
- For modders: TextBlocks not working? The mod bypasses TextBlocks entirely when enabled - use raw text in _description field
- Performance impact? Minimal - only patches one getter method and doesn't run during gameplay
- Hashetty fonts not working? Ensure EnableHashettyOverride is enabled and your text contains proper Hashetty toggle codes
Authors
- Sparroh
- funlennysub (original mod template)
- @DomPizzie (README template)
License
- This project is licensed under the MIT License - see the LICENSE.md file for details
Install & use Install: follow the bundled instructions
- Unzip the archive from playbuff and read the bundled readme / instructions first.
- Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
- For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
- Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.
Install locations vary a lot between mods — the bundled readme is the most reliable guide.
Install these first, or the mod will not work: