custom-crafter-api

# custom crafter custom crafter is a custom recipe plugin for PaperMC servers, and also a library (API) for defining custom recipes from your own plugin. Define custom recipes freely from your plugin and introduce new elements into the game. (https://github.com/Sakaki-Aruka/custom-crafter/blob/master/README_JP.md) --- ## Features - **Custom recipes for vanilla items** — add new recipes for existing Minecraft items. - **Custom item support** — use items created by your plugin as results or materials. - **Material management commands** — for server administrators managing recipe materials. - **Automatic integration** — registered recipes appear in players' crafting environment without extra setup. - Vanilla crafting continues to work unmodified. --- ## Demo <details><summary>Crafting demo video</summary> 1. Place base blocks (`GOLD_BLOCK`). 2. Craft `infinityIronBlockCore` (https://github.com/Sakaki-Aruka/custom-crafter/blob/master/demo/src/main/kotlin/online/aruka/custom_crafter/demo/register/ShapedRecipeProvider.kt). 3. Compress an iron block into `infinityIronBlock` (https://github.com/Sakaki-Aruka/custom-crafter/blob/master/demo/src/main/kotlin/online/aruka/custom_crafter/demo/register/ShapedRecipeProvider.kt). 4. Repeat with the same recipe. 5. Repeat again. 6. Extract the infinity iron block with `infinityIronBlockExtract` (https://github.com/Sakaki-Aruka/custom-crafter/blob/master/demo/src/main/kotlin/online/aruka/custom_crafter/demo/register/ShapelessRecipeProvider.kt). !(https://raw.githubusercontent.com/Sakaki-Aruka/custom-crafter/master/resources/crafting-demo.gif) </details> Clone the (https://github.com/Sakaki-Aruka/custom-crafter) and run the following command to build a demo plugin containing the recipes shown above, along with several others: ``` mvn -pl demo package ``` The resulting jar, ready to be placed in a server's `plugins` directory, is written to `demo/target`. --- ## Supported Environments | Custom_Crafter Version | Paper Version | |:-------------------------------|:--------------------------| | **5.4.0 (latest)** | 1.21.4 ~ 1.21.11, 26.1.x | | 5.0.13 ~ 5.0.21, 5.1.0 ~ 5.3.0 | 1.21.4 ~ 1.21.11, 26.1.x | | 5.0.0 ~ 5.0.11 | 1.21.3 | | 4.3 (legacy) | 1.21.3 | | 4.2 (legacy) | 1.20.1 ~ 1.20.4 | The minimum supported Paper version rarely changes between releases, so using the latest release is recommended. **Note:** custom crafter does not run on Spigot/Bukkit. Use PaperMC or a Paper fork. --- ## Using the API Since version 5.0.0, custom crafter also works as an API for defining and registering custom recipes from your own plugin. ### Documentation - (https://sakaki-aruka.github.io/custom-crafter/kdoc/) - (https://sakaki-aruka.github.io/custom-crafter/javadoc/) - (https://sakaki-aruka.github.io/custom-crafter/document/en/getting-started/) To build the documentation locally: ``` mvn -pl api dokka:dokka # KDoc mvn -pl api dokka:javadoc # Javadoc ``` ### Dependency Plugins depending on CustomCrafterAPI must list `Custom_Crafter` under `depend` in `plugin.yml`: ```yaml depend: - "Custom_Crafter" ``` --- Latest version: 5.4.0 ((https://central.sonatype.com/artifact/io.github.sakaki-aruka/custom-crafter-api/versions)) The CustomCrafter plugin is assumed to be present at runtime, so set its dependency scope to compile-time only — the same applies to the Kotlin stdlib if your plugin is written in Kotlin. Compile-time-only scope name by build tool: - Maven: `provided` - Gradle: `compileOnly` <details><summary>Maven</summary> ```xml <!-- CustomCrafterAPI --> <dependency> <groupId>io.github.sakaki-aruka</groupId> <artifactId>custom-crafter-api</artifactId> <version>5.4.0</version> <scope>provided</scope> </dependency> <!-- kotlin-stdlib --> <dependency> <groupId>org.jetbrains.kotlin</groupId> <artifactId>kotlin-stdlib</artifactId> <version>2.3.0</version> <scope>provided</scope> </dependency> ``` </details> <details><summary>Gradle (Groovy)</summary> ```groovy dependencies { compileOnly 'io.github.sakaki-aruka:custom-crafter-api:5.4.0' compileOnly 'org.jetbrains.kotlin:kotlin-stdlib:2.3.0' // if using Kotlin } ``` </details> <details><summary>Gradle (Kotlin DSL)</summary> ```kotlin dependencies { compileOnly("io.github.sakaki-aruka:custom-crafter-api:5.4.0") compileOnly("org.jetbrains.kotlin:kotlin-stdlib:2.3.0") // if using Kotlin } ``` </details> --- ## Server Installation custom crafter is written in Kotlin. 1. (https://github.com/Sakaki-Aruka/custom-crafter/releases/latest) and place the downloaded files in your `plugins` directory. 2. Start or reload the server. 3. Pl