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.chat_send_player(name, "Privileges of "..grantname..": "..minetest.privs_to_string(minetest.get_player_privs(grantname), ' '))
142 if grantname ~= name then
143 minetest.chat_send_player(grantname, name.." granted you privileges: "..minetest.privs_to_string(grantprivs, ' '))
147 minetest.register_chatcommand("revoke", {
148 params = "<name> <privilege>|all",
149 description = "Remove privilege from player",
151 func = function(name, param)
152 if not minetest.check_player_privs(name, {privs=true}) and
153 not minetest.check_player_privs(name, {basic_privs=true}) then
154 minetest.chat_send_player(name, "Your privileges are insufficient.")
157 local revokename, revokeprivstr = string.match(param, "([^ ]+) (.+)")
158 if not revokename or not revokeprivstr then
159 minetest.chat_send_player(name, "Invalid parameters (see /help revoke)")
162 local revokeprivs = minetest.string_to_privs(revokeprivstr)
163 local privs = minetest.get_player_privs(revokename)
164 for priv, _ in pairs(revokeprivs) do
165 if priv ~= "interact" and priv ~= "shout" and priv ~= "interact_extra" and not minetest.check_player_privs(name, {privs=true}) then
166 minetest.chat_send_player(name, "Your privileges are insufficient.")
170 if revokeprivstr == "all" then
173 for priv, _ in pairs(revokeprivs) do
177 minetest.set_player_privs(revokename, privs)
178 minetest.chat_send_player(name, "Privileges of "..revokename..": "..minetest.privs_to_string(minetest.get_player_privs(revokename), ' '))
179 if revokename ~= name then
180 minetest.chat_send_player(revokename, name.." revoked privileges from you: "..minetest.privs_to_string(revokeprivs, ' '))
184 minetest.register_chatcommand("setpassword", {
185 params = "<name> <password>",
186 description = "set given password",
187 privs = {password=true},
188 func = function(name, param)
189 local toname, raw_password = string.match(param, "^([^ ]+) +(.+)$")
191 toname = string.match(param, "^([^ ]+) *$")
195 minetest.chat_send_player(name, "Name field required")
199 if not raw_password then
200 minetest.set_player_password(toname, "")
203 minetest.set_player_password(toname, minetest.get_password_hash(toname, raw_password))
206 minetest.chat_send_player(name, "Password of player \""..toname.."\" "..actstr)
207 if toname ~= name then
208 minetest.chat_send_player(toname, "Your password was "..actstr.." by "..name)
212 minetest.register_chatcommand("clearpassword", {
214 description = "set empty password",
215 privs = {password=true},
216 func = function(name, param)
219 minetest.chat_send_player(name, "Name field required")
222 minetest.set_player_password(toname, '')
223 minetest.chat_send_player(name, "Password of player \""..toname.."\" cleared")
227 minetest.register_chatcommand("auth_reload", {
229 description = "reload authentication data",
230 privs = {server=true},
231 func = function(name, param)
232 local done = minetest.auth_reload()
234 minetest.chat_send_player(name, "Done.")
236 minetest.chat_send_player(name, "Failed.")
241 minetest.register_chatcommand("teleport", {
242 params = "<X>,<Y>,<Z> | <to_name> | <name> <X>,<Y>,<Z> | <name> <to_name>",
243 description = "teleport to given position",
244 privs = {teleport=true},
245 func = function(name, param)
246 -- Returns (pos, true) if found, otherwise (pos, false)
247 local function find_free_position_near(pos)
254 for _, d in ipairs(tries) do
255 local p = {x = pos.x+d.x, y = pos.y+d.y, z = pos.z+d.z}
256 local n = minetest.env:get_node(p)
257 if not minetest.registered_nodes[n.name].walkable then
264 local teleportee = nil
266 p.x, p.y, p.z = string.match(param, "^([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
267 teleportee = minetest.env:get_player_by_name(name)
268 if teleportee and p.x and p.y and p.z then
269 minetest.chat_send_player(name, "Teleporting to ("..p.x..", "..p.y..", "..p.z..")")
274 local teleportee = nil
276 local target_name = nil
277 target_name = string.match(param, "^([^ ]+)$")
278 teleportee = minetest.env:get_player_by_name(name)
280 local target = minetest.env:get_player_by_name(target_name)
285 if teleportee and p then
286 p = find_free_position_near(p)
287 minetest.chat_send_player(name, "Teleporting to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
292 if minetest.check_player_privs(name, {bring=true}) then
293 local teleportee = nil
295 local teleportee_name = nil
296 teleportee_name, p.x, p.y, p.z = string.match(param, "^([^ ]+) +([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
297 if teleportee_name then
298 teleportee = minetest.env:get_player_by_name(teleportee_name)
300 if teleportee and p.x and p.y and p.z then
301 minetest.chat_send_player(name, "Teleporting "..teleportee_name.." to ("..p.x..", "..p.y..", "..p.z..")")
306 local teleportee = nil
308 local teleportee_name = nil
309 local target_name = nil
310 teleportee_name, target_name = string.match(param, "^([^ ]+) +([^ ]+)$")
311 if teleportee_name then
312 teleportee = minetest.env:get_player_by_name(teleportee_name)
315 local target = minetest.env:get_player_by_name(target_name)
320 if teleportee and p then
321 p = find_free_position_near(p)
322 minetest.chat_send_player(name, "Teleporting "..teleportee_name.." to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
328 minetest.chat_send_player(name, "Invalid parameters (\""..param.."\") or player not found (see /help teleport)")
333 minetest.register_chatcommand("set", {
334 params = "[-n] <name> <value> | <name>",
335 description = "set or read server configuration setting",
336 privs = {server=true},
337 func = function(name, param)
338 local arg, setname, setvalue = string.match(param, "(-[n]) ([^ ]+) (.+)")
339 if arg and arg == "-n" and setname and setvalue then
340 minetest.setting_set(setname, setvalue)
341 minetest.chat_send_player(name, setname.." = "..setvalue)
344 local setname, setvalue = string.match(param, "([^ ]+) (.+)")
345 if setname and setvalue then
346 if not minetest.setting_get(setname) then
347 minetest.chat_send_player(name, "Failed. Use '/set -n <name> <value>' to create a new setting.")
350 minetest.setting_set(setname, setvalue)
351 minetest.chat_send_player(name, setname.." = "..setvalue)
354 local setname = string.match(param, "([^ ]+)")
356 local setvalue = minetest.setting_get(setname)
358 setvalue = "<not set>"
360 minetest.chat_send_player(name, setname.." = "..setvalue)
363 minetest.chat_send_player(name, "Invalid parameters (see /help set)")
367 minetest.register_chatcommand("mods", {
369 description = "lists mods installed on the server",
371 func = function(name, param)
373 local modnames = minetest.get_modnames()
374 for i, mod in ipairs(modnames) do
375 response = response .. mod
376 -- Add space if not at the end
377 if i ~= #modnames then
378 response = response .. " "
381 minetest.chat_send_player(name, response)
385 local function handle_give_command(cmd, giver, receiver, stackstring)
386 minetest.log("action", giver.." invoked "..cmd..', stackstring="'
388 minetest.log(cmd..' invoked, stackstring="'..stackstring..'"')
389 local itemstack = ItemStack(stackstring)
390 if itemstack:is_empty() then
391 minetest.chat_send_player(giver, 'error: cannot give an empty item')
393 elseif not itemstack:is_known() then
394 minetest.chat_send_player(giver, 'error: cannot give an unknown item')
397 local receiverref = minetest.env:get_player_by_name(receiver)
398 if receiverref == nil then
399 minetest.chat_send_player(giver, receiver..' is not a known player')
402 local leftover = receiverref:get_inventory():add_item("main", itemstack)
403 if leftover:is_empty() then
405 elseif leftover:get_count() == itemstack:get_count() then
406 partiality = "could not be "
408 partiality = "partially "
410 -- The actual item stack string may be different from what the "giver"
411 -- entered (e.g. big numbers are always interpreted as 2^16-1).
412 stackstring = itemstack:to_string()
413 if giver == receiver then
414 minetest.chat_send_player(giver, '"'..stackstring
415 ..'" '..partiality..'added to inventory.');
417 minetest.chat_send_player(giver, '"'..stackstring
418 ..'" '..partiality..'added to '..receiver..'\'s inventory.');
419 minetest.chat_send_player(receiver, '"'..stackstring
420 ..'" '..partiality..'added to inventory.');
424 minetest.register_chatcommand("give", {
425 params = "<name> <itemstring>",
426 description = "give item to player",
428 func = function(name, param)
429 local toname, itemstring = string.match(param, "^([^ ]+) +(.+)$")
430 if not toname or not itemstring then
431 minetest.chat_send_player(name, "name and itemstring required")
434 handle_give_command("/give", name, toname, itemstring)
437 minetest.register_chatcommand("giveme", {
438 params = "<itemstring>",
439 description = "give item to yourself",
441 func = function(name, param)
442 local itemstring = string.match(param, "(.+)$")
443 if not itemstring then
444 minetest.chat_send_player(name, "itemstring required")
447 handle_give_command("/giveme", name, name, itemstring)
450 minetest.register_chatcommand("spawnentity", {
451 params = "<entityname>",
452 description = "spawn entity at your position",
453 privs = {give=true, interact=true},
454 func = function(name, param)
455 local entityname = string.match(param, "(.+)$")
456 if not entityname then
457 minetest.chat_send_player(name, "entityname required")
460 print('/spawnentity invoked, entityname="'..entityname..'"')
461 local player = minetest.env:get_player_by_name(name)
462 if player == nil then
463 print("Unable to spawn entity, player is nil")
464 return true -- Handled chat message
466 local p = player:getpos()
468 minetest.env:add_entity(p, entityname)
469 minetest.chat_send_player(name, '"'..entityname
473 minetest.register_chatcommand("pulverize", {
475 description = "delete item in hand",
477 func = function(name, param)
478 local player = minetest.env:get_player_by_name(name)
479 if player == nil then
480 print("Unable to pulverize, player is nil")
481 return true -- Handled chat message
483 if player:get_wielded_item():is_empty() then
484 minetest.chat_send_player(name, 'Unable to pulverize, no item in hand.')
486 player:set_wielded_item(nil)
487 minetest.chat_send_player(name, 'An item was pulverized.')
493 minetest.rollback_punch_callbacks = {}
495 minetest.register_on_punchnode(function(pos, node, puncher)
496 local name = puncher:get_player_name()
497 if minetest.rollback_punch_callbacks[name] then
498 minetest.rollback_punch_callbacks[name](pos, node, puncher)
499 minetest.rollback_punch_callbacks[name] = nil
503 minetest.register_chatcommand("rollback_check", {
504 params = "[<range>] [<seconds>]",
505 description = "check who has last touched a node or near it, "..
506 "max. <seconds> ago (default range=0, seconds=86400=24h)",
507 privs = {rollback=true},
508 func = function(name, param)
509 local range, seconds = string.match(param, "(%d+) *(%d*)")
510 range = tonumber(range) or 0
511 seconds = tonumber(seconds) or 86400
512 minetest.chat_send_player(name, "Punch a node (limits set: range="..
513 dump(range).." seconds="..dump(seconds).."s)")
514 minetest.rollback_punch_callbacks[name] = function(pos, node, puncher)
515 local name = puncher:get_player_name()
516 minetest.chat_send_player(name, "Checking...")
517 local actor, act_p, act_seconds =
518 minetest.rollback_get_last_node_actor(pos, range, seconds)
520 minetest.chat_send_player(name, "Nobody has touched the "..
521 "specified location in "..dump(seconds).." seconds")
524 local nodedesc = "this node"
525 if act_p.x ~= pos.x or act_p.y ~= pos.y or act_p.z ~= pos.z then
526 nodedesc = minetest.pos_to_string(act_p)
528 local nodename = minetest.env:get_node(act_p).name
529 minetest.chat_send_player(name, "Last actor on "..nodedesc..
530 " was "..actor..", "..dump(act_seconds)..
531 "s ago (node is now "..nodename..")")
536 minetest.register_chatcommand("rollback", {
537 params = "<player name> [<seconds>] | :<actor> [<seconds>]",
538 description = "revert actions of a player; default for <seconds> is 60",
539 privs = {rollback=true},
540 func = function(name, param)
541 local target_name, seconds = string.match(param, ":([^ ]+) *(%d*)")
542 if not target_name then
543 local player_name = nil;
544 player_name, seconds = string.match(param, "([^ ]+) *(%d*)")
545 if not player_name then
546 minetest.chat_send_player(name, "Invalid parameters. See /help rollback and /help rollback_check")
549 target_name = "player:"..player_name
551 seconds = tonumber(seconds) or 60
552 minetest.chat_send_player(name, "Reverting actions of "..
553 dump(target_name).." since "..dump(seconds).." seconds.")
554 local success, log = minetest.rollback_revert_actions_by(
555 target_name, seconds)
557 minetest.chat_send_player(name, "(log is too long to show)")
559 for _,line in ipairs(log) do
560 minetest.chat_send_player(name, line)
564 minetest.chat_send_player(name, "Reverting actions succeeded.")
566 minetest.chat_send_player(name, "Reverting actions FAILED.")
571 minetest.register_chatcommand("status", {
573 description = "print server status line",
575 func = function(name, param)
576 minetest.chat_send_player(name, minetest.get_server_status())
580 minetest.register_chatcommand("time", {
581 params = "<0...24000>",
582 description = "set time of day",
583 privs = {settime=true},
584 func = function(name, param)
586 minetest.chat_send_player(name, "Missing parameter")
589 local newtime = tonumber(param)
590 if newtime == nil then
591 minetest.chat_send_player(name, "Invalid time")
593 minetest.env:set_timeofday((newtime % 24000) / 24000)
594 minetest.chat_send_player(name, "Time of day changed.")
595 minetest.log("action", name .. " sets time " .. newtime)
600 minetest.register_chatcommand("shutdown", {
602 description = "shutdown server",
603 privs = {server=true},
604 func = function(name, param)
605 minetest.log("action", name .. " shuts down server")
606 minetest.request_shutdown()
607 minetest.chat_send_all("*** Server shutting down (operator request).")
611 minetest.register_chatcommand("ban", {
613 description = "ban IP of player",
615 func = function(name, param)
617 minetest.chat_send_player(name, "Ban list: " .. minetest.get_ban_list())
620 if not minetest.env:get_player_by_name(param) then
621 minetest.chat_send_player(name, "No such player")
624 if not minetest.ban_player(param) then
625 minetest.chat_send_player(name, "Failed to ban player")
627 local desc = minetest.get_ban_description(param)
628 minetest.chat_send_player(name, "Banned " .. desc .. ".")
629 minetest.log("action", name .. " bans " .. desc .. ".")
634 minetest.register_chatcommand("unban", {
635 params = "<name/ip>",
636 description = "remove IP ban",
638 func = function(name, param)
639 if not minetest.unban_player_or_ip(param) then
640 minetest.chat_send_player(name, "Failed to unban player/IP")
642 minetest.chat_send_player(name, "Unbanned " .. param)
643 minetest.log("action", name .. " unbans " .. param)
648 minetest.register_chatcommand("clearobjects", {
650 description = "clear all objects in world",
651 privs = {server=true},
652 func = function(name, param)
653 minetest.log("action", name .. " clears all objects")
654 minetest.chat_send_all("Clearing all objects. This may take long. You may experience a timeout. (by " .. name .. ")")
655 minetest.env:clear_objects()
656 minetest.log("action", "object clearing done")
657 minetest.chat_send_all("*** Cleared all objects.")