depend on [matrix], new custom files approach + custom recipes

README.md

@@ -10,6 +10,8 @@ WIP MOD forum thread: https://forum.minetest.net/viewtopic.php?f=9&t=20115
 
 # Canvas recipes
 
+All recipes can be configured in `/custom.recipes.lua`, which will get created the first time the mod gets run and will never be overwritten.
+
     W = any wool block
     I = inner ingredient (see list below)
 
@@ -26,9 +28,9 @@ WIP MOD forum thread: https://forum.minetest.net/viewtopic.php?f=9&t=20115
 
 ![Canvas recipe](/screenshots/canvas-recipe.png)
 
-The largest canvas size is definitely able to crash your game or to create meshes too complex to be rendered if you try to grab too many nodes.
+The largest canvas size may likely create meshes too complex to be rendered if you try to grab too many nodes.
 
-For that reason, there is an optional limit for the amount of captured faces. That limit can be freely altered or disabled in the capture dialog. If you don't alter that limit the game shouldn't crash and should always generate working meshes.
+For that reason, there is an optional limit for the amount of captured faces. That limit can be freely altered or disabled in the capture dialog. If you don't alter that limit the game should always generate working meshes.
 
 # How to use
 
@@ -185,13 +187,13 @@ In the `.obj.dat` file of each mesh you'll find something like this:
 
 The variants used in each `.obj.dat` file depend on the ones you select in the interface at capture time.
 
-Default variants are stored in the file [default.nodevariants.lua](/default.nodevariants.lua) which gets copied over to `nodevariants.lua` when starting up the mod if no such file exists.
+Default variants are stored in the file [/default/nodevariants.lua](/default/nodevariants.lua) which gets copied over to `/custom.nodevariants.lua` when starting up the mod if no such file exists.
 
 Those variants will be the ones shown in the capture interface.
 
 In order to add a new variant simply add a line with your texture name and make sure you save such texture file in the `/textures` folder of the mod. You can also remove the lines you're not interested in and the mod will not generate those variants.
 
-You can do the above operation either on the `nodevariants.lua` file (it will affect all new captures) or in the `.obj.dat` file associated to each mesh (will affect only that mesh).
+You can do the above operation either on the `/custom.nodevariants.lua` file (it will affect all new captures) or in the `.obj.dat` file associated to each mesh (will affect only that mesh).
 
 For example, here we remove all but the `plain` version and add a custom one:
 
@@ -216,4 +218,4 @@ A couple considerations:
 
 # Changing default colors assigned to nodes
 
-The file [default.nodecolors.conf](/default.nodecolors.conf) contains the `modname:nodename = color` associations for all the nodes that get loaded in a minetest_game world. This file will be copied over to `nodecolors.conf` at startup (if no such file exists); in `nodecolors.conf` you're free to alter existing colors and to add new nodes, just make sure you stick to wool colors cause any invalid color will be replaced by `air`. Do not store your changes into `default.nodecolors.conf` cause it will be overwritten updating the mod (and it wouldn't get used anyway if a `nodecolors.conf` file is there at all).
+The file [/default/nodecolors.conf](/default/nodecolors.conf) contains the `modname:nodename = color` associations for all the nodes that get loaded in a minetest_game world. This file will be copied over to `/custom.nodecolors.conf` at startup (if no such file exists); in `/custom.nodecolors.conf` you're free to alter existing colors and to add new nodes, just make sure you stick to wool colors cause any invalid color will be replaced by `air`.

default.nodevariants.lua

@@ -1,6 +0,0 @@
-return {
-	plain = "plain-16.png",
-	plainborder = "plain-border-72.png",
-	wool = "wool-72.png",
-	woolborder = "wool-border-72.png",
-}

default/README.txt

@@ -0,0 +1,2 @@
+please do not edit any file in this folder,
+corresponding custom.* files get created in the main mod's folder for you to customize

default/nodecolors.conf

@@ -1,3 +1,8 @@
+# only alter this file if it's named "custom.nodecolors.conf"
+# alter the color mapping as you please and set to air
+# the nodes you don't want to used for mesh building in the game
+# the original mappings are in "default/nodecolors.conf"
+
 air                                 = air
 beds:bed_bottom                     = air
 beds:bed_top                        = air

default/nodevariants.lua

@@ -0,0 +1,11 @@
+-- only alter this file if it's named "custom.nodevariants.lua"
+-- alter the variants as you please and delete / comment out
+-- the variants you don't want to be available in the game
+-- the original versions are in "default/nodevariants.lua"
+
+return {
+	plain = "plain-16.png",
+	plainborder = "plain-border-72.png",
+	wool = "wool-72.png",
+	woolborder = "wool-border-72.png",
+}

default/recipes.lua

@@ -0,0 +1,44 @@
+-- only alter this file if it's named "custom.recipes.lua"
+-- alter the recipes as you please and delete / comment out
+-- the recipes you don't want to be available in the game
+-- the original versions are in "default/recipes.lua"
+
+return {
+	["wesh:canvas02"] = {
+		{"group:wool", "group:wool",           "group:wool"},
+		{"group:wool", "default:steel_ingot",  "group:wool"},
+		{"group:wool", "group:wool",           "group:wool"},
+	},
+	["wesh:canvas04"] = {
+		{"group:wool", "group:wool",           "group:wool"},
+		{"group:wool", "default:copper_ingot", "group:wool"},
+		{"group:wool", "group:wool",           "group:wool"},
+	},
+	["wesh:canvas08"] = {
+		{"group:wool", "group:wool",           "group:wool"},
+		{"group:wool", "default:tin_ingot",    "group:wool"},
+		{"group:wool", "group:wool",           "group:wool"},
+	},
+	["wesh:canvas16"] = {
+		{"group:wool", "group:wool",           "group:wool"},
+		{"group:wool", "default:bronze_ingot", "group:wool"},
+		{"group:wool", "group:wool",           "group:wool"},
+	},
+	["wesh:canvas32"] = {
+		{"group:wool", "group:wool",           "group:wool"},
+		{"group:wool", "default:gold_ingot",   "group:wool"},
+		{"group:wool", "group:wool",           "group:wool"},
+	},
+	["wesh:canvas64"] = {
+		{"group:wool", "group:wool",           "group:wool"},
+		{"group:wool", "default:diamond",      "group:wool"},
+		{"group:wool", "group:wool",           "group:wool"},
+	},
+	-- this is the orientation block with colored faces
+	-- marked according to the semiaxes they point to
+	["wesh:faces"] = {
+		{"group:wool", "",           "group:wool"},
+		{"",           "group:wool", ""},
+		{"group:wool", "",           "group:wool"},
+	}
+}

init.lua

@@ -12,9 +12,54 @@ wesh = {
 
 wesh.models_path = wesh.mod_path .. "/models/"
 local storage = dofile(wesh.mod_path .. "/storage.lua")
-local matrix = dofile(wesh.mod_path .. "/lib/matrix.lua")
 local smartfs = dofile(wesh.mod_path .. "/lib/smartfs.lua")
 
+-- ========================================================================
+-- local helpers
+-- ========================================================================
+
+local function copy_file(source, dest)
+	local src_file = io.open(source, "rb")
+	if not src_file then 
+		return false, "copy_file() unable to open source for reading"
+	end
+	local src_data = src_file:read("*all")
+	src_file:close()
+
+	local dest_file = io.open(dest, "wb")
+	if not dest_file then 
+		return false, "copy_file() unable to open dest for writing"
+	end
+	dest_file:write(src_data)
+	dest_file:close()
+	return true, "files copied successfully"
+end
+
+local function custom_or_default(modname, path, filename)
+	local default_filename = "default/" .. filename
+	local full_filename = path .. "/custom." .. filename
+	local full_default_filename = path .. "/" .. default_filename
+	
+	os.rename(path .. "/" .. filename, full_filename)
+	
+	local file = io.open(full_filename, "rb")
+	if not file then
+		minetest.debug("[" .. modname .. "] Copying " .. default_filename .. " to " .. filename .. " (path: " .. path .. ")")
+		local success, err = copy_file(full_default_filename, full_filename)
+		if not success then
+			minetest.debug("[" .. modname .. "] " .. err)
+			return false
+		end
+		file = io.open(full_filename, "rb")
+		if not file then
+			minetest.debug("[" .. modname .. "] Unable to load " .. filename .. " file from path " .. path)
+			return false
+		end
+	end
+	file:close()
+	return full_filename
+end
+
 -- ========================================================================
 -- initialization functions
 -- ========================================================================
@@ -84,34 +129,22 @@ function wesh.init_colors()
 			wesh.nodename_to_color["wool:" .. color] = color
 		end
 	end
-	
-	local colors_filename = "nodecolors.conf"
-	local default_colors_filename = "default." .. colors_filename
-	local full_colors_filename = wesh.mod_path .. "/" .. colors_filename
-	local full_default_colors_filename = wesh.mod_path .. "/" .. default_colors_filename
-	
-	local file = io.open(full_colors_filename, "rb")
-	if not file then
-		minetest.debug("[wesh] Copying " .. default_colors_filename .. " to " .. colors_filename)
-		local success, err = wesh.copy_file(full_default_colors_filename, full_colors_filename)
-		if not success then
-			minetest.debug("[wesh] " .. err)
-			return
-		end
-		file = io.open(full_colors_filename, "rb")
-		if not file then
-			minetest.debug("[wesh] Unable to load " .. colors_filename .. " file from mod folder")
-			return
-		end
-	end
 
+	local full_colors_filename = custom_or_default(wesh.name, wesh.mod_path, "nodecolors.conf")
+	if not full_colors_filename then return end
+	local file = io.open(full_colors_filename, "rb")
+	if not file then return end
+	
 	--  The following loop will fill the nodename_to_color table with custom values
 	local content = file:read("*all")
 	local lines = content:gsub("(\r\n)+", "\r"):gsub("\r+", "\n"):split("\n")
 	for _, line in ipairs(lines) do
-		local parts = line:gsub("%s+", ""):split("=")
+		line = line:gsub("%s+", "")
-		if #parts == 2 then
+		if line:sub(1,1) ~= "#" then 
-			wesh.nodename_to_color[parts[1]] = parts[2]
+			local parts = line:split("=")
+			if #parts == 2 then
+				wesh.nodename_to_color[parts[1]] = parts[2]
+			end
 		end
 	end
 	file:close()
@@ -274,31 +307,18 @@ function wesh.transform_facedir(canvas_facedir, node_facedir, invert_canvas)
 	return wesh.transform_cache[cache_key]
 end
 
-function wesh.init_variants()
+function wesh.init_variants()	
-	local variants_filename = "nodevariants.lua"
-	local default_variants_filename = "default." .. variants_filename
-	local full_variants_filename = wesh.mod_path .. "/" .. variants_filename
-	local full_default_variants_filename = wesh.mod_path .. "/" .. default_variants_filename
-	
-	local file = io.open(full_variants_filename, "rb")
-	if not file then
-		minetest.debug("[wesh] Copying " .. default_variants_filename .. " to " .. variants_filename)
-		local success, err = wesh.copy_file(full_default_variants_filename, full_variants_filename)
-		if not success then
-			minetest.debug("[wesh] " .. err)
-			return
-		end
-		file = io.open(full_variants_filename, "rb")
-		if not file then
-			minetest.debug("[wesh] Unable to load " .. variants_filename .. " file from mod folder")
-			return
-		end
-	end
-
-	local custom_variants = minetest.deserialize(file:read("*all"))	
 	wesh.variants = {
 		plain = "plain-16.png",
 	}
+	local full_variants_filename = custom_or_default(wesh.name, wesh.mod_path, "nodevariants.lua")
+	if not full_variants_filename then return end
+	
+	local file = io.open(full_variants_filename, "rb")
+	if not file then return end
+	
+	local custom_variants = minetest.deserialize(file:read("*all"))	
+	file:close()
 	
 	-- ensure there is at least one valid variant in the custom variants
 	if custom_variants and type(custom_variants) == "table" then
@@ -309,7 +329,6 @@ function wesh.init_variants()
 			end
 		end
 	end
-	file:close()
 end
 
 function wesh.init_vertex_textures()
@@ -335,14 +354,10 @@ end
 
 function wesh.register_canvas_nodes()
 
-	local function register_canvas(index, size, inner)
+	local function register_canvas(index, size, recipe)
 		minetest.register_craft({
 			output = "wesh:canvas" .. size,
-			recipe = {
+			recipe = recipe,
-				{"group:wool", "group:wool", "group:wool"},
-				{"group:wool", inner,        "group:wool"},
-				{"group:wool", "group:wool", "group:wool"},
-			}
 		})
 		minetest.register_node("wesh:canvas" .. size, {
 			drawtype = "mesh",
@@ -357,45 +372,48 @@ function wesh.register_canvas_nodes()
 		})
 	end
 	
-	local canvas_sizes = {
-		{"02", "default:steel_ingot"},
-		{"04", "default:copper_ingot"},
-		{"08", "default:tin_ingot"},
-		{"16", "default:bronze_ingot"},
-		{"32", "default:gold_ingot"},
-		{"64", "default:diamond"},
-	}
-	
 	wesh.valid_canvas_sizes = {}
 	
-	for index, canvas_data in pairs(canvas_sizes) do
+	local full_recipes_filename = custom_or_default(wesh.name, wesh.mod_path, "recipes.lua")
-		local size = canvas_data[1]
+	if not full_recipes_filename then return end
-		local inner = canvas_data[2]
+	
-		wesh.valid_canvas_sizes[tonumber(size)] = true
+	local recipes = dofile(full_recipes_filename);
-		register_canvas(index, size, inner)
+	
+	if type(recipes) ~= "table" then
+		minetest.debug("[" .. wesh.name .. "] custom.recipes.lua is empty or malformed, all relative crafts will be disabled")
+		return
 	end
 	
-	minetest.register_alias("wesh:canvas", "wesh:canvas16")
+	local canvas_sizes = { "02", "04", "08", "16", "32", "64" }
-
-	minetest.register_craft({
-		output = "wesh:faces",
-		recipe = {
-			{"group:wool", "",           "group:wool"},
-			{"",           "group:wool", ""},
-			{"group:wool", "",           "group:wool"},
-		}
-	})
 	
-	minetest.register_node("wesh:faces", {
+	for index, size in pairs(canvas_sizes) do
-		drawtype = "mesh",
+		local recipe = recipes["wesh:canvas" .. size]
-		mesh = "zzz_faces.obj",
+		if recipe then
-		tiles = { "faces-96x64.png" },
+			wesh.valid_canvas_sizes[tonumber(size)] = true
-		paramtype2 = "facedir",
+			register_canvas(index, size, recipe)
-		description = "Woolen Mesh Orientation Block",
+		end
-		walkable = true,
+	end
-		groups = { snappy = 2, choppy = 2, oddly_breakable_by_hand = 3 },
-	})
 	
+	if wesh.valid_canvas_sizes["16"] then
+		minetest.register_alias("wesh:canvas", "wesh:canvas16")
+	end
+	
+	if recipes["wesh:faces"] then
+		minetest.register_craft({
+			output = "wesh:faces",
+			recipe = recipes["wesh:faces"],
+		})
+		
+		minetest.register_node("wesh:faces", {
+			drawtype = "mesh",
+			mesh = "zzz_faces.obj",
+			tiles = { "faces-96x64.png" },
+			paramtype2 = "facedir",
+			description = "Woolen Mesh Orientation Block",
+			walkable = true,
+			groups = { snappy = 2, choppy = 2, oddly_breakable_by_hand = 3 },
+		})
+	end
 end
 
 function wesh.reset_geometry(canvas)
@@ -868,7 +886,7 @@ function wesh.prepare_data_file(description, canvas)
 end
 
 function wesh.save_mesh_to_file(obj_filename, meshdata, description, playername, canvas)
-	
+
 	if canvas.generate_obj then
 		-- save .obj file
 		local full_filename = wesh.temp_path .. "/" .. obj_filename
@@ -915,7 +933,7 @@ function wesh.save_mesh_to_file(obj_filename, meshdata, description, playername,
 		wesh.notify(playername, "Matrix file saved to '" .. matrix_data_filename .. "' in '" .. wesh.temp_path .. "'")
 		wesh.notify(playername, "Reload the world to move newly created matrix to the mod folder")
 	end
-	
+
 	return true
 end
 
@@ -996,23 +1014,6 @@ end
 -- file movement / copy
 -- ========================================================================
 
-function wesh.copy_file(source, dest)
-	local src_file = io.open(source, "rb")
-	if not src_file then 
-		return false, "copy_file() unable to open source for reading"
-	end
-	local src_data = src_file:read("*all")
-	src_file:close()
-
-	local dest_file = io.open(dest, "wb")
-	if not dest_file then 
-		return false, "copy_file() unable to open dest for writing"
-	end
-	dest_file:write(src_data)
-	dest_file:close()
-	return true, "files copied successfully"
-end
-
 function wesh.move_temp_files()
 	local meshes = wesh.get_temp_files()
 	for _, filename in ipairs(meshes) do
@@ -1749,5 +1750,4 @@ function wesh.traverse_matrix(callback, boundary, ...)
 	end
 end
 
-
 wesh.init()

mod.conf

@@ -1,2 +1,3 @@
 name = wesh
 
+depends = matrix