Use a safer implementation of gsub in core.chat_format_message (#9133)

[dragonfireclient.git] / doc / texture_packs.txt

diff --git a/doc/texture_packs.txt b/doc/texture_packs.txt
index 1813c29e42a75dcb33778f3ebbd67d126faa43ec..40fdf2eeb4e601dea486f18a2e015c90cb447a92 100644 (file)
--- a/doc/texture_packs.txt
+++ b/doc/texture_packs.txt
@@ -9,6 +9,7 @@ Texture pack directory structure
 
     textures
     |-- Texture Pack
+    |   |-- texture_pack.conf
     |   |-- screenshot.png
     |   |-- description.txt
     |   |-- override.txt
@@ -21,9 +22,17 @@ This is a directory containing the entire contents of a single texture pack.
 It can be chosen more or less freely and will also become the name of the
 texture pack. The name must not be “base”.
 
+### `texture_pack.conf`
+A key-value config file with the following keys:
+
+* `title` - human readable title
+* `description` - short description, shown in the content tab
+
 ### `description.txt`
+**Deprecated**, you should use texture_pack.conf instead.
+
 A file containing a short description of the texture pack to be shown in the
-texture packs tab.
+content tab.
 
 ### `screenshot.png`
 A preview image showing an in-game screenshot of this texture pack; it will be
@@ -159,3 +168,44 @@ Here are face selectors you can choose from:
 | bottom        | y-                                                |
 | sides         | x-, x+, z-, z+                                    |
 | all           | All faces. You can also use '*' instead of 'all'. |
+
+Designing leaves textures for the leaves rendering options
+----------------------------------------------------------
+
+Minetest has three modes for rendering leaves nodes if the node has the
+`allfaces_optional` drawtype.
+
+### Fancy
+
+Uses the texture specified in the `tiles` nodedef field.
+The texture should have some transparent pixels and be in the RGBA format so
+that the transparent pixels can have color information.
+Faces of every leaves node are rendered even if they are inside a solid volume
+of leaves; this gives a dense appearance.
+
+### Opaque
+
+Uses the texture specified in `tiles` but makes it opaque by converting each
+transparent pixel into an opaque pixel that uses the color information of that
+transparent pixel.
+Due to this the `tiles` texture format must be RGBA not 'indexed alpha' to allow
+each transparent pixel to have color information.
+
+The colors of the transparent pixels should be set for a good appearance in
+`opaque` mode. This can be done by painting the pixels the desired colors then
+erasing them. Then when saving the texture, use the 'save color information from
+transparent pixels' option (or equivalent).
+
+### Simple
+
+Uses the texture specified in the `special_tiles` nodedef field if it exists, if
+not, the `tiles` texture.
+The `special_tiles` texture should have fewer transparent pixels than the
+`tiles` texture and be in the 'indexed alpha' format.
+
+This mode is between the other two in terms of appearance and rendering load.
+The nodes are rendered using the `glasslike` drawtype, only showing the surface
+faces for any solid volume of leaves, not the internal faces.
+Due to this the `tiles` texture might appear lacking in density, so optionally a
+`special_tiles` texture can be used to provide a texture with fewer transparent
+pixels for a denser appearance.