2 -- This file contains built-in stuff in Minetest implemented in Lua.
4 -- It is always loaded and executed after registration of the C API,
5 -- before loading and running any mods.
9 -- Override some Lua library functions
12 print = minetest.debug
15 -- Define some random basic things
18 function basic_dump2(o)
19 if type(o) == "number" then
21 elseif type(o) == "string" then
22 return string.format("%q", o)
23 elseif type(o) == "boolean" then
25 elseif type(o) == "function" then
27 elseif type(o) == "userdata" then
29 elseif type(o) == "nil" then
32 error("cannot dump a " .. type(o))
37 function dump2(o, name, dumped)
41 if type(o) == "number" or type(o) == "string" or type(o) == "boolean"
42 or type(o) == "function" or type(o) == "nil"
43 or type(o) == "userdata" then
44 io.write(basic_dump2(o), "\n")
45 elseif type(o) == "table" then
47 io.write(dumped[o], "\n")
50 io.write("{}\n") -- new table
51 for k,v in pairs(o) do
52 local fieldname = string.format("%s[%s]", name, basic_dump2(k))
53 dump2(v, fieldname, dumped)
57 error("cannot dump a " .. type(o))
62 function dump(o, dumped)
64 if type(o) == "number" then
66 elseif type(o) == "string" then
67 return string.format("%q", o)
68 elseif type(o) == "table" then
70 return "<circular reference>"
74 for k,v in pairs(o) do
75 t[#t+1] = "" .. k .. " = " .. dump(v, dumped)
77 return "{" .. table.concat(t, ", ") .. "}"
78 elseif type(o) == "boolean" then
80 elseif type(o) == "function" then
82 elseif type(o) == "userdata" then
84 elseif type(o) == "nil" then
87 error("cannot dump a " .. type(o))
92 function string:split(sep)
93 local sep, fields = sep or ",", {}
94 local pattern = string.format("([^%s]+)", sep)
95 self:gsub(pattern, function(c) fields[#fields+1] = c end)
99 function string:trim()
100 return (self:gsub("^%s*(.-)%s*$", "%1"))
103 assert(string.trim("\n \t\tfoo bar\t ") == "foo bar")
105 function minetest.pos_to_string(pos)
106 return "(" .. pos.x .. "," .. pos.y .. "," .. pos.z .. ")"
110 -- Item definition helpers
113 function minetest.inventorycube(img1, img2, img3)
116 return "[inventorycube"
117 .. "{" .. img1:gsub("%^", "&")
118 .. "{" .. img2:gsub("%^", "&")
119 .. "{" .. img3:gsub("%^", "&")
122 function minetest.get_pointed_thing_position(pointed_thing, above)
123 if pointed_thing.type == "node" then
125 -- The position where a node would be placed
126 return pointed_thing.above
128 -- The position where a node would be dug
129 return pointed_thing.under
131 elseif pointed_thing.type == "object" then
132 obj = pointed_thing.ref
143 function minetest.dir_to_facedir(dir)
144 if math.abs(dir.x) > math.abs(dir.z) then
159 function minetest.dir_to_wallmounted(dir)
160 if math.abs(dir.y) > math.max(math.abs(dir.x), math.abs(dir.z)) then
166 elseif math.abs(dir.x) > math.abs(dir.z) then
181 function minetest.get_node_drops(nodename, toolname)
182 local drop = ItemStack({name=nodename}):get_definition().drop
185 return {ItemStack({name=nodename})}
186 elseif type(drop) == "string" then
188 return {ItemStack(drop)}
189 elseif drop.items == nil then
190 -- drop = {} to disable default drop
194 -- Extended drop table
198 for _, item in ipairs(drop.items) do
199 local good_rarity = true
200 local good_tool = true
201 if item.rarity ~= nil then
202 good_rarity = item.rarity < 1 or math.random(item.rarity) == 1
204 if item.tools ~= nil then
206 for _, tool in ipairs(item.tools) do
207 if tool:sub(1, 1) == '~' then
208 good_tool = toolname:find(tool:sub(2)) ~= nil
210 good_tool = toolname == tool
217 if good_rarity and good_tool then
218 got_count = got_count + 1
219 for _, add_item in ipairs(item.items) do
220 got_items[#got_items+1] = add_item
222 if drop.max_items ~= nil and got_count == drop.max_items then
230 function minetest.item_place_node(itemstack, placer, pointed_thing)
231 local item = itemstack:peek_item()
232 local def = itemstack:get_definition()
233 if def.type == "node" and pointed_thing.type == "node" then
234 local pos = pointed_thing.above
235 local oldnode = minetest.env:get_node(pos)
236 local olddef = ItemStack({name=oldnode.name}):get_definition()
238 if not olddef.buildable_to then
239 minetest.log("info", placer:get_player_name() .. " tried to place"
240 .. " node in invalid position " .. minetest.pos_to_string(pos)
241 .. ", replacing " .. oldnode.name)
245 minetest.log("action", placer:get_player_name() .. " places node "
246 .. def.name .. " at " .. minetest.pos_to_string(pos))
248 local newnode = {name = def.name, param1 = 0, param2 = 0}
250 -- Calculate direction for wall mounted stuff like torches and signs
251 if def.paramtype2 == 'wallmounted' then
252 local under = pointed_thing.under
253 local above = pointed_thing.above
254 local dir = {x = under.x - above.x, y = under.y - above.y, z = under.z - above.z}
255 newnode.param2 = minetest.dir_to_wallmounted(dir)
256 -- Calculate the direction for furnaces and chests and stuff
257 elseif def.paramtype2 == 'facedir' then
258 local playerpos = placer:getpos()
259 local dir = {x = pos.x - playerpos.x, y = pos.y - playerpos.y, z = pos.z - playerpos.z}
260 newnode.param2 = minetest.dir_to_facedir(dir)
261 minetest.log("action", "facedir: " .. newnode.param2)
264 -- Add node and update
265 minetest.env:add_node(pos, newnode)
267 -- Set metadata owner
268 if def.metadata_name ~= "" then
269 minetest.env:get_meta(pos):set_owner(placer:get_player_name())
274 for _, callback in ipairs(minetest.registered_on_placenodes) do
275 callback(pos, newnode, placer)
278 itemstack:take_item()
283 function minetest.item_place_object(itemstack, placer, pointed_thing)
284 local pos = minetest.get_pointed_thing_position(pointed_thing, true)
286 local item = itemstack:take_item()
287 minetest.env:add_item(pos, item)
292 function minetest.item_place(itemstack, placer, pointed_thing)
293 if itemstack:get_definition().type == "node" then
294 return minetest.item_place_node(itemstack, placer, pointed_thing)
296 return minetest.item_place_object(itemstack, placer, pointed_thing)
300 function minetest.item_drop(itemstack, dropper, pos)
301 minetest.env:add_item(pos, itemstack)
305 function minetest.item_eat(hp_change, replace_with_item)
306 return function(itemstack, user, pointed_thing) -- closure
307 if itemstack:take_item() ~= nil then
308 user:set_hp(user:get_hp() + hp_change)
309 itemstack:add_item(replace_with_item) -- note: replace_with_item is optional
315 function minetest.node_punch(pos, node, puncher)
318 for _, callback in ipairs(minetest.registered_on_punchnodes) do
319 callback(pos, node, puncher)
324 function minetest.node_dig(pos, node, digger)
325 minetest.debug("node_dig")
327 local def = ItemStack({name=node.name}):get_definition()
328 if not def.diggable then
329 minetest.debug("not diggable")
330 minetest.log("info", digger:get_player_name() .. " tried to dig "
331 .. node.name .. " which is not diggable "
332 .. minetest.pos_to_string(pos))
336 local meta = minetest.env:get_meta(pos)
337 if meta ~= nil and not meta:get_allow_removal() then
338 minetest.debug("dig prevented by metadata")
339 minetest.log("info", digger:get_player_name() .. " tried to dig "
340 .. node.name .. ", but removal is disabled by metadata "
341 .. minetest.pos_to_string(pos))
345 minetest.log('action', digger:get_player_name() .. " digs "
346 .. node.name .. " at " .. minetest.pos_to_string(pos))
348 if not minetest.setting_getbool("creative_mode") then
349 local wielded = digger:get_wielded_item()
350 local drops = minetest.get_node_drops(node.name, wielded:get_name())
353 tp = wielded:get_tool_capabilities()
354 dp = minetest.get_dig_params(def.groups, tp)
355 wielded:add_wear(dp.wear)
356 digger:set_wielded_item(wielded)
359 local _, dropped_item
360 for _, dropped_item in ipairs(drops) do
361 digger:get_inventory():add_item("main", dropped_item)
365 -- Remove node and update
366 minetest.env:remove_node(pos)
370 for _, callback in ipairs(minetest.registered_on_dignodes) do
371 callback(pos, node, digger)
376 -- Item definition defaults
379 minetest.nodedef_default = {
382 -- name intentionally not defined here
385 inventory_image = "",
387 wield_scale = {x=1,y=1,z=1},
390 liquids_pointable = false,
391 tool_capabilities = nil,
393 -- Interaction callbacks
394 on_place = minetest.item_place,
395 on_drop = minetest.item_drop,
398 on_punch = minetest.node_punch,
399 on_dig = minetest.node_dig,
405 special_materials = {
406 {image="", backface_culling=true},
407 {image="", backface_culling=true},
410 post_effect_color = {a=0, r=0, g=0, b=0},
413 is_ground_content = false,
414 sunlight_propagates = false,
419 buildable_to = false,
422 liquid_alternative_flowing = "",
423 liquid_alternative_source = "",
424 liquid_viscosity = 0,
426 damage_per_second = 0,
427 selection_box = {type="regular"},
428 legacy_facedir_simple = false,
429 legacy_wallmounted = false,
432 minetest.craftitemdef_default = {
434 -- name intentionally not defined here
437 inventory_image = "",
439 wield_scale = {x=1,y=1,z=1},
441 liquids_pointable = false,
442 tool_capabilities = nil,
444 -- Interaction callbacks
445 on_place = minetest.item_place,
446 on_drop = minetest.item_drop,
450 minetest.tooldef_default = {
452 -- name intentionally not defined here
455 inventory_image = "",
457 wield_scale = {x=1,y=1,z=1},
459 liquids_pointable = false,
460 tool_capabilities = nil,
462 -- Interaction callbacks
463 on_place = minetest.item_place,
464 on_drop = minetest.item_drop,
468 minetest.noneitemdef_default = { -- This is used for the hand and unknown items
470 -- name intentionally not defined here
473 inventory_image = "",
475 wield_scale = {x=1,y=1,z=1},
477 liquids_pointable = false,
478 tool_capabilities = nil,
480 -- Interaction callbacks
487 -- Make raw registration functions inaccessible to anyone except builtin.lua
490 local register_item_raw = minetest.register_item_raw
491 minetest.register_item_raw = nil
493 local register_alias_raw = minetest.register_alias_raw
494 minetest.register_item_raw = nil
497 -- Item / entity / ABM registration functions
500 minetest.registered_abms = {}
501 minetest.registered_entities = {}
502 minetest.registered_items = {}
503 minetest.registered_nodes = {}
504 minetest.registered_craftitems = {}
505 minetest.registered_tools = {}
506 minetest.registered_aliases = {}
508 -- For tables that are indexed by item name:
509 -- If table[X] does not exist, default to table[minetest.registered_aliases[X]]
510 local function set_alias_metatable(table)
511 setmetatable(table, {
512 __index = function(name)
513 return rawget(table, minetest.registered_aliases[name])
517 set_alias_metatable(minetest.registered_items)
518 set_alias_metatable(minetest.registered_nodes)
519 set_alias_metatable(minetest.registered_craftitems)
520 set_alias_metatable(minetest.registered_tools)
522 -- These item names may not be used because they would interfere
523 -- with legacy itemstrings
524 local forbidden_item_names = {
526 MaterialItem2 = true,
527 MaterialItem3 = true,
537 local function check_modname_prefix(name)
538 if name:sub(1,1) == ":" then
539 -- Escape the modname prefix enforcement mechanism
542 -- Modname prefix enforcement
543 local expected_prefix = minetest.get_current_modname() .. ":"
544 if name:sub(1, #expected_prefix) ~= expected_prefix then
545 error("Name " .. name .. " does not follow naming conventions: " ..
546 "\"modname:\" or \":\" prefix required")
548 local subname = name:sub(#expected_prefix+1)
549 if subname:find("[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_]") then
550 error("Name " .. name .. " does not follow naming conventions: " ..
551 "contains unallowed characters")
557 function minetest.register_abm(spec)
558 -- Add to minetest.registered_abms
559 minetest.registered_abms[#minetest.registered_abms+1] = spec
562 function minetest.register_entity(name, prototype)
565 error("Unable to register entity: Name is nil")
567 name = check_modname_prefix(tostring(name))
569 prototype.name = name
570 prototype.__index = prototype -- so that it can be used as a metatable
572 -- Add to minetest.registered_entities
573 minetest.registered_entities[name] = prototype
576 function minetest.register_item(name, itemdef)
579 error("Unable to register item: Name is nil")
581 name = check_modname_prefix(tostring(name))
582 if forbidden_item_names[name] then
583 error("Unable to register item: Name is forbidden: " .. name)
587 -- Apply defaults and add to registered_* table
588 if itemdef.type == "node" then
589 setmetatable(itemdef, {__index = minetest.nodedef_default})
590 minetest.registered_nodes[itemdef.name] = itemdef
591 elseif itemdef.type == "craft" then
592 setmetatable(itemdef, {__index = minetest.craftitemdef_default})
593 minetest.registered_craftitems[itemdef.name] = itemdef
594 elseif itemdef.type == "tool" then
595 setmetatable(itemdef, {__index = minetest.tooldef_default})
596 minetest.registered_tools[itemdef.name] = itemdef
597 elseif itemdef.type == "none" then
598 setmetatable(itemdef, {__index = minetest.noneitemdef_default})
600 error("Unable to register item: Type is invalid: " .. dump(itemdef))
603 -- Flowing liquid uses param2
604 if itemdef.type == "node" and itemdef.liquidtype == "flowing" then
605 itemdef.paramtype2 = "flowingliquid"
608 -- BEGIN Legacy stuff
609 if itemdef.cookresult_itemstring ~= nil and itemdef.cookresult_itemstring ~= "" then
610 minetest.register_craft({
612 output=itemdef.cookresult_itemstring,
614 cooktime=itemdef.furnace_cooktime
617 if itemdef.furnace_burntime ~= nil and itemdef.furnace_burntime >= 0 then
618 minetest.register_craft({
621 burntime=itemdef.furnace_burntime
626 -- Disable all further modifications
627 getmetatable(itemdef).__newindex = {}
629 --minetest.log("Registering item: " .. itemdef.name)
630 minetest.registered_items[itemdef.name] = itemdef
631 minetest.registered_aliases[itemdef.name] = nil
632 register_item_raw(itemdef)
635 function minetest.register_node(name, nodedef)
636 nodedef.type = "node"
637 minetest.register_item(name, nodedef)
640 function minetest.register_craftitem(name, craftitemdef)
641 craftitemdef.type = "craft"
643 -- BEGIN Legacy stuff
644 if craftitemdef.inventory_image == nil and craftitemdef.image ~= nil then
645 craftitemdef.inventory_image = craftitemdef.image
649 minetest.register_item(name, craftitemdef)
652 function minetest.register_tool(name, tooldef)
653 tooldef.type = "tool"
654 tooldef.stack_max = 1
656 -- BEGIN Legacy stuff
657 if tooldef.inventory_image == nil and tooldef.image ~= nil then
658 tooldef.inventory_image = tooldef.image
660 if tooldef.tool_capabilities == nil and
661 (tooldef.full_punch_interval ~= nil or
662 tooldef.basetime ~= nil or
663 tooldef.dt_weight ~= nil or
664 tooldef.dt_crackiness ~= nil or
665 tooldef.dt_crumbliness ~= nil or
666 tooldef.dt_cuttability ~= nil or
667 tooldef.basedurability ~= nil or
668 tooldef.dd_weight ~= nil or
669 tooldef.dd_crackiness ~= nil or
670 tooldef.dd_crumbliness ~= nil or
671 tooldef.dd_cuttability ~= nil) then
672 tooldef.tool_capabilities = {
673 full_punch_interval = tooldef.full_punch_interval,
674 basetime = tooldef.basetime,
675 dt_weight = tooldef.dt_weight,
676 dt_crackiness = tooldef.dt_crackiness,
677 dt_crumbliness = tooldef.dt_crumbliness,
678 dt_cuttability = tooldef.dt_cuttability,
679 basedurability = tooldef.basedurability,
680 dd_weight = tooldef.dd_weight,
681 dd_crackiness = tooldef.dd_crackiness,
682 dd_crumbliness = tooldef.dd_crumbliness,
683 dd_cuttability = tooldef.dd_cuttability,
688 minetest.register_item(name, tooldef)
691 function minetest.register_alias(name, convert_to)
692 if forbidden_item_names[name] then
693 error("Unable to register alias: Name is forbidden: " .. name)
695 if minetest.registered_items[name] ~= nil then
696 minetest.log("WARNING: Not registering alias, item with same name" ..
697 " is already defined: " .. name .. " -> " .. convert_to)
699 --minetest.log("Registering alias: " .. name .. " -> " .. convert_to)
700 minetest.registered_aliases[name] = convert_to
701 register_alias_raw(name, convert_to)
705 -- Alias the forbidden item names to "" so they can't be
706 -- created via itemstrings (e.g. /give)
708 for name in pairs(forbidden_item_names) do
709 minetest.registered_aliases[name] = ""
710 register_alias_raw(name, "")
715 -- Aliases for minetest.register_alias (how ironic...)
716 --minetest.alias_node = minetest.register_alias
717 --minetest.alias_tool = minetest.register_alias
718 --minetest.alias_craftitem = minetest.register_alias
721 -- Built-in node definitions. Also defined in C.
724 minetest.register_item(":unknown", {
726 description = "Unknown Item",
727 inventory_image = "unknown_item.png",
728 on_place = minetest.item_place,
729 on_drop = minetest.item_drop,
732 minetest.register_node(":air", {
733 description = "Air (you hacker you!)",
734 inventory_image = "unknown_block.png",
735 wield_image = "unknown_block.png",
736 drawtype = "airlike",
738 sunlight_propagates = true,
743 air_equivalent = true,
746 minetest.register_node(":ignore", {
747 description = "Ignore (you hacker you!)",
748 inventory_image = "unknown_block.png",
749 wield_image = "unknown_block.png",
750 drawtype = "airlike",
752 sunlight_propagates = false,
756 buildable_to = true, -- A way to remove accidentally placed ignores
757 air_equivalent = true,
760 -- The hand (bare definition)
761 minetest.register_item(":", {
766 -- Default material types
768 function digprop_err()
769 minetest.log("info", debug.traceback())
770 minetest.log("info", "WARNING: The minetest.digprop_* functions are obsolete and need to be replaced by item groups.")
773 minetest.digprop_constanttime = digprop_err
774 minetest.digprop_stonelike = digprop_err
775 minetest.digprop_dirtlike = digprop_err
776 minetest.digprop_gravellike = digprop_err
777 minetest.digprop_woodlike = digprop_err
778 minetest.digprop_leaveslike = digprop_err
779 minetest.digprop_glasslike = digprop_err
782 -- Creative inventory
785 minetest.creative_inventory = {}
787 minetest.add_to_creative_inventory = function(itemstring)
788 table.insert(minetest.creative_inventory, itemstring)
792 -- Callback registration
795 local function make_registration()
797 local registerfunc = function(func) table.insert(t, func) end
798 return t, registerfunc
801 minetest.registered_on_chat_messages, minetest.register_on_chat_message = make_registration()
802 minetest.registered_globalsteps, minetest.register_globalstep = make_registration()
803 minetest.registered_on_placenodes, minetest.register_on_placenode = make_registration()
804 minetest.registered_on_dignodes, minetest.register_on_dignode = make_registration()
805 minetest.registered_on_punchnodes, minetest.register_on_punchnode = make_registration()
806 minetest.registered_on_generateds, minetest.register_on_generated = make_registration()
807 minetest.registered_on_newplayers, minetest.register_on_newplayer = make_registration()
808 minetest.registered_on_dieplayers, minetest.register_on_dieplayer = make_registration()
809 minetest.registered_on_respawnplayers, minetest.register_on_respawnplayer = make_registration()
810 minetest.registered_on_joinplayers, minetest.register_on_joinplayer = make_registration()
811 minetest.registered_on_leaveplayers, minetest.register_on_leaveplayer = make_registration()
814 -- Misc. API functions
817 minetest.timers_to_add = {}
819 minetest.register_globalstep(function(dtime)
820 for _, timer in ipairs(minetest.timers_to_add) do
821 table.insert(minetest.timers, timer)
823 minetest.timers_to_add = {}
824 for index, timer in ipairs(minetest.timers) do
825 timer.time = timer.time - dtime
826 if timer.time <= 0 then
827 timer.func(timer.param)
828 table.remove(minetest.timers,index)
833 function minetest.after(time, func, param)
834 table.insert(minetest.timers_to_add, {time=time, func=func, param=param})
837 function minetest.check_player_privs(name, privs)
838 local player_privs = minetest.get_player_privs(name)
839 local missing_privileges = {}
840 for priv, val in pairs(privs) do
842 if not player_privs[priv] then
843 table.insert(missing_privileges, priv)
847 if #missing_privileges > 0 then
848 return false, missing_privileges
853 function minetest.get_connected_players()
854 -- This could be optimized a bit, but leave that for later
856 for _, obj in pairs(minetest.env:get_objects_inside_radius({x=0,y=0,z=0}, 1000000)) do
857 if obj:get_player_name() then
858 table.insert(list, obj)
864 function minetest.hash_node_position(pos)
865 return (pos.z+32768)*65536*65536 + (pos.y+32768)*65536 + pos.x+32768
872 minetest.registered_privileges = {}
874 function minetest.register_privilege(name, param)
875 local function fill_defaults(def)
876 if def.give_to_singleplayer == nil then
877 def.give_to_singleplayer = true
879 if def.description == nil then
880 def.description = "(no description)"
884 if type(param) == "table" then
887 def = {description = param}
890 minetest.registered_privileges[name] = def
893 minetest.register_privilege("interact", "Can interact with things and modify the world")
894 minetest.register_privilege("teleport", "Can use /teleport command")
895 minetest.register_privilege("bring", "Can teleport other players")
896 minetest.register_privilege("settime", "Can use /time")
897 minetest.register_privilege("privs", "Can modify privileges")
898 minetest.register_privilege("server", "Can do server maintenance stuff")
899 minetest.register_privilege("shout", "Can speak in chat")
900 minetest.register_privilege("ban", "Can ban and unban players")
901 minetest.register_privilege("give", "Can use /give and /giveme")
902 minetest.register_privilege("password", "Can use /setpassword and /clearpassword")
903 minetest.register_privilege("fly", {
904 description = "Can fly using the free_move mode",
905 give_to_singleplayer = false,
907 minetest.register_privilege("fast", {
908 description = "Can walk fast using the fast_move mode",
909 give_to_singleplayer = false,
916 minetest.chatcommands = {}
917 function minetest.register_chatcommand(cmd, def)
919 def.params = def.params or ""
920 def.description = def.description or ""
921 def.privs = def.privs or {}
922 minetest.chatcommands[cmd] = def
925 -- Register the help command
926 minetest.register_chatcommand("help", {
928 params = "(nothing)/all/privs/<cmd>",
929 description = "Get help for commands or list privileges",
930 func = function(name, param)
931 local format_help_line = function(cmd, def)
933 if def.params and def.params ~= "" then msg = msg .. " " .. def.params end
934 if def.description and def.description ~= "" then msg = msg .. ": " .. def.description end
940 for cmd, def in pairs(minetest.chatcommands) do
941 if minetest.check_player_privs(name, def.privs) then
942 table.insert(cmds, cmd)
945 minetest.chat_send_player(name, "Available commands: "..table.concat(cmds, " "))
946 minetest.chat_send_player(name, "Use '/help <cmd>' to get more information, or '/help all' to list everything.")
947 elseif param == "all" then
948 minetest.chat_send_player(name, "Available commands:")
949 for cmd, def in pairs(minetest.chatcommands) do
950 if minetest.check_player_privs(name, def.privs) then
951 minetest.chat_send_player(name, format_help_line(cmd, def))
954 elseif param == "privs" then
955 minetest.chat_send_player(name, "Available privileges:")
956 for priv, def in pairs(minetest.registered_privileges) do
957 minetest.chat_send_player(name, priv..": "..def.description)
961 def = minetest.chatcommands[cmd]
963 minetest.chat_send_player(name, "Command not available: "..cmd)
965 minetest.chat_send_player(name, format_help_line(cmd, def))
971 -- Register C++ commands without functions
972 minetest.register_chatcommand("me", {params = nil, description = "chat action (eg. /me orders a pizza)"})
973 minetest.register_chatcommand("status", {description = "print server status line"})
974 minetest.register_chatcommand("shutdown", {params = "", description = "shutdown server", privs = {server=true}})
975 minetest.register_chatcommand("setting", {params = "<name> = <value>", description = "set line in configuration file", privs = {server=true}})
976 minetest.register_chatcommand("clearobjects", {params = "", description = "clear all objects in world", privs = {server=true}})
977 minetest.register_chatcommand("time", {params = "<0...24000>", description = "set time of day", privs = {settime=true}})
978 minetest.register_chatcommand("ban", {params = "<name>", description = "ban IP of player", privs = {ban=true}})
979 minetest.register_chatcommand("unban", {params = "<name/ip>", description = "remove IP ban", privs = {ban=true}})
981 -- Register some other commands
982 minetest.register_chatcommand("privs", {
984 description = "print out privileges of player",
985 func = function(name, param)
989 if not minetest.check_player_privs(name, {privs=true}) then
990 minetest.chat_send_player(name, "Privileges of "..param.." are hidden from you.")
993 minetest.chat_send_player(name, "Privileges of "..param..": "..minetest.privs_to_string(minetest.get_player_privs(param), ' '))
996 minetest.register_chatcommand("grant", {
997 params = "<name> <privilege>",
998 description = "Give privilege to player",
999 privs = {privs=true},
1000 func = function(name, param)
1001 local grantname, grantprivstr = string.match(param, "([^ ]+) (.+)")
1002 if not grantname or not grantprivstr then
1003 minetest.chat_send_player(name, "Invalid parameters (see /help grant)")
1006 local grantprivs = minetest.string_to_privs(grantprivstr)
1007 local privs = minetest.get_player_privs(grantname)
1008 for priv, _ in pairs(grantprivs) do
1011 minetest.set_player_privs(grantname, privs)
1012 minetest.chat_send_player(name, "Privileges of "..grantname..": "..minetest.privs_to_string(minetest.get_player_privs(grantname), ' '))
1013 if grantname ~= name then
1014 minetest.chat_send_player(grantname, name.." granted you privileges: "..minetest.privs_to_string(grantprivs, ' '))
1018 minetest.register_chatcommand("revoke", {
1019 params = "<name> <privilege>",
1020 description = "Remove privilege from player",
1021 privs = {privs=true},
1022 func = function(name, param)
1023 local revokename, revokeprivstr = string.match(param, "([^ ]+) (.+)")
1024 if not revokename or not revokeprivstr then
1025 minetest.chat_send_player(name, "Invalid parameters (see /help revoke)")
1028 local revokeprivs = minetest.string_to_privs(revokeprivstr)
1029 local privs = minetest.get_player_privs(revokename)
1030 for priv, _ in pairs(revokeprivs) do
1033 minetest.set_player_privs(revokename, privs)
1034 minetest.chat_send_player(name, "Privileges of "..revokename..": "..minetest.privs_to_string(minetest.get_player_privs(revokename), ' '))
1035 if revokename ~= name then
1036 minetest.chat_send_player(revokename, name.." revoked privileges from you: "..minetest.privs_to_string(revokeprivs, ' '))
1040 minetest.register_chatcommand("setpassword", {
1041 params = "<name> <password>",
1042 description = "set given password",
1043 privs = {password=true},
1044 func = function(name, param)
1046 minetest.chat_send_player(name, "Password field required")
1049 minetest.set_player_password(name, param)
1050 minetest.chat_send_player(name, "Password set")
1053 minetest.register_chatcommand("clearpassword", {
1055 description = "set empty password",
1056 privs = {password=true},
1057 func = function(name, param)
1058 minetest.set_player_password(name, '')
1059 minetest.chat_send_player(name, "Password cleared")
1063 minetest.register_chatcommand("auth_reload", {
1065 description = "reload authentication data",
1066 privs = {server=true},
1067 func = function(name, param)
1068 local done = minetest.auth_reload()
1070 minetest.chat_send_player(name, "Done.")
1072 minetest.chat_send_player(name, "Failed.")
1077 minetest.register_chatcommand("teleport", {
1078 params = "<X>,<Y>,<Z> | <to_name> | <name> <X>,<Y>,<Z> | <name> <to_name>",
1079 description = "teleport to given position",
1080 privs = {teleport=true},
1081 func = function(name, param)
1082 -- Returns (pos, true) if found, otherwise (pos, false)
1083 local function find_free_position_near(pos)
1090 for _, d in ipairs(tries) do
1091 local p = {x = pos.x+d.x, y = pos.y+d.y, z = pos.z+d.z}
1092 local n = minetest.env:get_node(p)
1093 if not minetest.registered_nodes[n.name].walkable then
1100 local teleportee = nil
1102 p.x, p.y, p.z = string.match(param, "^([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
1103 teleportee = minetest.env:get_player_by_name(name)
1104 if teleportee and p.x and p.y and p.z then
1105 minetest.chat_send_player(name, "Teleporting to ("..p.x..", "..p.y..", "..p.z..")")
1106 teleportee:setpos(p)
1110 local teleportee = nil
1112 local target_name = nil
1113 target_name = string.match(param, "^([^ ]+)$")
1114 teleportee = minetest.env:get_player_by_name(name)
1116 local target = minetest.env:get_player_by_name(target_name)
1121 if teleportee and p then
1122 p = find_free_position_near(p)
1123 minetest.chat_send_player(name, "Teleporting to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
1124 teleportee:setpos(p)
1128 if minetest.check_player_privs(name, {bring=true}) then
1129 local teleportee = nil
1131 local teleportee_name = nil
1132 teleportee_name, p.x, p.y, p.z = string.match(param, "^([^ ]+) +([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
1133 if teleportee_name then
1134 teleportee = minetest.env:get_player_by_name(teleportee_name)
1136 if teleportee and p.x and p.y and p.z then
1137 minetest.chat_send_player(name, "Teleporting "..teleportee_name.." to ("..p.x..", "..p.y..", "..p.z..")")
1138 teleportee:setpos(p)
1142 local teleportee = nil
1144 local teleportee_name = nil
1145 local target_name = nil
1146 teleportee_name, target_name = string.match(param, "^([^ ]+) +([^ ]+)$")
1147 if teleportee_name then
1148 teleportee = minetest.env:get_player_by_name(teleportee_name)
1151 local target = minetest.env:get_player_by_name(target_name)
1156 if teleportee and p then
1157 p = find_free_position_near(p)
1158 minetest.chat_send_player(name, "Teleporting "..teleportee_name.." to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
1159 teleportee:setpos(p)
1164 minetest.chat_send_player(name, "Invalid parameters (\""..param.."\") or player not found (see /help teleport)")
1170 -- Builtin chat handler
1173 minetest.register_on_chat_message(function(name, message)
1174 local cmd, param = string.match(message, "/([^ ]+) *(.*)")
1178 local cmd_def = minetest.chatcommands[cmd]
1180 if not cmd_def.func then
1181 -- This is a C++ command
1184 local has_privs, missing_privs = minetest.check_player_privs(name, cmd_def.privs)
1186 cmd_def.func(name, param)
1188 minetest.chat_send_player(name, "You don't have permission to run this command (missing privileges: "..table.concat(missing_privs, ", ")..")")
1190 return true -- handled chat message
1197 -- Authentication handler
1200 function minetest.string_to_privs(str, delim)
1201 assert(type(str) == "string")
1202 delim = delim or ','
1204 for _, priv in pairs(string.split(str, delim)) do
1205 privs[priv:trim()] = true
1210 function minetest.privs_to_string(privs, delim)
1211 assert(type(privs) == "table")
1212 delim = delim or ','
1214 for priv, bool in pairs(privs) do
1216 table.insert(list, priv)
1219 return table.concat(list, delim)
1222 assert(minetest.string_to_privs("a,b").b == true)
1223 assert(minetest.privs_to_string({a=true,b=true}) == "a,b")
1225 minetest.auth_file_path = minetest.get_worldpath().."/auth.txt"
1226 minetest.auth_table = {}
1228 local function read_auth_file()
1230 local file, errmsg = io.open(minetest.auth_file_path, 'rb')
1232 minetest.log("info", minetest.auth_file_path.." could not be opened for reading ("..errmsg.."); assuming new world")
1235 for line in file:lines() do
1237 local name, password, privilegestring = string.match(line, "([^:]*):([^:]*):([^:]*)")
1238 if not name or not password or not privilegestring then
1239 error("Invalid line in auth.txt: "..dump(line))
1241 local privileges = minetest.string_to_privs(privilegestring)
1242 newtable[name] = {password=password, privileges=privileges}
1246 minetest.auth_table = newtable
1247 minetest.notify_authentication_modified()
1250 local function save_auth_file()
1252 -- Check table for validness before attempting to save
1253 for name, stuff in pairs(minetest.auth_table) do
1254 assert(type(name) == "string")
1256 assert(type(stuff) == "table")
1257 assert(type(stuff.password) == "string")
1258 assert(type(stuff.privileges) == "table")
1260 local file, errmsg = io.open(minetest.auth_file_path, 'w+b')
1262 error(minetest.auth_file_path.." could not be opened for writing: "..errmsg)
1264 for name, stuff in pairs(minetest.auth_table) do
1265 local privstring = minetest.privs_to_string(stuff.privileges)
1266 file:write(name..":"..stuff.password..":"..privstring..'\n')
1273 minetest.builtin_auth_handler = {
1274 get_auth = function(name)
1275 assert(type(name) == "string")
1276 -- Figure out what password to use for a new player (singleplayer
1277 -- always has an empty password, otherwise use default, which is
1278 -- usually empty too)
1279 local new_password_hash = ""
1280 if not minetest.is_singleplayer() then
1281 new_password_hash = minetest.get_password_hash(name, minetest.setting_get("default_password"))
1283 -- Add player to authentication table if not there already
1284 if not minetest.auth_table[name] then
1285 minetest.builtin_auth_handler.create_auth(name, minetest.get_password_hash(name, minetest.setting_get("default_password")))
1287 -- Figure out what privileges the player should have.
1288 -- Take a copy of the privilege table
1289 local privileges = {}
1290 for priv, _ in pairs(minetest.auth_table[name].privileges) do
1291 privileges[priv] = true
1293 -- If singleplayer, give all privileges except those marked as give_to_singleplayer = false
1294 if minetest.is_singleplayer() then
1295 for priv, def in pairs(minetest.registered_privileges) do
1296 if def.give_to_singleplayer then
1297 privileges[priv] = true
1300 -- For the admin, give everything
1301 elseif name == minetest.setting_get("name") then
1302 for priv, def in pairs(minetest.registered_privileges) do
1303 privileges[priv] = true
1308 password = minetest.auth_table[name].password,
1309 privileges = privileges,
1312 create_auth = function(name, password)
1313 assert(type(name) == "string")
1314 assert(type(password) == "string")
1315 minetest.log('info', "Built-in authentication handler adding player '"..name.."'")
1316 minetest.auth_table[name] = {
1317 password = password,
1318 privileges = minetest.string_to_privs(minetest.setting_get("default_privs")),
1322 set_password = function(name, password)
1323 assert(type(name) == "string")
1324 assert(type(password) == "string")
1325 if not minetest.auth_table[name] then
1326 minetest.builtin_auth_handler.create_auth(name, password)
1328 minetest.log('info', "Built-in authentication handler setting password of player '"..name.."'")
1329 minetest.auth_table[name].password = password
1334 set_privileges = function(name, privileges)
1335 assert(type(name) == "string")
1336 assert(type(privileges) == "table")
1337 if not minetest.auth_table[name] then
1338 minetest.builtin_auth_handler.create_auth(name, minetest.get_password_hash(name, minetest.setting_get("default_password")))
1340 minetest.auth_table[name].privileges = privileges
1341 minetest.notify_authentication_modified(name)
1350 function minetest.register_authentication_handler(handler)
1351 if minetest.registered_auth_handler then
1352 error("Add-on authentication handler already registered by "..minetest.registered_auth_handler_modname)
1354 minetest.registered_auth_handler = handler
1355 minetest.registered_auth_handler_modname = minetest.get_current_modname()
1358 function minetest.get_auth_handler()
1359 if minetest.registered_auth_handler then
1360 return minetest.registered_auth_handler
1362 return minetest.builtin_auth_handler
1365 function minetest.set_player_password(name, password)
1366 if minetest.get_auth_handler().set_password then
1367 minetest.get_auth_handler().set_password(name, password)
1371 function minetest.set_player_privs(name, privs)
1372 if minetest.get_auth_handler().set_privileges then
1373 minetest.get_auth_handler().set_privileges(name, privs)
1377 function minetest.auth_reload()
1378 if minetest.get_auth_handler().reload then
1379 return minetest.get_auth_handler().reload()
1388 math.randomseed(os.time())