Skip to content

Cleanup 1.21 and 1.20 docs #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BlakeBr0 merged 1 commit into from
Dec 30, 2024
Merged

Cleanup 1.21 and 1.20 docs #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions apps/web/content/docs/1.20/cucumber/tags-config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ category: Cucumber

## What It's For

The `cucumber-tags.json` file added in Cucumber Library version 3.0.3 is used to configure the output item of recipes that use a tag as an output. This system was added to allow for recipes that don't depend on a specific mod being present, as well as to allow pack devs to ensure these recipes give the correct item output.

This system is currently used by Mystical Agriculture versions 3.0.1 and newer.
The `cucumber-tags.json` file is used to configure the output item of recipes that use a tag as an output. This system was added to allow for recipes that don't depend on a specific mod being present, as well as to allow pack devs to ensure these recipes give the correct item output.

## How To Use It

Expand Down
2 changes: 0 additions & 2 deletions apps/web/content/docs/1.20/extendedcrafting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ hidden: true

Welcome to the Extended Crafting documentation. Here you will find information useful to you if you plan on using and configuring Extended Crafting in your modpack.

These docs are for versions 2.0.0 or later. If you are using an older version, head [here](https://github.com/BlakeBr0/ExtendedCrafting/wiki) for the old docs.

If you are looking for gameplay documentation, you should check out both the [wiki](../../wiki/extendedcrafting) and the in-game guide. Extended Crafting comes with a [Patchouli](https://www.curseforge.com/minecraft/mc-mods/patchouli) guide book right out of the box.

::docs-section-list{mod="extendedcrafting"}
Expand Down
6 changes: 3 additions & 3 deletions apps/web/content/docs/1.20/extendedcrafting/combination-recipes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Extended Crafting allows you easily add your own Combination Crafting recipes us

### The Recipe File

This section will go over the values available to use in a Combination Crafting recipe. Syntax can be inferred from the example json below.
This section will go over the values available to use in a Combination Crafting recipe. Syntax can be inferred from the example JSON below.

| Field | Required | Description |
|---------------|----------|-------------------------------------------------------------------------------------|
Expand All @@ -27,7 +27,7 @@ This section will go over the values available to use in a Combination Crafting
| `result` | ✓ | The item that this recipe will output once finished. |

::callout{title="Note" icon="i-heroicons-information-circle-solid"}
The amount of time (in ticks) a combination recipe takes to complete is powerCost / powerRate.
The amount of time (in ticks) a Combination recipe takes to complete is powerCost / powerRate.
::

### Example File
Expand Down Expand Up @@ -76,7 +76,7 @@ The amount of time (in ticks) a combination recipe takes to complete is powerCos
Extended Crafting comes with CraftTweaker support built-in. You can make use of CraftTweaker to easily manage Combination Crafting recipes.

::callout{title="Recipe Manager Support" icon="i-heroicons-information-circle-solid"}
As of version **6.0.3**, CraftTweaker integration now supports <a href="https://docs.blamejared.com/1.20.1/en/tutorial/Recipes/RecipeManagers" target="_blank">Recipe Managers</a>! Access all applicable methods using **\<recipetype:extendedcrafting:combination\>**!
CraftTweaker integration now supports <a href="https://docs.blamejared.com/1.20.1/en/tutorial/Recipes/RecipeManagers" target="_blank">Recipe Managers</a>! Access all applicable methods using **\<recipetype:extendedcrafting:combination\>**!
::

### Adding A Recipe
Expand Down
14 changes: 9 additions & 5 deletions apps/web/content/docs/1.20/extendedcrafting/compression-recipes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Compression Recipes
category: Extended Crafting
---

Mystical Agriculture allows you easily add your own Compressor recipes using both Datapacks and CraftTweaker.
Extended Crafting allows you easily add your own Compressor recipes using both Datapacks and CraftTweaker.

## Datapacks

Expand All @@ -15,7 +15,7 @@ Mystical Agriculture allows you easily add your own Compressor recipes using bot

### The Recipe File

This section will go over the values available to use in a Compressor recipe. Syntax can be inferred from the example json below.
This section will go over the values available to use in a Compressor recipe. Syntax can be inferred from the example JSON below.

| Field | Required | Description |
|--------------|----------|-------------------------------------------------------------------------------------|
Expand All @@ -27,6 +27,10 @@ This section will go over the values available to use in a Compressor recipe. Sy
| `catalyst` | ✓ | The catalyst item. This item does not get consumed. |
| `result` | ✓ | The item that this recipe will output once finished. |

::callout{title="Note" icon="i-heroicons-information-circle-solid"}
The amount of time (in ticks) a Compression recipe takes to complete is powerCost / powerRate.
::

### Example File

```json
Expand All @@ -51,10 +55,10 @@ This section will go over the values available to use in a Compressor recipe. Sy
Extended Crafting comes with CraftTweaker support built-in. You can make use of CraftTweaker to easily manage Compression Crafting recipes.

::callout{title="Recipe Manager Support" icon="i-heroicons-information-circle-solid"}
As of version **6.0.3**, CraftTweaker integration now supports <a href="https://docs.blamejared.com/1.20.1/en/tutorial/Recipes/RecipeManagers" target="_blank">Recipe Managers</a>! Access all applicable methods using **\<recipetype:extendedcrafting:compressor\>**!
CraftTweaker integration now supports <a href="https://docs.blamejared.com/1.20.1/en/tutorial/Recipes/RecipeManagers" target="_blank">Recipe Managers</a>! Access all applicable methods using **\<recipetype:extendedcrafting:compressor\>**!
::

### Adding a Recipe
### Adding A Recipe

```java
mods.extendedcrafting.CompressionCrafting.addRecipe(name, <input>, <output>, inputCount, <catalyst>, powerCost);
Expand All @@ -73,7 +77,7 @@ mods.extendedcrafting.CompressionCrafting.addRecipe(name, <input>, <output>, inp
| `powerRate` | | The rate the recipe should consume FE during the crafting stage. If this parameter isn't added, it will use the default rate defined in the config file. |

::callout{title="Note" icon="i-heroicons-information-circle-solid"}
powerCost / powerRate = the amount of ticks required in the crafting stage.
The amount of time (in ticks) a Compression recipe takes to complete is powerCost / powerRate.
::

#### Example
Expand Down
68 changes: 38 additions & 30 deletions apps/web/content/docs/1.20/extendedcrafting/ender-crafting-recipes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,28 +15,30 @@ Extended Crafting allows you easily add your own Ender Crafting recipes using bo

### The Recipe File

This section will go over the values available to use in an Ender Crafting recipe. Syntax can be inferred from the example jsons below.
This section will go over the values available to use in an Ender Crafting recipe. Syntax can be inferred from the example JSONs below.

#### Shaped

| Field | Required | Description |
|----------------|----------|----------------------------------------------------------------------|
| `type` | ✓ | The recipe type must be `extendedcrafting:shaped_ender_crafter`. |
| `craftingTime` | | The amount of time (in seconds) this recipe should take. |
| `pattern` | ✓ | The recipe pattern. |
| `key` | ✓ | The recipe key, for specifying which item each character represents. |
| `result` | ✓ | The item that this recipe will output once finished |
| Field | Required | Description |
|----------------|----------|-----------------------------------------------------------------------------------|
| `type` | ✓ | The recipe type must be `extendedcrafting:shaped_ender_crafter`. |
| `craftingTime` | | The amount of time (in seconds) this recipe should take with a single Alternator. |
| `pattern` | ✓ | The recipe pattern. |
| `key` | ✓ | The recipe key, for specifying which item each character represents. |
| `result` | ✓ | The item that this recipe will output once finished |

#### Shapeless

| Field | Required | Description |
|----------------|----------|---------------------------------------------------------------------|
| `type` | ✓ | The recipe type must be `extendedcrafting:shapeless_ender_crafter`. |
| `craftingTime` | | The amount of time (in seconds) this recipe should take. |
| `ingredients` | ✓ | An array of 1-9 input items. |
| `result` | ✓ | The item that this recipe will output once finished. |
| Field | Required | Description |
|----------------|----------|-----------------------------------------------------------------------------------|
| `type` | ✓ | The recipe type must be `extendedcrafting:shapeless_ender_crafter`. |
| `craftingTime` | | The amount of time (in seconds) this recipe should take with a single Alternator. |
| `ingredients` | ✓ | An array of 1-9 input items. |
| `result` | ✓ | The item that this recipe will output once finished. |

**Note**: `craftingTime` refers to the amount of time in seconds that the recipe should take with a single alternator. Adding more alternators will make the crafting operation faster.
::callout{title="Note" icon="i-heroicons-information-circle-solid"}
Crafting Time will decrease depending on how many Alternators are in range. See the config settings for more information.
::

### Example Files
#### Shaped
Expand Down Expand Up @@ -84,7 +86,7 @@ This section will go over the values available to use in an Ender Crafting recip
Extended Crafting comes with CraftTweaker support built-in. You can make use of CraftTweaker to easily manage Ender Crafting recipes.

::callout{title="Recipe Manager Support" icon="i-heroicons-information-circle-solid"}
As of version **6.0.3**, CraftTweaker integration now supports <a href="https://docs.blamejared.com/1.20.1/en/tutorial/Recipes/RecipeManagers" target="_blank">Recipe Managers</a>! Access all applicable methods using **\<recipetype:extendedcrafting:ender_crafter\>**!
CraftTweaker integration now supports <a href="https://docs.blamejared.com/1.20.1/en/tutorial/Recipes/RecipeManagers" target="_blank">Recipe Managers</a>! Access all applicable methods using **\<recipetype:extendedcrafting:ender_crafter\>**!
::

### Adding A Shaped Recipe
Expand All @@ -93,14 +95,16 @@ As of version **6.0.3**, CraftTweaker integration now supports <a href="https://
mods.extendedcrafting.EnderCrafting.addShaped(name, <output>, [[<>, <>, <>], [<>, <>, <>], [<>, <>, <>]], seconds);
```

| Field | Required | Description |
|-----------|----------|----------------------------------------------------------------------------------------------------------------------------------------|
| `name` | ✓ | A unique name for this recipe. Must be all lower case and have no spaces. |
| `output` | ✓ | The output item for this recipe. |
| `<>` | ✓ | An input ingredient for the slot shown. |
| `seconds` | | The amount of seconds this recipe should take. If this parameter isn't added, it will use the default rate defined in the config file. |
| Field | Required | Description |
|-----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `name` | ✓ | A unique name for this recipe. Must be all lower case and have no spaces. |
| `output` | ✓ | The output item for this recipe. |
| `<>` | ✓ | An input ingredient for the slot shown. These input arrays work in the same way as the normal crafting recipes, check out the CraftTweaker wiki for more information. |
| `seconds` | | The amount of seconds this recipe should take with a single Alternator. If this parameter isn't added, it will use the default rate defined in the config file. |

The input arrays work in the same way as the normal crafting recipes, check out the CraftTweaker wiki for more information.
::callout{title="Note" icon="i-heroicons-information-circle-solid"}
Crafting Time will decrease depending on how many Alternators are in range. See the config settings for more information.
::

#### Example

Expand All @@ -118,12 +122,16 @@ mods.extendedcrafting.EnderCrafting.addShaped("test_shaped", <item:minecraft:sti
mods.extendedcrafting.EnderCrafting.addShapeless(name, <output>, [inputs], seconds);
```

| Field | Required | Description |
|-----------|----------|----------------------------------------------------------------------------------------------------------------------------------------|
| `name` | ✓ | A unique name for this recipe. Must be all lower case and have no spaces. |
| `output` | ✓ | The output item for this recipe. |
| `inputs` | ✓ | An array of 1-9 items required to make the recipe. |
| `seconds` | | The amount of seconds this recipe should take. If this parameter isn't added, it will use the default rate defined in the config file. |
| Field | Required | Description |
|-----------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `name` | ✓ | A unique name for this recipe. Must be all lower case and have no spaces. |
| `output` | ✓ | The output item for this recipe. |
| `inputs` | ✓ | An array of 1-9 items required to make the recipe. |
| `seconds` | | The amount of seconds this recipe should take with a single Alternator. If this parameter isn't added, it will use the default rate defined in the config file. |

::callout{title="Note" icon="i-heroicons-information-circle-solid"}
Crafting Time will decrease depending on how many Alternators are in range. See the config settings for more information.
::

#### Example

Expand All @@ -141,4 +149,4 @@ mods.extendedcrafting.EnderCrafting.remove(<output>);

| Field | Required | Description |
|----------|----------|-------------------------------------|
| `output` | ✓ | The item to all remove recipes for. |
| `output` | ✓ | The item to remove all recipes for. |
Loading
Loading