GK2 Known Formula Helper

A BepInEx mod for Graveyard Keeper 2 that improves the alchemy folio and laboratory workflow.

Version 0.3.2 adds ranked alternative laboratory mixes, optional HUD positioning support for GK2RecipePin and Kebo Recipe Pins, plus bundled typography support for readable helper text.

Features

• Pin known alchemy formulas from the folio.
• Shows pinned formulas directly on the HUD.
• Compact recipe cards with:
  • Ready / Missing status
  • owned vs. required ingredient counts
  • buyable ingredients
  • vendor name and stock when available
• Automatically selects the best known ingredient mix for each formula.
• Displays powder-free alternative mixes when a suitable known recipe exists.
• Open the normal alchemy folio directly from the laboratory result slot.
• Select a known formula directly from the folio.
• Automatically load the best matching mix into the laboratory.
• Shows up to ten known mix variants for the selected formula.
• Switches between variants with < / > buttons or Left Arrow / Right Arrow.
• Updates the laboratory ingredient slots immediately when a variant changes.
• Craftable mixes are preferred when the required resources are already available.
• Laboratory mix selection considers available crafting resources and accessible storage.
• Recipes with missing ingredients are automatically pinned.
• Incomplete recipes are still loaded into the laboratory so available ingredients remain visible at the station.
• Normal folio pin / unpin behavior is preserved when the folio is opened normally.
• Controller support for folio recipe selection.
• Optional compatibility with:
  • Pin My Recipe
  • GK2 Shopping List
  • GK2RecipePin
  • Kebo Recipe Pins

These integrations are optional. The mod does not require any of them.

How it works

The helper evaluates your known alchemy formulas and chooses the most useful ingredient combination based on the resources currently available to the crafting system.

Pinned formulas are displayed directly on the HUD so you can quickly see:

• whether a recipe is ready
• which ingredients are missing
• how many ingredients you currently own
• whether missing ingredients can be purchased
• vendor name and stock when available
• a powder-free alternative when one is known

Laboratory folio workflow

When the laboratory does not currently contain a valid mix, the empty result slot can be used to open the normal alchemy folio.

Selecting a known formula from the folio will:

1. Find the best known ingredient mix for the formula.
2. Prefer a mix that can already be crafted with the currently available resources.
3. Load that mix directly into the laboratory.
4. Automatically pin the formula if ingredients are still missing.

The recipe is still loaded when incomplete, allowing the laboratory to show the available and missing ingredients normally.

When the alchemy folio is opened outside this laboratory selection mode, clicking formulas continues to pin or unpin them normally.

Mix variants

After selecting a formula from the laboratory folio, the helper ranks up to ten known mixes using the same resource-aware rules as the initial selection. If at least one mix is craftable, only craftable variants are shown. If none is currently craftable, the helper still shows up to ten useful variants with missing ingredients. The first mix loads automatically. Use the < and > buttons beside the ingredient slots, or Left Arrow and Right Arrow (Comma and Period also work), to load another variant. The ingredient slots, counts and craft result are redrawn immediately.

The variant arrows are placed to the left and right of the laboratory ingredient slots. Their positions adapt to the two-slot Laboratory I and the three-slot Laboratory II. With a controller, press D-pad left/right while variants are active to switch mixes. The on-screen + and − controls remain available for changing the craft count.

Powder-free alternatives

Some alchemy formulas have multiple valid ingredient combinations.

If the preferred mix contains alchemic powder and a known alternative without powder exists, the HUD can display the powder-free combination underneath the main recipe.

This makes it easier to preserve powders when another valid combination is available.

Requirements

• Graveyard Keeper 2
• BepInEx 5
• .NET Framework 4.7.2 target

Tested with:

• Graveyard Keeper 2 1.007.1
• BepInEx 5.4.23.5

Installation

1. Install BepInEx 5.
2. Create:

BepInEx/plugins/GK2KnownFormulaHelper

1. Copy GK2KnownFormulaHelper.dll into that folder.
2. Start or restart the game.

Updating

Close the game and extract the Nexus ZIP into the game folder, merging its BepInEx folder with the existing one. Replace the previous helper DLL. If your older installation uses another plugin folder or the filename GK2LaboratoryFolioHelper.dll, remove that old helper copy so only one version is loaded. Keep your configuration file; the plugin ID and configuration filename are unchanged.

The HUD position preview is disabled by default. If you enabled it while testing, set Enabled = false in [Debug.HudPositionPreview] for normal play.

Building

Restore tools and build the project:

dotnet tool restore
dotnet tool run csharpier format .
dotnet build -c Release

The compiled DLL is created at:

bin/Release/net472/GK2KnownFormulaHelper.dll

Release packaging and publishing are handled by private maintainer tooling and are not part of this repository.

Release packaging

Release packaging for Nexus Mods and Thunderstore is handled with private maintainer tooling.

The public repository contains the source code, build configuration, manifest metadata, assets and licenses required for development, but does not include the maintainer's release automation scripts.

Compatibility

Optional mod integrations are detected dynamically at runtime and are not hard compile-time dependencies.

Compatibility code covers Pin My Recipe, GK2 Shopping List, GK2RecipePin and Kebo Recipe Pins 2.5.1. The HUD interfaces have been checked against locally available DLLs. The combined in-game layout has not yet been verified with every mod; other HUD mods and very tall pin lists may still need layout adjustments.

Pin My Recipe

The Known Formula Helper HUD reacts to compatible recipe pin elements and can reposition itself to avoid overlapping the Pin My Recipe HUD.

GK2 Shopping List

The HUD detects the visible GK2 Shopping List panel and can position alchemy formula cards below compatible HUD elements when necessary.

GK2RecipePin and Kebo Recipe Pins

The helper also detects the GK2RecipePin tracker and the Kebo Recipe Pins 2.5.1 HUD, including when these mods load after BepInEx.

Alchemy formula cards are positioned below visible panels that overlap their horizontal screen area. Kebo lists placed elsewhere on screen do not shift the formula cards unless they reach into that area. Hidden panels, including Kebo's list when all ready pins are hidden, do not reserve space.

The layout reacts to panel creation, resizing, visibility changes and Kebo's positioning updates. Install either mod separately with its own required loader and dependencies; neither is bundled with the helper.

Controller support

The normal alchemy folio remains controller navigable when opened from the laboratory.

Formula selection uses the existing folio navigation instead of a separate custom recipe picker.

When mix variants are active, controller focus follows the laboratory row: result, left arrow, each available ingredient slot, right arrow, Craft Max, and back to result. Laboratory I contributes two ingredient slots; Laboratory II contributes three.

Press R3 anywhere in the game to remove the most recently added formula pin; opening the folio is not required. If another mod uses R3, disable RemoveLastPinWithR3 = false under [Input] in the helper configuration.

UI typography

The helper uses the optional Alegreya Sans TMP font by default for readable helper text. To switch back to the game's font, set this in the BepInEx configuration:

[UI]
FontStyle = Game

Game keeps the current game font. Sharp applies Alegreya Sans only to formula names, ingredient and vendor text, statuses, counts, alternative recipe labels, and helper preview text. Variant arrows, controller symbols, navigation glyphs, and other symbolic controls retain their cloned vanilla font and material.

Sharp requires assets/knownformulahelper_fonts.bundle beside the plugin DLL. If it is missing or does not contain the required glyphs, the helper uses the game font and logs one fallback warning. The bundle is optional and is never loaded globally.

Credits and inspiration

A big thank you to the authors of Pin My Recipe and GK2 Shopping List.

Both mods provided great ideas for presenting pinned recipes, ingredient information, and compact HUD elements in a clear and useful way.

GK2 Known Formula Helper is an independent implementation, but its HUD design and usability were strongly inspired by ideas found in these mods.

Special thanks for the inspiration around:

• compact pinned recipe layouts
• readable ingredient presentation
• HUD positioning and usability
• keeping useful information visible without opening additional windows

Alegreya Sans is Copyright 2013 The Alegreya Sans Project Authors and is licensed under the SIL Open Font License 1.1. The complete license is included with the font asset at LICENSES/AlegreyaSans-OFL.txt.

Compatibility with Pin My Recipe and GK2 Shopping List is optional and handled dynamically at runtime.

Development notes

To test HUD positions without installing other pin mods, set Enabled = true under [Debug.HudPositionPreview] in BepInEx/config/w00dst0ckOos.GK2LaboratoryFolioHelper.cfg and restart the game. In a loaded save, F7 advances through simulated panel positions and F6 goes back. The cases include small/tall panels, right/left/center placement, two panels, and hidden panels. A temporary formula card appears if no formulas are pinned. Cycle to Off to end the preview, or set Enabled = false and restart to disable it completely. This tests positioning; the other mods' loaders are not simulated.

• Narrow Harmony patches
• Preserve vanilla crafting behaviour
• No save-data changes
• No hard dependency on optional HUD mods
• No per-frame polling for normal pin updates

Changelog

See CHANGELOG.md.

License

This project is licensed under the MIT License.