ExpandedHUD

A comprehensive HUD enhancement mod for MycoPunk that provides detailed weapon statistics, combat metrics, and movement information.

Description

ExpandedHUD enhances gameplay by displaying detailed weapon statistics, real-time combat damage tracking, and player movement speed. Features include gun stats (damage, fire rate, recoil, etc.), damage meter with DPS calculations, and a speedometer for precise movement tracking.

The template includes proper plugin attributes, HarmonyLib integration, logging setup, and publishing configuration for Thunderstore mod manager. All mods in the MycoPunk collection are built from this base template, ensuring consistent structure and standards across different modifications.

Getting Started

Dependencies

• MycoPunk (base game)
• BepInEx - Version 5.4.2403 or compatible
• .NET Framework 4.8
• HarmonyLib (included via NuGet)

Building/Compiling

1. Clone this repository and customize the following:

   • Rename namespace and class names appropriately
   • Modify PluginGUID to be unique (format: "author.modname")
   • Update PluginName and PluginVersion
   • Add your specific Harmony patches and functionality

2. Add any additional NuGet packages or references needed for your mod

3. Open the solution file in Visual Studio, Rider, or your preferred C# IDE

4. Build the project in Release mode to generate the .dll file

Alternatively, use dotnet CLI:

dotnet build --configuration Release

Installing

For distribution as a completed mod:

Option 1: Via Thunderstore (Recommended)

1. Update thunderstore.toml with your mod's specific information
2. Publish using Thunderstore CLI or mod manager
3. Users download and install via Thunderstore Mod Manager

Option 2: Manual Distribution

1. Package the built .dll, any config files, and README
2. Users place the .dll in their <MycoPunk Directory>/BepInEx/plugins/ folder

Note: This template is not meant to be installed directly - customize it first for your specific mod functionality.

Executing program

Once customized and built, the mod will automatically load through BepInEx when the game starts. Check the BepInEx console for loading confirmation messages.

Mod Development Structure

• Plugin.cs: Main plugin class with Awake method and Harmony initialization
• thunderstore.toml: Publishing configuration for Thunderstore
• CSPROJECT.csproj: Build configuration with proper references
• Resources: Icon and documentation placeholders

Help

• First time modding? Check BepInEx documentation and MycoPunk modding resources
• Harmony patches failing? Ensure method signatures match the game's IL
• Dependency issues? Update NuGet packages and verify .NET runtime version
• Thunderstore publishing? Update all metadata in thunderstore.toml before publishing
• Plugin not loading? Check BepInEx logs for errors and verify GUID uniqueness

Authors

• Sparroh (MycoPunk mod collection maintainer)
• funlennysub (original BepInEx template)
• @DomPizzie (README template)

License

• This project is licensed under the MIT License - see the LICENSE.md file for details