Difference between revisions of "Server commands"

From Luanti Wiki
Jump to navigation Jump to search
(→‎Items: Explain the counting down trick, using a negative item count.)
(Description updates.)
Line 4: Line 4:
  
 
== 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.  
 
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 be replaced with an actual value. Arguments in <code><></code> are required whereas arguments in <code>[]</code> are optional.
 
In the following command reference, text enclosed in <code><></code> and <code>[]</code> are place-holders which have to be replaced with an actual value. Arguments in <code><></code> are required whereas arguments in <code>[]</code> are optional.
  
 
== Command reference ==
 
== Command reference ==
 +
 
=== 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.
 
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</code> - Shows a list of the available commands—depending on your privileges—on the server.
Line 16: Line 19:
  
 
=== Player-related ===
 
=== Player-related ===
 +
 
==== Informational ====
 
==== Informational ====
 +
 
* <code>/privs [player]</code> - List of privileges granted to [player], if not specified, your own privileges.
 
* <code>/privs [player]</code> - List of privileges granted to [player], if not specified, your own privileges.
  
 
==== Chat ====
 
==== Chat ====
 +
 
These commands require the “shout” privilege to work.
 
These commands require the “shout” privilege to work.
 
* <code>/msg <player> <message></code> - Send a private message <message> to <player>
 
* <code>/msg <player> <message></code> - Send a private message <message> to <player>
Line 26: Line 32:
  
 
==== Items ====
 
==== Items ====
 +
 
''For the <code>/give</code> and <code>/giveme</code> commands, a negative count will count down from 65536. This means for example that giving -1 of an itemstring will give 65535 items of that itemstring, which is also the hard size limit of a stack.''
 
''For the <code>/give</code> and <code>/giveme</code> commands, a negative count will count down from 65536. This means for example that giving -1 of an itemstring will give 65535 items of that itemstring, which is also the hard size limit of a stack.''
  
Line 33: Line 40:
  
 
==== Teleportation ====
 
==== Teleportation ====
 +
 
Teleportation is the immediate displacement of any player to a given position. All of these commands require the “teleport” privilege.
 
Teleportation is the immediate displacement of any player to a given position. All of these commands require the “teleport” privilege.
 
* <code>/teleport <x>,<y>,<z></code> - Teleport yourself to given [[coordinates]].
 
* <code>/teleport <x>,<y>,<z></code> - Teleport yourself to given [[coordinates]].
Line 40: Line 48:
  
 
=== Moderation ===
 
=== Moderation ===
 +
 
==== Password manipulation ====
 
==== Password manipulation ====
 +
 
These commands allow to set and reset the passwords of any player and require the “password” privilege to work.
 
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>/setpassword <player> <password></code> - set password of <player> to <password>
Line 46: Line 56:
  
 
==== Privilege manipulation ====
 
==== Privilege manipulation ====
 +
 
All these commands require you to have the “privs” (to manipulate all privileges) or “basic_privs” (to manipulate “interact” and “shout” privileges) privilege.
 
All these commands require you to have the “privs” (to manipulate all privileges) or “basic_privs” (to manipulate “interact” and “shout” privileges) privilege.
 
* <code>/grant <player> <privilege></code> - Give the <privilege> to <player>.
 
* <code>/grant <player> <privilege></code> - Give the <privilege> to <player>.
Line 53: Line 64:
  
 
==== Ban management ====
 
==== Ban management ====
 +
 
These commands ban/unban a certain player and require the “ban” privilege.
 
These commands ban/unban a certain player and require the “ban” privilege.
 
* <code>/ban</code> - show list of banned players
 
* <code>/ban</code> - show list of banned players
Line 60: Line 72:
  
 
=== Server-related ===
 
=== Server-related ===
 +
 
==== Informational ====
 
==== 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>/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).
Line 66: Line 80:
  
 
==== 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>/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>/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.
Line 71: Line 86:
  
 
==== 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</code> - Shuts down the server.
 
* <code>/set <variable></code> - Read the server <variable> (→[[minetest.conf]]) with the given name and let the server show it to you.
 
* <code>/set <variable></code> - Read the server <variable> (→[[minetest.conf]]) with the given name and let the server show it to you.
 
* <code>/set <variable> <new value></code> - Set the existing server <variable> to the given <new value>.
 
* <code>/set <variable> <new value></code> - Set the existing server <variable> to the given <new value>.
 
* <code>/set -n <variable> <initial value></code> - Create a new server variable named <variable> and set it to <initial value>.
 
* <code>/set -n <variable> <initial value></code> - Create a new server variable named <variable> and set it to <initial 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>/clearobjects</code> - Clears all objects/entities (removes all dropped [[item stacks]] and [[mobs]]). Note this may crash the server or slow it down to a crawl for 10 to more than 60 seconds.
 +
* <code>/auth_reload</code> - Reloads ''auth.txt'', which is the authentication data, containing privileges and Base64-scrambled passwords.
  
== Poorly documented commands ==
+
=== Rollback === <!--FIXME: poorly documented.-->
The following commands also exist in Minetest, but these need better documentation.
 
=== Server maintenence ===
 
* <code>/auth_reload</code> - reload authentification data (requires “server” privilege)
 
  
=== 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> - 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 <player name> [seconds]</code> - revert actions of a player; default for [seconds] is 60
+
* <code>/rollback <player name> [seconds]</code> - Revert 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> - Revert actions of an actor ''(not a player)''; default for [seconds] is 60
  
 
[[Category:Server]]
 
[[Category:Server]]
 
[[Category:Commands]]
 
[[Category:Commands]]

Revision as of 12:43, 4 April 2014

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.

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. 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.

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 <> and [] are place-holders which have to be replaced with an actual value. Arguments in <> are required whereas arguments in [] are optional.

Command reference

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.

  • /help - Shows a list of the available commands—depending on your privileges—on the server.
  • /help <command> - 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.
  • /help all - Lists the available commands—depending on your privileges—on the server and a short description and syntax reference to each one.
  • /help privs - Lists all privileges on the server that could possibly be granted to players and shows a short description about each of them.

Player-related

Informational

  • /privs [player] - List of privileges granted to [player], if not specified, your own privileges.

Chat

These commands require the “shout” privilege to work.

  • /msg <player> <message> - Send a private message <message> to <player>
  • /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

For the /give and /giveme commands, a negative count will count down from 65536. This means for example that giving -1 of an itemstring will give 65535 items of that itemstring, which is also the hard size limit of a stack.

  • /giveme <itemstring> [count] - 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.
  • /give <player> <itemstring> [count] - Give certain item [count] times (default: 1 times) to the player. Requires the “give” privilege.
  • /pulverize - Destroys the wielded item. Can be used by any player.

Teleportation

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

  • /teleport <x>,<y>,<z> - Teleport yourself to given coordinates.
  • /teleport <player> - Teleport 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.

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> - set password of <player> to <password>
  • /clearpassword <player> - make password of <player> empty

Privilege manipulation

All these commands require you to have the “privs” (to manipulate all privileges) or “basic_privs” (to manipulate “interact” and “shout” privileges) privilege.

  • /grant <player> <privilege> - Give the <privilege> to <player>.
  • /grant <player> all - Give all available privileges to <player>.
  • /revoke <player> <privilege> - Take away a <privilege> from <player>.
  • /revoke <player> all - Take away as much privileges as possible from <player>.

Ban management

These commands ban/unban a certain player and require the “ban” privilege.

  • /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.

  • /status - Server’s Minetest version, time the server is running in seconds (called “uptime”), list of connected players and the message of the day (if it exists).
  • /mods - List of mods installed on the server.

World manipulation

  • /time <time> - Set the 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.
  • /set -n time_speed <speed> - Set 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> - spawns an entity of type <entity> near your position (requires “give” and “interact” privileges)

Server maintenance

All of these commands require the “server” privilege.

  • /shutdown - Shuts down the server.
  • /set <variable> - Read the server <variable> (→minetest.conf) with the given name and let the server show it to you.
  • /set <variable> <new value> - Set the existing server <variable> to the given <new value>.
  • /set -n <variable> <initial value> - Create a new server variable named <variable> and set it to <initial value>.
  • /clearobjects - Clears all objects/entities (removes all dropped item stacks and mobs). Note this may crash the server or slow it down to a crawl for 10 to more than 60 seconds.
  • /auth_reload - Reloads auth.txt, which is the authentication data, containing privileges and Base64-scrambled passwords.

Rollback

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

  • /rollback_check [range] [seconds] - 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).
  • /rollback <player name> [seconds] - Revert actions of a player; default for [seconds] is 60
  • /rollback :<actor name> [seconds]: - Revert actions of an actor (not a player); default for [seconds] is 60