Add basic support for mcl_ games

Author: SmallJoker

.luacheckrc

@@ -7,12 +7,15 @@ ignore = {
 max_line_length = 250
 
 read_globals = {
-	"default",
+	"core",
 	"ItemStack",
-	"lucky_block",
 	"minetest",
-	"screwdriver",
 	"vector",
+	-- (Soft) sependencies
+	"default",
+	"lucky_block",
+	"mcl_formspec",
+	"mcl_sounds",
 }
 
 globals = {"hopper"}

gamecompat.lua

@@ -0,0 +1,38 @@
+
+-- Default values
+hopper.formspec_bg = "bgcolor[#080808BB;true]" .. "listcolors[#00000069;#5A5A5A;#141318;#30434C;#FFF]"
+hopper.metal_sounds = nil
+hopper.node_fire_flame = nil
+
+local formspec_list_template = "list[%s;%s;%f,%f;%f,%f;%s]"
+hopper.formspec_add_list = function(location, listname, x, y, w, h, offset)
+	return formspec_list_template:format(location, listname, x, y, w, h, tostring(offset) or "")
+end
+
+-- Minetest Game
+if core.get_modpath("default") then
+	hopper.formspec_bg = "" -- Use formspec prepend
+	hopper.metal_sounds = default.node_sound_metal_defaults()
+
+	if core.get_modpath("fire") then
+		hopper.node_fire_flame = "fire:basic_flame"
+	end
+end
+
+-- VoxeLibre, Mineclonia
+if core.get_modpath("mcl_init") then
+	hopper.formspec_bg = "" -- Use formspec prepend
+
+	if core.get_modpath("mcl_sounds") then
+		hopper.metal_sounds = mcl_sounds.node_sound_metal_defaults()
+	end
+	if core.get_modpath("mcl_fire") then
+		hopper.node_fire_flame = "mcl_fire:fire"
+	end
+	if core.get_modpath("mcl_formspec") then
+		hopper.formspec_add_list = function(location, listname, x, y, w, h, offset)
+			return mcl_formspec.get_itemslot_bg_v4(x, y, w, h) ..
+				formspec_list_template:format(location, listname, x, y, w, h, tostring(offset) or "")
+		end
+	end
+end

init.lua

@@ -9,11 +9,7 @@ hopper.translator_escaped = function(...)
 	return minetest.formspec_escape(S(...))
 end
 
-if minetest.get_modpath("default") then
-	hopper.formspec_bg = default.gui_bg .. default.gui_bg_img .. default.gui_slots
-else
-	hopper.formspec_bg = "bgcolor[#080808BB;true]" .. "listcolors[#00000069;#5A5A5A;#141318;#30434C;#FFF]"
-end
+dofile(MP.."/gamecompat.lua")
 
 dofile(MP.."/config.lua")
 dofile(MP.."/api.lua")
@@ -47,20 +43,33 @@ minetest.register_on_player_receive_fields(function(player, formname, fields)
 	end
 end)
 
-
+function hopper._formspec_add_player_lists(y)
+	return hopper.formspec_add_list("current_player", "main", 0.4, y, 8, 1) ..
+		hopper.formspec_add_list("current_player", "main", 0.4, y + 1.4, 8, 3, 8)
+end
 
 -- add lucky blocks
 if minetest.get_modpath("lucky_block") then
 	lucky_block:add_blocks({
 		{"dro", {"hopper:hopper"}, 3},
-		{"nod", "default:lava_source", 1},
 	})
+	if hopper.node_fire_flame then
+		lucky_block:add_blocks({
+			{"nod", hopper.node_fire_flame, 1},
+		})
+	end
 end
 
 -- Utility function for inventory movement logs
 function hopper.log_inventory(...)
 	minetest.log(hopper.config.inv_log_level, ...)
 end
 
+-- Test whether the functions work
+core.register_on_mods_loaded(function()
+	hopper.formspec_add_list("player:foo", "bar", 0, 1, 8, 4)
+	hopper.formspec_add_list("player:foo", "bar", 0, 1, 8, 4, 4)
+	hopper._formspec_add_player_lists(1)
+end)
 
 minetest.log("action", "[hopper] Hopper mod loaded")

mod.conf

@@ -1,4 +1,3 @@
 name = hopper
-description = Adds hoppers to transport items between chests/furnace etc. Forum: https://forum.minetest.net/viewtopic.php?f=9&t=20058
-depends = default
-optional_depends = lucky_block, doc, protector, wine
+description = Adds hoppers to transport items between chests/furnace etc.
+optional_depends = lucky_block, doc, protector, wine, default, mcl_sounds

nodes/chute.lua

@@ -1,16 +1,17 @@
 local S = minetest.get_translator("hopper")
 local FS = hopper.translator_escaped
 
+
 local function get_chute_formspec(pos)
 	local spos = hopper.get_string_pos(pos)
 	local formspec =
-		"size[8,7]"
+		"formspec_version[3]"
+		.. "size[10.6,9]"
 		.. hopper.formspec_bg
-		.. "label[3,-0.1;" .. FS("Hopper Chute") .."]"
-		.. "list[nodemeta:" .. spos .. ";main;3,0.4;2,2;]"
-		.. hopper.get_eject_button_texts(pos, 6, 0.8)
-		.. "list[current_player;main;0,2.85;8,1;]"
-		.. "list[current_player;main;0,4.08;8,3;8]"
+		.. "label[4.15,0.35;" .. FS("Hopper Chute") .."]"
+		.. hopper.formspec_add_list("nodemeta:" .. spos, "main", 4.15, 0.8, 2, 2)
+		.. hopper.get_eject_button_texts(pos, 7.3, 1.4)
+		.. hopper._formspec_add_player_lists(3.7)
 		.. "listring[nodemeta:" .. spos .. ";main]"
 		.. "listring[current_player;main]"
 	return formspec

nodes/hoppers.lua

@@ -2,17 +2,16 @@ local S = minetest.get_translator("hopper")
 local FS = hopper.translator_escaped
 local ALPHA_CLIP = minetest.features.use_texture_alpha_string_modes and "clip" or true
 
--- formspec
 local function get_hopper_formspec(pos)
 	local spos = hopper.get_string_pos(pos)
 	local formspec =
-		"size[8,9]"
+		"formspec_version[3]"
+		.. "size[10.6,11.3]"
 		.. hopper.formspec_bg
-		.. "label[3.5,-0.1;" .. FS("Hopper") .."]"
-		.. "list[nodemeta:" .. spos .. ";main;2,0.4;4,4;]"
-		.. hopper.get_eject_button_texts(pos, 6.5, 2)
-		.. "list[current_player;main;0,4.85;8,1;]"
-		.. "list[current_player;main;0,6.08;8,3;8]"
+		.. "label[4.6,0.35;" .. FS("Hopper") .."]"
+		.. hopper.formspec_add_list("nodemeta:" .. spos, "main", 2.9, 0.8, 4, 4)
+		.. hopper.get_eject_button_texts(pos, 8.5, 2.6)
+		.. hopper._formspec_add_player_lists(6)
 		.. "listring[nodemeta:" .. spos .. ";main]"
 		.. "listring[current_player;main]"
 	return formspec

nodes/sorter.lua

@@ -18,29 +18,30 @@ local function get_sorter_formspec(pos)
 	local spos = hopper.get_string_pos(pos)
 
 	local filter_all = minetest.get_meta(pos):get_string("filter_all") == "true"
-	local y_displace = 0
+	local y_displace = 0.4
 	local filter_texture, filter_button_tooltip, filter_body
 	if filter_all then
 		filter_body = ""
 		filter_texture = "hopper_mode_off.png"
 		filter_button_tooltip = FS("This sorter is currently set to try sending all items\nin the direction of the arrow. Click this button\nto enable an item-type-specific filter.")
 	else
-		filter_body = "label[3.7,0;"..FS("Filter").."]list[nodemeta:" .. spos .. ";filter;0,0.5;8,1;]"
+		filter_body = "label[4.8,0.35;"..FS("Filter").."]"
+			.. hopper.formspec_add_list("nodemeta:" .. spos, "filter", 0.4, 0.8, 8, 1)
 		filter_texture = "hopper_mode_on.png"
 		filter_button_tooltip = FS("This sorter is currently set to only send items listed\nin the filter list in the direction of the arrow.\nClick this button to set it to try sending all\nitems that way first.")
-		y_displace = 1.6
+		y_displace = 2.2
 	end
 
 	local formspec =
-		"size[8," .. 7 + y_displace .. "]"
+		"formspec_version[3]"
+		.. "size[10.6," .. (8.3 + y_displace) .. "]"
 		.. hopper.formspec_bg
 		.. filter_body
-		.. "list[nodemeta:" .. spos .. ";main;3,".. tostring(0.3 + y_displace) .. ";2,2;]"
-		.. ("image_button_exit[0,%g;1,1;%s;filter_all;]"):format(y_displace, filter_texture)
+		.. hopper.formspec_add_list("nodemeta:" .. spos, "main", 4.15, 0.1 + y_displace, 2, 2)
+		.. ("image_button_exit[0.4,%g;1,1;%s;filter_all;]"):format(y_displace, filter_texture)
 		.. "tooltip[filter_all;" .. filter_button_tooltip.. "]"
-		.. hopper.get_eject_button_texts(pos, 6, 0.8 + y_displace)
-		.. "list[current_player;main;0,".. tostring(2.85 + y_displace) .. ";8,1;]"
-		.. "list[current_player;main;0,".. tostring(4.08 + y_displace) .. ";8,3;8]"
+		.. hopper.get_eject_button_texts(pos, 7.3, 0.7 + y_displace)
+		.. hopper._formspec_add_player_lists(3 + y_displace)
 		.. "listring[nodemeta:" .. spos .. ";main]"
 		.. "listring[current_player;main]"
 	return formspec

utility.lua

@@ -42,13 +42,6 @@ hopper.get_string_pos = function(pos)
 	return pos.x .. "," .. pos.y .. "," ..pos.z
 end
 
--- Apparently node_sound_metal_defaults is a newer thing, I ran into games using an older version of the default mod without it.
-if default.node_sound_metal_defaults ~= nil then
-	hopper.metal_sounds = default.node_sound_metal_defaults()
-else
-	hopper.metal_sounds = default.node_sound_stone_defaults()
-end
-
 -------------------------------------------------------------------------------------------
 -- Inventory transfer functions