summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVanessa Dannenberg <vanessa.e.dannenberg@gmail.com>2018-08-22 20:36:25 -0400
committerVanessa Dannenberg <vanessa.e.dannenberg@gmail.com>2018-08-22 20:39:45 -0400
commitcac65df76c1b6aaf2f00a815ec6ce04f49822519 (patch)
treedf4d6c386dc18f17e914894899bb4d47d54f4b32
parentd3274ab66f01a8f5c46ed17c9edd281559f35154 (diff)
downloadunifieddyes-cac65df76c1b6aaf2f00a815ec6ce04f49822519.tar
unifieddyes-cac65df76c1b6aaf2f00a815ec6ce04f49822519.tar.gz
unifieddyes-cac65df76c1b6aaf2f00a815ec6ce04f49822519.tar.bz2
unifieddyes-cac65df76c1b6aaf2f00a815ec6ce04f49822519.tar.xz
unifieddyes-cac65df76c1b6aaf2f00a815ec6ce04f49822519.zip
clarify API regarding neutral_node field
-rw-r--r--API.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/API.md b/API.md
index eff27ed..e19729f 100644
--- a/API.md
+++ b/API.md
@@ -124,9 +124,9 @@ If your mod used the old paradigm where you craft a neutral-colored item, place
`type` can be "shapeless" or unspecified/`nil`, and works the same as in the normal call.
-`neutral_node` should specify the name of whatever item or node serves as the base, neutrally-colored material in your recipe. If there isn't one, set this to an empty string.
+`neutral_node` should specify the name of whatever item or node serves as the base, neutrally-colored material in your recipe. This really only applies if your node is just made from one item (or more than one of the same item), plus one or more dyes. If your node is just made from a collection of item and no one item is really the neutral material, or anyway if you don't need this substitution, you must set it to an empty string.
-`recipe` is the same as in the normal call, except that Unified Dyes will replace all instances of the string "NEUTRAL_NODE" with the item specified in the preceding `neutral_node` field. Every instance of "MAIN_DYE" will be replaced with a portion of dye, as Unified Dyes' recipe helper works through its color lists (i.e. this key will become whatever dye is needed for each recipe).
+`recipe` is the same as in the normal call, except that Unified Dyes will replace all instances of the string "NEUTRAL_NODE" with the item specified in the preceding `neutral_node` field. Every instance of "MAIN_DYE" will be replaced with a portion of dye, as Unified Dyes' recipe helper works through its color lists (i.e. this field will become whatever dye is needed for each recipe).
If your mod never has never used Unified Dyes at all, in short, do the following: