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)")
119 elseif not minetest.auth_table[grantname] then
120 minetest.chat_send_player(name, "Player "..grantname.." does not exist.")
123 local grantprivs = minetest.string_to_privs(grantprivstr)
124 if grantprivstr == "all" then
125 grantprivs = minetest.registered_privileges
127 local privs = minetest.get_player_privs(grantname)
128 local privs_known = true
129 for priv, _ in pairs(grantprivs) do
130 if priv ~= "interact" and priv ~= "shout" and priv ~= "interact_extra" and not minetest.check_player_privs(name, {privs=true}) then
131 minetest.chat_send_player(name, "Your privileges are insufficient.")
134 if not minetest.registered_privileges[priv] then
135 minetest.chat_send_player(name, "Unknown privilege: "..priv)
140 if not privs_known then
143 minetest.set_player_privs(grantname, privs)
144 minetest.log(name..' granted ('..minetest.privs_to_string(grantprivs, ', ')..') privileges to '..grantname)
145 minetest.chat_send_player(name, "Privileges of "..grantname..": "..minetest.privs_to_string(minetest.get_player_privs(grantname), ' '))
146 if grantname ~= name then
147 minetest.chat_send_player(grantname, name.." granted you privileges: "..minetest.privs_to_string(grantprivs, ' '))
151 minetest.register_chatcommand("revoke", {
152 params = "<name> <privilege>|all",
153 description = "Remove privilege from player",
155 func = function(name, param)
156 if not minetest.check_player_privs(name, {privs=true}) and
157 not minetest.check_player_privs(name, {basic_privs=true}) then
158 minetest.chat_send_player(name, "Your privileges are insufficient.")
161 local revokename, revokeprivstr = string.match(param, "([^ ]+) (.+)")
162 if not revokename or not revokeprivstr then
163 minetest.chat_send_player(name, "Invalid parameters (see /help revoke)")
165 elseif not minetest.auth_table[revokename] then
166 minetest.chat_send_player(name, "Player "..revokename.." does not exist.")
169 local revokeprivs = minetest.string_to_privs(revokeprivstr)
170 local privs = minetest.get_player_privs(revokename)
171 for priv, _ in pairs(revokeprivs) do
172 if priv ~= "interact" and priv ~= "shout" and priv ~= "interact_extra" and not minetest.check_player_privs(name, {privs=true}) then
173 minetest.chat_send_player(name, "Your privileges are insufficient.")
177 if revokeprivstr == "all" then
180 for priv, _ in pairs(revokeprivs) do
184 minetest.set_player_privs(revokename, privs)
185 minetest.log(name..' revoked ('..minetest.privs_to_string(revokeprivs, ', ')..') privileges from '..revokename)
186 minetest.chat_send_player(name, "Privileges of "..revokename..": "..minetest.privs_to_string(minetest.get_player_privs(revokename), ' '))
187 if revokename ~= name then
188 minetest.chat_send_player(revokename, name.." revoked privileges from you: "..minetest.privs_to_string(revokeprivs, ' '))
192 minetest.register_chatcommand("setpassword", {
193 params = "<name> <password>",
194 description = "set given password",
195 privs = {password=true},
196 func = function(name, param)
197 local toname, raw_password = string.match(param, "^([^ ]+) +(.+)$")
199 toname = string.match(param, "^([^ ]+) *$")
203 minetest.chat_send_player(name, "Name field required")
207 if not raw_password then
208 minetest.set_player_password(toname, "")
211 minetest.set_player_password(toname, minetest.get_password_hash(toname, raw_password))
214 minetest.chat_send_player(name, "Password of player \""..toname.."\" "..actstr)
215 if toname ~= name then
216 minetest.chat_send_player(toname, "Your password was "..actstr.." by "..name)
220 minetest.register_chatcommand("clearpassword", {
222 description = "set empty password",
223 privs = {password=true},
224 func = function(name, param)
227 minetest.chat_send_player(name, "Name field required")
230 minetest.set_player_password(toname, '')
231 minetest.chat_send_player(name, "Password of player \""..toname.."\" cleared")
235 minetest.register_chatcommand("auth_reload", {
237 description = "reload authentication data",
238 privs = {server=true},
239 func = function(name, param)
240 local done = minetest.auth_reload()
242 minetest.chat_send_player(name, "Done.")
244 minetest.chat_send_player(name, "Failed.")
249 minetest.register_chatcommand("teleport", {
250 params = "<X>,<Y>,<Z> | <to_name> | <name> <X>,<Y>,<Z> | <name> <to_name>",
251 description = "teleport to given position",
252 privs = {teleport=true},
253 func = function(name, param)
254 -- Returns (pos, true) if found, otherwise (pos, false)
255 local function find_free_position_near(pos)
262 for _, d in ipairs(tries) do
263 local p = {x = pos.x+d.x, y = pos.y+d.y, z = pos.z+d.z}
264 local n = minetest.get_node(p)
265 if not minetest.registered_nodes[n.name].walkable then
272 local teleportee = nil
274 p.x, p.y, p.z = string.match(param, "^([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
278 teleportee = minetest.get_player_by_name(name)
279 if teleportee and p.x and p.y and p.z then
280 minetest.chat_send_player(name, "Teleporting to ("..p.x..", "..p.y..", "..p.z..")")
285 local teleportee = nil
287 local target_name = nil
288 target_name = string.match(param, "^([^ ]+)$")
289 teleportee = minetest.get_player_by_name(name)
291 local target = minetest.get_player_by_name(target_name)
296 if teleportee and p then
297 p = find_free_position_near(p)
298 minetest.chat_send_player(name, "Teleporting to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
303 if minetest.check_player_privs(name, {bring=true}) then
304 local teleportee = nil
306 local teleportee_name = nil
307 teleportee_name, p.x, p.y, p.z = string.match(param, "^([^ ]+) +([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
311 if teleportee_name then
312 teleportee = minetest.get_player_by_name(teleportee_name)
314 if teleportee and p.x and p.y and p.z then
315 minetest.chat_send_player(name, "Teleporting "..teleportee_name.." to ("..p.x..", "..p.y..", "..p.z..")")
320 local teleportee = nil
322 local teleportee_name = nil
323 local target_name = nil
324 teleportee_name, target_name = string.match(param, "^([^ ]+) +([^ ]+)$")
325 if teleportee_name then
326 teleportee = minetest.get_player_by_name(teleportee_name)
329 local target = minetest.get_player_by_name(target_name)
334 if teleportee and p then
335 p = find_free_position_near(p)
336 minetest.chat_send_player(name, "Teleporting "..teleportee_name.." to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
342 minetest.chat_send_player(name, "Invalid parameters (\""..param.."\") or player not found (see /help teleport)")
347 minetest.register_chatcommand("set", {
348 params = "[-n] <name> <value> | <name>",
349 description = "set or read server configuration setting",
350 privs = {server=true},
351 func = function(name, param)
352 local arg, setname, setvalue = string.match(param, "(-[n]) ([^ ]+) (.+)")
353 if arg and arg == "-n" and setname and setvalue then
354 minetest.setting_set(setname, setvalue)
355 minetest.chat_send_player(name, setname.." = "..setvalue)
358 local setname, setvalue = string.match(param, "([^ ]+) (.+)")
359 if setname and setvalue then
360 if not minetest.setting_get(setname) then
361 minetest.chat_send_player(name, "Failed. Use '/set -n <name> <value>' to create a new setting.")
364 minetest.setting_set(setname, setvalue)
365 minetest.chat_send_player(name, setname.." = "..setvalue)
368 local setname = string.match(param, "([^ ]+)")
370 local setvalue = minetest.setting_get(setname)
372 setvalue = "<not set>"
374 minetest.chat_send_player(name, setname.." = "..setvalue)
377 minetest.chat_send_player(name, "Invalid parameters (see /help set)")
381 minetest.register_chatcommand("mods", {
383 description = "lists mods installed on the server",
385 func = function(name, param)
387 local modnames = minetest.get_modnames()
388 for i, mod in ipairs(modnames) do
389 response = response .. mod
390 -- Add space if not at the end
391 if i ~= #modnames then
392 response = response .. " "
395 minetest.chat_send_player(name, response)
399 local function handle_give_command(cmd, giver, receiver, stackstring)
400 minetest.log("action", giver.." invoked "..cmd..', stackstring="'
402 minetest.log(cmd..' invoked, stackstring="'..stackstring..'"')
403 local itemstack = ItemStack(stackstring)
404 if itemstack:is_empty() then
405 minetest.chat_send_player(giver, 'error: cannot give an empty item')
407 elseif not itemstack:is_known() then
408 minetest.chat_send_player(giver, 'error: cannot give an unknown item')
411 local receiverref = minetest.get_player_by_name(receiver)
412 if receiverref == nil then
413 minetest.chat_send_player(giver, receiver..' is not a known player')
416 local leftover = receiverref:get_inventory():add_item("main", itemstack)
417 if leftover:is_empty() then
419 elseif leftover:get_count() == itemstack:get_count() then
420 partiality = "could not be "
422 partiality = "partially "
424 -- The actual item stack string may be different from what the "giver"
425 -- entered (e.g. big numbers are always interpreted as 2^16-1).
426 stackstring = itemstack:to_string()
427 if giver == receiver then
428 minetest.chat_send_player(giver, '"'..stackstring
429 ..'" '..partiality..'added to inventory.');
431 minetest.chat_send_player(giver, '"'..stackstring
432 ..'" '..partiality..'added to '..receiver..'\'s inventory.');
433 minetest.chat_send_player(receiver, '"'..stackstring
434 ..'" '..partiality..'added to inventory.');
438 minetest.register_chatcommand("give", {
439 params = "<name> <itemstring>",
440 description = "give item to player",
442 func = function(name, param)
443 local toname, itemstring = string.match(param, "^([^ ]+) +(.+)$")
444 if not toname or not itemstring then
445 minetest.chat_send_player(name, "name and itemstring required")
448 handle_give_command("/give", name, toname, itemstring)
451 minetest.register_chatcommand("giveme", {
452 params = "<itemstring>",
453 description = "give item to yourself",
455 func = function(name, param)
456 local itemstring = string.match(param, "(.+)$")
457 if not itemstring then
458 minetest.chat_send_player(name, "itemstring required")
461 handle_give_command("/giveme", name, name, itemstring)
464 minetest.register_chatcommand("spawnentity", {
465 params = "<entityname>",
466 description = "spawn entity at your position",
467 privs = {give=true, interact=true},
468 func = function(name, param)
469 local entityname = string.match(param, "(.+)$")
470 if not entityname then
471 minetest.chat_send_player(name, "entityname required")
474 print('/spawnentity invoked, entityname="'..entityname..'"')
475 local player = minetest.get_player_by_name(name)
476 if player == nil then
477 print("Unable to spawn entity, player is nil")
478 return true -- Handled chat message
480 local p = player:getpos()
482 minetest.add_entity(p, entityname)
483 minetest.chat_send_player(name, '"'..entityname
487 minetest.register_chatcommand("pulverize", {
489 description = "delete item in hand",
491 func = function(name, param)
492 local player = minetest.get_player_by_name(name)
493 if player == nil then
494 print("Unable to pulverize, player is nil")
495 return true -- Handled chat message
497 if player:get_wielded_item():is_empty() then
498 minetest.chat_send_player(name, 'Unable to pulverize, no item in hand.')
500 player:set_wielded_item(nil)
501 minetest.chat_send_player(name, 'An item was pulverized.')
507 minetest.rollback_punch_callbacks = {}
509 minetest.register_on_punchnode(function(pos, node, puncher)
510 local name = puncher:get_player_name()
511 if minetest.rollback_punch_callbacks[name] then
512 minetest.rollback_punch_callbacks[name](pos, node, puncher)
513 minetest.rollback_punch_callbacks[name] = nil
517 minetest.register_chatcommand("rollback_check", {
518 params = "[<range>] [<seconds>]",
519 description = "check who has last touched a node or near it, "..
520 "max. <seconds> ago (default range=0, seconds=86400=24h)",
521 privs = {rollback=true},
522 func = function(name, param)
523 local range, seconds = string.match(param, "(%d+) *(%d*)")
524 range = tonumber(range) or 0
525 seconds = tonumber(seconds) or 86400
526 minetest.chat_send_player(name, "Punch a node (limits set: range="..
527 dump(range).." seconds="..dump(seconds).."s)")
528 minetest.rollback_punch_callbacks[name] = function(pos, node, puncher)
529 local name = puncher:get_player_name()
530 minetest.chat_send_player(name, "Checking...")
531 local actor, act_p, act_seconds =
532 minetest.rollback_get_last_node_actor(pos, range, seconds)
534 minetest.chat_send_player(name, "Nobody has touched the "..
535 "specified location in "..dump(seconds).." seconds")
538 local nodedesc = "this node"
539 if act_p.x ~= pos.x or act_p.y ~= pos.y or act_p.z ~= pos.z then
540 nodedesc = minetest.pos_to_string(act_p)
542 local nodename = minetest.get_node(act_p).name
543 minetest.chat_send_player(name, "Last actor on "..nodedesc..
544 " was "..actor..", "..dump(act_seconds)..
545 "s ago (node is now "..nodename..")")
550 minetest.register_chatcommand("rollback", {
551 params = "<player name> [<seconds>] | :<actor> [<seconds>]",
552 description = "revert actions of a player; default for <seconds> is 60",
553 privs = {rollback=true},
554 func = function(name, param)
555 local target_name, seconds = string.match(param, ":([^ ]+) *(%d*)")
556 if not target_name then
557 local player_name = nil;
558 player_name, seconds = string.match(param, "([^ ]+) *(%d*)")
559 if not player_name then
560 minetest.chat_send_player(name, "Invalid parameters. See /help rollback and /help rollback_check")
563 target_name = "player:"..player_name
565 seconds = tonumber(seconds) or 60
566 minetest.chat_send_player(name, "Reverting actions of "..
567 dump(target_name).." since "..dump(seconds).." seconds.")
568 local success, log = minetest.rollback_revert_actions_by(
569 target_name, seconds)
571 minetest.chat_send_player(name, "(log is too long to show)")
573 for _,line in ipairs(log) do
574 minetest.chat_send_player(name, line)
578 minetest.chat_send_player(name, "Reverting actions succeeded.")
580 minetest.chat_send_player(name, "Reverting actions FAILED.")
585 minetest.register_chatcommand("status", {
587 description = "print server status line",
589 func = function(name, param)
590 minetest.chat_send_player(name, minetest.get_server_status())
594 minetest.register_chatcommand("time", {
595 params = "<0...24000>",
596 description = "set time of day",
597 privs = {settime=true},
598 func = function(name, param)
600 minetest.chat_send_player(name, "Missing parameter")
603 local newtime = tonumber(param)
604 if newtime == nil then
605 minetest.chat_send_player(name, "Invalid time")
607 minetest.set_timeofday((newtime % 24000) / 24000)
608 minetest.chat_send_player(name, "Time of day changed.")
609 minetest.log("action", name .. " sets time " .. newtime)
614 minetest.register_chatcommand("shutdown", {
616 description = "shutdown server",
617 privs = {server=true},
618 func = function(name, param)
619 minetest.log("action", name .. " shuts down server")
620 minetest.request_shutdown()
621 minetest.chat_send_all("*** Server shutting down (operator request).")
625 minetest.register_chatcommand("ban", {
627 description = "ban IP of player",
629 func = function(name, param)
631 minetest.chat_send_player(name, "Ban list: " .. minetest.get_ban_list())
634 if not minetest.get_player_by_name(param) then
635 minetest.chat_send_player(name, "No such player")
638 if not minetest.ban_player(param) then
639 minetest.chat_send_player(name, "Failed to ban player")
641 local desc = minetest.get_ban_description(param)
642 minetest.chat_send_player(name, "Banned " .. desc .. ".")
643 minetest.log("action", name .. " bans " .. desc .. ".")
648 minetest.register_chatcommand("unban", {
649 params = "<name/ip>",
650 description = "remove IP ban",
652 func = function(name, param)
653 if not minetest.unban_player_or_ip(param) then
654 minetest.chat_send_player(name, "Failed to unban player/IP")
656 minetest.chat_send_player(name, "Unbanned " .. param)
657 minetest.log("action", name .. " unbans " .. param)
662 minetest.register_chatcommand("clearobjects", {
664 description = "clear all objects in world",
665 privs = {server=true},
666 func = function(name, param)
667 minetest.log("action", name .. " clears all objects")
668 minetest.chat_send_all("Clearing all objects. This may take long. You may experience a timeout. (by " .. name .. ")")
669 minetest.clear_objects()
670 minetest.log("action", "object clearing done")
671 minetest.chat_send_all("*** Cleared all objects.")
675 minetest.register_chatcommand("msg", {
676 params = "<name> <message>",
677 description = "Send a private message",
678 privs = {shout=true},
679 func = function(name, param)
680 local found, _, sendto, message = param:find("^([^%s]+)%s(.+)$")
682 if minetest.get_player_by_name(sendto) then
683 minetest.log("action", "PM from "..name.." to "..sendto..": "..message)
684 minetest.chat_send_player(sendto, "PM from "..name..": "..message, false)
685 minetest.chat_send_player(name, "Message sent")
687 minetest.chat_send_player(name, "The player "..sendto.." is not online")
690 minetest.chat_send_player(name, "Invalid usage, see /help msg")