Include chatcommands, world to separate file, update LICENSE

Author: SX

LICENSE

@@ -1,6 +1,13 @@
-MIT License
+--
+-- MIT License for Mineunit main framework code.
+-- Applies to everything that is not covered with additional copyright notes.
+--
+-- Notes:
+-- MIT license might not apply to code in common, default or game subdirectories.
+-- See notes below MIT license, notes in source code and copyright notes for Minetest.
+--
 
-Copyright (c) 2020 Minetest mods
+Copyright (c) 2020 SX <50966843+S-S-X@users.noreply.github.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +26,28 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+--
+-- Minetest LGPLv2.1 license contents
+--
+
+Minetest
+Copyright (C) 2010-2018 celeron55, Perttu Ahola <celeron55@gmail.com>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation; either version 2.1 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+--
+-- Additional licenses apply, see source files for more information.
+--

common/chatcommands.lua

@@ -0,0 +1,112 @@
+-- Minetest: builtin/common/chatcommands.lua
+
+core.registered_chatcommands = {}
+
+function core.register_chatcommand(cmd, def)
+	def = def or {}
+	def.params = def.params or ""
+	def.description = def.description or ""
+	def.privs = def.privs or {}
+	def.mod_origin = core.get_current_modname() or "??"
+	core.registered_chatcommands[cmd] = def
+end
+
+function core.unregister_chatcommand(name)
+	if core.registered_chatcommands[name] then
+		core.registered_chatcommands[name] = nil
+	else
+		core.log("warning", "Not unregistering chatcommand " ..name..
+			" because it doesn't exist.")
+	end
+end
+
+function core.override_chatcommand(name, redefinition)
+	local chatcommand = core.registered_chatcommands[name]
+	assert(chatcommand, "Attempt to override non-existent chatcommand "..name)
+	for k, v in pairs(redefinition) do
+		rawset(chatcommand, k, v)
+	end
+	core.registered_chatcommands[name] = chatcommand
+end
+
+local cmd_marker = "/"
+
+local function gettext(...)
+	return ...
+end
+
+local function gettext_replace(text, replace)
+	return text:gsub("$1", replace)
+end
+
+
+if INIT == "client" then
+	cmd_marker = "."
+	gettext = core.gettext
+	gettext_replace = fgettext_ne
+end
+
+local function do_help_cmd(name, param)
+	local function format_help_line(cmd, def)
+		local msg = core.colorize("#00ffff", cmd_marker .. cmd)
+		if def.params and def.params ~= "" then
+			msg = msg .. " " .. def.params
+		end
+		if def.description and def.description ~= "" then
+			msg = msg .. ": " .. def.description
+		end
+		return msg
+	end
+	if param == "" then
+		local cmds = {}
+		for cmd, def in pairs(core.registered_chatcommands) do
+			if INIT == "client" or core.check_player_privs(name, def.privs) then
+				cmds[#cmds + 1] = cmd
+			end
+		end
+		table.sort(cmds)
+		return true, gettext("Available commands: ") .. table.concat(cmds, " ") .. "\n"
+				.. gettext_replace("Use '$1help <cmd>' to get more information,"
+				.. " or '$1help all' to list everything.", cmd_marker)
+	elseif param == "all" then
+		local cmds = {}
+		for cmd, def in pairs(core.registered_chatcommands) do
+			if INIT == "client" or core.check_player_privs(name, def.privs) then
+				cmds[#cmds + 1] = format_help_line(cmd, def)
+			end
+		end
+		table.sort(cmds)
+		return true, gettext("Available commands:").."\n"..table.concat(cmds, "\n")
+	elseif INIT == "game" and param == "privs" then
+		local privs = {}
+		for priv, def in pairs(core.registered_privileges) do
+			privs[#privs + 1] = priv .. ": " .. def.description
+		end
+		table.sort(privs)
+		return true, "Available privileges:\n"..table.concat(privs, "\n")
+	else
+		local cmd = param
+		local def = core.registered_chatcommands[cmd]
+		if not def then
+			return false, gettext("Command not available: ")..cmd
+		else
+			return true, format_help_line(cmd, def)
+		end
+	end
+end
+
+if INIT == "client" then
+	core.register_chatcommand("help", {
+		params = gettext("[all | <cmd>]"),
+		description = gettext("Get help for commands"),
+		func = function(param)
+			return do_help_cmd(nil, param)
+		end,
+	})
+else
+	core.register_chatcommand("help", {
+		params = "[all | privs | <cmd>]",
+		description = "Get help for commands or list privileges",
+		func = do_help_cmd,
+	})
+end

core.lua

@@ -5,37 +5,7 @@ local noop_object = {
 	__index = function(...) return function(...)end end,
 }
 
-_G.world = { nodes = {} }
-local world = _G.world
-_G.world.set_node = function(pos, node)
-	local hash = minetest.hash_node_position(pos)
-	world.nodes[hash] = node
-	local nodedef = minetest.registered_nodes[node.name]
-	-- Execute on_construct callbacks
-	if nodedef and type(nodedef.on_construct) == "function" then
-		nodedef.on_construct(pos)
-	end
-end
-_G.world.clear = function() _G.world.nodes = {} end
-_G.world.layout = function(layout, offset)
-	_G.world.clear()
-	_G.world.add_layout(layout, offset)
-end
-_G.world.add_layout = function(layout, offset)
-	for _, node in ipairs(layout) do
-		local pos = {
-			x = node[1].x,
-			y = node[1].y,
-			z = node[1].z,
-		}
-		if offset then
-			pos.x = pos.x + offset.x
-			pos.y = pos.y + offset.y
-			pos.z = pos.z + offset.z
-		end
-		_G.world.set_node(pos, {name=node[2], param2=0})
-	end
-end
+_G.world = mineunit("world")
 
 _G.core.get_worldpath = function(...) return _G.mineunit:get_worldpath(...) end
 _G.core.get_modpath = function(...) return _G.mineunit:get_modpath(...) end

init.lua

@@ -42,11 +42,13 @@ mineunit.__index = mineunit
 local _mineunits = {}
 setmetatable(mineunit, {
 	__call = function(self, name)
+		local res
 		if not _mineunits[name] then
 			mineunit:debug("Loading mineunit module", name)
-			require("mineunit." .. name:gsub("/", "."))
+			res = require("mineunit." .. name:gsub("/", "."))
 		end
 		_mineunits[name] = true
+		return res
 	end,
 })
 

world.lua

@@ -0,0 +1,69 @@
+local world = {
+	nodes = {}
+}
+
+-- Helper to execute callbacks
+local function call(fn, ...)
+	if type(fn) == "function" then
+		return fn(...)
+	end
+end
+
+-- Static pointed_thing
+local function get_pointed_thing(pos, pointed_thing_type)
+	return {
+		type = pointed_thing_type or "node",
+		above = {x=pos.x,y=pos.y+1,z=pos.z}, -- Pointing from above to downwards,
+		under = {x=pos.x,y=pos.y,z=pos.z}, -- crosshair at protected node surface
+	}
+end
+
+-- set_node sets world node without callbacks
+function world.set_node(pos, node)
+	local hash = minetest.hash_node_position(pos)
+	world.nodes[hash] = node
+	local nodedef = minetest.registered_nodes[node.name]
+	if nodedef then
+		call(nodedef.on_construct, pos)
+	end
+end
+
+-- Called after constructing node when node was placed using
+-- minetest.item_place_node / minetest.place_node.
+-- If return true no item is taken from itemstack.
+function world.place_node(pos, node, placer, itemstack, pointed_thing)
+	world.set_node(pos, node)
+	local nodedef = minetest.registered_nodes[node.name]
+	if nodedef then
+		itemstack = itemstack or ItemStack(node.name .. " 1")
+		pointed_thing = pointed_thing or get_pointed_thing(pos)
+		call(nodedef.after_place_node, pos, placer, itemstack, pointed_thing)
+	end
+end
+
+function world.clear()
+	world.nodes = {}
+end
+
+function world.layout(layout, offset)
+	world.clear()
+	world.add_layout(layout, offset)
+end
+
+function world.add_layout(layout, offset)
+	for _, node in ipairs(layout) do
+		local pos = {
+			x = node[1].x,
+			y = node[1].y,
+			z = node[1].z,
+		}
+		if offset then
+			pos.x = pos.x + offset.x
+			pos.y = pos.y + offset.y
+			pos.z = pos.z + offset.z
+		end
+		_G.world.set_node(pos, {name=node[2], param2=0})
+	end
+end
+
+return world