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.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
HudRepositionAPImod 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)
- Install with a Thunderstore mod manager (r2modman, Thunderstore App, etc.).
- Ensure SparrohUILib is installed as a dependency.
Manual installation
- Install BepInEx and SparrohUILib for Mycopunk.
- Place
ConsumableHotkeys.dllin<Mycopunk Directory>/BepInEx/plugins/.
The mod loads automatically through BepInEx when the game starts. Check the BepInEx log for a successful load message.
Building
- Clone this repository.
- 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 Hotkeysis true. - HUD missing? Set
Enable HUDto 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.
