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)
66 core.chat_send_player(name, "Available commands: "..table.concat(cmds, " "))
67 core.chat_send_player(name, "Use '/help <cmd>' to get more information, or '/help all' to list everything.")
68 elseif param == "all" then
70 for cmd, def in pairs(core.chatcommands) do
71 if core.check_player_privs(name, def.privs) then
72 table.insert(cmds, cmd)
76 core.chat_send_player(name, "Available commands:")
77 for _, cmd in ipairs(cmds) do
78 local def = core.chatcommands[cmd]
79 core.chat_send_player(name, format_help_line(cmd, def))
81 elseif param == "privs" then
83 for priv, def in pairs(core.registered_privileges) do
84 table.insert(privs, priv)
87 core.chat_send_player(name, "Available privileges:")
88 for _, priv in ipairs(privs) do
89 local def = core.registered_privileges[priv]
90 core.chat_send_player(name, priv..": "..def.description)
94 def = core.chatcommands[cmd]
96 core.chat_send_player(name, "Command not available: "..cmd)
98 core.chat_send_player(name, format_help_line(cmd, def))
103 core.register_chatcommand("privs", {
105 description = "print out privileges of player",
106 func = function(name, param)
110 --[[if not core.check_player_privs(name, {privs=true}) then
111 core.chat_send_player(name, "Privileges of "..param.." are hidden from you.")
115 core.chat_send_player(name, "Privileges of "..param..": "..core.privs_to_string(core.get_player_privs(param), ' '))
118 core.register_chatcommand("grant", {
119 params = "<name> <privilege>|all",
120 description = "Give privilege to player",
122 func = function(name, param)
123 if not core.check_player_privs(name, {privs=true}) and
124 not core.check_player_privs(name, {basic_privs=true}) then
125 core.chat_send_player(name, "Your privileges are insufficient.")
128 local grantname, grantprivstr = string.match(param, "([^ ]+) (.+)")
129 if not grantname or not grantprivstr then
130 core.chat_send_player(name, "Invalid parameters (see /help grant)")
132 elseif not core.auth_table[grantname] then
133 core.chat_send_player(name, "Player "..grantname.." does not exist.")
136 local grantprivs = core.string_to_privs(grantprivstr)
137 if grantprivstr == "all" then
138 grantprivs = core.registered_privileges
140 local privs = core.get_player_privs(grantname)
141 local privs_known = true
142 for priv, _ in pairs(grantprivs) do
143 if priv ~= "interact" and priv ~= "shout" and priv ~= "interact_extra" and not core.check_player_privs(name, {privs=true}) then
144 core.chat_send_player(name, "Your privileges are insufficient.")
147 if not core.registered_privileges[priv] then
148 core.chat_send_player(name, "Unknown privilege: "..priv)
153 if not privs_known then
156 core.set_player_privs(grantname, privs)
157 core.log(name..' granted ('..core.privs_to_string(grantprivs, ', ')..') privileges to '..grantname)
158 core.chat_send_player(name, "Privileges of "..grantname..": "..core.privs_to_string(core.get_player_privs(grantname), ' '))
159 if grantname ~= name then
160 core.chat_send_player(grantname, name.." granted you privileges: "..core.privs_to_string(grantprivs, ' '))
164 core.register_chatcommand("revoke", {
165 params = "<name> <privilege>|all",
166 description = "Remove privilege from player",
168 func = function(name, param)
169 if not core.check_player_privs(name, {privs=true}) and
170 not core.check_player_privs(name, {basic_privs=true}) then
171 core.chat_send_player(name, "Your privileges are insufficient.")
174 local revokename, revokeprivstr = string.match(param, "([^ ]+) (.+)")
175 if not revokename or not revokeprivstr then
176 core.chat_send_player(name, "Invalid parameters (see /help revoke)")
178 elseif not core.auth_table[revokename] then
179 core.chat_send_player(name, "Player "..revokename.." does not exist.")
182 local revokeprivs = core.string_to_privs(revokeprivstr)
183 local privs = core.get_player_privs(revokename)
184 for priv, _ in pairs(revokeprivs) do
185 if priv ~= "interact" and priv ~= "shout" and priv ~= "interact_extra" and not core.check_player_privs(name, {privs=true}) then
186 core.chat_send_player(name, "Your privileges are insufficient.")
190 if revokeprivstr == "all" then
193 for priv, _ in pairs(revokeprivs) do
197 core.set_player_privs(revokename, privs)
198 core.log(name..' revoked ('..core.privs_to_string(revokeprivs, ', ')..') privileges from '..revokename)
199 core.chat_send_player(name, "Privileges of "..revokename..": "..core.privs_to_string(core.get_player_privs(revokename), ' '))
200 if revokename ~= name then
201 core.chat_send_player(revokename, name.." revoked privileges from you: "..core.privs_to_string(revokeprivs, ' '))
205 core.register_chatcommand("setpassword", {
206 params = "<name> <password>",
207 description = "set given password",
208 privs = {password=true},
209 func = function(name, param)
210 local toname, raw_password = string.match(param, "^([^ ]+) +(.+)$")
212 toname = string.match(param, "^([^ ]+) *$")
216 core.chat_send_player(name, "Name field required")
220 if not raw_password then
221 core.set_player_password(toname, "")
224 core.set_player_password(toname, core.get_password_hash(toname, raw_password))
227 core.chat_send_player(name, "Password of player \""..toname.."\" "..actstr)
228 if toname ~= name then
229 core.chat_send_player(toname, "Your password was "..actstr.." by "..name)
233 core.register_chatcommand("clearpassword", {
235 description = "set empty password",
236 privs = {password=true},
237 func = function(name, param)
240 core.chat_send_player(name, "Name field required")
243 core.set_player_password(toname, '')
244 core.chat_send_player(name, "Password of player \""..toname.."\" cleared")
248 core.register_chatcommand("auth_reload", {
250 description = "reload authentication data",
251 privs = {server=true},
252 func = function(name, param)
253 local done = core.auth_reload()
255 core.chat_send_player(name, "Done.")
257 core.chat_send_player(name, "Failed.")
262 core.register_chatcommand("teleport", {
263 params = "<X>,<Y>,<Z> | <to_name> | <name> <X>,<Y>,<Z> | <name> <to_name>",
264 description = "teleport to given position",
265 privs = {teleport=true},
266 func = function(name, param)
267 -- Returns (pos, true) if found, otherwise (pos, false)
268 local function find_free_position_near(pos)
275 for _, d in ipairs(tries) do
276 local p = {x = pos.x+d.x, y = pos.y+d.y, z = pos.z+d.z}
277 local n = core.get_node_or_nil(p)
279 local def = core.registered_nodes[n.name]
280 if def and not def.walkable then
288 local teleportee = nil
290 p.x, p.y, p.z = string.match(param, "^([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
294 teleportee = core.get_player_by_name(name)
295 if teleportee and p.x and p.y and p.z then
296 core.chat_send_player(name, "Teleporting to ("..p.x..", "..p.y..", "..p.z..")")
301 local teleportee = nil
303 local target_name = nil
304 target_name = string.match(param, "^([^ ]+)$")
305 teleportee = core.get_player_by_name(name)
307 local target = core.get_player_by_name(target_name)
312 if teleportee and p then
313 p = find_free_position_near(p)
314 core.chat_send_player(name, "Teleporting to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
319 if core.check_player_privs(name, {bring=true}) then
320 local teleportee = nil
322 local teleportee_name = nil
323 teleportee_name, p.x, p.y, p.z = string.match(param, "^([^ ]+) +([%d.-]+)[, ] *([%d.-]+)[, ] *([%d.-]+)$")
327 if teleportee_name then
328 teleportee = core.get_player_by_name(teleportee_name)
330 if teleportee and p.x and p.y and p.z then
331 core.chat_send_player(name, "Teleporting "..teleportee_name.." to ("..p.x..", "..p.y..", "..p.z..")")
336 local teleportee = nil
338 local teleportee_name = nil
339 local target_name = nil
340 teleportee_name, target_name = string.match(param, "^([^ ]+) +([^ ]+)$")
341 if teleportee_name then
342 teleportee = core.get_player_by_name(teleportee_name)
345 local target = core.get_player_by_name(target_name)
350 if teleportee and p then
351 p = find_free_position_near(p)
352 core.chat_send_player(name, "Teleporting "..teleportee_name.." to "..target_name.." at ("..p.x..", "..p.y..", "..p.z..")")
358 core.chat_send_player(name, "Invalid parameters (\""..param.."\") or player not found (see /help teleport)")
363 core.register_chatcommand("set", {
364 params = "[-n] <name> <value> | <name>",
365 description = "set or read server configuration setting",
366 privs = {server=true},
367 func = function(name, param)
368 local arg, setname, setvalue = string.match(param, "(-[n]) ([^ ]+) (.+)")
369 if arg and arg == "-n" and setname and setvalue then
370 core.setting_set(setname, setvalue)
371 core.chat_send_player(name, setname.." = "..setvalue)
374 local setname, setvalue = string.match(param, "([^ ]+) (.+)")
375 if setname and setvalue then
376 if not core.setting_get(setname) then
377 core.chat_send_player(name, "Failed. Use '/set -n <name> <value>' to create a new setting.")
380 core.setting_set(setname, setvalue)
381 core.chat_send_player(name, setname.." = "..setvalue)
384 local setname = string.match(param, "([^ ]+)")
386 local setvalue = core.setting_get(setname)
388 setvalue = "<not set>"
390 core.chat_send_player(name, setname.." = "..setvalue)
393 core.chat_send_player(name, "Invalid parameters (see /help set)")
397 core.register_chatcommand("mods", {
399 description = "lists mods installed on the server",
401 func = function(name, param)
403 local modnames = core.get_modnames()
404 for i, mod in ipairs(modnames) do
405 response = response .. mod
406 -- Add space if not at the end
407 if i ~= #modnames then
408 response = response .. " "
411 core.chat_send_player(name, response)
415 local function handle_give_command(cmd, giver, receiver, stackstring)
416 core.log("action", giver.." invoked "..cmd..', stackstring="'
418 core.log(cmd..' invoked, stackstring="'..stackstring..'"')
419 local itemstack = ItemStack(stackstring)
420 if itemstack:is_empty() then
421 core.chat_send_player(giver, 'error: cannot give an empty item')
423 elseif not itemstack:is_known() then
424 core.chat_send_player(giver, 'error: cannot give an unknown item')
427 local receiverref = core.get_player_by_name(receiver)
428 if receiverref == nil then
429 core.chat_send_player(giver, receiver..' is not a known player')
432 local leftover = receiverref:get_inventory():add_item("main", itemstack)
433 if leftover:is_empty() then
435 elseif leftover:get_count() == itemstack:get_count() then
436 partiality = "could not be "
438 partiality = "partially "
440 -- The actual item stack string may be different from what the "giver"
441 -- entered (e.g. big numbers are always interpreted as 2^16-1).
442 stackstring = itemstack:to_string()
443 if giver == receiver then
444 core.chat_send_player(giver, '"'..stackstring
445 ..'" '..partiality..'added to inventory.');
447 core.chat_send_player(giver, '"'..stackstring
448 ..'" '..partiality..'added to '..receiver..'\'s inventory.');
449 core.chat_send_player(receiver, '"'..stackstring
450 ..'" '..partiality..'added to inventory.');
454 core.register_chatcommand("give", {
455 params = "<name> <itemstring>",
456 description = "give item to player",
458 func = function(name, param)
459 local toname, itemstring = string.match(param, "^([^ ]+) +(.+)$")
460 if not toname or not itemstring then
461 core.chat_send_player(name, "name and itemstring required")
464 handle_give_command("/give", name, toname, itemstring)
467 core.register_chatcommand("giveme", {
468 params = "<itemstring>",
469 description = "give item to yourself",
471 func = function(name, param)
472 local itemstring = string.match(param, "(.+)$")
473 if not itemstring then
474 core.chat_send_player(name, "itemstring required")
477 handle_give_command("/giveme", name, name, itemstring)
480 core.register_chatcommand("spawnentity", {
481 params = "<entityname>",
482 description = "spawn entity at your position",
483 privs = {give=true, interact=true},
484 func = function(name, param)
485 local entityname = string.match(param, "(.+)$")
486 if not entityname then
487 core.chat_send_player(name, "entityname required")
490 core.log("action", '/spawnentity invoked, entityname="'..entityname..'"')
491 local player = core.get_player_by_name(name)
492 if player == nil then
493 core.log("error", "Unable to spawn entity, player is nil")
494 return true -- Handled chat message
496 local p = player:getpos()
498 core.add_entity(p, entityname)
499 core.chat_send_player(name, '"'..entityname
503 core.register_chatcommand("pulverize", {
505 description = "delete item in hand",
507 func = function(name, param)
508 local player = core.get_player_by_name(name)
509 if player == nil then
510 core.log("error", "Unable to pulverize, player is nil")
511 return true -- Handled chat message
513 if player:get_wielded_item():is_empty() then
514 core.chat_send_player(name, 'Unable to pulverize, no item in hand.')
516 player:set_wielded_item(nil)
517 core.chat_send_player(name, 'An item was pulverized.')
523 core.rollback_punch_callbacks = {}
525 core.register_on_punchnode(function(pos, node, puncher)
526 local name = puncher:get_player_name()
527 if core.rollback_punch_callbacks[name] then
528 core.rollback_punch_callbacks[name](pos, node, puncher)
529 core.rollback_punch_callbacks[name] = nil
533 core.register_chatcommand("rollback_check", {
534 params = "[<range>] [<seconds>] [limit]",
535 description = "check who has last touched a node or near it, "..
536 "max. <seconds> ago (default range=0, seconds=86400=24h, limit=5)",
537 privs = {rollback=true},
538 func = function(name, param)
539 local range, seconds, limit =
540 param:match("(%d+) *(%d*) *(%d*)")
541 range = tonumber(range) or 0
542 seconds = tonumber(seconds) or 86400
543 limit = tonumber(limit) or 5
545 core.chat_send_player(name, "That limit is too high!")
548 core.chat_send_player(name, "Punch a node (range="..
549 range..", seconds="..seconds.."s, limit="..limit..")")
551 core.rollback_punch_callbacks[name] = function(pos, node, puncher)
552 local name = puncher:get_player_name()
553 core.chat_send_player(name, "Checking "..core.pos_to_string(pos).."...")
554 local actions = core.rollback_get_node_actions(pos, range, seconds, limit)
555 local num_actions = #actions
556 if num_actions == 0 then
557 core.chat_send_player(name, "Nobody has touched the "..
558 "specified location in "..seconds.." seconds")
561 local time = os.time()
562 for i = num_actions, 1, -1 do
563 local action = actions[i]
564 core.chat_send_player(name,
565 ("%s %s %s -> %s %d seconds ago.")
567 core.pos_to_string(action.pos),
577 core.register_chatcommand("rollback", {
578 params = "<player name> [<seconds>] | :<actor> [<seconds>]",
579 description = "revert actions of a player; default for <seconds> is 60",
580 privs = {rollback=true},
581 func = function(name, param)
582 local target_name, seconds = string.match(param, ":([^ ]+) *(%d*)")
583 if not target_name then
584 local player_name = nil
585 player_name, seconds = string.match(param, "([^ ]+) *(%d*)")
586 if not player_name then
587 core.chat_send_player(name, "Invalid parameters. See /help rollback and /help rollback_check")
590 target_name = "player:"..player_name
592 seconds = tonumber(seconds) or 60
593 core.chat_send_player(name, "Reverting actions of "..
594 target_name.." since "..seconds.." seconds.")
595 local success, log = core.rollback_revert_actions_by(
596 target_name, seconds)
598 core.chat_send_player(name, "(log is too long to show)")
600 for _, line in pairs(log) do
601 core.chat_send_player(name, line)
605 core.chat_send_player(name, "Reverting actions succeeded.")
607 core.chat_send_player(name, "Reverting actions FAILED.")
612 core.register_chatcommand("status", {
614 description = "print server status line",
616 func = function(name, param)
617 core.chat_send_player(name, core.get_server_status())
621 core.register_chatcommand("time", {
622 params = "<0...24000>",
623 description = "set time of day",
624 privs = {settime=true},
625 func = function(name, param)
627 core.chat_send_player(name, "Missing parameter")
630 local newtime = tonumber(param)
631 if newtime == nil then
632 core.chat_send_player(name, "Invalid time")
634 core.set_timeofday((newtime % 24000) / 24000)
635 core.chat_send_player(name, "Time of day changed.")
636 core.log("action", name .. " sets time " .. newtime)
641 core.register_chatcommand("shutdown", {
643 description = "shutdown server",
644 privs = {server=true},
645 func = function(name, param)
646 core.log("action", name .. " shuts down server")
647 core.request_shutdown()
648 core.chat_send_all("*** Server shutting down (operator request).")
652 core.register_chatcommand("ban", {
654 description = "ban IP of player",
656 func = function(name, param)
658 core.chat_send_player(name, "Ban list: " .. core.get_ban_list())
661 if not core.get_player_by_name(param) then
662 core.chat_send_player(name, "No such player")
665 if not core.ban_player(param) then
666 core.chat_send_player(name, "Failed to ban player")
668 local desc = core.get_ban_description(param)
669 core.chat_send_player(name, "Banned " .. desc .. ".")
670 core.log("action", name .. " bans " .. desc .. ".")
675 core.register_chatcommand("unban", {
676 params = "<name/ip>",
677 description = "remove IP ban",
679 func = function(name, param)
680 if not core.unban_player_or_ip(param) then
681 core.chat_send_player(name, "Failed to unban player/IP")
683 core.chat_send_player(name, "Unbanned " .. param)
684 core.log("action", name .. " unbans " .. param)
689 core.register_chatcommand("kick", {
690 params = "<name> [reason]",
691 description = "kick a player",
693 func = function(name, param)
694 local tokick, reason = string.match(param, "([^ ]+) (.+)")
698 if not core.kick_player(tokick, reason) then
699 core.chat_send_player(name, "Failed to kick player " .. tokick)
701 core.chat_send_player(name, "kicked " .. tokick)
702 core.log("action", name .. " kicked " .. tokick)
707 core.register_chatcommand("clearobjects", {
709 description = "clear all objects in world",
710 privs = {server=true},
711 func = function(name, param)
712 core.log("action", name .. " clears all objects")
713 core.chat_send_all("Clearing all objects. This may take long. You may experience a timeout. (by " .. name .. ")")
715 core.log("action", "object clearing done")
716 core.chat_send_all("*** Cleared all objects.")
720 core.register_chatcommand("msg", {
721 params = "<name> <message>",
722 description = "Send a private message",
723 privs = {shout=true},
724 func = function(name, param)
725 local found, _, sendto, message = param:find("^([^%s]+)%s(.+)$")
727 if core.get_player_by_name(sendto) then
728 core.log("action", "PM from "..name.." to "..sendto..": "..message)
729 core.chat_send_player(sendto, "PM from "..name..": "..message)
730 core.chat_send_player(name, "Message sent")
732 core.chat_send_player(name, "The player "..sendto.." is not online")
735 core.chat_send_player(name, "Invalid usage, see /help msg")