diff options
Diffstat (limited to 'unifieddyes/README.md')
| -rw-r--r-- | unifieddyes/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/unifieddyes/README.md b/unifieddyes/README.md new file mode 100644 index 0000000..44ddbb2 --- /dev/null +++ b/unifieddyes/README.md @@ -0,0 +1,16 @@ +VanessaE's Unified Dyes +======================= + +The purpose of this mod originally was to supply a complete set of colors for Minetest mod authors to use for colorized nodes, or to reference in recipes. Since the advent of the default dyes mod in minetest_game, this mod has become more of an extension of the default mod. Since the advent of param2 colorization, it has also become a library for general color handling. + +Unified Dyes expands the standard dye set from 15 colors to 32, 89, or 256 (see the API and usage info). + +Dependencies: Minetest engine version 0.4.16 or higher and a corresponding copy of minetest_game. + +License: GPL 2.0 or higher. + +Install: Unzip the distribution file, rename the resultant folder to just "unifieddyes", move it into Minetest's mods folder, and enable it in your world configuration. + +Usage: for detailed usage information, please see [the Unified Dyes Thread](https://forum.minetest.net/viewtopic.php?f=11&t=2178&p=28399) on the Minetest forum. + +API: the full API is documented here: https://github.com/minetest-mods/unifieddyes/blob/master/API.md |