Volucraft

<!--DO NOT EDIT MANUALLY: synced from gh readme--> # Volucraft 3D (Volumetric) Crafting in Minecraft! I've been waiting for this for so long... ## How to Volucraft To start, obtain an Amalgamation Table from the Creative Inventory (in Functional Blocks after the Crafting Table), or craft one (3 iron ingots on the top, any shulker box in the middle surrounded by 3 adjacent crafting tables, and one hopper in each of the two remaining slots). ## Recipes Due to the nature of 3D recipes, any orientation of ItemStacks that can be transformed rigidly* to match a recipe is a valid input. *Rotations, reflections, and translations are all accepted as long as the recipe remains within the bounds of the Amalgamation Table. Volucraft comes with one builtin datapack with four recipes: 1. Enchanted Golden Apple - 26 Gold Blocks surround 1 Apple in the center. 2. Trident - One Prismarine Shard is placed in the center, then another shard is placed in one of the corners. A bone is placed in the opposite corner of the shard, then the other two bones are placed in adjacent corners. 3. Crying Obsidian (x4) - 4 Obsidian are placed the bottom, then alternating Ghast Tears and Dragon's Breath are placed in the 4 tiles immediately above it, and then 4 more Obsidian are placed above those. 4. Diamond - 27 Coal Blocks ### Creating Your Own Recipe Volucraft recipes are data-driven, like regular crafting recipes! They go in the regular data/\<modid\>/recipe folder, but with a different type and pattern. The key and result fields remain identical to regular crafting recipes. See the example (trident recipe) below: ```json { "type": "volucraft:amalgamation", "key": { "/": "minecraft:prismarine_shard", "V": "minecraft:bone" }, "pattern": , , ], "result": { "id": "minecraft:trident" } } ``` Note how the pattern consists of 3 regular 2D patterns stacked on top of each other. As of 0.2.0, Shapeless Recipes (type `volucraft:amalgamation_shapeless`) are also supported. They have the same format as `crafting_shapeless` recipes, but support up to 27 ingredients instead of the usual 9. ### Viewing Recipes As of 0.0.3, Volucraft supports recipe viewing via Reliable Recipe Viewer integration! ### 2D Crafting Recipes As of 0.2.0, the Amalgamation Table now accepts regular crafting recipes. 2D Shaped and Shapeless recipes are automatically added as Shaped and Shapeless Amalgamation recipes, respectively. Other recipes, such as firework recipes, are accounted for in vanilla, but not for other mods (see (#for-mod-developers)). Note that the id of the extruded recipe is the original recipe's id appended with `.volucraft_autoextruded`. Extruded recipes are automatically granted and revoked along with their 2D counterparts. ## Configuration Volucraft can be configured on the client to match your preferences. <details> <summary>Before 0.1.0</summary> It comes with two builtin resource packs and an optional config powered by YACL. The two resource packs modify the translucency of the slots. 1. All Translucent Slots - makes all slots render translucent by default, instead of only turning translucent when containing items 2. More Translucent Slots - slots that contain items will become even less opaque than usual The YACL config controls the color of the background of the portion of the Amalgamation Table screen that contains the cube. </details> It comes with an optional config powered by YACL (you will need to install YACL to access the config). The YACL config controls slot translucency and the background color of the portion of the Amalgamation Table screen that contains the slots. ## For Mod Developers Want to contribute? Open a PR! To add this project as a dependency, use Modrinth's maven. You'll need to add (https://modrinth.com/mod/registrar) also. Otherwise, I would assume you want to add some sort of support for your recipes. See above to make 3D recipes; otherwise, (as of 0.2.1) see `survivalblock.volucraft.common.recipe.extrude.ExtrusionFormula` to register an `Extruder` that converts your 2D recipes to 3D. ## Background This mod was originally made with the intention of bringing it to Modfest 26.<br> However, after a lack of time and a few bad decisions, Modfest 26's deadline arrived and I didn't have anything to submit.<br> However, Mod Garden: DIY was starting up, and seeing as I had an amazing mod concept lying around and barely any code to show for it, I decided to write as much of the rest of the mod (I didn't have a lot) as I could.<br> Thanks to this, I get to have the first mod (to my knowledge) that can display both ModFest and Mod Garden badges (technically) without lying! How cool is that? <a href="https://modfest.net/26"><img alt="Made for Modfest 26" src="https://raw.githubusercontent.com/ModFest/art/f81e