> For the complete documentation index, see [llms.txt](https://1robie.gitbook.io/recipebook/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://1robie.gitbook.io/recipebook/getting-started/readme.md). # Introduction Welcome to the complete documentation for **RecipeBook**, the ultimate plugin for managing custom recipes in Minecraft! ## 🎯 About RecipeBook RecipeBook is a powerful and flexible Minecraft plugin that revolutionizes recipe management on your server. Whether you want to create custom crafting recipes, manage player inventories, or integrate with popular custom item plugins, RecipeBook provides all the tools you need. ## ⭐ Key Features ### πŸ”§ Advanced Recipe System * **8 different recipe types** (crafting, furnace, blast furnace, smoker, campfire, stonecutter, smithing table) * **Vanilla integration** with regular recipes folder * **Menu-exclusive recipes** with fake recipes folder * **Custom experience and cooking times** for all smelting recipes ### 🎨 Powerful Menu System * **Advanced GUI** integration with [zMenu](https://docs.zmenu.dev/) * **Customizable crafting requirements** and permissions * **Crafting time delays** for balanced gameplay * **Player storage system** for secure item management * **Queue management** for organized crafting ### πŸ”— Extensive Integrations * **PlaceholderAPI**: 15+ placeholders available * **Custom Item Plugins**: Nexo, ItemsAdder, zItems, zHead, Oraxen * **Discord Integration**: Real-time crafting notifications * **Database Support**: SQLite and MySQL ### ⚑ Performance & Reliability * **Folia Compatible**: Fully supports Folia's regionized multithreading for maximum performance and stability * **Asynchronous processing** for smooth performance * **RAM caching** for lightning-fast recipe lookups * **Batch processing** for efficient data handling * **Multi-platform logging** (Console, File, Discord, JSON) ## πŸ—ΊοΈ Quick Navigation ### πŸš€ Getting Started * [πŸ“‹ Requirements](/recipebook/getting-started/requirements.md) * [⚑ Quick Start](/recipebook/getting-started/quick-start.md) - Get running in 5 minutes! * [πŸ“¦ Installation Guide](https://github.com/1robie/RecipeBook_zMenu/blob/master/doc/getting-started/installation.md) * [✨ Features Overview](/recipebook/getting-started/features.md) ### βš™οΈ Configuration * [πŸ”§ Main Configuration](/recipebook/configuration/main-config.md) * [πŸ’Ύ Database Setup](/recipebook/configuration/database.md) * [πŸ“Š Logging & Discord](/recipebook/configuration/logging.md) * [πŸš€ Performance Optimization](/recipebook/configuration/performance.md) ### πŸ“ Recipe Management * [πŸ“– Recipe Types Overview](/recipebook/recipe-management/recipes.md) * [βš”οΈ Recipes vs Fake Recipes](/recipebook/recipe-management/recipe-vs-fake-recipes.md) * [πŸ”¨ Crafting Recipes](/recipebook/recipe-management/shaped-recipes.md) * [πŸ”₯ Smelting Recipes](/recipebook/recipe-management/furnace-recipes.md) ### 🎨 Menu System * [πŸ–₯️ Menu Configuration](/recipebook/menu-system/menu-configuration.md) * [πŸ“¦ Player Storage](/recipebook/player-storage/player-storage.md) ### πŸ”— Integrations * [πŸ”§ Plugin Integration](/recipebook/plugin-integrations/integration.md) ### πŸ’» Commands & Permissions * [⌨️ Commands](/recipebook/commands-and-permissions/commands.md) * [πŸ” Permissions](/recipebook/commands-and-permissions/permissions.md) ### πŸ› οΈ Advanced Usage * [πŸ“Š Placeholders](/recipebook/advanced-features/placeholders.md) * [⚑ Actions System](/recipebook/advanced-features/actions.md) * [πŸ”’ Requirements System](/recipebook/advanced-features/requirements.md) ### πŸ†˜ Support * [❓ FAQ & Troubleshooting](/recipebook/troubleshooting-and-support/faq.md) * [πŸ› Common Issues](/recipebook/troubleshooting-and-support/common-issues.md) * [πŸ“ž Contact & Support](/recipebook/additional-resources/contact.md) ## πŸŽ‰ Ready to Begin? Click on [**Quick Start**](/recipebook/getting-started/quick-start.md) to install RecipeBook in less than 5 minutes! ## 🌟 Why Choose RecipeBook? ### For Server Owners * **Easy Setup**: Get running with minimal configuration * **Flexible Design**: Adapts to any server type or theme * **Performance Optimized**: Won't slow down your server * **Extensive Documentation**: Everything you need to know ### For Players * **Intuitive Interface**: Easy-to-use crafting menus * **Secure Storage**: Never lose items during crafting * **Rich Experience**: Custom recipes and crafting mechanics * **Seamless Integration**: Works with your favorite custom items ### For Developers * **Open Integration**: Works with most popular plugins * **Extensive API**: Build custom integrations * **Active Support**: Regular updates and improvements * **Community Driven**: Open to suggestions and contributions *** *This wiki is constantly evolving. Feel free to contribute or report errors.* ## πŸ“Š Latest Stats * **8** Recipe Types Supported * **15+** PlaceholderAPI Placeholders * **5** Custom Item Plugin Integrations * **4** Logging Methods Available * **2** Database Types Supported *** **Version:** space.vars.version | **Minecraft:** 1.20.4+ | **Dependencies:** zMenu, PlaceholderAPI | **Folia Compatible**