1 -- Minetest: builtin/chatcommands.lua
4 -- Chat command handler
7 minetest.chatcommands = {}
8 function minetest.register_chatcommand(cmd, def)
10 def.params = def.params or ""
11 def.description = def.description or ""
12 def.privs = def.privs or {}
13 minetest.chatcommands[cmd] = def
16 minetest.register_on_chat_message(function(name, message)
17 local cmd, param = string.match(message, "^/([^ ]+) *(.*)")
21 local cmd_def = minetest.chatcommands[cmd]
23 local has_privs, missing_privs = minetest.check_player_privs(name, cmd_def.privs)
25 cmd_def.func(name, param)
27 minetest.chat_send_player(name, "You don't have permission to run this command (missing privileges: "..table.concat(missing_privs, ", ")..")")
29 return true -- handled chat message
37 minetest.register_chatcommand("me", {
39 description = "chat action (eg. /me orders a pizza)",
41 func = function(name, param)
42 minetest.chat_send_all("* " .. name .. " " .. param)
46 minetest.register_chatcommand("help", {
48 params = "(nothing)/all/privs/<cmd>",
49 description = "Get help for commands or list privileges",
50 func = function(name, param)
51 local format_help_line = function(cmd, def)
53 if def.params and def.params ~= "" then msg = msg .. " " .. def.params end
54 if def.description and def.description ~= "" then msg = msg .. ": " .. def.description end
60 for cmd, def in pairs(minetest.chatcommands) do
61 if minetest.check_player_privs(name, def.privs) then
62 table.insert(cmds, cmd)
65 minetest.chat_send_player(name, "Available commands: "..table.concat(cmds, " "))
66 minetest.chat_send_player(name, "Use '/help <cmd>' to get more information, or '/help all' to list everything.")
67 elseif param == "all" then
68 minetest.chat_send_player(name, "Available commands:")
69 for cmd, def in pairs(minetest.chatcommands) do
70 if minetest.check_player_privs(name, def.privs) then
71 minetest.chat_send_player(name, format_help_line(cmd, def))
74 elseif param == "privs" then
75 minetest.chat_send_player(name, "Available privileges:")
76 for priv, def in pairs(minetest.registered_privileges) do
77 minetest.chat_send_player(name, priv..": "..def.description)
81 def = minetest.chatcommands[cmd]
83 minetest.chat_send_player(name, "Command not available: "..cmd)
85 minetest.chat_send_player(name, format_help_line(cmd, def))
90 minetest.register_chatcommand("privs", {
92 description = "print out privileges of player",
93 func = function(name, param)
97 --[[if not minetest.check_player_privs(name, {privs=true}) then
98 minetest.chat_send_player(name, "Privileges of "..param.." are hidden from you.")
102 minetest.chat_send_player(name, "Privileges of "..param..": "..minetest.privs_to_string(minetest.get_player_privs(param), ' '))
105 minetest.register_chatcommand("grant", {
106 params = "<name> <privilege>|all",
107 description = "Give privilege to player",
109 func = function(name, param)
110 if not minetest.check_player_privs(name, {privs=true}) and
111 not minetest.check_player_privs(name, {basic_privs=true}) then
112 minetest.chat_send_player(name, "Your privileges are insufficient.")
115 local grantname, grantprivstr = string.match(param, "([^ ]+) (.+)")
116 if not grantname or not grantprivstr then
117 minetest.chat_send_player(name, "Invalid parameters (see /help grant)")
120 local grantprivs = minetest.string_to_privs(grantprivstr)
121 if grantprivstr == "all" then
122 grantprivs = minetest.registered_privileges
124 local privs = minetest.get_player_privs(grantname)
125 local privs_known = true
126 for priv, _ in pairs(grantprivs) do
127 if priv ~= "interact" and priv ~= "shout" and priv ~= "interact_extra" and not minetest.check_player_privs(name, {privs=true}) then
128 minetest.chat_send_player(name, "Your privileges are insufficient.")
131 if not minetest.registered_privileges[priv] then
132 minetest.chat_send_player(name, "Unknown privilege: "..priv)
137 if not privs_known then
140 minetest.set_player_privs(grantname, privs)
141 minetest.log(name..' granted ('..minetest.privs_to_string(grantprivs, ', ')..') privileges to '..grantname)
142 minetest.chat_send_player(name, "Privileges of "..grantname..": "..minetest.privs_to_string(minetest.get_player_privs(grantname), ' '))
143 if grantname ~= name then
144 minetest.chat_send_player(grantname, name.." granted you privileges: "..minetest.privs_to_string(grantprivs, ' '))
148 minetest.register_chatcommand("revoke", {
149 params = "<name> <privilege>|all",
150 description = "Remove privilege from player",
152 func = function(name, param)
153 if not minetest.check_player_privs(name, {privs=true}) and
154 not minetest.check_player_privs(name, {basic_privs=true}) then
155 minetest.chat_send_player(name, "Your privileges are insufficient.")
158 local revokename, revokeprivstr = string.match(param, "([^ ]+) (.+)")
159 if not revokename or not revokeprivstr then
160 minetest.chat_send_player(name, "Invalid parameters (see /help revoke)")
163 local revokeprivs = minetest.string_to_privs(revokeprivstr)
164 local privs = minetest.get_player_privs(revokename)
165 for priv, _ in pairs(revokeprivs) do
166 if priv ~= "interact" and priv ~= "shout" and priv ~= "interact_extra" and not minetest.check_player_privs(name, {privs=true}) then
167 minetest.chat_send_player(name, "Your privileges are insufficient.")
171 if revokeprivstr == "all" then
174 for priv, _ in pairs(revokeprivs) do
178 minetest.set_player_privs(revokename, privs)
179 minetest.log(name..' revoked ('..minetest.privs_to_string(revokeprivs, ', ')..') privileges from '..revokename)
180 minetest.chat_send_player(name, "Privileges of "..revokename..": "..minetest.privs_to_string(minetest.get_player_privs(revokename), ' '))
181 if revokename ~= name then
182 minetest.chat_send_player(revokename, name.." revoked privileges from you: "..minetest.privs_to_string(revokeprivs, ' '))
186 minetest.register_chatcommand("setpassword", {
187 params = "<name> <password>",
188 description = "set given password",
189 privs = {password=true},
190 func = function(name, param)
191 local toname, raw_password = string.match(param, "^([^ ]+) +(.+)$")
193 toname = string.match(param, "^([^ ]+) *$")
197 minetest.chat_send_player(name, "Name field required")
201 if not raw_password then
202 minetest.set_player_password(toname, "")
205 minetest.set_player_password(toname, minetest.get_password_hash(toname, raw_password))
208 minetest.chat_send_player(name, "Password of player \""..toname.."\" "..actstr)
209 if toname ~= name then
210 minetest.chat_send_player(toname, "Your password was "..actstr.." by "..name)
214 minetest.register_chatcommand("clearpassword", {
216 description = "set empty password",
217 privs = {password=true},
218 func = function(name, param)
221 minetest.chat_send_player(name, "Name field required")
224 minetest.set_player_password(toname, '')
225 minetest.chat_send_player(name, "Password of player \""..toname.."\" cleared")
229 minetest.register_chatcommand("auth_reload", {
231 description = "reload authentication data",
232 privs = {server=true},
233 func = function(name, param)
234 local done = minetest.auth_reload()
236 minetest.chat_send_player(name, "Done.")
238 minetest.chat_send_player(name, "Failed.")
243 minetest.register_chatcommand("teleport", {
244 params = "<X>,<Y>,<Z> | <to_name> | <name> <X>,<Y>,<Z> | <name> <to_name>",
245 description = "teleport to given position",
246 privs = {teleport=true},
247 func = function(name, param)
248 -- Returns (pos, true) if found, otherwise (pos, false)
249 local function find_free_position_near(pos)
256 for _, d in ipairs(tries) do
257 local p = {x = pos.x+d.x, y = pos.y+d.y, z = pos.z+d.z}
258 local n = minetest.env:get_node(p)
259 if not minetest.registered_nodes[n.name].walkable then
266 local teleportee = nil
268 p.x, p.y, p.z = string.match(param, "^([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
269 teleportee = minetest.env:get_player_by_name(name)
270 if teleportee and p.x and p.y and p.z then
271 minetest.chat_send_player(name, "Teleporting to ("..p.x..", "..p.y..", "..p.z..")")
276 local teleportee = nil
278 local target_name = nil
279 target_name = string.match(param, "^([^ ]+)$")
280 teleportee = minetest.env:get_player_by_name(name)
282 local target = minetest.env:get_player_by_name(target_name)
287 if teleportee and p then
288 p = find_free_position_near(p)
289 minetest.chat_send_player(name, "Teleporting to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
294 if minetest.check_player_privs(name, {bring=true}) then
295 local teleportee = nil
297 local teleportee_name = nil
298 teleportee_name, p.x, p.y, p.z = string.match(param, "^([^ ]+) +([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
299 if teleportee_name then
300 teleportee = minetest.env:get_player_by_name(teleportee_name)
302 if teleportee and p.x and p.y and p.z then
303 minetest.chat_send_player(name, "Teleporting "..teleportee_name.." to ("..p.x..", "..p.y..", "..p.z..")")
308 local teleportee = nil
310 local teleportee_name = nil
311 local target_name = nil
312 teleportee_name, target_name = string.match(param, "^([^ ]+) +([^ ]+)$")
313 if teleportee_name then
314 teleportee = minetest.env:get_player_by_name(teleportee_name)
317 local target = minetest.env:get_player_by_name(target_name)
322 if teleportee and p then
323 p = find_free_position_near(p)
324 minetest.chat_send_player(name, "Teleporting "..teleportee_name.." to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
330 minetest.chat_send_player(name, "Invalid parameters (\""..param.."\") or player not found (see /help teleport)")
335 minetest.register_chatcommand("set", {
336 params = "[-n] <name> <value> | <name>",
337 description = "set or read server configuration setting",
338 privs = {server=true},
339 func = function(name, param)
340 local arg, setname, setvalue = string.match(param, "(-[n]) ([^ ]+) (.+)")
341 if arg and arg == "-n" and setname and setvalue then
342 minetest.setting_set(setname, setvalue)
343 minetest.chat_send_player(name, setname.." = "..setvalue)
346 local setname, setvalue = string.match(param, "([^ ]+) (.+)")
347 if setname and setvalue then
348 if not minetest.setting_get(setname) then
349 minetest.chat_send_player(name, "Failed. Use '/set -n <name> <value>' to create a new setting.")
352 minetest.setting_set(setname, setvalue)
353 minetest.chat_send_player(name, setname.." = "..setvalue)
356 local setname = string.match(param, "([^ ]+)")
358 local setvalue = minetest.setting_get(setname)
360 setvalue = "<not set>"
362 minetest.chat_send_player(name, setname.." = "..setvalue)
365 minetest.chat_send_player(name, "Invalid parameters (see /help set)")
369 minetest.register_chatcommand("mods", {
371 description = "lists mods installed on the server",
373 func = function(name, param)
375 local modnames = minetest.get_modnames()
376 for i, mod in ipairs(modnames) do
377 response = response .. mod
378 -- Add space if not at the end
379 if i ~= #modnames then
380 response = response .. " "
383 minetest.chat_send_player(name, response)
387 local function handle_give_command(cmd, giver, receiver, stackstring)
388 minetest.log("action", giver.." invoked "..cmd..', stackstring="'
390 minetest.log(cmd..' invoked, stackstring="'..stackstring..'"')
391 local itemstack = ItemStack(stackstring)
392 if itemstack:is_empty() then
393 minetest.chat_send_player(giver, 'error: cannot give an empty item')
395 elseif not itemstack:is_known() then
396 minetest.chat_send_player(giver, 'error: cannot give an unknown item')
399 local receiverref = minetest.env:get_player_by_name(receiver)
400 if receiverref == nil then
401 minetest.chat_send_player(giver, receiver..' is not a known player')
404 local leftover = receiverref:get_inventory():add_item("main", itemstack)
405 if leftover:is_empty() then
407 elseif leftover:get_count() == itemstack:get_count() then
408 partiality = "could not be "
410 partiality = "partially "
412 -- The actual item stack string may be different from what the "giver"
413 -- entered (e.g. big numbers are always interpreted as 2^16-1).
414 stackstring = itemstack:to_string()
415 if giver == receiver then
416 minetest.chat_send_player(giver, '"'..stackstring
417 ..'" '..partiality..'added to inventory.');
419 minetest.chat_send_player(giver, '"'..stackstring
420 ..'" '..partiality..'added to '..receiver..'\'s inventory.');
421 minetest.chat_send_player(receiver, '"'..stackstring
422 ..'" '..partiality..'added to inventory.');
426 minetest.register_chatcommand("give", {
427 params = "<name> <itemstring>",
428 description = "give item to player",
430 func = function(name, param)
431 local toname, itemstring = string.match(param, "^([^ ]+) +(.+)$")
432 if not toname or not itemstring then
433 minetest.chat_send_player(name, "name and itemstring required")
436 handle_give_command("/give", name, toname, itemstring)
439 minetest.register_chatcommand("giveme", {
440 params = "<itemstring>",
441 description = "give item to yourself",
443 func = function(name, param)
444 local itemstring = string.match(param, "(.+)$")
445 if not itemstring then
446 minetest.chat_send_player(name, "itemstring required")
449 handle_give_command("/giveme", name, name, itemstring)
452 minetest.register_chatcommand("spawnentity", {
453 params = "<entityname>",
454 description = "spawn entity at your position",
455 privs = {give=true, interact=true},
456 func = function(name, param)
457 local entityname = string.match(param, "(.+)$")
458 if not entityname then
459 minetest.chat_send_player(name, "entityname required")
462 print('/spawnentity invoked, entityname="'..entityname..'"')
463 local player = minetest.env:get_player_by_name(name)
464 if player == nil then
465 print("Unable to spawn entity, player is nil")
466 return true -- Handled chat message
468 local p = player:getpos()
470 minetest.env:add_entity(p, entityname)
471 minetest.chat_send_player(name, '"'..entityname
475 minetest.register_chatcommand("pulverize", {
477 description = "delete item in hand",
479 func = function(name, param)
480 local player = minetest.env:get_player_by_name(name)
481 if player == nil then
482 print("Unable to pulverize, player is nil")
483 return true -- Handled chat message
485 if player:get_wielded_item():is_empty() then
486 minetest.chat_send_player(name, 'Unable to pulverize, no item in hand.')
488 player:set_wielded_item(nil)
489 minetest.chat_send_player(name, 'An item was pulverized.')
495 minetest.rollback_punch_callbacks = {}
497 minetest.register_on_punchnode(function(pos, node, puncher)
498 local name = puncher:get_player_name()
499 if minetest.rollback_punch_callbacks[name] then
500 minetest.rollback_punch_callbacks[name](pos, node, puncher)
501 minetest.rollback_punch_callbacks[name] = nil
505 minetest.register_chatcommand("rollback_check", {
506 params = "[<range>] [<seconds>]",
507 description = "check who has last touched a node or near it, "..
508 "max. <seconds> ago (default range=0, seconds=86400=24h)",
509 privs = {rollback=true},
510 func = function(name, param)
511 local range, seconds = string.match(param, "(%d+) *(%d*)")
512 range = tonumber(range) or 0
513 seconds = tonumber(seconds) or 86400
514 minetest.chat_send_player(name, "Punch a node (limits set: range="..
515 dump(range).." seconds="..dump(seconds).."s)")
516 minetest.rollback_punch_callbacks[name] = function(pos, node, puncher)
517 local name = puncher:get_player_name()
518 minetest.chat_send_player(name, "Checking...")
519 local actor, act_p, act_seconds =
520 minetest.rollback_get_last_node_actor(pos, range, seconds)
522 minetest.chat_send_player(name, "Nobody has touched the "..
523 "specified location in "..dump(seconds).." seconds")
526 local nodedesc = "this node"
527 if act_p.x ~= pos.x or act_p.y ~= pos.y or act_p.z ~= pos.z then
528 nodedesc = minetest.pos_to_string(act_p)
530 local nodename = minetest.env:get_node(act_p).name
531 minetest.chat_send_player(name, "Last actor on "..nodedesc..
532 " was "..actor..", "..dump(act_seconds)..
533 "s ago (node is now "..nodename..")")
538 minetest.register_chatcommand("rollback", {
539 params = "<player name> [<seconds>] | :<actor> [<seconds>]",
540 description = "revert actions of a player; default for <seconds> is 60",
541 privs = {rollback=true},
542 func = function(name, param)
543 local target_name, seconds = string.match(param, ":([^ ]+) *(%d*)")
544 if not target_name then
545 local player_name = nil;
546 player_name, seconds = string.match(param, "([^ ]+) *(%d*)")
547 if not player_name then
548 minetest.chat_send_player(name, "Invalid parameters. See /help rollback and /help rollback_check")
551 target_name = "player:"..player_name
553 seconds = tonumber(seconds) or 60
554 minetest.chat_send_player(name, "Reverting actions of "..
555 dump(target_name).." since "..dump(seconds).." seconds.")
556 local success, log = minetest.rollback_revert_actions_by(
557 target_name, seconds)
559 minetest.chat_send_player(name, "(log is too long to show)")
561 for _,line in ipairs(log) do
562 minetest.chat_send_player(name, line)
566 minetest.chat_send_player(name, "Reverting actions succeeded.")
568 minetest.chat_send_player(name, "Reverting actions FAILED.")
573 minetest.register_chatcommand("status", {
575 description = "print server status line",
577 func = function(name, param)
578 minetest.chat_send_player(name, minetest.get_server_status())
582 minetest.register_chatcommand("time", {
583 params = "<0...24000>",
584 description = "set time of day",
585 privs = {settime=true},
586 func = function(name, param)
588 minetest.chat_send_player(name, "Missing parameter")
591 local newtime = tonumber(param)
592 if newtime == nil then
593 minetest.chat_send_player(name, "Invalid time")
595 minetest.env:set_timeofday((newtime % 24000) / 24000)
596 minetest.chat_send_player(name, "Time of day changed.")
597 minetest.log("action", name .. " sets time " .. newtime)
602 minetest.register_chatcommand("shutdown", {
604 description = "shutdown server",
605 privs = {server=true},
606 func = function(name, param)
607 minetest.log("action", name .. " shuts down server")
608 minetest.request_shutdown()
609 minetest.chat_send_all("*** Server shutting down (operator request).")
613 minetest.register_chatcommand("ban", {
615 description = "ban IP of player",
617 func = function(name, param)
619 minetest.chat_send_player(name, "Ban list: " .. minetest.get_ban_list())
622 if not minetest.env:get_player_by_name(param) then
623 minetest.chat_send_player(name, "No such player")
626 if not minetest.ban_player(param) then
627 minetest.chat_send_player(name, "Failed to ban player")
629 local desc = minetest.get_ban_description(param)
630 minetest.chat_send_player(name, "Banned " .. desc .. ".")
631 minetest.log("action", name .. " bans " .. desc .. ".")
636 minetest.register_chatcommand("unban", {
637 params = "<name/ip>",
638 description = "remove IP ban",
640 func = function(name, param)
641 if not minetest.unban_player_or_ip(param) then
642 minetest.chat_send_player(name, "Failed to unban player/IP")
644 minetest.chat_send_player(name, "Unbanned " .. param)
645 minetest.log("action", name .. " unbans " .. param)
650 minetest.register_chatcommand("clearobjects", {
652 description = "clear all objects in world",
653 privs = {server=true},
654 func = function(name, param)
655 minetest.log("action", name .. " clears all objects")
656 minetest.chat_send_all("Clearing all objects. This may take long. You may experience a timeout. (by " .. name .. ")")
657 minetest.env:clear_objects()
658 minetest.log("action", "object clearing done")
659 minetest.chat_send_all("*** Cleared all objects.")