This reference describes the full BreweryX recipe format — the YAML file the plugin reads on load. It lists all available fields, their types, valid values and usage examples.
If you are just getting started with BreweryX, we recommend using our recipe generator first: it automatically validates all fields and produces correct YAML. The reference is useful if you want to understand the format in depth or write recipes by hand.
Every BreweryX recipe is a YAML entry where the key is a unique recipe ID (e.g. my_beer or thunder_whiskey). Inside the entry are all the drink's parameters: name, description, ingredients, cooking time and optional fields.
Below is a minimal recipe example with the main fields:
my_beer:
name: '&6Craft Beer'
lore:
- 'Tasty beer'
- 'Refreshing'
ingredients:
- WHEAT/6
- WATER_BUCKET/1
cookingtime: 5
color: WHITE
difficulty: 6Ingredients are specified as a list of strings in the MATERIAL/AMOUNT format. Any vanilla Minecraft item is supported. Examples:
Distillation is used for strong spirits: whiskey, rum, vodka. After brewing, a drink can be distilled multiple times to increase strength and improve flavor. Distillation happens in the still.
Fields:
BreweryX supports aging drinks in barrels made from different wood types. Each barrel type affects the drink's flavor and properties. Aging lasts the specified number of in-game days.
Wood types (wood):
The drink color determines its appearance in the inventory and in the player's hand. BreweryX supports both standard Minecraft named colors and HEX colors for version 1.16+.
Named colors:
Effects are standard Minecraft potion effects applied when the drink is consumed. Format: EFFECT/LEVEL/DURATION (in seconds).
You can specify multiple effects, as well as ranges for the quality system (poor/medium/good). Examples:
effects: - SPEED/1/60 - NAUSEA/1/30 # With quality ranges: effects: - SPEED/1-3/10-60 - REGENERATION/1-2/5-30
BreweryX allows you to customize the display name (name), description (lore) and display text (displayname) for each quality level. Format: three values separated by slashes — poor/medium/good.
Available fields:
When a drink is consumed, server or player commands can be executed. Commands run as the server or the player respectively.
Available fields:
The customModelData field allows you to set a custom model for the item, if resource packs are installed. Used with plugins like ItemsAdder to display custom textures.
Format: a single value (for all qualities) or three separated by slashes for different qualities: '1000/1001/1002'.
BreweryX supports three quality levels: poor, medium, and good. Quality is determined by brewing precision: if the player removes the drink from the cauldron too early or too late, the quality decreases.
For each level you can set a unique: name, lore, effects, CustomModelData and display names. Format — three values separated by slashes: 'poor/medium/good'. Example:
name: '&4Bad Beer/&6Normal Beer/&aGood Beer' lore: - '+Lukewarm beer' - '++Pleasant taste' - '+++Excellent ale' customModelData: 1000/1001/1002 effects: - SPEED/1-3/10-60 - REGENERATION/1-2/5-30
Below is a complete whiskey recipe with distillation, barrel aging, effects and strength. This example demonstrates all the main fields:
thunder_whiskey:
name: '&8Thunder Whiskey'
lore:
- 'Strong aged whiskey'
- 'Made in oak barrels'
ingredients:
- WHEAT/10
- WATER_BUCKET/2
- SUGAR/4
effects:
- SPEED/1/60
- NAUSEA/1/30
cookingtime: 10
distillruns: 2
distilltime: 120
wood: 2
age: 5
color: ORANGE
difficulty: 7
alcohol: 30