make sure a listed block is indeed loaded before writing to it

(in case the mapgen takes long enough on a server that players
have wandered off and the server has unloaded blocks)

for each block queued, make sure it and all 6 of its neighbors are
actually loaded before populating, else move the block to the end of the
queue.

API.txt

@@ -588,3 +588,43 @@ And this particular one is mapped slightly differently from the others:
 
 (Note the +150 and +50 offsets)
 
+
+==================
+Default game nodes
+==================
+
+Although this project was intended to be used with minetest_game, it can be
+configured to work with something else instead.  All you need to do is provide
+the names of the nodes in your game you want biome_lib's internals to use.
+
+Put these settings in your game's minetest.conf (or your client's own config,
+if desired).  You'll need to set all of them.
+
+biome_lib_default_grow_through_nodes
+	Comma-separated list of things that a spawned node is allowed to grow
+	through.  Air is always added to whatever you specify.
+	Default:  air, default:snow
+
+biome_lib_default_water_nodes
+	Comma-separated list of nodes that should be treated as water for the sake
+	of looking for neighboring "wet" ground.
+	Default: default:water_source, default:water_flowing,
+		default:river_water_source, default:river_water_flowing
+
+biome_lib_default_wet_surfaces
+	Comma-separated list of nodes that should be considered "wet" if one of
+	the aforementioned water nodes is nearby.
+	Default: default:dirt, default:dirt_with_grass, default:sand
+
+biome_lib_default_grow_nodes
+	Comma-separated list of nodes that something must be sitting on to be
+	able to actively change from one thing to another (such as a sapling
+	growing into a tree), to be used for ALL growable nodes, if the calling
+	mod doesn't provide its own lists.
+	Default: "default:dirt_with_grass"
+
+biome_lib_default_ground_nodes
+	Comma-separated list of nodes to use as the "root" of something that can
+	gradually climb up a wall, to be used for ALL such nodes, if the calling
+	mod doesn't provide its own lists.
+	Default: "default:dirt_with_grass"

README.md

@@ -12,7 +12,7 @@ Both mapgen-based spawning and ABM-based spawning is supported. Growing code is
 
 It is primarily intended for mapgen v6, but it should work fine when used with mapgen v7.
 
-**Dependencies**: default from minetest_game
+**Dependencies:** nothing, but if you don't use `minetest_game`, you'll need to supply some settings (see API.txt).
 
 **Recommends**: [Plantlife Modpack](https://github.com/minetest-mods/plantlife_modpack), 
 [More Trees](https://github.com/minetest-mods/moretrees)

depends.txt

@@ -1,3 +0,0 @@
-default
-intllib?
-

growth.lua

@@ -20,8 +20,8 @@ function biome_lib:grow_plants(opts)
 	local options = opts
 
 	options.height_limit = options.height_limit or 5
-	options.ground_nodes = options.ground_nodes or { "default:dirt_with_grass" }
-	options.grow_nodes = options.grow_nodes or { "default:dirt_with_grass" }
+	options.ground_nodes = options.ground_nodes or biome_lib.default_ground_nodes
+	options.grow_nodes = options.grow_nodes or biome_lib.default_grow_nodes
 	options.seed_diff = options.seed_diff or 0
 
 	local n
@@ -55,7 +55,7 @@ function biome_lib:grow_plants(opts)
 			if options.need_wall and options.verticals_list then
 				walldir = biome_lib:find_adjacent_wall(p_top, options.verticals_list, options.choose_random_wall)
 			end
-			if (n_top.name == "air" or n_top.name == "default:snow")
+			if biome_lib.default_grow_through_nodes[n_top.name]
 			  and (not options.need_wall or (options.need_wall and walldir)) then
 				if options.grow_vertically and walldir then
 					if biome_lib:search_downward(pos, options.height_limit, options.ground_nodes) then

init.lua

@@ -1,4 +1,4 @@
--- Biome library mod by Vanessa Ezekowitz
+-- Biome library mod by VanessaE
 --
 -- I got the temperature map idea from "hmmmm", values used for it came from
 -- Splizard's snow mod.
@@ -9,8 +9,6 @@
 biome_lib = {}
 biome_lib.air = {name = "air"}
 
-plantslib = setmetatable({}, { __index=function(t,k) print("Use of deprecated function:", k) return biome_lib[k] end })
-
 biome_lib.blocklist_aircheck = {}
 biome_lib.blocklist_no_aircheck = {}
 
@@ -32,6 +30,41 @@ biome_lib.total_no_aircheck_calls = 0
 
 biome_lib.queue_run_ratio = tonumber(minetest.settings:get("biome_lib_queue_run_ratio")) or 100
 
+local function tableize(s)
+	return string.split(string.trim(string.gsub(s, " ", "")))
+end
+
+local c1 = minetest.settings:get("biome_lib_default_grow_through_nodes")
+biome_lib.default_grow_through_nodes = {["air"] = true}
+if c1 then
+	for _, i in ipairs(tableize(c1)) do
+		biome_lib.default_grow_through_nodes[i] = true
+	end
+else
+	biome_lib.default_grow_through_nodes["default:snow"] = true
+end
+
+local c2 = minetest.settings:get("biome_lib_default_water_nodes")
+biome_lib.default_water_nodes = {}
+if c2 then
+	for _, i in ipairs(tableize(c2)) do
+		biome_lib.default_water_nodes[i] = true
+	end
+else
+	biome_lib.default_water_nodes["default:water_source"] = true
+	biome_lib.default_water_nodes["default:water_flowing"] = true
+	biome_lib.default_water_nodes["default:river_water_source"] = true
+	biome_lib.default_water_nodes["default:river_water_flowing"] = true
+end
+
+local c3 = minetest.settings:get("biome_lib_default_wet_surfaces")
+local c4 = minetest.settings:get("biome_lib_default_ground_nodes")
+local c5 = minetest.settings:get("biome_lib_default_grow_nodes")
+
+biome_lib.default_wet_surfaces = c3 and tableize(c3) or {"default:dirt", "default:dirt_with_grass", "default:sand"}
+biome_lib.default_ground_nodes = c4 and tableize(c4) or {"default:dirt_with_grass"}
+biome_lib.default_grow_nodes =   c5 and tableize(c5) or {"default:dirt_with_grass"}
+
 -- Boilerplate to support localized strings if intllib mod is installed.
 local S
 if minetest.global_exists("intllib") then
@@ -45,12 +78,12 @@ else
 end
 biome_lib.intllib = S
 
-local DEBUG = false --... except if you want to spam the console with debugging info :-)
+local DEBUG = minetest.settings:get_bool("biome_lib_debug", false)
 
 function biome_lib:dbg(msg)
 	if DEBUG then
-		print("[Plantlife] "..msg)
-		minetest.log("verbose", "[Plantlife] "..msg)
+		print("[Biome Lib] "..msg)
+		minetest.log("verbose", "[Biome Lib] "..msg)
 	end
 end
 
@@ -125,7 +158,7 @@ function biome_lib:set_defaults(biome)
 	biome.near_nodes_size = biome.near_nodes_size or 0
 	biome.near_nodes_count = biome.near_nodes_count or 1
 	biome.rarity = biome.rarity or 50
-	biome.max_count = biome.max_count or 5
+	biome.max_count = biome.max_count or 125
 	if biome.check_air ~= false then biome.check_air = true end
 
 -- specific to abm spawner
@@ -296,6 +329,7 @@ local function populate_single_surface(biome, pos, perlin_fertile_area, checkair
 end
 
 function biome_lib:populate_surfaces(biome, nodes_or_function_or_model, snodes, checkair)
+	local items_added = 0
 
 	biome_lib:set_defaults(biome)
 
@@ -316,10 +350,10 @@ function biome_lib:populate_surfaces(biome, nodes_or_function_or_model, snodes,
 	local num_in_biome_nodes = #in_biome_nodes
 
 	if num_in_biome_nodes == 0 then
-		return
+		return 0
 	end
 
-	for i = 1, math.min(biome.max_count, num_in_biome_nodes) do
+	for i = 1, math.min(math.ceil(biome.max_count/25), num_in_biome_nodes) do
 		local tries = 0
 		local spawned = false
 		while tries < 2 and not spawned do
@@ -388,14 +422,28 @@ function biome_lib:populate_surfaces(biome, nodes_or_function_or_model, snodes,
 				tries = tries + 1
 			end
 		end
+		if spawned then items_added = items_added + 1 end
 	end
+	return items_added
+end
+
+-- make sure the target block and all 6 neighbors are actually loaded.
+
+local function confirm_block_surroundings(pos)
+	return minetest.get_node_or_nil(pos)
+	  and minetest.get_node_or_nil({ x=pos.x-16, y=pos.y,   z=pos.z   })
+	  and minetest.get_node_or_nil({ x=pos.x+16, y=pos.y,   z=pos.z   })
+	  and minetest.get_node_or_nil({ x=pos.x,   y=pos.y-16, z=pos.z   })
+	  and minetest.get_node_or_nil({ x=pos.x,   y=pos.y+16, z=pos.z   })
+	  and minetest.get_node_or_nil({ x=pos.x,   y=pos.y,   z=pos.z-16 })
+	  and minetest.get_node_or_nil({ x=pos.x,   y=pos.y,   z=pos.z+16 })
 end
 
 -- Primary mapgen spawner, for mods that can work with air checking enabled on
 -- a surface during the initial map read stage.
 
-function biome_lib:generate_block_with_air_checking()
-	if #biome_lib.blocklist_aircheck == 0 then
+function biome_lib:generate_block_with_air_checking(shutdown)
+	if not biome_lib.blocklist_aircheck[1] then
 		return
 	end
 
@@ -407,24 +455,33 @@ function biome_lib:generate_block_with_air_checking()
 
 	local blockhash =	minetest.hash_node_position(minp)
 
-	if not biome_lib.surface_nodes_aircheck.blockhash then
+	if not biome_lib.surface_nodes_aircheck.blockhash then -- read it into the block cache
 		biome_lib.surface_nodes_aircheck.blockhash =
 			minetest.find_nodes_in_area_under_air(minp, maxp, biome_lib.surfaceslist_aircheck)
 		biome_lib.actioncount_aircheck.blockhash = 1
-
+		if #biome_lib.surface_nodes_aircheck.blockhash > 0 then
+			biome_lib:dbg("Mapblock at "..minetest.pos_to_string(minp).." added, with "..#biome_lib.surface_nodes_aircheck.blockhash.." surface nodes detected.")
+		end
+	elseif not shutdown and not confirm_block_surroundings(minp) and #biome_lib.blocklist_aircheck > 1 then
+		biome_lib.blocklist_aircheck[#biome_lib.blocklist_aircheck+1] = biome_lib.blocklist_aircheck[1]
+		table.remove(biome_lib.blocklist_aircheck, 1)
+		biome_lib:dbg("Mapblock at "..minetest.pos_to_string(minp).." had an unloaded neighbor, moved it to the end of the queue.")
 	else
-		if biome_lib.actioncount_aircheck.blockhash <= #biome_lib.actionslist_aircheck then
+		if biome_lib.actionslist_aircheck[biome_lib.actioncount_aircheck.blockhash] then
 			-- [1] is biome, [2] is node/function/model
-			biome_lib:populate_surfaces(
+			local added = biome_lib:populate_surfaces(
 				biome_lib.actionslist_aircheck[biome_lib.actioncount_aircheck.blockhash][1],
 				biome_lib.actionslist_aircheck[biome_lib.actioncount_aircheck.blockhash][2],
 				biome_lib.surface_nodes_aircheck.blockhash, true)
+			if added > 0 then
+				biome_lib:dbg("Ran biome_lib:populate_surfaces for block at "..minetest.pos_to_string(minp)..
+					".  Entry #"..biome_lib.actioncount_aircheck.blockhash.." added "..added.." items.")
+			end
 			biome_lib.actioncount_aircheck.blockhash = biome_lib.actioncount_aircheck.blockhash + 1
 		else
-			if biome_lib.surface_nodes_aircheck.blockhash then
-				table.remove(biome_lib.blocklist_aircheck, 1)
-				biome_lib.surface_nodes_aircheck.blockhash = nil
-			end
+			table.remove(biome_lib.blocklist_aircheck, 1)
+			biome_lib.surface_nodes_aircheck.blockhash = nil
+			biome_lib.actioncount_aircheck.blockhash = nil
 		end
 	end
 end
@@ -432,8 +489,8 @@ end
 -- Secondary mapgen spawner, for mods that require disabling of
 -- checking for air during the initial map read stage.
 
-function biome_lib:generate_block_no_aircheck()
-	if #biome_lib.blocklist_no_aircheck == 0 then
+function biome_lib:generate_block_no_aircheck(shutdown)
+	if not biome_lib.blocklist_no_aircheck[1] then
 		return
 	end
 
@@ -443,25 +500,23 @@ function biome_lib:generate_block_no_aircheck()
 	local blockhash =	minetest.hash_node_position(minp)
 
 	if not biome_lib.surface_nodes_no_aircheck.blockhash then
-
-		-- directly read the block to be searched into the chunk cache
-
 		biome_lib.surface_nodes_no_aircheck.blockhash =
 			minetest.find_nodes_in_area(minp, maxp, biome_lib.surfaceslist_no_aircheck)
 		biome_lib.actioncount_no_aircheck.blockhash = 1
-
+	elseif not shutdown and not confirm_block_surroundings(minp) and #biome_lib.blocklist_no_aircheck > 1 then
+		biome_lib.blocklist_no_aircheck[#biome_lib.blocklist_no_aircheck+1] = biome_lib.blocklist_no_aircheck[1]
+		table.remove(biome_lib.blocklist_no_aircheck, 1)
 	else
-		if biome_lib.actioncount_no_aircheck.blockhash <= #biome_lib.actionslist_no_aircheck then
+		if biome_lib.actionslist_no_aircheck[biome_lib.actioncount_no_aircheck.blockhash] then
 			biome_lib:populate_surfaces(
 				biome_lib.actionslist_no_aircheck[biome_lib.actioncount_no_aircheck.blockhash][1],
 				biome_lib.actionslist_no_aircheck[biome_lib.actioncount_no_aircheck.blockhash][2],
 				biome_lib.surface_nodes_no_aircheck.blockhash, false)
 			biome_lib.actioncount_no_aircheck.blockhash = biome_lib.actioncount_no_aircheck.blockhash + 1
 		else
-			if biome_lib.surface_nodes_no_aircheck.blockhash then
-				table.remove(biome_lib.blocklist_no_aircheck, 1)
-				biome_lib.surface_nodes_no_aircheck.blockhash = nil
-			end
+			table.remove(biome_lib.blocklist_no_aircheck, 1)
+			biome_lib.surface_nodes_no_aircheck.blockhash = nil
+			biome_lib.actioncount_no_aircheck.blockhash = nil
 		end
 	end
 end
@@ -481,10 +536,10 @@ minetest.register_globalstep(function(dtime)
 	while (#biome_lib.blocklist_aircheck > 0 or #biome_lib.blocklist_no_aircheck > 0)
 	  and biome_lib.globalstep_runtime < 200000 do  -- 0.2 seconds, in uS.
 		if #biome_lib.blocklist_aircheck > 0 then
-			biome_lib:generate_block_with_air_checking()
+			biome_lib:generate_block_with_air_checking(false)
 		end
 		if #biome_lib.blocklist_no_aircheck > 0 then
-			biome_lib:generate_block_no_aircheck()
+			biome_lib:generate_block_no_aircheck(false)
 		end
 		biome_lib.globalstep_runtime = minetest.get_us_time() - biome_lib.globalstep_start_time
 	end
@@ -501,7 +556,7 @@ minetest.register_on_shutdown(function()
 	print("[biome_lib] Stand by, playing out the rest of the aircheck mapblock log")
 	print("(there are "..#biome_lib.blocklist_aircheck.." entries)...")
 	while #biome_lib.blocklist_aircheck > 0 do
-		biome_lib:generate_block_with_air_checking(0.1)
+		biome_lib:generate_block_with_air_checking(true)
 	end
 end)
 
@@ -513,7 +568,7 @@ minetest.register_on_shutdown(function()
 	print("[biome_lib] Stand by, playing out the rest of the no-aircheck mapblock log")
 	print("(there are "..#biome_lib.blocklist_no_aircheck.." entries)...")
 	while #biome_lib.blocklist_no_aircheck > 0 do
-		biome_lib:generate_block_no_aircheck(0.1)
+		biome_lib:generate_block_no_aircheck(true)
 	end
 end)
 
@@ -622,11 +677,11 @@ function biome_lib:spawn_on_surfaces(sd,sp,sr,sc,ss,sa)
 
 			local currentsurface = minetest.get_node(pos).name
 
-			if currentsurface == "default:water_source" and
+			if biome_lib.default_water_nodes[currentsurface] and
 					#minetest.find_nodes_in_area(
 						{x=pos.x, y=pos.y-biome.depth_max-1, z=pos.z},
 						vector.new(pos),
-						{"default:dirt", "default:dirt_with_grass", "default:sand"}
+						biome_lib.default_wet_surfaces
 					) == 0 then
 				return -- On water but no ground nearby
 			end
@@ -687,12 +742,9 @@ function biome_lib:replace_object(pos, replacement, grow_function, walldir, seed
 	end
 end
 
-
 dofile(biome_lib.modpath .. "/search_functions.lua")
 assert(loadfile(biome_lib.modpath .. "/growth.lua"))(time_scale)
 
-
-
 -- Check for infinite stacks
 
 if minetest.get_modpath("unified_inventory") or not minetest.settings:get_bool("creative_mode") then
@@ -710,10 +762,29 @@ function biome_lib:get_nodedef_field(nodename, fieldname)
 	return minetest.registered_nodes[nodename][fieldname]
 end
 
+if DEBUG then
+	biome_lib.last_count_air = 0
+	biome_lib.last_count_no_air = 0
+
+	function biome_lib.show_pending_block_counts()
+		if biome_lib.last_count_air ~= #biome_lib.blocklist_aircheck
+			or biome_lib.last_count_no_air ~= #biome_lib.blocklist_no_aircheck then
+			biome_lib:dbg(string.format("Pending block counts,  air: %-7i no-air: %i",
+				#biome_lib.blocklist_aircheck, #biome_lib.blocklist_no_aircheck))
+
+			biome_lib.last_count_air = #biome_lib.blocklist_aircheck
+			biome_lib.last_count_no_air = #biome_lib.blocklist_no_aircheck
+		end
+		minetest.after(1, biome_lib.show_pending_block_counts)
+	end
+
+	biome_lib.show_pending_block_counts()
+
+	minetest.after(0, function()
+		print("Registered a total of "..(#biome_lib.surfaceslist_aircheck)+(#biome_lib.surfaceslist_no_aircheck).." surface types to be evaluated, spread")
+		print("across "..#biome_lib.actionslist_aircheck.." actions with air-checking and "..#biome_lib.actionslist_no_aircheck.." actions without.")
+	end)
+
+end
+
 print("[Biome Lib] Loaded")
-
-minetest.after(0, function()
-	print("[Biome Lib] Registered a total of "..(#biome_lib.surfaceslist_aircheck)+(#biome_lib.surfaceslist_no_aircheck).." surface types to be evaluated, spread")
-	print("[Biome Lib] across "..#biome_lib.actionslist_aircheck.." actions with air-checking and "..#biome_lib.actionslist_no_aircheck.." actions without.")
-end)
-

mod.conf

@@ -1,2 +1,3 @@
 name = biome_lib
 min_minetest_version = 5.2.0
+optional_depends = default, intllib

search_functions.lua

@@ -52,9 +52,23 @@ function biome_lib:find_open_side(pos)
 	return nil
 end
 
--- "Record" the chunks being generated by the core mapgen
+-- "Record" the map chunks being generated by the core mapgen,
+-- split into individual mapblocks to reduce lag
 
 minetest.register_on_generated(function(minp, maxp, blockseed)
-	biome_lib.blocklist_aircheck[#biome_lib.blocklist_aircheck + 1] = { minp, maxp }
-	biome_lib.blocklist_no_aircheck[#biome_lib.blocklist_no_aircheck + 1] = { minp, maxp }
+	for x = 0, 4 do
+		local minx = minp.x + x*16
+		for y = 0, 4 do
+			local miny = minp.y + y*16
+			for z = 0, 4 do
+				local minz = minp.z + z*16
+
+				local bmin = {x=minx, y=miny, z=minz}
+				local bmax = {x=minx + 15, y=miny + 15, z=minz + 15}
+
+				biome_lib.blocklist_aircheck[#biome_lib.blocklist_aircheck + 1] = { bmin, bmax }
+				biome_lib.blocklist_no_aircheck[#biome_lib.blocklist_no_aircheck + 1] = { bmin, bmax }
+			end
+		end
+	end
 end)