1 -- Minetest: builtin/chatcommands.lua
4 -- Chat command handler
8 function core.register_chatcommand(cmd, def)
10 def.params = def.params or ""
11 def.description = def.description or ""
12 def.privs = def.privs or {}
13 core.chatcommands[cmd] = def
16 core.register_on_chat_message(function(name, message)
17 local cmd, param = string.match(message, "^/([^ ]+) *(.*)")
21 local cmd_def = core.chatcommands[cmd]
23 local has_privs, missing_privs = core.check_player_privs(name, cmd_def.privs)
25 cmd_def.func(name, param)
27 core.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 core.register_chatcommand("me", {
39 description = "chat action (eg. /me orders a pizza)",
41 func = function(name, param)
42 core.chat_send_all("* " .. name .. " " .. param)
46 core.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(core.chatcommands) do
61 if core.check_player_privs(name, def.privs) then
62 table.insert(cmds, cmd)
65 core.chat_send_player(name, "Available commands: "..table.concat(cmds, " "))
66 core.chat_send_player(name, "Use '/help <cmd>' to get more information, or '/help all' to list everything.")
67 elseif param == "all" then
68 core.chat_send_player(name, "Available commands:")
69 for cmd, def in pairs(core.chatcommands) do
70 if core.check_player_privs(name, def.privs) then
71 core.chat_send_player(name, format_help_line(cmd, def))
74 elseif param == "privs" then
75 core.chat_send_player(name, "Available privileges:")
76 for priv, def in pairs(core.registered_privileges) do
77 core.chat_send_player(name, priv..": "..def.description)
81 def = core.chatcommands[cmd]
83 core.chat_send_player(name, "Command not available: "..cmd)
85 core.chat_send_player(name, format_help_line(cmd, def))
90 core.register_chatcommand("privs", {
92 description = "print out privileges of player",
93 func = function(name, param)
97 --[[if not core.check_player_privs(name, {privs=true}) then
98 core.chat_send_player(name, "Privileges of "..param.." are hidden from you.")
102 core.chat_send_player(name, "Privileges of "..param..": "..core.privs_to_string(core.get_player_privs(param), ' '))
105 core.register_chatcommand("grant", {
106 params = "<name> <privilege>|all",
107 description = "Give privilege to player",
109 func = function(name, param)
110 if not core.check_player_privs(name, {privs=true}) and
111 not core.check_player_privs(name, {basic_privs=true}) then
112 core.chat_send_player(name, "Your privileges are insufficient.")
115 local grantname, grantprivstr = string.match(param, "([^ ]+) (.+)")
116 if not grantname or not grantprivstr then
117 core.chat_send_player(name, "Invalid parameters (see /help grant)")
119 elseif not core.auth_table[grantname] then
120 core.chat_send_player(name, "Player "..grantname.." does not exist.")
123 local grantprivs = core.string_to_privs(grantprivstr)
124 if grantprivstr == "all" then
125 grantprivs = core.registered_privileges
127 local privs = core.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 core.check_player_privs(name, {privs=true}) then
131 core.chat_send_player(name, "Your privileges are insufficient.")
134 if not core.registered_privileges[priv] then
135 core.chat_send_player(name, "Unknown privilege: "..priv)
140 if not privs_known then
143 core.set_player_privs(grantname, privs)
144 core.log(name..' granted ('..core.privs_to_string(grantprivs, ', ')..') privileges to '..grantname)
145 core.chat_send_player(name, "Privileges of "..grantname..": "..core.privs_to_string(core.get_player_privs(grantname), ' '))
146 if grantname ~= name then
147 core.chat_send_player(grantname, name.." granted you privileges: "..core.privs_to_string(grantprivs, ' '))
151 core.register_chatcommand("revoke", {
152 params = "<name> <privilege>|all",
153 description = "Remove privilege from player",
155 func = function(name, param)
156 if not core.check_player_privs(name, {privs=true}) and
157 not core.check_player_privs(name, {basic_privs=true}) then
158 core.chat_send_player(name, "Your privileges are insufficient.")
161 local revokename, revokeprivstr = string.match(param, "([^ ]+) (.+)")
162 if not revokename or not revokeprivstr then
163 core.chat_send_player(name, "Invalid parameters (see /help revoke)")
165 elseif not core.auth_table[revokename] then
166 core.chat_send_player(name, "Player "..revokename.." does not exist.")
169 local revokeprivs = core.string_to_privs(revokeprivstr)
170 local privs = core.get_player_privs(revokename)
171 for priv, _ in pairs(revokeprivs) do
172 if priv ~= "interact" and priv ~= "shout" and priv ~= "interact_extra" and not core.check_player_privs(name, {privs=true}) then
173 core.chat_send_player(name, "Your privileges are insufficient.")
177 if revokeprivstr == "all" then
180 for priv, _ in pairs(revokeprivs) do
184 core.set_player_privs(revokename, privs)
185 core.log(name..' revoked ('..core.privs_to_string(revokeprivs, ', ')..') privileges from '..revokename)
186 core.chat_send_player(name, "Privileges of "..revokename..": "..core.privs_to_string(core.get_player_privs(revokename), ' '))
187 if revokename ~= name then
188 core.chat_send_player(revokename, name.." revoked privileges from you: "..core.privs_to_string(revokeprivs, ' '))
192 core.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 core.chat_send_player(name, "Name field required")
207 if not raw_password then
208 core.set_player_password(toname, "")
211 core.set_player_password(toname, core.get_password_hash(toname, raw_password))
214 core.chat_send_player(name, "Password of player \""..toname.."\" "..actstr)
215 if toname ~= name then
216 core.chat_send_player(toname, "Your password was "..actstr.." by "..name)
220 core.register_chatcommand("clearpassword", {
222 description = "set empty password",
223 privs = {password=true},
224 func = function(name, param)
227 core.chat_send_player(name, "Name field required")
230 core.set_player_password(toname, '')
231 core.chat_send_player(name, "Password of player \""..toname.."\" cleared")
235 core.register_chatcommand("auth_reload", {
237 description = "reload authentication data",
238 privs = {server=true},
239 func = function(name, param)
240 local done = core.auth_reload()
242 core.chat_send_player(name, "Done.")
244 core.chat_send_player(name, "Failed.")
249 core.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 = core.get_node_or_nil(p)
266 local def = core.registered_nodes[n.name]
267 if def and not def.walkable then
275 local teleportee = nil
277 p.x, p.y, p.z = string.match(param, "^([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
281 teleportee = core.get_player_by_name(name)
282 if teleportee and p.x and p.y and p.z then
283 core.chat_send_player(name, "Teleporting to ("..p.x..", "..p.y..", "..p.z..")")
288 local teleportee = nil
290 local target_name = nil
291 target_name = string.match(param, "^([^ ]+)$")
292 teleportee = core.get_player_by_name(name)
294 local target = core.get_player_by_name(target_name)
299 if teleportee and p then
300 p = find_free_position_near(p)
301 core.chat_send_player(name, "Teleporting to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
306 if core.check_player_privs(name, {bring=true}) then
307 local teleportee = nil
309 local teleportee_name = nil
310 teleportee_name, p.x, p.y, p.z = string.match(param, "^([^ ]+) +([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
314 if teleportee_name then
315 teleportee = core.get_player_by_name(teleportee_name)
317 if teleportee and p.x and p.y and p.z then
318 core.chat_send_player(name, "Teleporting "..teleportee_name.." to ("..p.x..", "..p.y..", "..p.z..")")
323 local teleportee = nil
325 local teleportee_name = nil
326 local target_name = nil
327 teleportee_name, target_name = string.match(param, "^([^ ]+) +([^ ]+)$")
328 if teleportee_name then
329 teleportee = core.get_player_by_name(teleportee_name)
332 local target = core.get_player_by_name(target_name)
337 if teleportee and p then
338 p = find_free_position_near(p)
339 core.chat_send_player(name, "Teleporting "..teleportee_name.." to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
345 core.chat_send_player(name, "Invalid parameters (\""..param.."\") or player not found (see /help teleport)")
350 core.register_chatcommand("set", {
351 params = "[-n] <name> <value> | <name>",
352 description = "set or read server configuration setting",
353 privs = {server=true},
354 func = function(name, param)
355 local arg, setname, setvalue = string.match(param, "(-[n]) ([^ ]+) (.+)")
356 if arg and arg == "-n" and setname and setvalue then
357 core.setting_set(setname, setvalue)
358 core.chat_send_player(name, setname.." = "..setvalue)
361 local setname, setvalue = string.match(param, "([^ ]+) (.+)")
362 if setname and setvalue then
363 if not core.setting_get(setname) then
364 core.chat_send_player(name, "Failed. Use '/set -n <name> <value>' to create a new setting.")
367 core.setting_set(setname, setvalue)
368 core.chat_send_player(name, setname.." = "..setvalue)
371 local setname = string.match(param, "([^ ]+)")
373 local setvalue = core.setting_get(setname)
375 setvalue = "<not set>"
377 core.chat_send_player(name, setname.." = "..setvalue)
380 core.chat_send_player(name, "Invalid parameters (see /help set)")
384 core.register_chatcommand("mods", {
386 description = "lists mods installed on the server",
388 func = function(name, param)
390 local modnames = core.get_modnames()
391 for i, mod in ipairs(modnames) do
392 response = response .. mod
393 -- Add space if not at the end
394 if i ~= #modnames then
395 response = response .. " "
398 core.chat_send_player(name, response)
402 local function handle_give_command(cmd, giver, receiver, stackstring)
403 core.log("action", giver.." invoked "..cmd..', stackstring="'
405 core.log(cmd..' invoked, stackstring="'..stackstring..'"')
406 local itemstack = ItemStack(stackstring)
407 if itemstack:is_empty() then
408 core.chat_send_player(giver, 'error: cannot give an empty item')
410 elseif not itemstack:is_known() then
411 core.chat_send_player(giver, 'error: cannot give an unknown item')
414 local receiverref = core.get_player_by_name(receiver)
415 if receiverref == nil then
416 core.chat_send_player(giver, receiver..' is not a known player')
419 local leftover = receiverref:get_inventory():add_item("main", itemstack)
420 if leftover:is_empty() then
422 elseif leftover:get_count() == itemstack:get_count() then
423 partiality = "could not be "
425 partiality = "partially "
427 -- The actual item stack string may be different from what the "giver"
428 -- entered (e.g. big numbers are always interpreted as 2^16-1).
429 stackstring = itemstack:to_string()
430 if giver == receiver then
431 core.chat_send_player(giver, '"'..stackstring
432 ..'" '..partiality..'added to inventory.');
434 core.chat_send_player(giver, '"'..stackstring
435 ..'" '..partiality..'added to '..receiver..'\'s inventory.');
436 core.chat_send_player(receiver, '"'..stackstring
437 ..'" '..partiality..'added to inventory.');
441 core.register_chatcommand("give", {
442 params = "<name> <itemstring>",
443 description = "give item to player",
445 func = function(name, param)
446 local toname, itemstring = string.match(param, "^([^ ]+) +(.+)$")
447 if not toname or not itemstring then
448 core.chat_send_player(name, "name and itemstring required")
451 handle_give_command("/give", name, toname, itemstring)
454 core.register_chatcommand("giveme", {
455 params = "<itemstring>",
456 description = "give item to yourself",
458 func = function(name, param)
459 local itemstring = string.match(param, "(.+)$")
460 if not itemstring then
461 core.chat_send_player(name, "itemstring required")
464 handle_give_command("/giveme", name, name, itemstring)
467 core.register_chatcommand("spawnentity", {
468 params = "<entityname>",
469 description = "spawn entity at your position",
470 privs = {give=true, interact=true},
471 func = function(name, param)
472 local entityname = string.match(param, "(.+)$")
473 if not entityname then
474 core.chat_send_player(name, "entityname required")
477 core.log("action", '/spawnentity invoked, entityname="'..entityname..'"')
478 local player = core.get_player_by_name(name)
479 if player == nil then
480 core.log("error", "Unable to spawn entity, player is nil")
481 return true -- Handled chat message
483 local p = player:getpos()
485 core.add_entity(p, entityname)
486 core.chat_send_player(name, '"'..entityname
490 core.register_chatcommand("pulverize", {
492 description = "delete item in hand",
494 func = function(name, param)
495 local player = core.get_player_by_name(name)
496 if player == nil then
497 core.log("error", "Unable to pulverize, player is nil")
498 return true -- Handled chat message
500 if player:get_wielded_item():is_empty() then
501 core.chat_send_player(name, 'Unable to pulverize, no item in hand.')
503 player:set_wielded_item(nil)
504 core.chat_send_player(name, 'An item was pulverized.')
510 core.rollback_punch_callbacks = {}
512 core.register_on_punchnode(function(pos, node, puncher)
513 local name = puncher:get_player_name()
514 if core.rollback_punch_callbacks[name] then
515 core.rollback_punch_callbacks[name](pos, node, puncher)
516 core.rollback_punch_callbacks[name] = nil
520 core.register_chatcommand("rollback_check", {
521 params = "[<range>] [<seconds>] [limit]",
522 description = "check who has last touched a node or near it, "..
523 "max. <seconds> ago (default range=0, seconds=86400=24h, limit=5)",
524 privs = {rollback=true},
525 func = function(name, param)
526 local range, seconds, limit =
527 param:match("(%d+) *(%d*) *(%d*)")
528 range = tonumber(range) or 0
529 seconds = tonumber(seconds) or 86400
530 limit = tonumber(limit) or 5
532 core.chat_send_player(name, "That limit is too high!")
535 core.chat_send_player(name, "Punch a node (range="..
536 range..", seconds="..seconds.."s, limit="..limit..")")
538 core.rollback_punch_callbacks[name] = function(pos, node, puncher)
539 local name = puncher:get_player_name()
540 core.chat_send_player(name, "Checking "..core.pos_to_string(pos).."...")
541 local actions = core.rollback_get_node_actions(pos, range, seconds, limit)
542 local num_actions = #actions
543 if num_actions == 0 then
544 core.chat_send_player(name, "Nobody has touched the "..
545 "specified location in "..seconds.." seconds")
548 local time = os.time()
549 for i = num_actions, 1, -1 do
550 local action = actions[i]
551 core.chat_send_player(name,
552 ("%s %s %s -> %s %d seconds ago.")
554 core.pos_to_string(action.pos),
564 core.register_chatcommand("rollback", {
565 params = "<player name> [<seconds>] | :<actor> [<seconds>]",
566 description = "revert actions of a player; default for <seconds> is 60",
567 privs = {rollback=true},
568 func = function(name, param)
569 local target_name, seconds = string.match(param, ":([^ ]+) *(%d*)")
570 if not target_name then
571 local player_name = nil
572 player_name, seconds = string.match(param, "([^ ]+) *(%d*)")
573 if not player_name then
574 core.chat_send_player(name, "Invalid parameters. See /help rollback and /help rollback_check")
577 target_name = "player:"..player_name
579 seconds = tonumber(seconds) or 60
580 core.chat_send_player(name, "Reverting actions of "..
581 target_name.." since "..seconds.." seconds.")
582 local success, log = core.rollback_revert_actions_by(
583 target_name, seconds)
585 core.chat_send_player(name, "(log is too long to show)")
587 for _, line in pairs(log) do
588 core.chat_send_player(name, line)
592 core.chat_send_player(name, "Reverting actions succeeded.")
594 core.chat_send_player(name, "Reverting actions FAILED.")
599 core.register_chatcommand("status", {
601 description = "print server status line",
603 func = function(name, param)
604 core.chat_send_player(name, core.get_server_status())
608 core.register_chatcommand("time", {
609 params = "<0...24000>",
610 description = "set time of day",
611 privs = {settime=true},
612 func = function(name, param)
614 core.chat_send_player(name, "Missing parameter")
617 local newtime = tonumber(param)
618 if newtime == nil then
619 core.chat_send_player(name, "Invalid time")
621 core.set_timeofday((newtime % 24000) / 24000)
622 core.chat_send_player(name, "Time of day changed.")
623 core.log("action", name .. " sets time " .. newtime)
628 core.register_chatcommand("shutdown", {
630 description = "shutdown server",
631 privs = {server=true},
632 func = function(name, param)
633 core.log("action", name .. " shuts down server")
634 core.request_shutdown()
635 core.chat_send_all("*** Server shutting down (operator request).")
639 core.register_chatcommand("ban", {
641 description = "ban IP of player",
643 func = function(name, param)
645 core.chat_send_player(name, "Ban list: " .. core.get_ban_list())
648 if not core.get_player_by_name(param) then
649 core.chat_send_player(name, "No such player")
652 if not core.ban_player(param) then
653 core.chat_send_player(name, "Failed to ban player")
655 local desc = core.get_ban_description(param)
656 core.chat_send_player(name, "Banned " .. desc .. ".")
657 core.log("action", name .. " bans " .. desc .. ".")
662 core.register_chatcommand("unban", {
663 params = "<name/ip>",
664 description = "remove IP ban",
666 func = function(name, param)
667 if not core.unban_player_or_ip(param) then
668 core.chat_send_player(name, "Failed to unban player/IP")
670 core.chat_send_player(name, "Unbanned " .. param)
671 core.log("action", name .. " unbans " .. param)
676 core.register_chatcommand("kick", {
677 params = "<name> [reason]",
678 description = "kick a player",
680 func = function(name, param)
681 local tokick, reason = string.match(param, "([^ ]+) (.+)")
685 if not core.kick_player(tokick, reason) then
686 core.chat_send_player(name, "Failed to kick player " .. tokick)
688 core.chat_send_player(name, "kicked " .. tokick)
689 core.log("action", name .. " kicked " .. tokick)
694 core.register_chatcommand("clearobjects", {
696 description = "clear all objects in world",
697 privs = {server=true},
698 func = function(name, param)
699 core.log("action", name .. " clears all objects")
700 core.chat_send_all("Clearing all objects. This may take long. You may experience a timeout. (by " .. name .. ")")
702 core.log("action", "object clearing done")
703 core.chat_send_all("*** Cleared all objects.")
707 core.register_chatcommand("msg", {
708 params = "<name> <message>",
709 description = "Send a private message",
710 privs = {shout=true},
711 func = function(name, param)
712 local found, _, sendto, message = param:find("^([^%s]+)%s(.+)$")
714 if core.get_player_by_name(sendto) then
715 core.log("action", "PM from "..name.." to "..sendto..": "..message)
716 core.chat_send_player(sendto, "PM from "..name..": "..message)
717 core.chat_send_player(name, "Message sent")
719 core.chat_send_player(name, "The player "..sendto.." is not online")
722 core.chat_send_player(name, "Invalid usage, see /help msg")