CustomRecipesGUI Plugin

Overview

CustomRecipesGUI is a Paper plugin that introduces a hybrid crafting system combining real Minecraft crafting table recipes with an in-game graphical recipe browser. It allows server developers to define custom recipes in a config file, register them into vanilla crafting tables, and provide players with a clean GUI-based way to view and understand those recipes.

Key Features

• Real crafting table integration using Paper’s recipe system
• Custom recipe definitions loaded from config.yml
• Support for multiple items required per crafting slot
• Full validation and item consumption on crafting
• GUI-based recipe browser using a 6×9 inventory layout
• Blue stained glass pane border around all GUIs
• Recipe preview screen with full 3×3 crafting grid display
• Output item preview included in recipe view
• Back button navigation between menus
• No pagination (single-page recipe list)

GUI System

Main Recipes GUI:

• Size: 6×9 inventory
• Displays all registered custom recipe outputs
• Entire outer border is blue stained glass panes
• Center area contains clickable recipe items
• Clicking a recipe opens its preview screen

Recipe Preview GUI:

• Size: 6×9 inventory
• Shows full 3×3 crafting layout
• Displays required ingredients per slot
• Shows final output item
• Includes a back button to return to main menu
• Same blue stained glass border for consistency

Crafting System

• Recipes are registered as real Paper ShapedRecipes
• Crafting is validated using PrepareItemCraftEvent
• Final consumption is handled during CraftItemEvent
• Prevents invalid crafting attempts
• Supports multiple-item requirements per slot
• Follows normal Minecraft crafting behavior for item consumption

Configuration Format

Recipes are defined in config.yml with:

• Display name
• 3×3 crafting shape
• Ingredient mapping per slot
• Output item definition

Each ingredient supports:

• Vanilla materials only
• Required stack amounts per slot
• Flexible placement using shape keys

Limitations

• No support for external item plugins (vanilla only)
• No pagination for recipe GUI
• GUI is display-only (no crafting inside menus)
• Requires correct config formatting to avoid load errors

Purpose

Designed for servers that want custom weapons and items integrated cleanly into vanilla crafting while still giving players an intuitive way to browse and understand recipes without needing external documentation.