unifieddyes - structure and documetnation english add

mods/unifieddyes/unifieddyes-en.md

@@ -0,0 +1,86 @@
+Minetest mod unified dyes (english)
+==================================
+
+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 and a library for 
+general color handling.
+
+Unified Dyes expands the standard dye set from 15 colors to 32, 197, or 256 (see below).
+
+#### Dependencies:
+* any minetest game (0.4.17 or 5.2.0)
+* mods
+    * default
+    * dye
+    * basic_materials (0.4.17 or 5.2.0)
+    * intllib (optional)
+
+#### Enhances
+
+* flowers mod.
+* bobblocks
+* blox
+* castles++
+* coloredwood
+* cotton
+* flags
+* homedecor
+* ilights
+* metals
+* painting
+* plasticbox
+* stained glass
+* unifiedbricks
+
+#### License: 
+
+* GPL 2.0 or higher.
+
+## The Palettes:
+
+In these images, the "-50%" markings on the left next to some shades mean 50% saturation 
+for all hues in that shade line. Note that the shades above "full" don't have (or need) 
+this variation, since they're already lower-saturation by having been generated by brightening 
+the full colors. For the greys, the percentages shown are of brightness relative to pure white. 
+In these palettes, there are a few special cases: pink is aliased to light red, 
+brown is aliased to medium orange, and the recipe for dark orange differs 
+from the standard formula. I got the names for the more esoteric colors from 
+this site: http://www.procato.com/rgb+index/
+
+![unifieddyes-extended-palette.png](unifieddyes-extended-palette.png)
+
+This is the official "extended" palette, showing 240 colors, arranged as 24 hues 
+with 10 brightness/saturation combinations for each, plus 16 greys. For an example 
+of how this palette is used, see Stained Glass mod. If you happen to examine the palette file, 
+you'll notice several bright green pixels in one corner, so-colored to remind me (or you) 
+that these are unused pixels that will be discarded by the engine. If you notice 
+a warning about this palette not having exactly 256 pixels, ignore it.
+
+![unifieddyes_palette_split.png](unifieddyes_palette_split.png)
+
+This is the 197-color palette, which is actually supplied as a set of "cut up" palette images: 
+each of the 24 hues above has its own file, with each file containing 8 shades of that hue, 
+plus one more containing the 5 levels of greyscale. These palettes are used when you need 
+the "colorfacedir" mode, especially when you need to define a whole bunch of alternate shapes 
+from your base node. You define a single base node, as usual, then 25 copies of each 
+of your alternate shapes, one suitably-named copy per hue (there's a helper function for this, 
+by the way). Take a look at my Colored Wood mod for examples of how this is done 
+(you can also see examples of the "extended" palette in that mod).
+
+![unifieddyes-colorwallmounted.png](unifieddyes-colorwallmounted.png)
+
+This is the "colorwallmounted" palette, which contains an abridged version of the above palette, 
+since the engine only allows 32 color slots with that mode. This palette 
+contains eight of the standard hues, three shades each (full, medium, dark), 
+plus the standard 5-shades of greyscale, along with light blue, light green, and pink. 
+Take a look at my Industrial Lights mod for an example of how this palette is used.
+
+## About venenux version
+
+VenenuX minenux project has a unifieddyes mod backported for minetest 0.4 and 5.2, 
+it backported almost all the fixeds and some improvements to work stable in those versions.
+
+https://codeberg.org/minenux/minetest-mod-unifieddyes
+
+