Difference between revisions of "Server commands"

From Luanti Wiki
Jump to navigation Jump to search
m (→‎World manipulation: refined defintion)
(→‎Profiler: fix syntax)
 
(78 intermediate revisions by 12 users not shown)
Line 1: Line 1:
−
Server commands are special commands to the server that can be entered by any player via the chat to cause the server to do something. There are a few commands which can be issued by everyone, but some commands only work if you have certain [[privileges]] granted on the server. Use “/privs” to see your own privileges. If not noted otherwise, the commands in this article are assumed to require no privileges. This article will only cover the commands that come with Minetest 0.4.7. Mods may add additional commands; refer to the mod’s documentation or use “/help all” in this case.
+
{{Languages}}
 +
 
 +
'''Server commands''' (also called “'''chat commands'''”) are special commands to the server that can be entered by any player via the [[chat]] to cause the server to do something.
 +
 
 +
== Command basics ==
 +
 
 +
Luanti comes with a set of built-in commands, but [[Games|games]] and [[Mods|mods]] may add custom commands or even alter or remove some of the built-in-commands.
 +
 
 +
There are many commands, but you only need to remember the <code>/help</code> command. This will give you a list of all commands that are ''currently'' available, plus a brief explanation.
 +
 
 +
There are a few commands which can be issued by everyone, but some commands only work if you have certain [[privileges]] granted on the server. Use the command <code>/privs</code> to see your own privileges. If not noted otherwise, the commands in this article are assumed to require no privileges.  
 +
 
 
== Issuing a command ==
 
== Issuing a command ==
−
To issue a command, simply type it like a [[Chat|chat]] message or use the [[console]]. Alternatively, you can just press the “/” key (only in default [[Controls|controls]]) which simply opens a [[chat window]] where the “/” has already been typed for you and then type the command right away. Although you use the chat window to issue the command, the command itself will ''not'' appear in the chat. Since every command starts with “/”, this means that ordinary chat messages can’t start with “/”; they will be interpreted as a command instead, even if such a command does not exist. You can tell wheather or not a command was successful by the server’s respone. If you see something “-!- Invalid command: /blargh” in the chat, you probably mis-spelled something. The most commands will cause the server to write you something else on the chat log for you, if successful.
+
To issue a command, simply type it like a [[Chat|chat]] message or use the [[console]]. Alternatively, you can just press the “/” key (only in default [[Controls|controls]]) which simply opens a [[chat window]] where the “/” has already been typed for you and then type the command right away. The command itself will ''not'' appear in the chat. Since every command starts with “/”, this means that ordinary chat messages can’t start with “/”; they will be interpreted as a command instead, even if such a command does not exist. You can tell whether or not a command was successful by the server’s response. If you see something “<code>-!- Invalid command: /blargh</code>” in the chat, you probably misspelled something. The most commands will cause the server to write you something else on the chat log for you, if successful.
 +
 
 +
== Issuing a command from the system terminal ==
 +
To issue commands on a Luanti server instance started from the terminal, Luanti has to be built with the [https://www.gnu.org/software/ncurses/ ncurses] library enabled. When <code>luantiserver</code> is started with the <code>--terminal</code> argument, commands can be executed as they are in-game; i.e. <code>/<command></code>
  
 
== General syntax ==
 
== General syntax ==
−
All commands start with “/”. After that, one word follows which is itself followed by some or none arguments. You’ll find the exact syntax in the command reference.  
+
 
−
In the following command reference, text enclosed in <code><></code> and <code>[]</code> are place-holders which have to replaced with an actual value. Arguments in <code><></code> are required whereas arguments in <code>[]</code> are optional.
+
All server commands start with “/”. After that, one word follows which is itself followed by some or none arguments. You’ll find the exact syntax in the command reference.  
−
== Command reference ==
+
In the following command reference, text enclosed in <code><></code> is a placeholder for an actual value. Anything written in <code>[]</code> can be omitted.
 +
 
 +
=== Relative numbers (tilde notation) ===
 +
 
 +
Some commands that accept numbers can accept relative numbers. This means the value is relative to something else, like the current position. To use a relative value, prepend the number with a <code>~</code>. The number will then be added to the reference value. E.g. <code>~5</code> means the reference value plus 5, <code>~-7</code> means the reference value minus 7. Also, writing <code>~</code> on its own stands for the reference value. This is also known as the “tilde notation”.
 +
 
 +
Example: <code>/teleport ~ ~10 ~</code> teleports you 10 blocks above your current position.
 +
 
 +
== Command reference of built-in commands ==
 +
The commands listed here are built into Luanti by default. They’re almost always available, but it’s possible for games and mods to remove even built-in commands (but this is rarely used).
 +
 
 +
This reference is up-to-date for version 5.9.0. Remember to use <code>/help</code> for the latest command reference (but it is less detailed).
 +
 
 
=== Quick documentation ===
 
=== Quick documentation ===
−
Show short documentation of server commands and privileges; it will appear in the chat log, too. In case the help is too long, you can open the console with F10 to view everything agiain.
 
−
* <code>/help</code> - Shows a list of the available commands—depending on your privileges—on the server.
 
−
* <code>/help <command></code> - Shows short description about the given command. You can view the help of a command even if you do not have the privilege to issue it.
 
−
* <code>/help all</code> - Lists the available commands—depending on your privileges—on the server and a short description and syntax reference to each one.
 
−
* <code>/help privs</code> - Lists all privileges on the server that could possibly be granted to players and shows a short description about each of them.
 
−
=== Chat ===
 
−
Probably these commands require the “shout” privilege to work (wiki editors: please check this!).
 
−
* <code>/msg <player> <message></code> - Send a private message <message> to <player>
 
−
* <code>/me <action></code> - Makes a text in the format “* <your name> <action>” appear in the chat log. E.g. “/me eats pizza.” leads to “* Alfred eats pizza.” (if your name is “Alfred”)
 
−
See [[Chat]] for details.
 
  
−
=== Request information ===
+
Show short documentation of server commands and privileges.
 +
 
 +
* <code>/help</code>—Shows a list of the available commands on the server
 +
* <code>/help <command></code>—Shows short description about the given command
 +
* <code>/help all</code>—Same as <code>/help all</code>
 +
* <code>/help privs</code>—Lists all privileges on the server that could possibly be granted to players and shows a short description about each of them
 +
 
 +
With the exception of <code>/help <command></code>, these commands open a window where you can browse the available commands. They are organized by origin. “*builtin*” contains commands that come with Luanti. The other sections contain commands coming from mods.
 +
 
 +
The text color indicates whether you have the neccessary privileges for a command. A green command means you can use it, gray means you cannot. For <code>/help privs</code>, privileges in green are yours.
 +
 
 +
If you append <code> -t</code> to the command (with the space), the commands will be listed in the chat instead.
 +
 
 +
=== Player-related ===
 +
 
 +
==== Informational ====
 +
 
 +
* <code>/privs [<player>]</code>—List of privileges granted to <player>, if not specified, your own privileges
 +
* <code>/haspriv <privilege></code>—List all online players that have the specified privilege
 +
* <code>/last-login [<player>]</code>—Show the date and time when <player> has logged in the last time into this server ([https://en.wikipedia.org/wiki/Coordinated_Universal_Time UTC] time zone, [https://en.wikipedia.org/wiki/ISO_8601 ISO 8601] format). If not specified, shows your own last login time
 +
 
 +
==== Chat ====
 +
 
 +
These commands require the “shout” privilege to work.
 +
* <code>/msg <player> <message></code>—Send a direct message <message> to <player>; but not to the other players. '''Note''': The message is not really secret. Anyone intercepting the network traffic and the server operator could still, in principle, read it
 +
* <code>/me <action></code>—Makes a text in the format “* <your name> <action>” appear in the chat log. E.g. “/me eats pizza.” leads to “* Alfred eats pizza.” (if your name is “Alfred”)
 +
See [[Chat]] for details
 +
 
 +
==== Items ====
 +
 
 +
* <code>/give <player> <itemstring> [<count> [<wear>]]</code>—Give the specified item (see [[Itemstrings]]) <count> times (default: 1) to the player. <wear> specifies the damage for tools (0-65535) and is meaningless for other items, higher means more damage (default: 0). Requires the “give” privilege
 +
* <code>/giveme <itemstring> [<count> [<wear>]]</code>—Give item to yourself. <count> and <wear> have the same meaning as for /give. Requires the “give” privilege.
 +
* <code>/pulverize</code>—Destroys the wielded item. Can be used by any player
 +
* <code>/clearinv [<name>]</code>—Destroys all items in your inventory (no argument provided) or in someone else's inventory (<code>name</code> provided). To clear someone else's inventory, you need the “server” privilege
 +
 
 +
'''Hint''': Negative numbers for <count> and <wear> will count down from 65536, so you can use -1 as shorthand for 65535, the maximum possible value.
 +
 
 +
===== Examples =====
 +
 
 +
* <code>/giveme default:torch</code>—Gives you a [[torch]]
 +
* <code>/give Peter default:cobble 50</code>—Gives Peter 50 [[cobblestone]]
 +
* <code>/giveme default:pick_steel 1 16383</code>—Gives you a steel [[pickaxe]] which is about 25% worn-off
 +
 
 +
==== Teleportation ====
 +
 
 +
Teleportation is the immediate displacement of any player to a given position. All of the following commands require the “teleport” privilege:
 +
 
 +
* <code>/teleport <x>,<y>,<z></code>—Teleports yourself to given [[coordinates]]
 +
* <code>/teleport <target_player></code>—Teleports yourself to the player with the name <target_player>
 +
* <code>/teleport <player> <x>,<y>,<z></code>—Teleports <player> to given coordinates. Also requires the “bring” privilege
 +
* <code>/teleport <player1> <player2></code>—Teleports <player1> to <player2>. Also requires the “bring” privilege
 +
 
 +
The coordinates support relative values with <code>~</code> (see above). You can set a position relative to your current position then.
 +
 
 +
[[Games/Minetest Game|Minetest Game]] also provides the command “<code>/home</code>”. See [[#Command reference for Minetest Game commands]]
 +
 
 +
==== Kill ====
 +
* <code>/kill [<name>]</code>: Kill player or yourself. Requires “<code>server</code>” privilege
 +
 
 +
=== Moderation ===
 +
 
 +
==== Password manipulation ====
 +
 
 +
These commands allow to set and reset the passwords of any player and require the “password” privilege to work.
 +
* <code>/setpassword <player> <password></code>—Sets password of <player> to <password>
 +
* <code>/clearpassword <player></code>—Makes password of <player> empty
 +
 
 +
==== Privilege manipulation ====
 +
 
 +
All these commands require you to have the “privs” (to manipulate all privileges) or “basic_privs” [to manipulate the privileges set as basic_privs in the minetest.conf ( default “interact” and “shout”) privileges] privilege.
 +
* <code>/grant <player> <privilege></code>—Gives the <privilege> to <player>
 +
* <code>/grant <player> all</code>—Give all available privileges to <player>
 +
* <code>/grantme <privilege></code>—Give <privilege> to yourself
 +
* <code>/grantme all</code>—Gives all privilege to yourself
 +
* <code>/revoke <player> <privilege></code>—Takes away a <privilege> from <player>
 +
* <code>/revoke <player> all</code>—Takes away as many privileges as possible from <player>
 +
* <code>/revokeme <privilege></code>—Takes away a <privilege> from yourself
 +
* <code>/revokeme all</code>—Takes away as many privileges as possible from you
 +
 
 +
<code><privilege></code> can also take a list of privileges, each separated by a comma. For example: <code>/grantme fly,noclip,fast</code> grants you the “fly”, “noclip” and “fast” privileges.
 +
 
 +
==== Excluding players from server ====
 +
These commands allow the user to kick, ban and unban players. Kicking a player means to remove a connected player from the server. This requires the “kick” privilege. Banning a player prevents him/her to connect to the server again. The player does not need to be connected at this time. Unbanning means to remove a ban from a player, allowing him/her to connect to the server again. The ban and unban commands require the “ban” privilege.
 +
* <code>/kick <player name> [<reason>]</code> – Kicks the player with the name <player name>. Optionally a <reason> can be provided in text-form. This text is also shown to the kicked player.
 +
* <code>/ban</code> - show list of banned players
 +
* <code>/ban <player name></code>—Ban IP of player
 +
* <code>/unban <player name></code>—Remove ban of player with the specified name
 +
* <code>/unban <IP address></code>—Remove ban of player with the specified IP address
 +
 
 +
=== Server-related ===
 +
 
 +
==== Informational ====
 +
 
 
Request some information from the server; the answer from the server will also be written into the chatlog.
 
Request some information from the server; the answer from the server will also be written into the chatlog.
−
* <code>/status</code> - Server’s Minetest version, time the server is running in seconds (called “uptime”), list of connected players and the [[Message Of The Day|message of the day]] (if it exists).
 
−
* <code>/mods</code> - List of mods installed on the server.
 
−
* <code>/privs [player]</code> - List of privileges granted to [player], if not specified, your own privileges.
 
−
=== Player actions ===
 
−
These commands affects players.
 
−
* <code>/giveme <itemstring> [count]</code> - Give certain item [count] times (default: 1 times) to yourself. For a list of items to use this with, see the [[Itemstrings]] page. Requires the “give” privilege.
 
−
* <code>/give <player> <itemstring> [count]</code> - Give certain item [count] times (default: 1 times) to the player. Requires the “give” privilege.
 
−
* <code>/pulverize</code> - Destroys the wielded item. Can be used by any player.
 
−
* <code>/teleport <x>,<y>,<z></code> - Teleport yourself to given [[coordinates]]. Requires the “teleport” privilege.
 
−
* <code>/teleport <player></code> - Teleport yourself to the player with the name <target_player>. Requires the “teleport” privilege.
 
−
* <code>/teleport <player> <x>,<y>,<z></code> - Teleports <player> to given coordinates. Requires the “teleport” and “bring” privileges.
 
−
* <code>/teleport <player1> <player2></code> - Teleports <player1> to <player2>. Requires the “teleport” and “bring” privileges.
 
  
−
=== Privilege manipulation ===
+
* <code>/admin</code>—Player name of the administrator / server operator of the server you're connected to.
−
All these commands require you to have the “privs” (to manipulate all privileges) or “basic_privs” (to manipulate “interact” and “shout” privileges) privilege.
+
* <code>/status</code>—Shows some information about the server. Usually, this is the server’s Luanti version, the uptime (time the server has been running without interruption), list of connected players and the [[Message Of The Day|message of the day]] (if it exists). If the uptime does not have a time unit, it is in seconds. Servers can customize this message.
−
* <code>/grant <player> <privilege></code> - Give the <privilege> to <player>.
+
* <code>/mods</code>—List of mods installed on the server.
−
* <code>/grant <player> all</code> - Give all available privileges to <player>.
+
* <code>/days</code>—Current game day (counting starts at 0)
−
* <code>/revoke <player> <privilege></code> - Take away a <privilege> from <player>.
+
* <code>/time</code>—Current game time (24h clock)
−
* <code>/revoke <player> all</code> - Take away as much privileges as possible from <player>.
 
  
−
=== World manipulation ===
+
==== World manipulation ====
−
* <code>/time <nowiki><time></nowiki></code> - Set the [[Time of day|time of day]] (tod). 0 tod and 24000 tod are midnight, 12000 tod is noon, 18600 tod is sunset, 4750 tod is sunrise. (time of day = hour * 1000). Requires the “settime” privilege.
+
 
−
* <code>/set -n time_speed <speed></code> - Set the speed of [[Day/night cycle|day/night cycle]] where <code><speed></code> is the time speed (read as “<code><speed></code> times faster than in real life”). 72 is the default, which means a day-night cycle lasts 20 minutes by default. Requires the “server” privilege.
+
* <code>/time <nowiki><hours>:<minutes></nowiki></code>—Sets the [[Time of day|time of day]] in the 24-hour format (0:00-23:59). Requires the “settime” privilege. Precede the time with a tilde for a relative time change.
 +
* <code>/time <nowiki><time_of_day></nowiki></code>—Sets the [[Time of day|time of day]] as a number between 0 and 24000 (see [[time of day]]). Requires the “settime” privilege. Supports relative number syntax with <code>~</code> (see above).
 +
* <code>/set -n time_speed <speed></code>—Sets the speed of [[Time of day|day/night cycle]] where <code><speed></code> is the time speed (read as “<code><speed></code> times faster than in real life”). 72 is the default, which means a day-night cycle lasts 20 minutes by default. Requires the “server” privilege
 +
* <code>/spawnentity <entity> [<X>,<Y>,<Z>]</code>—Spawns an [http://dev.minetest.net/LuaEntitySAO#Lua_Entity entity] of type <entity> (see [[List of entity names]]) near your position or at the X,Y,Z coordinates, if specified. Requires “give” and “interact” privileges. The coordinates support relative values with <code>~</code> (see above)
 +
 
 +
==== Server maintenance ====
  
−
=== Server maintenance ===
 
 
All of these commands require the “server” privilege.
 
All of these commands require the “server” privilege.
−
* <code>/shutdown</code> - Shuts down the server. (In versions prior to 0.4.0, this can only be done by the user called "name" in the server's [[minetest.conf]].)
+
* <code>/shutdown [-r]</code>—Shuts down the server. If <code>-r</code> is provided, players are given an offer to reconnect
−
* <code>/set <variable></code> - Read the server <variable> (→[[minetest.conf]]) with the given name and let the server show it to you.
+
* <code>/shutdown <delay> [-r]</code>—Shuts down the server in <code><delay></code> seconds or aborts a pending shutdown if the number is -1. If <code>-r</code> is provided, players are given an offer to reconnect
−
* <code>/set <variable> <new value></code> - Set the existing server <variable> to the given <new value>.
+
* <code>/set <variable></code>—Shows the value of the given server <variable> (→[[minetest.conf]])
−
* <code>/set -n <variable> <initial value></code> - Create a new server variable named <variable> and set it to <initial value>.
+
* <code>/set <variable> <new value></code>—Sets the existing server <variable> to the given <new value>
−
* <code>/clearobjects</code> - Clears all objects/entities (removes all dropped [[item stacks]] and [[mobs]]). Note this may crash the server or slow it down insanely for about 30 to 60 seconds.
+
* <code>/set -n <variable> <initial value></code>—Creates a new server variable named <variable> and sets it to <initial value>
 +
* <code>/clearobjects [full|quick]</code>—Clears objects/entities (removes dropped [[items]], [[mobs]] and possibly more) on the server. In “quick” mode (default), objects in loaded mapblocks are removed immediately, while other objects are removed when the mapblock they're in is loaded. In “full” mode, all objects are cleared. Quick mode is very fast, but the full mode may slow down the server to a crawl for 10 to more than 60 seconds or even freeze it.
 +
* <code>/auth_reload</code>—Reloads ''auth.txt'', which is the authentication data, containing privileges and Base64-scrambled passwords
 +
* <code>/emergeblocks here [<radius>]</code>—Starts loading (or generating, if inexistent) map blocks around the player's current position with an optional radius (in nodes)
 +
* <code>/emergeblocks <pos1> <pos2></code>—Starts loading (or generating, if inexistent) map blocks contained in the area within pos1 and pos2
 +
* <code>/fixlight here [<radius>]</code>—Resets lighting around the player's current position with an optional radius (in nodes)
 +
* <code>/fixlight <pos1> <pos2></code>—Resets lighting contained in the area within pos1 and pos2
 +
* <code>/deleteblocks here [<radius>]</code>—Removes the MapBlock the player is in, from the database. As this triggers mapgen, this might start mechanisms like mud reflow or cavegen which very likely affect mapblocks outside the specified range. 113 blocks are a safe-distance for a server with no interfering mods. <code><radius></code> is an optional argument to specify the range (in nodes) in which MapBlocks are deleted
 +
* <code>/deleteblocks <pos1> <pos2></code>—Removes the MapBlock containing blocks inside the area from pos1 to pos2 from the database. May crash for larger areas. Warnings from above apply
 +
* <code>/remove_player <name></code>—Removes all data accociated to the given player. This only works if the player is currently not connected. This is not deleting authentication information. If a player with this name connects again, he/she inventory, position, etc. are gone. Password remains.
  
−
== Poorly documented commands ==
 
−
The following commands also exist in Minetest, but these need better documentation.
 
−
=== World manipulation ===
 
−
* <code>/spawnentity <entity></code> - spawns an [http://dev.minetest.net/LuaEntitySAO#Lua_Entity entity] of type <entity> near your position (requires “give” and “interact” privileges)
 
  
−
=== Server maintenence ===
+
Note: The coordinates in <code>/emergeblocks</code>, <code>/fixlight</code> and <code>/deleteblocks</code> support relative numbers (relative to your current position) with <code>~</code> (see above).
−
* <code>/auth_reload</code> - reload authentification data (requires “server” privilege)
 
−
=== Banning and unbanning players ===
 
−
These commands ban/unban a certain player and require the “ban” privilege.
 
−
* <code>/ban</code> - show list of banned players
 
−
* <code>/ban <player name></code> - ban IP of player
 
−
* <code>/unban <player name></code> - remove ban of player with the specified name
 
−
* <code>/unban <IP address></code> - remove ban of player with the specified IP address
 
  
−
=== Password ===
+
=== Rollback === <!--FIXME: poorly documented.-->
−
These commands allow to set and reset the passwords of any player and require the “password” privilege to work.
 
−
* <code>/setpassword <player> <password></code> - set password of <player> to <password>
 
−
* <code>/clearpassword <player></code> - make password of <player> empty
 
  
−
=== Rollback ===
 
 
Allows to use [[Rollback]]. Requires the “rollback” privilege.
 
Allows to use [[Rollback]]. Requires the “rollback” privilege.
−
* <code>/rollback_check [range] [seconds]</code> - check who has last touched a node or near it, max. [seconds] ago. (default [range]=0, default [seconds]=86400, which equals 24 hours in real time)
+
* <code>/rollback_check [<range>] [<seconds>]</code>—Checks who has last touched a node or near it, max. <seconds> ago (default <range>=0, default <seconds>=86400, which equals 24 hours in real time).
−
* <code>/rollback <player name> [seconds]</code> - revert actions of a player; default for [seconds] is 60
+
* <code>/rollback <player name> [<seconds>]</code>—Reverts actions of a player; default for <seconds> is 60
−
* <code>/rollback :<actor name> [seconds]:</code> - revert actions of an actor; default for [seconds] is 60
+
* <code>/rollback :<actor name> [<seconds>]</code>—Reverts actions of an actor ''(not a player)''; default for <seconds> is 60
 +
 
 +
=== Profiler ===
 +
 
 +
The <code>/profiler</code> command is a hidden command for developers to test the performance of a game or mod. It is only available if the setting <code>profiler.load</code> is enabled.
 +
 
 +
If enabled, the profiler starts when the server is launched and then constantly runs in the background and measures the time of certain functions.
 +
 
 +
* <code>/profiler print [<filter>]</code>: Prints profiler data into chat (hint: open chat console for better readability)
 +
* <code>/profiler dump [<filter>]</code>: Writes profiler data Luanti log
 +
* <code>/profiler save [<format> [<filter>]]</code>: Save profiler data into a file in the world directory in a given file format. Possible formats are: txt, csv, lua, json, json_pretty
 +
* <code>/profiler reset</code>: Resets the collected profiler data
 +
 
 +
The <code><filter></code> argument optionally filters the output by modname.
 +
 
 +
== Command reference for Minetest Game commands ==
 +
If you use Minetest Game, a few additional commands are available. These commands may not be available if you use a different [[Games]].
 +
 
 +
* <code>/sethome</code>—Sets your current position as your “home point”. Requires the “home” privilege
 +
* <code>/home</code>—Teleports yourself to your “home point”. This command does not work if you haven’t set your “home point” yet, set it with <code>/sethome</code> first. Requires the “home” privilege
 +
* <code>/killme</code>—Kills yourself
  
 
[[Category:Server]]
 
[[Category:Server]]
−
[[Category:Commands]]
 

Latest revision as of 19:07, 27 October 2024

Languages Language: English • Deutsch • français • 中文（简体）‎

Server commands (also called “chat commands”) are special commands to the server that can be entered by any player via the chat to cause the server to do something.

Command basics

Luanti comes with a set of built-in commands, but games and mods may add custom commands or even alter or remove some of the built-in-commands.

There are many commands, but you only need to remember the /help command. This will give you a list of all commands that are currently available, plus a brief explanation.

There are a few commands which can be issued by everyone, but some commands only work if you have certain privileges granted on the server. Use the command /privs to see your own privileges. If not noted otherwise, the commands in this article are assumed to require no privileges.

Issuing a command

To issue a command, simply type it like a chat message or use the console. Alternatively, you can just press the “/” key (only in default controls) which simply opens a chat window where the “/” has already been typed for you and then type the command right away. The command itself will not appear in the chat. Since every command starts with “/”, this means that ordinary chat messages can’t start with “/”; they will be interpreted as a command instead, even if such a command does not exist. You can tell whether or not a command was successful by the server’s response. If you see something “-!- Invalid command: /blargh” in the chat, you probably misspelled something. The most commands will cause the server to write you something else on the chat log for you, if successful.

Issuing a command from the system terminal

To issue commands on a Luanti server instance started from the terminal, Luanti has to be built with the ncurses library enabled. When luantiserver is started with the --terminal argument, commands can be executed as they are in-game; i.e. /<command>

General syntax

All server commands start with “/”. After that, one word follows which is itself followed by some or none arguments. You’ll find the exact syntax in the command reference. In the following command reference, text enclosed in <> is a placeholder for an actual value. Anything written in [] can be omitted.

Relative numbers (tilde notation)

Some commands that accept numbers can accept relative numbers. This means the value is relative to something else, like the current position. To use a relative value, prepend the number with a ~. The number will then be added to the reference value. E.g. ~5 means the reference value plus 5, ~-7 means the reference value minus 7. Also, writing ~ on its own stands for the reference value. This is also known as the “tilde notation”.

Example: /teleport ~ ~10 ~ teleports you 10 blocks above your current position.

Command reference of built-in commands

The commands listed here are built into Luanti by default. They’re almost always available, but it’s possible for games and mods to remove even built-in commands (but this is rarely used).

This reference is up-to-date for version 5.9.0. Remember to use /help for the latest command reference (but it is less detailed).

Quick documentation

Show short documentation of server commands and privileges.

  • /help—Shows a list of the available commands on the server
  • /help <command>—Shows short description about the given command
  • /help all—Same as /help all
  • /help privs—Lists all privileges on the server that could possibly be granted to players and shows a short description about each of them

With the exception of /help <command>, these commands open a window where you can browse the available commands. They are organized by origin. “*builtin*” contains commands that come with Luanti. The other sections contain commands coming from mods.

The text color indicates whether you have the neccessary privileges for a command. A green command means you can use it, gray means you cannot. For /help privs, privileges in green are yours.

If you append -t to the command (with the space), the commands will be listed in the chat instead.

Player-related

Informational

  • /privs [<player>]—List of privileges granted to <player>, if not specified, your own privileges
  • /haspriv <privilege>—List all online players that have the specified privilege
  • /last-login [<player>]—Show the date and time when <player> has logged in the last time into this server (UTC time zone, ISO 8601 format). If not specified, shows your own last login time

Chat

These commands require the “shout” privilege to work.

  • /msg <player> <message>—Send a direct message <message> to <player>; but not to the other players. Note: The message is not really secret. Anyone intercepting the network traffic and the server operator could still, in principle, read it
  • /me <action>—Makes a text in the format “* <your name> <action>” appear in the chat log. E.g. “/me eats pizza.” leads to “* Alfred eats pizza.” (if your name is “Alfred”)

See Chat for details

Items

  • /give <player> <itemstring> [<count> [<wear>]]—Give the specified item (see Itemstrings) <count> times (default: 1) to the player. <wear> specifies the damage for tools (0-65535) and is meaningless for other items, higher means more damage (default: 0). Requires the “give” privilege
  • /giveme <itemstring> [<count> [<wear>]]—Give item to yourself. <count> and <wear> have the same meaning as for /give. Requires the “give” privilege.
  • /pulverize—Destroys the wielded item. Can be used by any player
  • /clearinv [<name>]—Destroys all items in your inventory (no argument provided) or in someone else's inventory (name provided). To clear someone else's inventory, you need the “server” privilege

Hint: Negative numbers for <count> and <wear> will count down from 65536, so you can use -1 as shorthand for 65535, the maximum possible value.

Examples
  • /giveme default:torch—Gives you a torch
  • /give Peter default:cobble 50—Gives Peter 50 cobblestone
  • /giveme default:pick_steel 1 16383—Gives you a steel pickaxe which is about 25% worn-off

Teleportation

Teleportation is the immediate displacement of any player to a given position. All of the following commands require the “teleport” privilege:

  • /teleport <x>,<y>,<z>—Teleports yourself to given coordinates
  • /teleport <target_player>—Teleports yourself to the player with the name <target_player>
  • /teleport <player> <x>,<y>,<z>—Teleports <player> to given coordinates. Also requires the “bring” privilege
  • /teleport <player1> <player2>—Teleports <player1> to <player2>. Also requires the “bring” privilege

The coordinates support relative values with ~ (see above). You can set a position relative to your current position then.

Minetest Game also provides the command “/home”. See #Command reference for Minetest Game commands

Kill

  • /kill [<name>]: Kill player or yourself. Requires “server” privilege

Moderation

Password manipulation

These commands allow to set and reset the passwords of any player and require the “password” privilege to work.

  • /setpassword <player> <password>—Sets password of <player> to <password>
  • /clearpassword <player>—Makes password of <player> empty

Privilege manipulation

All these commands require you to have the “privs” (to manipulate all privileges) or “basic_privs” [to manipulate the privileges set as basic_privs in the minetest.conf ( default “interact” and “shout”) privileges] privilege.

  • /grant <player> <privilege>—Gives the <privilege> to <player>
  • /grant <player> all—Give all available privileges to <player>
  • /grantme <privilege>—Give <privilege> to yourself
  • /grantme all—Gives all privilege to yourself
  • /revoke <player> <privilege>—Takes away a <privilege> from <player>
  • /revoke <player> all—Takes away as many privileges as possible from <player>
  • /revokeme <privilege>—Takes away a <privilege> from yourself
  • /revokeme all—Takes away as many privileges as possible from you

<privilege> can also take a list of privileges, each separated by a comma. For example: /grantme fly,noclip,fast grants you the “fly”, “noclip” and “fast” privileges.

Excluding players from server

These commands allow the user to kick, ban and unban players. Kicking a player means to remove a connected player from the server. This requires the “kick” privilege. Banning a player prevents him/her to connect to the server again. The player does not need to be connected at this time. Unbanning means to remove a ban from a player, allowing him/her to connect to the server again. The ban and unban commands require the “ban” privilege.

  • /kick <player name> [<reason>] – Kicks the player with the name <player name>. Optionally a <reason> can be provided in text-form. This text is also shown to the kicked player.
  • /ban - show list of banned players
  • /ban <player name>—Ban IP of player
  • /unban <player name>—Remove ban of player with the specified name
  • /unban <IP address>—Remove ban of player with the specified IP address

Server-related

Informational

Request some information from the server; the answer from the server will also be written into the chatlog.

  • /admin—Player name of the administrator / server operator of the server you're connected to.
  • /status—Shows some information about the server. Usually, this is the server’s Luanti version, the uptime (time the server has been running without interruption), list of connected players and the message of the day (if it exists). If the uptime does not have a time unit, it is in seconds. Servers can customize this message.
  • /mods—List of mods installed on the server.
  • /days—Current game day (counting starts at 0)
  • /time—Current game time (24h clock)

World manipulation

  • /time <hours>:<minutes>—Sets the time of day in the 24-hour format (0:00-23:59). Requires the “settime” privilege. Precede the time with a tilde for a relative time change.
  • /time <time_of_day>—Sets the time of day as a number between 0 and 24000 (see time of day). Requires the “settime” privilege. Supports relative number syntax with ~ (see above).
  • /set -n time_speed <speed>—Sets the speed of day/night cycle where <speed> is the time speed (read as “<speed> times faster than in real life”). 72 is the default, which means a day-night cycle lasts 20 minutes by default. Requires the “server” privilege
  • /spawnentity <entity> [<X>,<Y>,<Z>]—Spawns an entity of type <entity> (see List of entity names) near your position or at the X,Y,Z coordinates, if specified. Requires “give” and “interact” privileges. The coordinates support relative values with ~ (see above)

Server maintenance

All of these commands require the “server” privilege.

  • /shutdown [-r]—Shuts down the server. If -r is provided, players are given an offer to reconnect
  • /shutdown <delay> [-r]—Shuts down the server in <delay> seconds or aborts a pending shutdown if the number is -1. If -r is provided, players are given an offer to reconnect
  • /set <variable>—Shows the value of the given server <variable> (→minetest.conf)
  • /set <variable> <new value>—Sets the existing server <variable> to the given <new value>
  • /set -n <variable> <initial value>—Creates a new server variable named <variable> and sets it to <initial value>
  • /clearobjects [full|quick]—Clears objects/entities (removes dropped items, mobs and possibly more) on the server. In “quick” mode (default), objects in loaded mapblocks are removed immediately, while other objects are removed when the mapblock they're in is loaded. In “full” mode, all objects are cleared. Quick mode is very fast, but the full mode may slow down the server to a crawl for 10 to more than 60 seconds or even freeze it.
  • /auth_reload—Reloads auth.txt, which is the authentication data, containing privileges and Base64-scrambled passwords
  • /emergeblocks here [<radius>]—Starts loading (or generating, if inexistent) map blocks around the player's current position with an optional radius (in nodes)
  • /emergeblocks <pos1> <pos2>—Starts loading (or generating, if inexistent) map blocks contained in the area within pos1 and pos2
  • /fixlight here [<radius>]—Resets lighting around the player's current position with an optional radius (in nodes)
  • /fixlight <pos1> <pos2>—Resets lighting contained in the area within pos1 and pos2
  • /deleteblocks here [<radius>]—Removes the MapBlock the player is in, from the database. As this triggers mapgen, this might start mechanisms like mud reflow or cavegen which very likely affect mapblocks outside the specified range. 113 blocks are a safe-distance for a server with no interfering mods. <radius> is an optional argument to specify the range (in nodes) in which MapBlocks are deleted
  • /deleteblocks <pos1> <pos2>—Removes the MapBlock containing blocks inside the area from pos1 to pos2 from the database. May crash for larger areas. Warnings from above apply
  • /remove_player <name>—Removes all data accociated to the given player. This only works if the player is currently not connected. This is not deleting authentication information. If a player with this name connects again, he/she inventory, position, etc. are gone. Password remains.


Note: The coordinates in /emergeblocks, /fixlight and /deleteblocks support relative numbers (relative to your current position) with ~ (see above).

Rollback

Allows to use Rollback. Requires the “rollback” privilege.

  • /rollback_check [<range>] [<seconds>]—Checks who has last touched a node or near it, max. <seconds> ago (default <range>=0, default <seconds>=86400, which equals 24 hours in real time).
  • /rollback <player name> [<seconds>]—Reverts actions of a player; default for <seconds> is 60
  • /rollback :<actor name> [<seconds>]—Reverts actions of an actor (not a player); default for <seconds> is 60

Profiler

The /profiler command is a hidden command for developers to test the performance of a game or mod. It is only available if the setting profiler.load is enabled.

If enabled, the profiler starts when the server is launched and then constantly runs in the background and measures the time of certain functions.

  • /profiler print [<filter>]: Prints profiler data into chat (hint: open chat console for better readability)
  • /profiler dump [<filter>]: Writes profiler data Luanti log
  • /profiler save [<format> [<filter>]]: Save profiler data into a file in the world directory in a given file format. Possible formats are: txt, csv, lua, json, json_pretty
  • /profiler reset: Resets the collected profiler data

The <filter> argument optionally filters the output by modname.

Command reference for Minetest Game commands

If you use Minetest Game, a few additional commands are available. These commands may not be available if you use a different Games.

  • /sethome—Sets your current position as your “home point”. Requires the “home” privilege
  • /home—Teleports yourself to your “home point”. This command does not work if you haven’t set your “home point” yet, set it with /sethome first. Requires the “home” privilege
  • /killme—Kills yourself
Retrieved from "http://wiki.luanti.org/index.php?title=Server_commands&oldid=28608"