Potion Craft: Alchemist Simulator
0 of 0

File information

Last updated

Original upload

Created by

RoboPhred

Uploaded by

robophred

Virus scan

Safe to use

Tags for this mod

About this mod

Crucible is a modding framework for PotionCraft, providing resources for both BepInEx mods and code-free config driven mods. Now compatible with Potion Craft 1.1!

Requirements
Permissions and credits
Crucible is now compatible with Potion Craft 1.0!

Crucible Mod Framework

Crucible is a modding framework and plugin loader for PotionCraft.  It contains both an API for BepInEx mod authors to access game features, and a mod loader that allows the customization of several aspects of the game without needing to use compiled code mods or BepInEx plugins.

The latest version of Crucible can always be found on GitHub.

Crucible Mod Packages

Crucible provides a new method of creating mods that does not require dll compilation or game patching.  These "Package mods" use configuration files and additional assets to tell the Crucible Framework what changes to make to the game.

Currently, this format supports creating custom ingredients, including all associated art assets and behaviors.

For more information on making package mods, see the project wiki.

Support for custom potion bases and potion maps is in the works, with custom potion effects and customer requests to follow.

BepInEx Modding API

Crucible provides a modding api for BepInEx mods, easing development of PotionCraft mods and taking on some responsibility for handling breaking changes.
The following features are currently available in the modding api:
  • Shared access to sprite atlases, allowing mods to add new icons without conflicting with each other.
  • Shared access to save data, allowing mods to add data to the save files without corrupting each other's data.
  • Access to create and customize ingredients, wrapped behind and API that will remain stable across game updates.
  • Access to Crucible's package mod system, allowing mods to enable new features for code-less configuration based mods.

Projects that use Crucible

Support

Support is offered on a best-effort basis on the PotionCraft Discord under the #modding channel.

A note on Pantry

This mod is the spiritual successor to the Pantry mod, which has been discontinued.  Pantry was built in a way that makes it difficult to be compatible with other mods, a mistake Crucible tries to avoid.  Support for Pantry has ended, and future development will go into building Crucible.

Porting ingredient mods from Pantry is relatively straightforward.  The yaml file structure is largely identical, with a few renamed operations.  See the wiki for more information.

Crucible is Open Source

Crucible is licensed under the LGPL license.
Source available at GitHub