unifieddyes/README.md

1.1 KiB

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 on the Minetest forum.

API: the full API is documented here: https://github.com/mt-mods/unifieddyes/blob/master/API.md