Getting Started: Crucible Package Mods

Crucible Package Mods allow you to customize PotionCraft using text based configuration files. These mods can easily be edited and shared, and do not require any coding experience to make.

Creating a Crucible Package

To make a Crucible Package Mod, create a folder with your mod's name inside PotionCraft/crucible/mods. This folder will contain all your art assets, as well as the package.yml file describing your mod's features.

Package.yml

In your mod folder, you should make a text file named package.yml file. This file is a YAML-formatted text file that specifies what features your mod has.

To start with, specify the mod's name, the author name, and the version of the mod:

name: My Mod
author: Me
version: 1.0.0

Adding Features

The features accessible from config mods depend on the modules installed to Crucible. Crucible provides some base features, and other plugins can further extend the available options.

Currently, Crucible provides the following features out of the box:

• Custom Ingredients
• Custom NPCs
• Custom Potion Bottles

Custom Ingredients

For a full reference of ingredient options, see Reference: Ingredients

Custom NPCs

For a full reference of customer options, see Reference: Customers

For a full reference of trader options, see Reference: Traders

For example mods see Example Mods

Custom Potion Bottles

For a full reference of potion bottle options, see Reference: Potion Bottles

For a full reference of potion bottle icon options, see Reference: Potion Bottle Icons

For a full reference of potion bottle sticker options, see Reference: Potion Bottle Stickers

For example mods see Example Mods