BreweryXRecipe Generator
GuideRecipesRU

BreweryX Recipe Generator

HomeGuideRecipes

BreweryX

breweryx.breweryteam.devGitHub

Project

Version 2.0VintlGvard
© VintlGvard — BreweryX Recipe Generator
Home→Guide

BreweryX Reference — Recipe Format and All YAML Fields

Introduction

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.

Contents
  • Basic Recipe Structure
  • Required Fields
  • Ingredients (ingredients)
  • Cooking and Difficulty (cookingtime, difficulty)
  • Distillation (distillruns, distilltime)
  • Barrel Aging (wood, age)
  • Drink Color (color)
  • Effects (effects)
  • Strength and Glow (alcohol, glint)
  • Display Names and Messages
  • Commands (servercommands, playercommands)
  • CustomModelData
  • Drink Quality
  • Full Recipe Example
Basic Recipe Structure

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: 6
Required Fields
recipe_id
A unique string identifier for the recipe (e.g. my_beer). Used as the key in recipes.yml and for command references.
name
The display name of the drink with color codes (e.g. &6Craft Beer). Supports & codes, named colors and HEX.
ingredients
A list of ingredients in the MATERIAL/AMOUNT format. At least one ingredient required. Examples: WHEAT/6, WATER_BUCKET/1.
cookingtime
Cooking time in minutes. Values from 0 (instant) to 1000. Determines how long a player must stand by the cauldron.
difficulty
Crafting difficulty from 1 to 10. Higher values require more precise timing to produce a quality drink.
Ingredients (ingredients)

Ingredients are specified as a list of strings in the MATERIAL/AMOUNT format. Any vanilla Minecraft item is supported. Examples:

WHEAT/6
6 wheat — the classic beer ingredient.
WATER_BUCKET/1
1 water bucket — required for most drinks.
SUGAR/2
2 sugar — makes the drink sweeter, used in mead and whiskey.
HONEY_BOTTLE/1
1 honey bottle — the primary mead ingredient.
NETHER_WART/1
1 nether wart — for potion-like drinks.
Cooking and Difficulty (cookingtime, difficulty)
cookingtime
Cooking time in minutes. Values from 0 to 1000. At 0 the drink brews instantly when all ingredients are added. Recommended: 3–15 minutes for beer, 10–30 for spirits.
difficulty
Difficulty from 1 to 10. Determines how precisely the player must hit the target time window. At difficulty 1 almost any timing yields a good result; at 10 you need minute-level precision.
Distillation (distillruns, distilltime)

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:

distillruns
Number of distillation runs (1–10). Each run increases the drink's strength. For whiskey, typically 2–3 runs.
distilltime
Duration of one distillation run in seconds (1–3600). Recommended: 60–300 seconds. If too short, the drink may not distill properly.
Barrel Aging (wood, age)

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):

0
Any wood barrel — automatically picks an available barrel.
1
Birch barrel — light flavor, good for light drinks.
2
Oak barrel — the classic choice for most drinks.
3
Jungle barrel — tropical aroma for mead and fruit drinks.
4
Spruce barrel — dark, rich flavor, excellent for whiskey.
5
Acacia barrel — exotic taste for unusual drinks.
6
Dark Oak barrel — intense oak flavor.
7
Crimson barrel — rich mushroom aroma.
8
Warped barrel — oceanic undertone.
9
Mangrove barrel — unique flavor for experiments.
10
Cherry barrel — sweet fruity aroma.
11
Bamboo barrel — light tropical taste.
12
Cut Copper barrel — metallic taste for experiments.
Drink Color (color)

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:

WHITE
White — for light drinks and milk cocktails.
BRIGHT_GREY
Light gray — for transparent drinks.
GREY
Gray — for dark drinks with charcoal.
BLACK
Black — for porters and stouts.
DARK_RED
Dark red — for dark strong drinks.
RED
Red — for strong and spicy drinks.
BRIGHT_RED
Bright red — for fiery drinks.
ORANGE
Orange — for citrus drinks and whiskey.
YELLOW
Yellow — for beer and mead.
GREEN
Green — for herbal drinks.
LIME
Lime — for green drinks.
OLIVE
Olive — for strong herbal tinctures.
TEAL
Teal — for ocean drinks.
CYAN
Cyan — for icy drinks.
BLUE
Blue — for icy and water drinks.
WATER
Water — transparent blue for light drinks.
PURPLE
Purple — for magical potions.
PINK
Pink — for floral drinks.
Effects (effects)

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
Strength and Glow (alcohol, glint)
alcohol
Drink strength as a percentage (0–100). Affects the player's intoxication level. At 0% the drink causes no intoxication. Recommended: 5–15% for beer, 20–40% for spirits.
glint
Item glow (true/false). If true, the drink will shimmer like an enchanted item. Suitable for magical potions and rare drinks.
Display Names and Messages

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:

name
The drink's name. You can set one for all qualities or three with slashes: '&4Poor/&6Normal/&aGood'.
lore
The drink's description (list of strings). Quality prefixes: '+' for bad quality, '++' for normal, '+++ ' for good. Lines without a prefix always show.
displayname
Display name in the inventory. Overrides name for more precise customization.
Commands (servercommands, playercommands)

When a drink is consumed, server or player commands can be executed. Commands run as the server or the player respectively.

Available fields:

servercommands
List of commands executed by the server on consumption. Format: 'command'. Example: 'give %player% diamond 1'.
playercommands
List of commands executed by the player on consumption. Format: 'command'. Example: 'me drinks a strong spirit'.
drinkmessage
Message sent to the player on consumption. Supports color codes.
CustomModelData

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'.

Drink Quality

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
Full Recipe Example

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

Open generatorReady recipes