You are viewing a potentially older version of this package. View all versions.
Sparroh-ConsumableHotkeys-1.0.6 icon

ConsumableHotkeys

Hotkeys and status HUD for Personal Access Token, Premium Loot License, Bootleg Replicator, and Clearance Certificate. Hotkeys are blocked in chat, menus, and known mod UIs.

Date uploaded 11 hours ago
Version 1.0.6
Download link Sparroh-ConsumableHotkeys-1.0.6.zip
Downloads 2
Dependency string Sparroh-ConsumableHotkeys-1.0.6

This mod requires the following mods to function

BepInEx-BepInExPack_Mycopunk-5.4.2403 icon
BepInEx-BepInExPack_Mycopunk

BepInEx pack for Mycopunk. Preconfigured and ready to use.

Preferred version: 5.4.2403
Sparroh-SparrohUILib-1.1.1 icon
Sparroh-SparrohUILib

Shared UI library for Sparroh Mycopunk mods. Provides themed widgets, HUD builders, windows, and resolution-aware layout.

Preferred version: 1.1.1

README

ConsumableHotkeys

A BepInEx mod for Mycopunk that adds hotkeys and a status HUD for common consumables.

Features

  • Hotkeys to activate consumables without opening inventory:
    • Personal Access Token
    • Premium Loot License
    • Bootleg Replicator
    • Clearance Certificate
  • Status HUD showing active/inactive state (or remaining uses for Clearance Certificate) and inventory counts
  • Configurable keybinds, HUD position, and active/inactive colors, with config reload support
  • Context-aware hotkeys — ignored while chat or other text input is focused, any vanilla menu/window is open, or known mod UIs are open (CheatMenu+, ForceModifiers, HUD reposition mode, and similar)
  • Optional HUD reposition integration when a compatible HudRepositionAPI mod is present

Default Hotkeys

Consumable Default Key
Personal Access Token H
Premium Loot License J
Bootleg Replicator K
Clearance Certificate L

Dependencies

  • Mycopunk (base game)
  • BepInEx 5.4.2403 or compatible (e.g. BepInExPack for Mycopunk)
  • SparrohUILib (required)

Installation

Via Thunderstore (recommended)

  1. Install with a Thunderstore mod manager (r2modman, Thunderstore App, etc.).
  2. Ensure SparrohUILib is installed as a dependency.

Manual installation

  1. Install BepInEx and SparrohUILib for Mycopunk.
  2. Place ConsumableHotkeys.dll in <Mycopunk Directory>/BepInEx/plugins/.

The mod loads automatically through BepInEx when the game starts. Check the BepInEx log for a successful load message.

Building

  1. Clone this repository.
  2. Open the solution in Visual Studio, Rider, or another C# IDE and build Release, or run:
dotnet build --configuration Release

The output DLL is written under bin/Release/netstandard2.1/.

Configuration

Settings are stored at:

<Mycopunk Directory>/BepInEx/config/sparroh.consumablehotkeys.cfg

The config file is watched and reloaded when it changes.

Section Option Description
Consumables Enable Hotkeys Toggle hotkey activation
Consumables Enable HUD Toggle the status HUD
Consumables PersonalAccessToken Key Hotkey for Personal Access Token
Consumables PremiumLootLicense Key Hotkey for Premium Loot License
Consumables BootlegReplicator Key Hotkey for Bootleg Replicator
Consumables ClearanceCertificate Key Hotkey for Clearance Certificate
HUD Positioning HUD X Horizontal anchor (0–1)
HUD Positioning HUD Y Vertical anchor (0–1)
Colors Active Color Rich-text color for active status (hex RRGGBB)
Colors Inactive Color Rich-text color for inactive status (hex RRGGBB)

Troubleshooting

  • Mod not loading? Confirm BepInEx and SparrohUILib are installed, then check the BepInEx log for errors.
  • Hotkeys not working? Check for key conflicts, that you have the consumable in inventory, and that chat, menus, and known mod UIs are closed. Ensure Enable Hotkeys is true.
  • HUD missing? Set Enable HUD to true and make sure you are in-game with a local player loaded.

Authors

  • Sparroh

License

This project is licensed under the MIT License — see the LICENSE file for details.

CHANGELOG

Changelog

1.0.6

  • Switch hotkeys to Unity Input System InputActionMap callbacks (no per-frame key polling)
  • Rebind/enable map from config; dispose actions on unload
  • Keeps menu/chat/mod-UI blocking inside the press callback only

1.0.5

  • Further micro-stutter reductions:
    • Hotkey menu/focus checks only run when a bound key is pressed (idle frames are 4 key reads)
    • HUD rebuilds TMP text only when a state hash changes (flags, counts, colors)
    • Mod menu detector resolves once via known type names (no AppDomain GetTypes scans)
    • Cheaper early-out on the global SetFlag postfix

1.0.4

  • Fix micro-stutters:
    • Stop forever AppDomain type scans when no known mod menus are installed
    • Remove leftover debug Harmony postfixes (including a no-op on every PlayerData.GetFlag)
    • Poll HUD state at ~5 Hz with dirty text updates instead of rewriting TMP every frame
  • HUD still refreshes immediately on hotkey use and when consumable flags change (expiry / clearance uses)

1.0.3

  • Fixed icon transparency

1.0.2

  • Refactor

1.0.1

  • Hotkeys are ignored while chat or other text input is focused, any vanilla menu/window is open, or known mod UIs are open (CheatMenu+, ForceModifiers, HUD reposition mode, and similar)

1.0.0

  • Initial standalone release (split out from ExpandedHUD)
  • Hotkeys for Personal Access Token, Premium Loot License, Bootleg Replicator, and Clearance Certificate
  • Status HUD with active/inactive state, Clearance Certificate uses remaining, and inventory counts
  • Configurable keybinds, HUD position, and active/inactive colors