Skip to content

Home

Jump to bottom
hikarii edited this page Nov 21, 2025 · 7 revisions

Welcome to the CustomRecipes Wiki

Create your own custom Crafting, Furnace, Anvil, and other recipes with tons of configuration options with Full GUI Support. You can customize any Vanilla Recipes too!

Installation

Requirements

The most important step is correctly installing the plugin with compatible versions!

Minecraft Version Java Version CustomRecipes
1.21+ Java 21+ 1.5.0

Setup

  1. Download the latest CustomRecipes-1.5.0.jar from Releases
  2. Place the jar file in your server's plugins folder
  3. Start your server to generate default configuration
  4. Done! Use /cr gui to manage recipes or /cr list to browse them

Quick Start

Commands

Command Description Permission
/cr or /customrecipes Main command (opens list for players, help for admins) customrecipes.list
/cr list Browse all custom recipes in GUI customrecipes.list
/cr gui Open recipe management GUI (admin only) customrecipes.gui
/cr reload Reload plugin configuration customrecipes.reload
/cr help Show help message customrecipes.manage

Aliases: /cr, /crecipes, /customrecipe

Note: Recipe management commands (enable, disable, delete) have been removed in v1.5.0. All recipe management is now done through the GUI (/cr gui).

Creating Your First Recipe

Using the GUI (Recommended):

  1. Use /cr gui to open the management interface
  2. Click "+ Create New Recipe" button
  3. Select recipe type (Shaped/Shapeless)
  4. Click slots to set ingredients
  5. Set the result item with custom name, lore, enchantments
  6. Click Save to create the recipe
  7. Recipe is active immediately - no reload needed!

Manual YAML Editing:

  1. Navigate to plugins/CustomRecipes/recipes/
  2. Create or edit a .yml file
  3. Add your recipe (see format below)
  4. Reload: /cr reload

New in Version 1.5.0

🎨 Vanilla Recipe Editor

  • Modify or disable vanilla Minecraft recipes
  • Access via /cr gui → "📜 Vanilla Recipes"
  • Edit ingredients, results, or completely disable recipes
  • Changes apply immediately without restart

👥 Player Recipe Browser

  • New /cr list command for all players
  • Beautiful paginated GUI showing all available recipes
  • Click any recipe to view crafting pattern and details
  • Filter recipes by station type (Crafting Table, Furnace, etc.)
  • Players can discover and learn recipes in-game

🔧 Pattern Editor GUI

  • Visual shaped recipe pattern editor
  • Drag and drop ingredients into 3x3 grid
  • Real-time preview of recipe pattern
  • Much easier than manual YAML editing

✨ Enchantment Selector

  • Easy enchantment selection interface
  • Adjust enchantment levels with +/- buttons
  • See all available enchantments for each item type
  • Supports all Minecraft 1.21 enchantments (including mace enchantments)

🎯 Advanced Features

  • Exact Item Matching - Require specific items with exact names, lore, enchantments
  • Durability Control - Set custom durability values on result items
  • Item Flags - Hide attributes, enchantments, and more
  • Recipe Descriptions - Add helpful descriptions to guide players
  • Enable/Disable Recipes - Toggle recipes without deleting them
  • Auto-Migration System - Seamless upgrades between plugin versions

Recipe Format (Advanced)

Recipes are stored in plugins/CustomRecipes/recipes/ as YAML files.

Example: Custom Enchanted Sword

fire-sword:
  type: SHAPED  # SHAPED or SHAPELESS
  result:
    material: DIAMOND_SWORD
    amount: 1
    name: "<gradient:#FF0000:#00FF00>Fire Sword</gradient>"
    lore:
      - "<gray>A legendary blade"
      - "<red>+10 Attack Damage"
      - ""
      - "<yellow>Right-click to ignite enemies"
    enchantments:
      - "sharpness:5"
      - "fire_aspect:2"
    flags:
      - "HIDE_ENCHANTS"
      - "HIDE_ATTRIBUTES"
    durability: 1561  # Optional: custom durability
  ingredients:
    - material: DIAMOND
      amount: 1
      slot: 0  # Top-left of 3x3 grid
    - material: DIAMOND
      amount: 1
      slot: 1
    - material: BLAZE_ROD
      amount: 1
      slot: 4  # Center slot
    # ... more ingredients
  description:  # Shown in recipe browser
    - "Combine diamonds with a blaze rod"
    - "to create a powerful fire sword"

Example: Exact Item Recipe

special-potion:
  type: SHAPELESS
  result:
    material: POTION
    amount: 1
    name: "<aqua>Potion of Ultimate Healing"
  ingredients:
    - material: POTION
      amount: 1
      exact_item: true  # Requires exact item match
      name: "<red>Health Potion"
      lore:
        - "A basic healing potion"
    - material: GOLDEN_APPLE
      amount: 2

Color Codes (MiniMessage)

CustomRecipes supports the MiniMessage format for rich text formatting:

Named Colors: <black>, <dark_blue>, <dark_green>, <dark_aqua>, <dark_red>, <dark_purple>, <gold>, <gray>, <dark_gray>, <blue>, <green>, <aqua>, <red>, <light_purple>, <yellow>, <white>

Hex Colors:

  • <#FF5555>Custom Hex Color</color>
  • <color:#FF5555>Custom Hex Color</color>

Gradients:

  • <gradient:#FF0000:#00FF00>Rainbow Text</gradient>
  • <gradient:#FF0000:#00FF00:#0000FF>Multi-color Gradient</gradient>

Decorations:

  • <bold>Bold Text</bold>
  • <italic>Italic Text</italic>
  • <underlined>Underlined</underlined>
  • <strikethrough>Strikethrough</strikethrough>
  • <obfuscated>Magic Text</obfuscated>

Reset:

  • <reset> - Reset all formatting

Full MiniMessage Documentation

Permissions

Permission Description Default
customrecipes.* Grants all permissions op
customrecipes.list View all custom recipes true
customrecipes.gui Open recipe management GUI (admin) op
customrecipes.manage Create, edit, enable/disable, delete recipes op
customrecipes.reload Reload plugin configuration op
customrecipes.update.notify Receive update notifications on join op

Note: Regular players only need customrecipes.list to browse recipes via /cr list.

Examples

Spawn Egg Recipe

BeeSpawnEgg:
  type: SHAPED
  result:
    material: BEE_SPAWN_EGG
    amount: 1
    name: "<yellow>Bee Spawn Egg"
    lore:
      - "<gray>Craft using honey bottles"
  ingredients:
    - material: HONEY_BOTTLE
      amount: 1
      slot: 0
    - material: HONEY_BOTTLE
      amount: 1
      slot: 1
    - material: HONEY_BOTTLE
      amount: 1
      slot: 2
    - material: HONEY_BOTTLE
      amount: 1
      slot: 3
    - material: CLOCK
      amount: 1
      slot: 4
    - material: HONEY_BOTTLE
      amount: 1
      slot: 5
    - material: HONEY_BOTTLE
      amount: 1
      slot: 6
    - material: HONEY_BOTTLE
      amount: 1
      slot: 7
    - material: HONEY_BOTTLE
      amount: 1
      slot: 8
  description:
    - "Surround a clock with honey bottles"

Bulk Crafting Recipe

EnderPearlStack:
  type: SHAPED
  result:
    material: ENDER_PEARL
    amount: 16
    name: "<dark_purple>Ender Pearl Stack"
  ingredients:
    - material: ENDER_EYE
      amount: 1
      slot: 0
    - material: ENDER_EYE
      amount: 1
      slot: 1
    - material: ENDER_EYE
      amount: 1
      slot: 2
    - material: ENDER_EYE
      amount: 1
      slot: 3
    - material: ENDER_PEARL
      amount: 1
      slot: 4
    - material: ENDER_EYE
      amount: 1
      slot: 5
    - material: ENDER_EYE
      amount: 1
      slot: 6
    - material: ENDER_EYE
      amount: 1
      slot: 7
    - material: ENDER_EYE
      amount: 1
      slot: 8

Enchanted Tool Recipe

SuperPickaxe:
  type: SHAPED
  result:
    material: DIAMOND_PICKAXE
    amount: 1
    name: "<gradient:#00D4FF:#7B2CBF>Super Pickaxe</gradient>"
    lore:
      - "<gray>An incredibly powerful pickaxe"
      - "<yellow>Efficiency X"
      - "<aqua>Fortune V"
    enchantments:
      - "efficiency:10"
      - "fortune:5"
      - "unbreaking:3"
    flags:
      - "HIDE_ENCHANTS"
  ingredients:
    - material: DIAMOND_BLOCK
      amount: 1
      slot: 0
    - material: DIAMOND_BLOCK
      amount: 1
      slot: 1
    - material: DIAMOND_BLOCK
      amount: 1
      slot: 2
    - material: NETHERITE_INGOT
      amount: 1
      slot: 4
    - material: NETHERITE_INGOT
      amount: 1
      slot: 7
  description:
    - "The ultimate mining tool"
    - "Crafted with diamond blocks and netherite"

Support

Need help?

Discord

Roadmap

✅ Completed Features

  • Shaped and Shapeless recipes
  • Custom names, lore, enchantments
  • Full GUI management system
  • Vanilla recipe editing
  • Player recipe browser with filters
  • Pattern editor GUI
  • Enchantment selector
  • Exact item matching
  • Durability control
  • MiniMessage formatting support
  • Auto-migration system
  • Recipe descriptions
  • Enable/disable recipes

🔜 Planned Features

  • Furnace Recipes - Custom smelting recipes (Furnace, Blast Furnace, Smoker)
  • Anvil Recipes - Custom anvil combinations
  • Smithing Table Recipes - Custom smithing upgrades
  • Brewing Stand Recipes - Custom potion brewing
  • Stonecutter Recipes - Custom stonecutter patterns
  • Recipe Categories/Groups - Organize recipes into categories
  • Recipe Unlocking System - Progression-based recipe discovery
  • Conditional Recipes - Permission-based or world-based recipes
  • Custom Sounds - Play sounds when crafting
  • Recipe Book Integration - Show recipes in vanilla recipe book
  • Import/Export System - Share recipes between servers
  • Recipe Templates - Pre-made recipe templates
  • Multi-Language Support - Translations for different languages
  • MySQL Support - Store recipes in database
  • Per-Player Recipes - Track which recipes each player has unlocked

Made with ❤️ for the Minecraft community

Version: 1.5.0 | Minecraft: 1.21+ | Java: 21+

Clone this wiki locally