From d60a0b324771aaf635a07e73d0fdbd2cd36455ab Mon Sep 17 00:00:00 2001 From: Dragon-Seeker Date: Thu, 23 May 2024 15:32:28 -0500 Subject: [PATCH 1/2] Fix various links, formatting, spelling, and grammatical mistakes --- docs/alloy-forgery/adding-recipes-and-fuels.md | 13 +++++++------ docs/alloy-forgery/building-a-forge.md | 14 +++++++------- docs/alloy-forgery/defining-a-forge.md | 12 +++++++----- docs/alloy-forgery/home.md | 4 ++-- docs/alloy-forgery/recipe-adaptation.md | 16 ++++++++-------- 5 files changed, 31 insertions(+), 28 deletions(-) diff --git a/docs/alloy-forgery/adding-recipes-and-fuels.md b/docs/alloy-forgery/adding-recipes-and-fuels.md index 51911b1..173d41c 100644 --- a/docs/alloy-forgery/adding-recipes-and-fuels.md +++ b/docs/alloy-forgery/adding-recipes-and-fuels.md @@ -36,7 +36,7 @@ Here is an example of a recipe: ``` ### Input Format -Inputs follow the Minecraft ingredient format (used by most other recipes) with such being the identifier of a given item tag (`"tag": ...`) or entry (`"item": ...`) and an additional `count` field used to give info about how much of such is required. +The inputs follow the Minecraft ingredient format (used by most other recipes) with such being the identifier of a given item tag (`"tag": ...`) or entry (`"item": ...`) and an additional `count` field used to give info about how much of such is required. A single recipe can accept, at max, **10** different ingredient entries. Furthermore, we also support any of Fabric's custom Ingredients like its Custom NBT-based Ingredient. @@ -44,17 +44,18 @@ A single recipe can accept, at max, **10** different ingredient entries. Further There currently exist two methods of returning an item as an output: -- **Item** - Using the `item` field as the items identifier combined with a `count` for control on the stack size of such returned item. Such is shown above as the first example. +#### **Item** + Using the `item` field as the item's identifier combined with a `count` for control on the stack size of such returned item. Such is shown above as the first example. + +#### **Tagged** + **Supported as of version 2.0.16+** -- **Tagged** (Supported as of version 2.0.16+) Using the `default` field supplied with the desired target tag will allow for whichever entries within such to be used as an output though due to tags random ordering, it's best to supply a `priority` array of outputs to chose from that are known to work out the gate if found. ??? note "Tag Output Selection" The `priority` array will be sequentially checked to see if the specified entry exists and if none are found, will default to using the tag to try and find any entry to use as an output. -Tagged Output Example: -```JSON +```JSON title="lead_ingots_from_raw_ore.json" { "fabric:load_conditions": [ { diff --git a/docs/alloy-forgery/building-a-forge.md b/docs/alloy-forgery/building-a-forge.md index 7fb3353..9a5c133 100644 --- a/docs/alloy-forgery/building-a-forge.md +++ b/docs/alloy-forgery/building-a-forge.md @@ -5,14 +5,12 @@ project: alloy-forgery *Up to date as of 2.0.22* -You can currently make an Alloy Forge out of 5 materials: Bricks, Stone Bricks, Blackstone, Deepslate, and End Stone. -Alloy Forges are dynamically generated. You can add more of these through data, which is explained [on this page.](./defining-a-forge.md) +You can currently make an Alloy Forge out of 5 materials: Bricks, Stone Bricks, Blackstone, Deepslate, and End Stone. Alloy Forges are dynamically generated. You can add more of these through data, which is explained [on this page.](../defining-a-forge.md) The basic shape of a forge looks like this: ![an image showing how to construct an Alloy Forge in 3 steps. Layer one is a 3x3 base. Layer two is the forge controller block in the front, and one block on each side, leaving the corners and the middle empty. Step three is the same as step two, but with a block instead of a controller](../assets/alloy-forgery/forge_structure.png) It has a 3x3 bottom, and is shaped like a chimney. You can put more blocks around it, even covering the top. -_The glass is there to show the basic shape, it is not part of any default forges._ ## Forge Controller @@ -41,14 +39,16 @@ A forge can by default be fueled by vanilla materials. Currently they accept the - Blaze Rods - Lava Bucket -For more information on how to add recipes and fuels, [go to this page.](./recipes.md) +For more information on how to add recipes and fuels, [go to this page.](../adding-recipes-and-fuels.md) ## Automation As of Alloy Forgery 2.0.0 automation has been improved. You can now finally use hoppers to automate alloy forging. ![](../assets/alloy-forgery/forge_hoppers_example.png) -**NOTE** *- You can also use a Hopper Minecart instead of a regular hopper. Modded transfer methods might not be supported.* + +??? note "Faster Transfer Method" + You can also use a Hopper Minecart instead of a regular hopper. Modded transfer methods might not be supported. --- -As of Alloy Forgery 2.0.8 hoppers will automatically stop inserting items when it is forging. In larger contraptions, or older versions of the mod, you might want to use redstone in order to automate them more effectively. -![An image showing a comparator outputting a signal from a Forge Controller block into a redstone lamp.](../assets/alloy-forgery/forge_comparator_example.png) +As of Alloy Forgery 2.0.8 hoppers will automatically stop inserting items when it is forging. In larger contraptions, or older versions of the mod, you might want to use Redstone in order to automate them more effectively. +![An image showing a comparator outputting a signal from a Forge Controller block into a Redstone lamp.](../assets/alloy-forgery/forge_comparator_example.png) For this you can use a comparator on the Forge Controller. It even supports putting the comparator ***inside*** the Forge. \ No newline at end of file diff --git a/docs/alloy-forgery/defining-a-forge.md b/docs/alloy-forgery/defining-a-forge.md index 34e94ba..19c6331 100644 --- a/docs/alloy-forgery/defining-a-forge.md +++ b/docs/alloy-forgery/defining-a-forge.md @@ -26,8 +26,10 @@ An example is provided below: } ``` -- `material` - Defines the block used for crafting the Forge Controller and the block the Forge is built from. -- `additional_materials` - Defines extra materials the Forge structure can be built from. -- `tier` - The tier of the Forge. Determines what recipes it can process. -- `fuel_capacity` - How much fuel the Forge can hold before needing to be refueled. -- `speed_multiplier` - A multiplier which decides how fast the Forge processes a recipe. Does not impact fuel consumption. +| Field

| Description | +|--|--| +| `material` | Defines the block used for crafting the Forge Controller and the block the Forge is built from. | +| `additional_materials` | Defines extra materials the Forge structure can be built from. | +| `tier` | The tier of the Forge. Determines what recipes it can process. | +| `fuel_capacity` | How much fuel the Forge can hold before needing to be refueled. | +| `speed_multiplier` | A multiplier which decides how fast the Forge processes a recipe. Does not impact fuel consumption. | diff --git a/docs/alloy-forgery/home.md b/docs/alloy-forgery/home.md index 51de387..5f21fdc 100644 --- a/docs/alloy-forgery/home.md +++ b/docs/alloy-forgery/home.md @@ -7,7 +7,7 @@ project: alloy-forgery Alloy Forgery is a mod all about forging metals. -If you are a player looking for info on how to make an Alloy Forge, see the ["Building a Forge"](./building-a-forge) section. We recommend a mod like Roughly Enough Items or EMI to view alloy recipes. +If you are a player looking for info on how to make an Alloy Forge, see the ["Building a Forge"](../building-a-forge) section. We recommend a mod like Roughly Enough Items or EMI to view alloy recipes. -By default Alloy Forgery provides no new materials, but it does provide recipes for smelting ores into extra ingots. It also supports a handful of mods out of the box, [which you can see here.](https://github.com/wisp-forest/alloy-forgery/tree/1.20/src/main/resources/data/alloy_forgery/recipes/compat) +By default, Alloy Forgery provides no new materials, but it does provide recipes for smelting ores into extra ingots. It also supports a handful of mods out of the box, [which you can see here.](https://github.com/wisp-forest/alloy-forgery/tree/1.20/src/main/resources/data/alloy_forgery/recipes/compat) diff --git a/docs/alloy-forgery/recipe-adaptation.md b/docs/alloy-forgery/recipe-adaptation.md index f715f18..681be41 100644 --- a/docs/alloy-forgery/recipe-adaptation.md +++ b/docs/alloy-forgery/recipe-adaptation.md @@ -3,9 +3,9 @@ title: Recipe Adaptation project: alloy-forgery --- -Since 2.1.0, Alloy Forgery comes with a System to adapt existing eecipes to alloy forging recipes with the only current implementation of the system being used to adapt existing Blast Furnace recipes to work within the forge. +Since 2.1.0, Alloy Forgery added a system to adapt existing recipes to alloy forging recipes. Currently, the only adapted recipe type for which the system is being using for it's for Blast Furnace recipes to work within the forge. -Developed alongside this adaptation system is the ability to create tags for Recipes with such following the same format as any other tag just being the tags should be placed within the `{your_namespace_here}/tags/recipes/` folder within your datapack +Developed alongside this adaptation system is the ability to create tags for Recipes with such following the same format as any other tag just being the tags should be placed within the `{your_namespace_here}/tags/recipes/` folder within your datapack. ## Blast Furnace Adaptation @@ -21,9 +21,9 @@ You can also specifically blacklist a blasting recipe from gaining the increased More recent versions of Alloy Forgery include a config file which contains some more options on controlling blasting adaption, such outlined below: -| Option | Description | -|--------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `allowHigherTierOutput` | Allows for the ability to toggle on or off the tier increase on **ALL** Blasting Recipes. | -| `allowBlastingFurnaceAdaption` | Allows for the ability to toggle on or off the blasting adaption for **ALL** Blasting Recipes. | -| `baseInputAmount` | Adjusts the required input amount for the adapted Blasting Recipe. Such functions as a multiplier for both the input and output meaning that with the default value of '2', the required amount needed to craft is '2' with an output of '2'. | -| `higherTierOutputIncrease` | Controls the amount of increased output that is gotten when using a tier 3 Alloy Forge if such tier output was not disabled. | \ No newline at end of file +| Option

| Description | +|--|--| +| `allowHigherTierOutput`| Allows for the ability to toggle on or off the tier increase on **ALL** Blasting Recipes. | +| `allowBlastingFurnaceAdaption`| Allows for the ability to toggle on or off the blasting adaption for **ALL** Blasting Recipes. | +| `baseInputAmount` | Adjusts the required input amount for the adapted Blasting Recipe. Such functions as a multiplier for both the input and output meaning that with the default value of '2', the required amount needed to craft is '2' with an output of '2'. | +| `higherTierOutputIncrease` | Controls the amount of increased output that is gotten when using a tier 3 Alloy Forge if such tier output was not disabled. | \ No newline at end of file From b1d34770ea05dab9e6e472bc8e170ab9ffc1ea45 Mon Sep 17 00:00:00 2001 From: Dragon-Seeker Date: Fri, 24 May 2024 13:07:18 -0500 Subject: [PATCH 2/2] Adjust recipe adaption text and other formatting changes - Add info about datapack tutorial within the af home page --- .../alloy-forgery/adding-recipes-and-fuels.md | 24 +++++++++---------- docs/alloy-forgery/home.md | 2 ++ docs/alloy-forgery/recipe-adaptation.md | 2 +- 3 files changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/alloy-forgery/adding-recipes-and-fuels.md b/docs/alloy-forgery/adding-recipes-and-fuels.md index 173d41c..df39baa 100644 --- a/docs/alloy-forgery/adding-recipes-and-fuels.md +++ b/docs/alloy-forgery/adding-recipes-and-fuels.md @@ -3,7 +3,7 @@ title: Adding Recipes and Fuels project: alloy-forgery --- -## Creating a recipe +# Creating a recipe When creating an Alloy Forge recipe you want to use the `alloy_forgery:forging` type. The recipe can be placed anywhere under `data//recipes` in your data. Here is an example of a recipe: @@ -35,20 +35,20 @@ Here is an example of a recipe: } ``` -### Input Format +## Input Format The inputs follow the Minecraft ingredient format (used by most other recipes) with such being the identifier of a given item tag (`"tag": ...`) or entry (`"item": ...`) and an additional `count` field used to give info about how much of such is required. A single recipe can accept, at max, **10** different ingredient entries. Furthermore, we also support any of Fabric's custom Ingredients like its Custom NBT-based Ingredient. -### Output Format +## Output Format There currently exist two methods of returning an item as an output: -#### **Item** +### Item Using the `item` field as the item's identifier combined with a `count` for control on the stack size of such returned item. Such is shown above as the first example. -#### **Tagged** - **Supported as of version 2.0.16+** +### Tagged + ***Supported as of version 2.0.16+*** Using the `default` field supplied with the desired target tag will allow for whichever entries within such to be used as an output though due to tags random ordering, it's best to supply a `priority` array of outputs to chose from that are known to work out the gate if found. @@ -92,7 +92,7 @@ There currently exist two methods of returning an item as an output: } ``` -#### Overrides +### Overrides Overrides allow changing the output item depending on the tier of the Forge. Accepted formatting: | Examples | Description | @@ -101,14 +101,14 @@ Overrides allow changing the output item depending on the tier of the Forge. Acc | `"3+"` | The override applies to tier 3, and anything above it. | | `"2 to 5"` | The override only applies to the specified range of tiers, in this case from tier 2 to tier 5. | -#### Minimum Forge Tier +### Minimum Forge Tier `min_forge_tier` field indicates the minimum tier required to use this recipe. -#### Fuel Per Tick +### Fuel Per Tick `fuel_per_tick` field indicates the amount of fuel consumed by the Forge per tick. One bucket of lava is 24000 fuel. -### Recipe Remainders -**Supported as of version 2.0.17+, requires owo-lib 0.8.0+** +## Recipe Remainders +***Supported as of version 2.0.17+, requires owo-lib 0.8.0+*** Due to Vanilla's very generic recipe remainders, you can use owo's [Recipe Specific Remainders](../owo/recipe-remainders.md) instead, allowing for fully customizable recipe remainders, or use the built-in global remainder system loaded through the `data//forge_remainder` folder. @@ -139,7 +139,7 @@ The initial Item ID here is the input to be replaced. Supported settings: In the lower example, the initial item (copper ore) is what is being checked for, and the second item (sand) is returned once the recipe completes. -## Adding new fuels +# Adding new fuels Alloy Forgery loads fuel from a specific folder in data. The path is `data//alloy_forge_fuels`, and in here you put your fuel definition. A fuel file does not require a specific name, and can hold multiple different fuels. Currently, we only support items for fuels, tags are not accepted. An example is provided below: ```JSON diff --git a/docs/alloy-forgery/home.md b/docs/alloy-forgery/home.md index 5f21fdc..af2d9c2 100644 --- a/docs/alloy-forgery/home.md +++ b/docs/alloy-forgery/home.md @@ -11,3 +11,5 @@ If you are a player looking for info on how to make an Alloy Forge, see the ["Bu By default, Alloy Forgery provides no new materials, but it does provide recipes for smelting ores into extra ingots. It also supports a handful of mods out of the box, [which you can see here.](https://github.com/wisp-forest/alloy-forgery/tree/1.20/src/main/resources/data/alloy_forgery/recipes/compat) +Furthermore, if you need any assistance on finding out how to create a Datapack in general, you can see [Datapack Tutorial](../datapack-tutorial.md) for help with such. + diff --git a/docs/alloy-forgery/recipe-adaptation.md b/docs/alloy-forgery/recipe-adaptation.md index 681be41..868098f 100644 --- a/docs/alloy-forgery/recipe-adaptation.md +++ b/docs/alloy-forgery/recipe-adaptation.md @@ -3,7 +3,7 @@ title: Recipe Adaptation project: alloy-forgery --- -Since 2.1.0, Alloy Forgery added a system to adapt existing recipes to alloy forging recipes. Currently, the only adapted recipe type for which the system is being using for it's for Blast Furnace recipes to work within the forge. +Since 2.1.0, Alloy Forgery added a system to adapt existing recipes to alloy forging recipes. Currently, only Blast Furnace recipes are adapted to work with the forge. Developed alongside this adaptation system is the ability to create tags for Recipes with such following the same format as any other tag just being the tags should be placed within the `{your_namespace_here}/tags/recipes/` folder within your datapack.