Improve area selection, add translation support.

.luacheckrc

@@ -11,7 +11,6 @@ read_globals = {
     table = {fields = {"copy", "getn", "indexof"}},
 
     "minetest",
-    "DIR_DELIM",
     "PseudoRandom",
     "vector",
     "VoxelArea",

README.md

@@ -1,6 +1,7 @@
 # Meshport (Minetest Mesh Exporter)
 
 [![Build status](https://github.com/random-geek/meshport/workflows/build/badge.svg)](https://github.com/random-geek/meshport/actions)
+[![ContentDB](https://content.minetest.net/packages/random_geek/meshport/shields/downloads/)](https://content.minetest.net/packages/random_geek/meshport/)
 [![License](https://img.shields.io/badge/license-LGPLv3.0%2B-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0.en.html)
 
 ![screenshot](screenshot.png)
@@ -14,8 +15,25 @@ drawtypes are not yet supported.
 
 ## Usage
 
-Use `/mesh1` and `/mesh2` to set the corners of the area you want exported,
-then use `/meshport [filename]` to export the mesh (filename is optional).
+Only players with the `meshport` privilege are allowed to select areas and
+export meshes. This privilege is granted to singleplayer/admin players by
+default.
+
+To export a mesh, first select the area you want to export. There are two ways
+to do this:
+
+- Use the **Meshport Area Selector** tool. Left- or right-click on a node or
+  object to select either corner of the area. Hold sneak while clicking a node
+  to select the node in front of the face you clicked on.
+- Or, use the `/mesh1` and `/mesh2` commands to set either corner. You can
+  specify a position (e.g. `/mesh1 -24 0 24`) or leave the argument blank to
+  use your current position (e.g. `/mesh1`).
+
+After selecting an area, use `/meshport [filename]` to export the mesh
+(filename is optional).
+
+The `/meshrst` command can be used to clear the current
+selection.
 
 Folders containing exported meshes, including `.obj` and `.mtl` files, are
 saved in the `meshport` folder of the world directory.
@@ -91,4 +109,7 @@ allowing both faces to be visible.
 
 ## License
 
-Meshport is licensed under the GNU LGPL v3.0.
+Textures are licensed under [CC BY 4.0][2]. Everything else (including source code)
+is licensed under the GNU LGPL v3.0.
+
+[2]: https://creativecommons.org/licenses/by/4.0/

export.lua

@@ -21,6 +21,9 @@
 -- Much of the mesh generation code in this file is derived from Minetest's
 -- MapblockMeshGenerator class. See minetest/src/client/content_mapblock.cpp.
 
+local S = meshport.S
+local vec = vector.new -- Makes defining tables of vertices a little less painful.
+
 --[[
 	THE CUBIC NODE PRIORITY SYSTEM
 
@@ -58,8 +61,6 @@ local CUBIC_FACE_PRIORITY = {
 	plantlike_rooted = 4, -- base of plantlike_rooted is equivalent to `normal`.
 }
 
-local vec = vector.new -- Makes defining tables of vertices a little less painful.
-
 local CUBIC_SIDE_FACES = {
 	{vec(-0.5,  0.5, -0.5), vec( 0.5,  0.5, -0.5), vec( 0.5,  0.5,  0.5), vec(-0.5,  0.5,  0.5)}, -- Y+
 	{vec(-0.5, -0.5,  0.5), vec( 0.5, -0.5,  0.5), vec( 0.5, -0.5, -0.5), vec(-0.5, -0.5, -0.5)}, -- Y-
@@ -573,9 +574,9 @@ local function create_mesh_node(nodeDef, param2, playerName)
 
 		if not meshport.obj_paths[meshName] then
 			if string.lower(string.sub(meshName, -4)) ~= ".obj" then
-				meshport.log(playerName, "warning", string.format("Mesh %q is not supported.", meshName))
+				meshport.log(playerName, "warning", S("Mesh \"@1\" is not supported.", meshName))
 			else
-				meshport.log(playerName, "warning", string.format("Mesh %q could not be found.", meshName))
+				meshport.log(playerName, "warning", S("Mesh \"@1\" could not be found.", meshName))
 			end
 
 			-- Cache a blank faces object so the player isn't warned again.
@@ -760,7 +761,7 @@ end
 
 
 function meshport.create_mesh(playerName, p1, p2, path)
-	meshport.log(playerName, "info", "Generating mesh...")
+	meshport.log(playerName, "info", S("Generating mesh..."))
 	initialize_resources()
 
 	p1, p2 = vector.sort(p1, p2)
@@ -795,5 +796,5 @@ function meshport.create_mesh(playerName, p1, p2, path)
 	mesh:write_mtl(path, playerName)
 
 	cleanup_resources()
-	meshport.log(playerName, "info", "Finished. Saved to " .. path)
+	meshport.log(playerName, "info", S("Finished. Saved to @1", path))
 end

init.lua

@@ -19,6 +19,7 @@
 
 meshport = {
 	player_data = {},
+	S = minetest.get_translator("meshport"),
 }
 
 modpath = minetest.get_modpath("meshport")
@@ -28,81 +29,298 @@ dofile(modpath .. "/parse_obj.lua")
 dofile(modpath .. "/nodebox.lua")
 dofile(modpath .. "/export.lua")
 
-minetest.register_privilege("meshport", "Can save meshes with meshport.")
+local S = meshport.S
+local vec = vector.new
+
+minetest.register_privilege("meshport", S("Can save meshes with Meshport."))
 
 minetest.register_on_leaveplayer(function(player, timed_out)
 	local name = player:get_player_name()
 	meshport.player_data[name] = nil
 end)
 
-for i = 1, 2 do
-	minetest.register_chatcommand("mesh" .. i, {
+for n = 1, 2 do
+	local tex = "meshport_corner_" .. n .. ".png"
+
+	minetest.register_entity("meshport:corner_" .. n, {
+		initial_properties = {
+			physical = false,
+			visual = "cube",
+			visual_size = {x = 1.04, y = 1.04, z = 1.04},
+			selectionbox = {-0.52, -0.52, -0.52, 0.52, 0.52, 0.52},
+			textures = {tex, tex, tex, tex, tex, tex},
+			static_save = false,
+			glow = minetest.LIGHT_MAX,
+		},
+
+		on_punch = function(self, hitter)
+			self.object:remove()
+		end,
+	})
+end
+
+minetest.register_entity("meshport:border", {
+	initial_properties = {
+		physical = false,
+		visual = "upright_sprite",
+		textures = {
+			"meshport_border.png",
+			"meshport_border.png^[transformFX",
+		},
+		static_save = false,
+		glow = minetest.LIGHT_MAX,
+	},
+
+	on_punch = function(self, hitter)
+		if not hitter then
+			return
+		end
+
+		local playerName = hitter:get_player_name()
+		if not playerName then
+			return
+		end
+
+		local borders = meshport.player_data[playerName].borders
+		for i = 1, 6 do -- Remove all borders at once.
+			if borders[i] then
+				borders[i]:remove()
+				borders[i] = nil
+			end
+		end
+	end,
+})
+
+local SIDE_ROTATIONS = {
+	vec(0.5 * math.pi, 0, 0), -- Y+
+	vec(1.5 * math.pi, 0, 0), -- Y-
+	vec(0, 1.5 * math.pi, 0), -- X+
+	vec(0, 0.5 * math.pi, 0), -- X-
+	vec(0, 0, 0), -- Z+
+	vec(0, math.pi, 0), -- Z-
+}
+
+
+local function mark_borders(playerData)
+	local pos1, pos2 = vector.sort(playerData.pos[1], playerData.pos[2])
+	local center = vector.multiply(vector.add(pos1, pos2), 0.5)
+	-- Add 0.01 to avoid z-fighting with blocks or corner markers.
+	local c1, c2 = vector.subtract(pos1, 0.5 + 0.01), vector.add(pos2, 0.5 + 0.01)
+
+	local sideCenters = {
+		vec(center.x, c2.y, center.z), -- Y+
+		vec(center.x, c1.y, center.z), -- Y-
+		vec(c2.x, center.y, center.z), -- X+
+		vec(c1.x, center.y, center.z), -- X-
+		vec(center.x, center.y, c2.z), -- Z+
+		vec(center.x, center.y, c1.z), -- Z-
+	}
+
+	local size = vector.subtract(c2, c1)
+	local sideSizes = {
+		{x = size.x, y = size.z}, -- Y+
+		{x = size.x, y = size.z}, -- Y-
+		{x = size.z, y = size.y}, -- X+
+		{x = size.z, y = size.y}, -- X-
+		{x = size.x, y = size.y}, -- Z+
+		{x = size.x, y = size.y}, -- Z-
+	}
+
+	local half = vector.multiply(size, 0.5)
+	local selectionBoxes = {
+		{-half.x, -0.02, -half.z, half.x, 0, half.z}, -- Y+
+		{-half.x, 0, -half.z, half.x, 0.02, half.z}, -- Y-
+		{-0.02, -half.y, -half.z, 0, half.y, half.z}, -- X+
+		{0, -half.y, -half.z, 0.02, half.y, half.z}, -- X-
+		{-half.x, -half.y, -0.02, half.x, half.y, 0}, -- Z+
+		{-half.x, -half.y, 0, half.x, half.y, 0.02}, -- Z-
+	}
+
+	for i = 1, 6 do
+		local entity = minetest.add_entity(sideCenters[i], "meshport:border")
+		entity:set_properties({
+			visual_size = sideSizes[i],
+			selectionbox = selectionBoxes[i],
+		})
+		entity:set_rotation(SIDE_ROTATIONS[i])
+		playerData.borders[i] = entity
+	end
+end
+
+
+local function set_position(playerName, n, pos)
+	if not meshport.player_data[playerName] then
+		meshport.player_data[playerName] = {
+			pos = {},
+			corners = {},
+			borders = {},
+		}
+	end
+
+	local data = meshport.player_data[playerName]
+	data.pos[n] = pos
+
+	if data.corners[n] then
+		data.corners[n]:remove()
+	end
+
+	data.corners[n] = minetest.add_entity(pos, "meshport:corner_" .. n)
+
+	for i = 1, 6 do
+		if data.borders[i] then
+			data.borders[i]:remove()
+			data.borders[i] = nil
+		end
+	end
+
+	if data.pos[1] and data.pos[2] then
+		mark_borders(data)
+	end
+
+	meshport.log(playerName, "info", S("Position @1 set to @2.", n, minetest.pos_to_string(pos)))
+end
+
+
+for n = 1, 2 do
+	minetest.register_chatcommand("mesh" .. n, {
 		params = "[pos]",
-		description = string.format(
-				"Set position %i for meshport. Player's position is used if no other position is specified.", i),
+		description = S(
+			"Set position @1 for Meshport. Player's position is used if no other position is specified.", n),
 		privs = {meshport = true},
 
-		func = function(name, param)
+		func = function(playerName, param)
 			local pos
 
 			if param == "" then
-				pos = minetest.get_player_by_name(name):get_pos()
+				pos = minetest.get_player_by_name(playerName):get_pos()
 			else
 				pos = minetest.string_to_pos(param)
 			end
 
 			if not pos then
-				meshport.log(name, "error", "Not a valid position.")
+				meshport.log(playerName, "error", S("Not a valid position."))
 				return
 			end
 
 			pos = vector.round(pos)
-
-			if not meshport.player_data[name] then
-				meshport.player_data[name] = {}
-			end
-
-			if i == 1 then
-				meshport.player_data[name].p1 = pos
-			elseif i == 2 then
-				meshport.player_data[name].p2 = pos
-			end
-
-			meshport.log(name, "info", string.format("Position %i set to %s.", i, minetest.pos_to_string(pos)))
+			set_position(playerName, n, pos)
 		end,
 	})
 end
 
-minetest.register_chatcommand("meshport", {
-	params = "[filename]",
-	description = "Save a mesh of the selected area (filename optional).",
+
+local function on_wand_click(itemstack, player, pointedThing, n)
+	if not player or pointedThing.type == "nothing" then
+		return
+	end
+
+	local playerName = player:get_player_name()
+
+	if not minetest.check_player_privs(playerName, "meshport") then
+		meshport.log(playerName, "error", S("You must have the meshport privilege to use this tool."))
+		return
+	end
+
+	local pos
+	if pointedThing.type == "node" then
+		if player:get_player_control().sneak then
+			pos = pointedThing.above
+		else
+			pos = pointedThing.under
+		end
+	elseif pointedThing.type == "object" then
+		local entity = pointedThing.ref:get_luaentity()
+		if entity.name == "meshport:border" then
+			return
+		end
+
+		pos = vector.round(pointedThing.ref:get_pos())
+	else
+		return -- In case another pointed_thing.type is added
+	end
+
+	set_position(playerName, n, pos)
+end
+
+
+minetest.register_tool("meshport:wand", {
+	description = S("Meshport Area Selector\nLeft-click to set 1st corner, right-click to set 2nd corner."),
+	short_description = S("Meshport Area Selector"),
+	inventory_image = "meshport_wand.png",
+
+	on_use = function(itemstack, placer, pointedThing) -- Left-click
+		on_wand_click(itemstack, placer, pointedThing, 1)
+	end,
+
+	on_place = function(itemstack, placer, pointedThing) -- Right-click
+		on_wand_click(itemstack, placer, pointedThing, 2)
+		return itemstack -- Required by on_place
+	end,
+
+	on_secondary_use = function(itemstack, placer, pointedThing) -- Right-click on non-node
+		on_wand_click(itemstack, placer, pointedThing, 2)
+	end,
+})
+
+minetest.register_chatcommand("meshrst", {
+	description = S("Clear the current Meshport area."),
 	privs = {meshport = true},
 
-	func = function(name, filename)
-		local playerData = meshport.player_data[name] or {}
+	func = function(playerName, param)
+		local data = meshport.player_data[playerName]
+		if data then
+			for n = 1, 2 do
+				data.pos[n] = nil
+				if data.corners[n] then
+					data.corners[n]:remove()
+					data.corners[n] = nil
+				end
+			end
 
-		if not playerData.p1 or not playerData.p2 then
-			meshport.log(name, "error", "No area selected. Use /mesh1 and /mesh2 to select an area.")
+			for i = 1, 6 do
+				if data.borders[i] then
+					data.borders[i]:remove()
+					data.borders[i] = nil
+				end
+			end
+		end
+
+		meshport.log(playerName, "info", S("Cleared the current area."))
+	end,
+})
+
+minetest.register_chatcommand("meshport", {
+	params = "[filename]",
+	description = S("Save a mesh of the selected area (filename optional)."),
+	privs = {meshport = true},
+
+	func = function(playerName, filename)
+		local playerData = meshport.player_data[playerName] or {}
+
+		if not (playerData.pos and playerData.pos[1] and playerData.pos[2]) then
+			meshport.log(playerName, "error",
+				S("No area selected. Use the Meshport Area Selector or /mesh1 and /mesh2 to select an area."))
 			return
 		end
 
 		if filename:find("[^%w-_]") then
-			meshport.log(name, "error", "Invalid name supplied. Please use valid characters ([A-Z][a-z][0-9][-_]).")
+			meshport.log(playerName, "error",
+				S("Invalid name supplied. Please use valid characters: [A-Z][a-z][0-9][-_]"))
 			return
 		elseif filename == "" then
 			filename = os.date("%Y-%m-%d_%H-%M-%S")
 		end
 
-		local mpPath = minetest.get_worldpath() .. DIR_DELIM .. "meshport"
-		local folderName = name .. "_" .. filename
+		local mpPath = minetest.get_worldpath() .. "/" .. "meshport"
+		local folderName = playerName .. "_" .. filename
 
 		if table.indexof(minetest.get_dir_list(mpPath, true), folderName) > 0 then
-			meshport.log(name, "error",
-				string.format("Folder %q already exists. Try using a different name.", folderName))
+			meshport.log(playerName, "error",
+				S("Folder \"@1\" already exists. Try using a different name.", folderName))
 			return
 		end
 
-		local path = mpPath .. DIR_DELIM .. folderName
-		meshport.create_mesh(name, playerData.p1, playerData.p2, path)
+		local path = mpPath .. "/" .. folderName
+		meshport.create_mesh(playerName, playerData.pos[1], playerData.pos[2], path)
 	end,
 })

locale/template.txt

@@ -0,0 +1,23 @@
+# textdomain:meshport
+
+Warning: @1
+Error: @1
+Can save meshes with Meshport.
+Position @1 set to @2.
+Set position @1 for Meshport. Player's position is used if no other position is specified.
+Not a valid position.
+You must have the meshport privilege to use this tool.
+Meshport Area Selector@\nLeft-click to set 1st corner, right-click to set 2nd corner.
+Meshport Area Selector
+Clear the current Meshport area.
+Cleared the current area.
+Save a mesh of the selected area (filename optional).
+No area selected. Use the Meshport Area Selector or /mesh1 and /mesh2 to select an area.
+Invalid name supplied. Please use valid characters: [A-Z][a-z][0-9][-_]
+Folder "@1" already exists. Try using a different name.
+Mesh "@1" is not supported.
+Mesh "@1" could not be found.
+Generating mesh...
+Finished. Saved to @1
+Ignoring texture modifers in material "@1".
+Could not find texture "@1". Using a dummy material instead.

mesh.lua

@@ -17,6 +17,8 @@
 	along with Meshport. If not, see <https://www.gnu.org/licenses/>.
 ]]
 
+local S = meshport.S
+
 --[[
 	A buffer of faces.
 
@@ -279,7 +281,7 @@ end
 function meshport.Mesh:write_obj(path)
 	local objFile = io.open(path .. "/model.obj", "w")
 
-	objFile:write("# Created using meshport (https://github.com/random-geek/meshport).\n")
+	objFile:write("# Created using Meshport (https://github.com/random-geek/meshport).\n")
 	objFile:write("mtllib materials.mtl\n")
 
 	-- Write vertices.
@@ -312,7 +314,7 @@ end
 function meshport.Mesh:write_mtl(path, playerName)
 	local matFile = io.open(path .. "/materials.mtl", "w")
 
-	matFile:write("# Created using meshport (https://github.com/random-geek/meshport).\n")
+	matFile:write("# Created using Meshport (https://github.com/random-geek/meshport).\n")
 
 	-- Write material information.
 	for mat, _ in pairs(self.faces) do
@@ -323,13 +325,13 @@ function meshport.Mesh:write_mtl(path, playerName)
 
 		if meshport.texture_paths[texName] then
 			if texName ~= mat then
-				meshport.log(playerName, "warning", string.format("Ignoring texture modifers in material %q.", mat))
+				meshport.log(playerName, "warning", S("Ignoring texture modifers in material \"@1\".", mat))
 			end
 
 			matFile:write(string.format("map_Kd %s\n", meshport.texture_paths[texName]))
 		else
 			meshport.log(playerName, "warning",
-					string.format("Could not find texture %q. Using a dummy material instead.", texName))
+					S("Could not find texture \"@1\". Using a dummy material instead.", texName))
 			matFile:write(string.format("Kd %f %f %f\n", math.random(), math.random(), math.random()))
 		end
 	end

utils.lua

@@ -17,6 +17,8 @@
 	along with Meshport. If not, see <https://www.gnu.org/licenses/>.
 ]]
 
+local S = meshport.S
+
 meshport.NEIGHBOR_DIRS = {
 	-- face neighbors
 	vector.new( 0, 1, 0), -- 1
@@ -111,9 +113,9 @@ function meshport.log(name, level, s)
 	if level == "info" then
 		message = minetest.colorize("#00EF00", s)
 	elseif level == "warning" then
-		message = minetest.colorize("#EFEF00", "Warning: " .. s)
+		message = minetest.colorize("#EFEF00", S("Warning: @1", s))
 	elseif level == "error" then
-		message = minetest.colorize("#EF0000", "Error: " .. s)
+		message = minetest.colorize("#EF0000", S("Error: @1", s))
 	end
 
 	minetest.chat_send_player(name, "[meshport] " .. message)
@@ -378,13 +380,13 @@ function meshport.get_asset_paths(assetFolderName, extension)
 
 	-- Iterate through each enabled mod.
 	for _, modName in ipairs(minetest.get_modnames()) do
-		modAssetPath = minetest.get_modpath(modName) .. DIR_DELIM .. assetFolderName
+		modAssetPath = minetest.get_modpath(modName) .. "/" .. assetFolderName
 
 		-- Iterate through all the files in the requested folder of the mod.
 		for _, fileName in ipairs(minetest.get_dir_list(modAssetPath, false)) do
 			-- Add files to the table. If an extension is specified, only add files with that extension.
 			if not extension or string.lower(string.sub(fileName, -string.len(extension))) == extension then
-				assets[fileName] = modAssetPath .. DIR_DELIM .. fileName
+				assets[fileName] = modAssetPath .. "/" .. fileName
 			end
 		end
 	end