bunch of documentation

df_mapitems/cave_pearls.lua

@@ -73,9 +73,11 @@ local add_to_table = function(dest, source)
 	end
 end
 
-minetest.register_node("df_mapitems:wall_pearls", {
+minetest.register_node("df_mapitems:cave_pearls", {
 	description = S("Cave Pearls"),
 	tiles = {"dfcaverns_cave_pearl.png"},
+	_doc_items_longdesc = df_mapitems.doc.cave_pearls_desc,
+	_doc_items_usagehelp = df_mapitems.doc.cave_pearls_usage,
 	drawtype = "nodebox",
 	paramtype = "light",
 	paramtype2 = "facedir",
@@ -95,7 +97,7 @@ minetest.register_node("df_mapitems:wall_pearls", {
 })
 
 local c_air = minetest.get_content_id("air")
-local c_pearls = minetest.get_content_id("df_mapitems:wall_pearls")
+local c_pearls = minetest.get_content_id("df_mapitems:cave_pearls")
 
 local valid_nodes = {} -- cache values
 local is_valid_mounting_node = function(c_node)

df_mapitems/doc.lua

@@ -41,3 +41,6 @@ df_mapitems.doc.glow_ruby_ore_usage = S("Aside from its aesthetic value this roc
 
 df_mapitems.doc.big_crystal_desc = S("Monolithic crystals of this size form only over extremely long periods deep underground, in large long-lived cavities that allow them room to grow. Water and the life it hosts tend to disrupt the formation process of these crystals so they're only found in dry environments.")
 df_mapitems.doc.big_crystal_usage = S("Aside from its aesthetic value this crystal has no particular use.")
+
+df_mapitems.doc.cave_pearls_desc = S("These nodules are actually calcified bacterial colonies.")
+df_mapitems.doc.cave_pearls_usage = S("Aside from their soft glow and beauty, cave pearls have no practical use. Except perhaps as handholds for climbing.")

df_trees/doc.lua

@@ -40,4 +40,32 @@ else
 end
 
 df_trees.doc.torchspine_desc = S("Torchspines are strange organic formations that are alive only in a technical sense. They \"feed\" on volatile flammable vapors vented up through their structure, growing from combustion residue deposited at their tips.")
-df_trees.doc.torchspine_usage = S("A torchspine alternates between active and quiescent phases and emits dim light when active. They can be harvested for torches, and their embers sprout into new torchspines when placed on flammable surfaces.")
+df_trees.doc.torchspine_usage = S("A torchspine alternates between active and quiescent phases and emits dim light when active. They can be harvested for torches, and their embers sprout into new torchspines when placed on flammable surfaces.")
+
+df_trees.doc.spindlestem_desc = S("Spindlestems are too big to easily pluck by hand but too small to be called a proper tree. Nevertheless, they are a common and useful resource for underground travelers - particularly their glowing caps.")
+df_trees.doc.spindlestem_usage = S("The stem of a Spindlestem is surprisingly sturdy, and despite their thinness they can grow quite tall. They can be used as a wood substitute in many crafting recipes.")
+
+df_trees.doc.spindlestem_cap_white_desc = S("The cap of a Spindlestem, uncontaminated by any symbiotic luminescent microorganisms.")
+df_trees.doc.spindlestem_cap_white_usage = S("These things are useless except as weak fuel for a fire.")
+
+df_trees.doc.spindlestem_cap_red_desc = S("The cap of a Spindlestem, glowing a weak red due to symbiotic microorganisms.")
+df_trees.doc.spindlestem_cap_red_usage = S("Red Spindlestems are a sign of nearby iron deposits - or perhaps Goblin Caps. Their glowing symbiotes can be extracted as a long-lived light source, though the glow is weak.")
+
+df_trees.doc.spindlestem_cap_green_desc = S("The cap of a Spindlestem, glowing a soft green due to symbiotic microorganisms.")
+df_trees.doc.spindlestem_cap_green_usage = S("Green Spindlestems are a sign of nearby copper deposits. Their glowing symbiotes can be extracted as a long-lived light source, though the glow is not strong.")
+
+df_trees.doc.spindlestem_cap_cyan_desc = S("The cap of a Spindlestem, glowing a strong cyan due to symbiotic microorganisms.")
+df_trees.doc.spindlestem_cap_cyan_usage = S("Cyan Spindlestems are a sign of both copper and iron deposits nearby. Their glowing symbiotes can be extracted as a long-lived light source.")
+
+df_trees.doc.spindlestem_cap_golden_desc = S("The cap of a Spindlestem, glowing a brilliant yellow due to symbiotic microorganisms.")
+df_trees.doc.spindlestem_cap_golden_usage = S("Golden Spindlestems are a sign of rare and magical mineral deposits nearby. Their glowing symbiotes can be extracted as a strong and long-lived light source.")
+
+
+df_trees.doc.spindlestem_extract_red_desc = S("Living extract from the cap of a red Spindlestem.")
+df_trees.doc.spindlestem_extract_red_usage = df_trees.doc.spindlestem_cap_red_usage
+df_trees.doc.spindlestem_extract_green_desc = S("Living extract from the cap of a green Spindlestem.")
+df_trees.doc.spindlestem_extract_green_usage = df_trees.doc.spindlestem_cap_green_usage
+df_trees.doc.spindlestem_extract_cyan_desc = S("Living extract from the cap of a cyan Spindlestem.")
+df_trees.doc.spindlestem_extract_cyan_usage = df_trees.doc.spindlestem_cap_cyan_usage
+df_trees.doc.spindlestem_extract_golden_desc = S("Living extract from the cap of a yellow Spindlestem.")
+df_trees.doc.spindlestem_extract_golden_usage = df_trees.doc.spindlestem_cap_golden_usage

df_trees/spindlestem.lua

@@ -62,6 +62,8 @@ local disp = 0.0625 -- adjusting position a bit
 
 minetest.register_node("df_trees:spindlestem_stem", {
 	description = S("Spindlestem"),
+	_doc_items_longdesc = df_trees.doc.spindlestem_desc,
+	_doc_items_usagehelp = df_trees.doc.spindlestem_usage,
 	is_ground_content = true,
 	groups = {wood = 1, choppy = 2, oddly_breakable_by_hand = 1, flammable = 2, spindlestem = 1},
 	sounds = default.node_sound_wood_defaults(),
@@ -92,8 +94,10 @@ local register_spindlestem_type = function(item_suffix, colour_name, colour_code
 	local cap_item = "df_trees:spindlestem_cap_"..item_suffix
 	
 	minetest.register_node(cap_item, {
-		description = S("@1 Spindlestem Cap", color_name),
+		description = S("@1 Spindlestem Cap", colour_name),
 		is_ground_content = true,
+		_doc_items_longdesc = df_trees.doc["spindlestem_cap_"..item_suffix.."_desc"],
+		_doc_items_usagehelp = df_trees.doc["spindlestem_cap_"..item_suffix.."_usage"],
 		groups = {wood = 1, choppy = 2, oddly_breakable_by_hand = 1, flammable = 2, spindlestem = 1},
 		sounds = default.node_sound_wood_defaults(),
 		tiles = {
@@ -181,6 +185,8 @@ local register_spindlestem_type = function(item_suffix, colour_name, colour_code
 		minetest.register_node("df_trees:glowing_bottle_"..item_suffix, {
 			description = S("@1 Spindlestem Extract", colour_name),
 			drawtype = "plantlike",
+			_doc_items_longdesc = df_trees.doc["spindlestem_extract_"..item_suffix.."_desc"],
+			_doc_items_usagehelp = df_trees.doc["spindlestem_extract_"..item_suffix.."_usage"],
 			tiles = {tex},
 			inventory_image = tex,
 			wield_image = tex,
@@ -226,8 +232,8 @@ end
 
 minetest.register_node("df_trees:spindlestem_seedling", {
 	description = S("Spindlestem Spawn"),
-	_doc_items_longdesc = nil,
-	_doc_items_usagehelp = nil,
+	_doc_items_longdesc = df_trees.doc.spindlestem_desc,
+	_doc_items_usagehelp = df_trees.doc.spindlestem_usage,
 	tiles = {
 		"dfcaverns_tower_cap.png",
 	},
@@ -307,7 +313,7 @@ local c_cyan = minetest.get_content_id("df_trees:spindlestem_cap_cyan")
 local c_golden = minetest.get_content_id("df_trees:spindlestem_cap_golden")
 
 get_spindlestem_cap_type = function(pos)
-	if pos.y > -100 then
+	if pos.y > -100 or minetest.find_node_near(pos, 15, "group:tower_cap") then
 		return c_white
 	end
 	if minetest.find_node_near(pos, 15, "group:goblin_cap") then

df_trees/tower_cap.lua

@@ -9,7 +9,7 @@ minetest.register_node("df_trees:tower_cap_stem", {
 	_doc_items_usagehelp = df_trees.doc.tower_cap_usage,
 	tiles = {"dfcaverns_tower_cap.png"},
 	is_ground_content = true,
-	groups = {tree = 1, choppy = 2, oddly_breakable_by_hand = 1, flammable = 2},
+	groups = {tree = 1, choppy = 2, oddly_breakable_by_hand = 1, flammable = 2, tower_cap = 1},
 	sounds = default.node_sound_wood_defaults(),
 })
 
@@ -20,7 +20,7 @@ minetest.register_node("df_trees:tower_cap", {
 	_doc_items_usagehelp = df_trees.doc.tower_cap_usage,
 	tiles = {"dfcaverns_tower_cap.png"},
 	is_ground_content = true,
-	groups = {tree = 1, choppy = 2, oddly_breakable_by_hand = 1, flammable = 2},
+	groups = {tree = 1, choppy = 2, oddly_breakable_by_hand = 1, flammable = 2, tower_cap = 1},
 	sounds = default.node_sound_wood_defaults(),
 })
 
@@ -31,7 +31,7 @@ minetest.register_node("df_trees:tower_cap_gills", {
 	_doc_items_usagehelp = df_trees.doc.tower_cap_usage,
 	tiles = {"dfcaverns_tower_cap_gills.png"},
 	is_ground_content = true,
-	groups = {snappy = 3, leafdecay = 3, flammable = 2, leaves = 1},
+	groups = {snappy = 3, leafdecay = 3, flammable = 2, leaves = 1, tower_cap = 1},
 	sounds = default.node_sound_leaves_defaults(),
 	drawtype = "plantlike",
 	paramtype = "light",
@@ -50,7 +50,7 @@ minetest.register_node("df_trees:tower_cap_gills", {
 	after_place_node = default.after_place_leaves,
 })
 
-if default.register_leafdecay then -- default.register_leafdecay is very new, remove this check some time after 0.4.16 is released
+if default.register_leafdecay then -- default.register_leafdecay is new, remove this check some time after 0.4.16 is released
 	default.register_leafdecay({
 		trunks = {"df_trees:tower_cap"}, -- don't need stem nodes here
 		leaves = {"df_trees:tower_cap_gills"},

guide.md

@@ -78,6 +78,16 @@ Fungiwoods have thinner stalks that sprout numerous thin irregular "shelves" bra
 
 Plump helmets and cave wheat grow here.
 
+## Spindlestems
+
+![Spindlestems](./df_caverns/screenshots/spindlestems.jpg)
+
+Spindlestem mushrooms are the weedy "saplings" of the upper fungal forests, too large to pick by hand but not exactly inspiring tree-like analogies. They are common, though, and not without their uses. Their long stems can serve as a wood substutitue in many crafts and their bioluminescent caps can produce a long-lived glowing extract that's useful as a source of light. They grow taller when crowded.
+
+The bioluminescence of Spindlestems are actually a very interesting feature. Despite their apparent visual diversity, Spindlestems are a single species. They pick up their glow from symbiotic microorganisms that colonize their caps, and the specific breed of symbiote that thrives in any given Spindlestem depends on the minerals present in the nearby rocks. Iron results in a weak red-glowing cap, copper results in a green-tinted cap, and the combination of both can result in a brighter cyan glow. Brilliant yellow "Golden Spindlestems" have also been spotted.
+
+For some reason, Spindlestems that grow in the presence of Tower Caps are never luminescent. Perhaps they're intimidated.
+
 # Second cavern layer
 
 By default, the second cavern layer can be found between -800 and -1400 meters elevation. Like the first layer, some caverns contain lakes filling their lower regions. The dry barren caverns at this level will have some occasional ruby crystal growths in them, but they will be detailed in an entry on the third cavern layer where they're much more common.
@@ -86,7 +96,9 @@ By default, the second cavern layer can be found between -800 and -1400 meters e
 
 ![Goblin Caps](./df_caverns/screenshots/goblin_cap.jpg)
 
-Goblin caps are the broader, squatter cousins of the Tower Cap fungus. Like Tower Caps they have no particular special properties, but their wood comes in two different colours - the reddish orange of their caps and the cream coloured stem wood. Plump helmets grow here.
+Goblin caps are the broader, squatter cousins of the Tower Cap fungus. Like Tower Caps they have no particular special properties, but their wood comes in two different colours - the reddish orange of their caps and the cream coloured stem wood. Plump helmets and Spindlestems grow here.
+
+For some reason, Spindlestems that grow in the presence of Goblin Caps are always red.
 
 ## Spore Tree caverns
 
@@ -104,6 +116,12 @@ Tunnel tubes are hollow, curved fungal growths that support a fruiting body at t
 
 Sweet pods and cave wheat can be found growing in tunnel tube caverns.
 
+## Cave pearls
+
+![Cave Pearls](./df_caverns/screenshots/cave_pearls.jpg)
+
+At these depths you may find a distinctive and beautiful formation encrusting the ceilings and walls of smaller tunnels and warrens; "cave pearls." These nodules are actually calcified bacterial colonies that can only form where they're left undisturbed for the long periods needed for them to grow this large.
+
 # Third cavern layer
 
 The third cavern layer is where things start to get really exotic. Black Caps, Nethercaps, Bloodthorn and reddish glowing crystal formations are found here. Those caverns that are partly-flooded have unusual features thanks to the strange life sharing them. By default the third cavern layer runs from -1400 to -2000 meters.
@@ -164,6 +182,8 @@ Venturing below the Sunless Sea will require either a great deal of digging thro
 
 Eventually, at around -2600 meters elevation, an explorer may encounter lakes of oil in lenticular caverns. Falling into a lake of oil is an unpleasant experience - one is completely blind when below the surface - but that's not the real danger. The atmosphere above the oil is filled with unbreathable gasses that are explosive when mixed with air and an ignition source (such as a carelessly placed torch). Even in the tunnels above the oil there are occasional gas seeps venting this gas from cracks and seams of coal. This gas is heavier than air and will pool in depressions, and of course it cannot be swum through so take care not to jump down into a place you can't easily climb back out of.
 
+A few mysterious blue flames may occasionally be found flickering on the edges of oil lakes, burning without oxygen and seeming to maintain their size as they drift about through the unbreathable atmosphere. These "gas wisps" may be a strange form of plasmoidal life but they are easily snuffed and so little is known about them.
+
 Buckets of oil serve as an excellent fuel source, powering a furnace as well as a block of coal.
 
 # Magma Sea

mine_gas/wisp.lua

@@ -1,10 +1,18 @@
 local MP = minetest.get_modpath(minetest.get_current_modname())
 local S, NS = dofile(MP.."/intllib.lua")
 
+local wisp_desc
+local wisp_usage
+
+if minetest.get_modpath("doc") then
+	wisp_desc = S("Mysterious blue flames may occasionally be found flickering on the edges of oil lakes, burning without oxygen and seeming to maintain their size as they drift about through the unbreathable atmosphere.")
+	wisp_usage = S("Gas Wisps have no known use, and fortunately they are not hostile or very dangerous.")
+end
+
 minetest.register_node("mine_gas:gas_wisp", {
 	description = S("Gas Wisp"),
-	_doc_items_longdesc = nil,
-	_doc_items_usagehelp = nil,
+	_doc_items_longdesc = wisp_desc,
+	_doc_items_usagehelp = wisp_usage,
 	walkable = false,
 	diggable = false,
 	buildable_to = true,