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.env: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.-]+)$")
275 teleportee = minetest.env:get_player_by_name(name)
276 if teleportee and p.x and p.y and p.z then
277 minetest.chat_send_player(name, "Teleporting to ("..p.x..", "..p.y..", "..p.z..")")
282 local teleportee = nil
284 local target_name = nil
285 target_name = string.match(param, "^([^ ]+)$")
286 teleportee = minetest.env:get_player_by_name(name)
288 local target = minetest.env:get_player_by_name(target_name)
293 if teleportee and p then
294 p = find_free_position_near(p)
295 minetest.chat_send_player(name, "Teleporting to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
300 if minetest.check_player_privs(name, {bring=true}) then
301 local teleportee = nil
303 local teleportee_name = nil
304 teleportee_name, p.x, p.y, p.z = string.match(param, "^([^ ]+) +([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
305 if teleportee_name then
306 teleportee = minetest.env:get_player_by_name(teleportee_name)
308 if teleportee and p.x and p.y and p.z then
309 minetest.chat_send_player(name, "Teleporting "..teleportee_name.." to ("..p.x..", "..p.y..", "..p.z..")")
314 local teleportee = nil
316 local teleportee_name = nil
317 local target_name = nil
318 teleportee_name, target_name = string.match(param, "^([^ ]+) +([^ ]+)$")
319 if teleportee_name then
320 teleportee = minetest.env:get_player_by_name(teleportee_name)
323 local target = minetest.env:get_player_by_name(target_name)
328 if teleportee and p then
329 p = find_free_position_near(p)
330 minetest.chat_send_player(name, "Teleporting "..teleportee_name.." to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
336 minetest.chat_send_player(name, "Invalid parameters (\""..param.."\") or player not found (see /help teleport)")
341 minetest.register_chatcommand("set", {
342 params = "[-n] <name> <value> | <name>",
343 description = "set or read server configuration setting",
344 privs = {server=true},
345 func = function(name, param)
346 local arg, setname, setvalue = string.match(param, "(-[n]) ([^ ]+) (.+)")
347 if arg and arg == "-n" and setname and setvalue then
348 minetest.setting_set(setname, setvalue)
349 minetest.chat_send_player(name, setname.." = "..setvalue)
352 local setname, setvalue = string.match(param, "([^ ]+) (.+)")
353 if setname and setvalue then
354 if not minetest.setting_get(setname) then
355 minetest.chat_send_player(name, "Failed. Use '/set -n <name> <value>' to create a new setting.")
358 minetest.setting_set(setname, setvalue)
359 minetest.chat_send_player(name, setname.." = "..setvalue)
362 local setname = string.match(param, "([^ ]+)")
364 local setvalue = minetest.setting_get(setname)
366 setvalue = "<not set>"
368 minetest.chat_send_player(name, setname.." = "..setvalue)
371 minetest.chat_send_player(name, "Invalid parameters (see /help set)")
375 minetest.register_chatcommand("mods", {
377 description = "lists mods installed on the server",
379 func = function(name, param)
381 local modnames = minetest.get_modnames()
382 for i, mod in ipairs(modnames) do
383 response = response .. mod
384 -- Add space if not at the end
385 if i ~= #modnames then
386 response = response .. " "
389 minetest.chat_send_player(name, response)
393 local function handle_give_command(cmd, giver, receiver, stackstring)
394 minetest.log("action", giver.." invoked "..cmd..', stackstring="'
396 minetest.log(cmd..' invoked, stackstring="'..stackstring..'"')
397 local itemstack = ItemStack(stackstring)
398 if itemstack:is_empty() then
399 minetest.chat_send_player(giver, 'error: cannot give an empty item')
401 elseif not itemstack:is_known() then
402 minetest.chat_send_player(giver, 'error: cannot give an unknown item')
405 local receiverref = minetest.env:get_player_by_name(receiver)
406 if receiverref == nil then
407 minetest.chat_send_player(giver, receiver..' is not a known player')
410 local leftover = receiverref:get_inventory():add_item("main", itemstack)
411 if leftover:is_empty() then
413 elseif leftover:get_count() == itemstack:get_count() then
414 partiality = "could not be "
416 partiality = "partially "
418 -- The actual item stack string may be different from what the "giver"
419 -- entered (e.g. big numbers are always interpreted as 2^16-1).
420 stackstring = itemstack:to_string()
421 if giver == receiver then
422 minetest.chat_send_player(giver, '"'..stackstring
423 ..'" '..partiality..'added to inventory.');
425 minetest.chat_send_player(giver, '"'..stackstring
426 ..'" '..partiality..'added to '..receiver..'\'s inventory.');
427 minetest.chat_send_player(receiver, '"'..stackstring
428 ..'" '..partiality..'added to inventory.');
432 minetest.register_chatcommand("give", {
433 params = "<name> <itemstring>",
434 description = "give item to player",
436 func = function(name, param)
437 local toname, itemstring = string.match(param, "^([^ ]+) +(.+)$")
438 if not toname or not itemstring then
439 minetest.chat_send_player(name, "name and itemstring required")
442 handle_give_command("/give", name, toname, itemstring)
445 minetest.register_chatcommand("giveme", {
446 params = "<itemstring>",
447 description = "give item to yourself",
449 func = function(name, param)
450 local itemstring = string.match(param, "(.+)$")
451 if not itemstring then
452 minetest.chat_send_player(name, "itemstring required")
455 handle_give_command("/giveme", name, name, itemstring)
458 minetest.register_chatcommand("spawnentity", {
459 params = "<entityname>",
460 description = "spawn entity at your position",
461 privs = {give=true, interact=true},
462 func = function(name, param)
463 local entityname = string.match(param, "(.+)$")
464 if not entityname then
465 minetest.chat_send_player(name, "entityname required")
468 print('/spawnentity invoked, entityname="'..entityname..'"')
469 local player = minetest.env:get_player_by_name(name)
470 if player == nil then
471 print("Unable to spawn entity, player is nil")
472 return true -- Handled chat message
474 local p = player:getpos()
476 minetest.env:add_entity(p, entityname)
477 minetest.chat_send_player(name, '"'..entityname
481 minetest.register_chatcommand("pulverize", {
483 description = "delete item in hand",
485 func = function(name, param)
486 local player = minetest.env:get_player_by_name(name)
487 if player == nil then
488 print("Unable to pulverize, player is nil")
489 return true -- Handled chat message
491 if player:get_wielded_item():is_empty() then
492 minetest.chat_send_player(name, 'Unable to pulverize, no item in hand.')
494 player:set_wielded_item(nil)
495 minetest.chat_send_player(name, 'An item was pulverized.')
501 minetest.rollback_punch_callbacks = {}
503 minetest.register_on_punchnode(function(pos, node, puncher)
504 local name = puncher:get_player_name()
505 if minetest.rollback_punch_callbacks[name] then
506 minetest.rollback_punch_callbacks[name](pos, node, puncher)
507 minetest.rollback_punch_callbacks[name] = nil
511 minetest.register_chatcommand("rollback_check", {
512 params = "[<range>] [<seconds>]",
513 description = "check who has last touched a node or near it, "..
514 "max. <seconds> ago (default range=0, seconds=86400=24h)",
515 privs = {rollback=true},
516 func = function(name, param)
517 local range, seconds = string.match(param, "(%d+) *(%d*)")
518 range = tonumber(range) or 0
519 seconds = tonumber(seconds) or 86400
520 minetest.chat_send_player(name, "Punch a node (limits set: range="..
521 dump(range).." seconds="..dump(seconds).."s)")
522 minetest.rollback_punch_callbacks[name] = function(pos, node, puncher)
523 local name = puncher:get_player_name()
524 minetest.chat_send_player(name, "Checking...")
525 local actor, act_p, act_seconds =
526 minetest.rollback_get_last_node_actor(pos, range, seconds)
528 minetest.chat_send_player(name, "Nobody has touched the "..
529 "specified location in "..dump(seconds).." seconds")
532 local nodedesc = "this node"
533 if act_p.x ~= pos.x or act_p.y ~= pos.y or act_p.z ~= pos.z then
534 nodedesc = minetest.pos_to_string(act_p)
536 local nodename = minetest.env:get_node(act_p).name
537 minetest.chat_send_player(name, "Last actor on "..nodedesc..
538 " was "..actor..", "..dump(act_seconds)..
539 "s ago (node is now "..nodename..")")
544 minetest.register_chatcommand("rollback", {
545 params = "<player name> [<seconds>] | :<actor> [<seconds>]",
546 description = "revert actions of a player; default for <seconds> is 60",
547 privs = {rollback=true},
548 func = function(name, param)
549 local target_name, seconds = string.match(param, ":([^ ]+) *(%d*)")
550 if not target_name then
551 local player_name = nil;
552 player_name, seconds = string.match(param, "([^ ]+) *(%d*)")
553 if not player_name then
554 minetest.chat_send_player(name, "Invalid parameters. See /help rollback and /help rollback_check")
557 target_name = "player:"..player_name
559 seconds = tonumber(seconds) or 60
560 minetest.chat_send_player(name, "Reverting actions of "..
561 dump(target_name).." since "..dump(seconds).." seconds.")
562 local success, log = minetest.rollback_revert_actions_by(
563 target_name, seconds)
565 minetest.chat_send_player(name, "(log is too long to show)")
567 for _,line in ipairs(log) do
568 minetest.chat_send_player(name, line)
572 minetest.chat_send_player(name, "Reverting actions succeeded.")
574 minetest.chat_send_player(name, "Reverting actions FAILED.")
579 minetest.register_chatcommand("status", {
581 description = "print server status line",
583 func = function(name, param)
584 minetest.chat_send_player(name, minetest.get_server_status())
588 minetest.register_chatcommand("time", {
589 params = "<0...24000>",
590 description = "set time of day",
591 privs = {settime=true},
592 func = function(name, param)
594 minetest.chat_send_player(name, "Missing parameter")
597 local newtime = tonumber(param)
598 if newtime == nil then
599 minetest.chat_send_player(name, "Invalid time")
601 minetest.env:set_timeofday((newtime % 24000) / 24000)
602 minetest.chat_send_player(name, "Time of day changed.")
603 minetest.log("action", name .. " sets time " .. newtime)
608 minetest.register_chatcommand("shutdown", {
610 description = "shutdown server",
611 privs = {server=true},
612 func = function(name, param)
613 minetest.log("action", name .. " shuts down server")
614 minetest.request_shutdown()
615 minetest.chat_send_all("*** Server shutting down (operator request).")
619 minetest.register_chatcommand("ban", {
621 description = "ban IP of player",
623 func = function(name, param)
625 minetest.chat_send_player(name, "Ban list: " .. minetest.get_ban_list())
628 if not minetest.env:get_player_by_name(param) then
629 minetest.chat_send_player(name, "No such player")
632 if not minetest.ban_player(param) then
633 minetest.chat_send_player(name, "Failed to ban player")
635 local desc = minetest.get_ban_description(param)
636 minetest.chat_send_player(name, "Banned " .. desc .. ".")
637 minetest.log("action", name .. " bans " .. desc .. ".")
642 minetest.register_chatcommand("unban", {
643 params = "<name/ip>",
644 description = "remove IP ban",
646 func = function(name, param)
647 if not minetest.unban_player_or_ip(param) then
648 minetest.chat_send_player(name, "Failed to unban player/IP")
650 minetest.chat_send_player(name, "Unbanned " .. param)
651 minetest.log("action", name .. " unbans " .. param)
656 minetest.register_chatcommand("clearobjects", {
658 description = "clear all objects in world",
659 privs = {server=true},
660 func = function(name, param)
661 minetest.log("action", name .. " clears all objects")
662 minetest.chat_send_all("Clearing all objects. This may take long. You may experience a timeout. (by " .. name .. ")")
663 minetest.env:clear_objects()
664 minetest.log("action", "object clearing done")
665 minetest.chat_send_all("*** Cleared all objects.")
669 minetest.register_chatcommand("msg", {
670 params = "<name> <message>",
671 description = "Send a private message",
672 privs = {shout=true},
673 func = function(name, param)
674 local found, _, sendto, message = param:find("^([^%s]+)%s(.+)$")
676 if minetest.env:get_player_by_name(sendto) then
677 minetest.log("action", "PM from "..name.." to "..sendto..": "..message)
678 minetest.chat_send_player(sendto, "PM from "..name..": "..message)
679 minetest.chat_send_player(name, "Message sent")
681 minetest.chat_send_player(name, "The player "..sendto.." is not online")
684 minetest.chat_send_player(name, "Invalid usage, see /help msg")