> For the complete documentation index, see [llms.txt](https://thanhpahts-organization.gitbook.io/product-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://thanhpahts-organization.gitbook.io/product-docs/ultimate-crafting/i.-introduce.md).

# I. Introduce

### **1. Overview**

UltimateCrafting is a Paper plugin for creating fully configurable crafting stations. It is designed for servers that need category-based crafting menus, custom recipe files, MMOItems support, Vault money requirements, PlayerPoints requirements, permission checks, PlaceholderAPI checks, in-game editing, custom GUI buttons, custom heads, sounds, and custom model data.

The plugin is built around three main GUI layers. Players open the main category GUI, select a category, then select a recipe. The recipe GUI displays the output, required items, and craft button. Server owners can configure the entire layout through YAML files.

### **2. Main Features**

* Category-based crafting menus.
* Recipe files stored inside category folders.
* Vanilla output and MMOItems output.
* Vanilla requirements and MMOItems requirements.
* Vault money requirements.
* PlayerPoints requirements.
* Permission requirements.
* PlaceholderAPI requirements.
* Configurable recipe success rate.
* In-game Editor Mode for creating categories and recipes.
* Drag-and-drop item setup for output and item requirements.
* Vanilla custom item support through NBTTag.
* Custom GUI buttons, skull textures, HeadDatabase icons, sounds, and CustomModelData.
* Compatibility aliases for old commands and placeholders.

### **3. Optional Dependencies**

| Plugin         | Type     | Purpose                                                             |
| -------------- | -------- | ------------------------------------------------------------------- |
| Vault          | Optional | Required for money requirements.                                    |
| MMOItems       | Optional | Required for MMOItems output and MMOItems item requirements.        |
| PlayerPoints   | Optional | Required for points requirements and points placeholders.           |
| PlaceholderAPI | Optional | Required for PlaceholderAPI requirements and external placeholders. |
| HeadDatabase   | Optional | Required only when GUI items use hdb-id.                            |

### **4. Installation**

1. Place UltimateCrafting-1.0.jar into the server plugins folder.
2. Install optional dependencies only for the features you want to use.
3. Start the server once to generate the plugin folder.
4. Stop the server.
5. Edit config.yml, messages.yml, categories.yml, GUI files, and recipe files.
6. Start the server again, or use /ultimatecrafting reload after safe config edits.

<sup>*Important: the plugin does not overwrite existing config files on startup. Default files are only created when they do not already exist.*</sup>