8
edits
Changes
From Forge Community Wiki
User:KnightMiner/Tag Standards (view source)
Revision as of 04:17, 8 March 2021
, 04:17, 8 March 2021no edit summary
This page details standardized tag names for compatibility among modders. The following subsections give specific information on where the tags are used.
This page details standardized tag names for compatibility among modders. The following subsections give specific information on where the tags are used.
== General ==
In general, tag names should follow a couple of conventions for consistency:
* Tag names should be plural.
* Tag names should be in US English, rather than English variants such as British English. This is for consistency with the default language.
* Tags should be stored under <code>forge</code> if they are used commonly between mods. Tags specific to a single mod should be stored under the mod ID.
=== Output Consistency ===
This section describes how to set up recipes for tagged output to allow to choose their preferred output for tagged outputs.
* If recipe involves crafting a tagged input into a tagged output, do not use tags on the input. This means that the recipe result is consistent for a given input.
* If a recipe involves crafting multiple tagged inputs into a tagged output, all inputs expect 1 should be tagged. This allows the user to select the preferred output by varying non-tagged input.
** For linear recipes, the first slot should contain the untagged input.
** For two-dimensional recipes (such as crafting tables), the centermost slot should contain the untagged input. If there is an even number of inputs, prefer the the upper-left slot of the center.
Examples:
* A recipe crafting 9 Tinkers' Construct copper nuggets should use a single Tinkers' Construct copper ingot as the input. If all mods their recipe for copper nuggets like this, the mod will be consistent between the recipe input an output.
* A recipe crafting a Tinkers' Construct copper ingot from 9 copper nuggets should use a Tinkers' Construct copper nugget in the center of the 3x3. If all mods their recipe for copper ingots like this, the mod will be consistent between the center item and the output, while nuggets on the outside can be from any mod.
== Materials ==
== Materials ==