Add falls documentation

TODO.txt

@@ -35,5 +35,6 @@ b. Bosses in some order:
 2. Compress all textures, 3d objects, etc.
 3. Fix algae to be useful in other ways, fix bonemeal to not generate them on dirt...
 4. Go through the default encyclopedia and make changes as needed
-5. 
+5. Complete the documentation
+6. 
 

mods/falls/doc/basins.ent

@@ -0,0 +1,9 @@
+Basins
+-----------------
+Basins are meant to be used at the base of a waterfall.
+Place them beneath the water's surface, and particles
+will "bounce" up as if they hit rocks in the water.
+|
+To change the height, distance, amount, and direction
+of the particles, right-click the block to bring up 
+a formspec to edit these values.

mods/falls/doc/basins.img

@@ -0,0 +1 @@
+waterfall_basin.png

mods/falls/doc/falls.ent

@@ -0,0 +1,11 @@
+Falls
+-----------------
+This mod adds a new machine: The "whirlpool machine", which 
+you place a bucket of water in with a mese fragment,
+and pull the lever. You will receive a bucket of "turbulent water"
+|
+Turbulent water is used to build new particle based fountains, waterfall
+basins and waterfall blocks. Build a few and try building your very own 
+waterfall, the results are amazing!
+|
+Hint: try using lava too.

mods/falls/doc/falls.img

@@ -0,0 +1,3 @@
+fountain_inventory.png
+bucket_turbulent.png
+whirlpool_machine_back.png

mods/falls/doc/fountain.ent

@@ -0,0 +1,5 @@
+Fountain
+-----------------
+The fountain is a simple node one can place anywhere.
+It will merely generate a fountain of particles, and is 
+not adjustable.

mods/falls/doc/fountain.img

@@ -0,0 +1 @@
+fountain_inventory.png

mods/falls/doc/waterfall_blocks.ent

@@ -0,0 +1,9 @@
+Waterfall Blocks
+-----------------
+These blocks are meant to be used at the top of a 
+waterfall (or any water drop spot). They produce 
+particles out the side of the block and have 
+adjustable direction, distance, amount, and fall height.
+|
+Merely right click the node to bring of the formspec 
+to edit these values.

mods/falls/doc/waterfall_blocks.img

@@ -0,0 +1 @@
+waterfall_block_inv.png

mods/falls/doc/whirlpool_machine.ent

@@ -0,0 +1,11 @@
+Whirlpool Machine
+-----------------
+The whirlpool machine is the fundamental piece
+of the waterfalls mod. You place a bucket of waterfalls
+in the top slot (or lava), and then use a mese fragment
+in the bottom slot to power the machine.
+|
+Once filled, pull the lever to turn on the machine.
+|
+After the process completes, you will receive a turbulent
+water bucket, used to craft the other falls blocks.

mods/falls/doc/whirlpool_machine.img

@@ -0,0 +1,4 @@
+whirlpool_machine_front.png
+whirlpool_machine_back.png
+whirlpool_machine_top.png
+bucket_turbulent.png

mods/falls/documentation.lua

@@ -0,0 +1,12 @@
+-- falls/documentation.lua
+
+-----Load documentation via doc_helper------------------------
+local MP = minetest.get_modpath(minetest.get_current_modname())
+local docpath = MP .. DIR_DELIM .. "doc"
+doc.add_category("falls",
+{
+	name = "_falls_",
+	description = "Waterfalls Documentation",
+	build_formspec = doc.entry_builders.text_and_square_gallery,
+})
+doc.build_entries(docpath, "falls")

mods/falls/init.lua

@@ -2,7 +2,7 @@ local settings = Settings(minetest.get_modpath('falls')..'/settings.txt')
 local MP 	= minetest.get_modpath(minetest.get_current_modname())
 local S, NS = dofile(MP..'/intllib.lua')
 
-
+dofile(MP.."/documentation.lua")
 dofile(MP..'/bucket_turbulent.lua')
 if minetest.get_modpath("quartz") and minetest.get_modpath("moreores") and minetest.get_modpath("titanium") then
      dofile(MP..'/whirlpool.lua')

mods/falls/mod.conf

@@ -1,4 +1,4 @@
 name = falls
 description = A Particle-based Minetest Waterfalls/Lavafalls Mod
-depends = default
+depends = default, doc_helper
 optional_depends = unified_inventory, quartz, titanium, moreores, intllib