List of server commands: Difference between revisions

From Vintage Story Wiki
added the new map info
No edit summary
(added the new map info)
 
(98 intermediate revisions by 20 users not shown)
Line 1: Line 1:
<languages/>
<translate><!--T:48--> This is a list of commands that are executed on the server and therefore list/change things that may affect all players. Some of these commands may need {{ll|coordinates|coordinates}}, so make sure you use the right notation.</translate>
{{GameVersion|1.15}}
{{Protip
|<translate><!--T:50-->
1. Server commands all start with /
2. Do not type the [ and ] in the command syntax e.g. the correct command is  /time set 12  not  /time set [12]
3. After a change of server settings, the world needs to be restarted for the changes to take effect.</translate>
}}
__TOC__
<translate>
<translate>
<!--T:1-->
== Multiplayer Commands for Players == <!--T:89-->
__TOC__
</translate>
= Overview =
=== /land ===
This is a list of commands that are executed on the server and therefor list/change things that may affect all players. Some of these commands may need [[coordinates]], so make sure you use the right notation.
<translate><!--T:117--> Commands for {{ll|Land_claiming|Land Claiming}}</translate>
{{:List of server commands/land{{#translation:}}}}
 
=== /group === 
{{:List of server commands/group{{#translation:}}}}
 
=== /waypoint === 
<translate><!--T:51--> These commands affect the players {{ll|Worldmap|Worldmap}} and waypoints.</translate>
* <code>/waypoint [add|addat|addati|list|remove]</code><br /> <translate><!--T:52--> Add and edit your list of waypoints.</translate>
** <code>/waypoint add [color] [title]</code><br /> <translate><!--T:53--> Adds a waypoint with given color and text at your current position. The color may be any named [http://www.99colors.net/dot-net-colors .NET Color or a Hex Code].<br /> Example: <code>/waypoint add red copper</code></translate> 
** <code>/waypoint addat [coords] [pinned] [color] [title]</code><br /> <translate><!--T:54--> Add a waypoint at the given {{ll|coordinates|coordinates}}.</translate>
** <code>/waypoint addati [icon] [x] [y] [z] [pinned] [color] [title]</code><br /> <translate><!--T:55--> Add a waypoint at your current location, including colour and {{ll|VTML|icon}} info.</translate>
** <code>/waypoint list</code><br /> <translate><!--T:56--> Shows a list of all player waypoints by id number.</translate>
** <code>/waypoint remove [id]</code><br /> <translate><!--T:57--> Removes the waypoint id as shown in <code>/waypoint list</code>.</translate>
 
=== /kill ===
* <code>/kill</code><br /> <translate><!--T:58--> Kills the player.</translate>
 
=== /emote ===
* <code>/emote [wave|cheer|shrug|cry|nod|facepalm|bow|laugh|rage] </code><br /><translate><!--T:90--> Character does an emote animation.</translate>
 
=== /pm ===
* <code>/pm [playername] [message] </code><br /><translate><!--T:91--> Send a private message to a user (creates a temporary group)</translate>
 
 
== <translate><!--T:59--> Commands for Moderators and Admins</translate> ==
=== /help ===
* <code>/help</code><br /> <translate><!--T:60--> List all server commands.</translate>
 
=== /giveblock ===
* <code>/giveblock [blockcode][{attributes}] [quantity] [toplayername]</code><br /> <translate><!--T:61--> Creates an itemstack of the specified block in the specified quantity, and gives it to the specified player. The player must have an empty inventory slot to receive the itemstack. Quantity, toplayername and attributes are optional. The default quantity is 1. If player name is not set, the command user's own player is targeted. Attributes may optionally be supplied in curly braces after the blockcode without a space between the block name and the braces. The attributes should be given in JSON format. Example: <code>/giveblock clutter{type: "barrel-metal1"}</code></translate>
 
=== /giveitem ===
* <code>/giveitem [itemcode] [quantity] [toplayername] [attributes]</code><br /> <translate><!--T:62--> Same as above but for items.</translate>
 
=== /gamemode ===
{{:List of server commands/gamemode{{#translation:}}}}
=== /gm ===
<translate><!--T:106--> Shorthand of <code>/gamemode</code></translate>
 
=== /tp ===
{{:List of server commands/tp{{#translation:}}}}
 
=== /ban ===
* <code>/ban [playername] [reason]</code><br /> <translate><!--T:63--> Ban a player.</translate>
 
=== /unban ===
* <code>/unban [playername]</code><br /> <translate><!--T:64--> Unban a player.</translate>
 
=== /kick ===
* <code>/kick [playername] [reason]</code><br /> <translate><!--T:65--> Kick a player.</translate>


== Multiplayer Commands for Players == <!--T:2-->
=== /clear ===
* <code>/clearinv</code><br /> <translate><!--T:66--> Removes all items from your inventory.</translate>


=== Land claiming === <!--T:3-->
=== /nexttempstorm ===
[[List of server commands/land]]
* <code>/nexttempstorm </code><br /> <translate><!--T:93--> Tells you the amount of days left until the next temporal storm.</translate>
* <code>/nexttempstorm now</code><br /> <translate><!--T:94--> Fast forwards the time so that a temporal storm starts right away.</translate>


=== Groups === <!--T:4-->
<translate>== Privilege Control == <!--T:104--></translate>
[[List of server commands/group]]
=== /op ===
* <code>/op [playername]</code><br /> <translate><!--T:67--> Alias of <code>/player [playername] role admin</code>.</translate>


=== Other === <!--T:5-->
=== /role ===  
* <code>/kill</code><br />Kills the player.
{{:List of server commands/role{{#translation:}}}}


== Commands for Moderators and Admins== <!--T:6-->
=== /player ===
* <code>/help</code><br />List all commands.
{{:List of server commands/player{{#translation:}}}}


=== Player Control ===
<translate>== World Control == <!--T:105--></translate>
* <code>/giveblock [blockcode] [quantity] [toplayername]</code><br />Creates an itemstack of given block with given stack size to given player name. If player name is not set, the own player is targeted.
=== /worldconfig ===
<translate><!--T:107-->
Protip: Do not actually type the [ ] shown in this command syntax, that is intended only to show which values can be changed!


* <code>/giveitem [itemcode] [quantity] [toplayername]</code><br />Same as above but for items
<!--T:108-->
See dedicated page on {{ll|World Configuration|World Configuration}}</translate>


[[List of server commands/gamemode]]
==== World map ====


[[List of server commands/tp]]
All of the following work<ref>Tested 15 Mar 2024 in version 1.19.4</ref> in a singleplayer world to restore the parchment-style map to the classic colorful map:
* <code>/worldconfig colorAccurateWorldmap true</code>
* <code>/worldconfigcreate bool colorAccurateWorldmap true</code>
* <code>/player [playername] privilege grant colorAccurateWorldmap</code>


* <code>/ban [reason]</code><br />Ban a player.
In a multiplayer world, the following restores the classic map for an individual:
* <code>/player [playername] privilege grant colorAccurateWorldmap</code>
while the following restores the classic map for all players:
* <code>/worldconfig colorAccurateWorldmap true</code>
* <code>/worldconfigcreate bool colorAccurateWorldmap true</code>
(needs confirmation)


* <code>/unban [playername]</code><br />Unban a player.
=== /entity ===
{{:List of server commands/entity{{#translation:}}}}


* <code>/kick [reason]</code><br />Kick a player.
=== /time ===


* <code>/clear</code><br />Removes all items from your inventory.
{{Messagebox
|title= Warning
|text= Using commands to modify time frequently has unwanted side effects.  To avoid losing a world, test time commands in a ''separate'' world, and/or create a ''backup''.
}}


==Privilege Control==
{{:List of server commands/time{{#translation:}}}}
*<code>/op [playername]</code> Alias <code>/player [playername] role admin</code>


[[List of server commands/role]]
=== /weather ===
{{:List of server commands/weather{{#translation:}}}}


[[List of server commands/player]]
== <translate><!--T:69--> Server control and configuration</translate> ==
=== /serverconfig ===
{{:List of server commands/serverconfig{{#translation:}}}}


==World Control== <!--T:7-->
=== /stats ===
*<code>/seed</code><br />Shows the world seed
* <code>/stats</code><br /> <translate><!--T:70--> Show current server statistics, tick rate, memory usage, etc..</translate>


=== World Config ===
=== /announce ===
[[List of server commands/worldconfig]]
* <code>/announce [message]</code><br /> <translate><!--T:71--> Announce a server wide message in all chat groups.</translate>


=== Entities ===
=== /stop ===
<!--T:11-->
* <code>/stop</code><br /> <translate><!--T:73--> Stops the server.</translate>
[[List of server commands/entity]]


=== Time ===
=== /autosavenow===
[[List of server commands/time]]
* <code>/autosavenow</code><br /> <translate> <!--T:118--> Autosaves the server.</translate>


=== Weather ===
=== /list ===  
[[List of server commands/weather]]
*<code>/list [clients|banned|role|privileges]</code><br /> <translate><!--T:74--> Show various lists of information.</translate>
**<code>/list clients</code><br /> <translate><!--T:75--> Show current connected clients.</translate>
**<code>/list banned</code><br /> <translate><!--T:76--> Show current list of banned players.</translate>
**<code>/list role</code><br /> <translate><!--T:77--> Show list of all configured privilege roles.</translate>
**<code>/list privileges</code><br /> <translate><!--T:78--> Show list of all configured privileges.</translate>


==Server control and configuration== <!--T:12-->
=== /allowlan ===
*<code>/stats</code><br /> Show current server statistics ,tick rate, memory usage, etc..
* <code>/allowlan [on|off]</code><br /> <translate><!--T:95--> Whether or not to allow external lan connections to the server (temporary runtime setting for non dedicated servers)</translate>


*<code>/announce</code><br /> Announce a server wide message in all chat groups.
== <translate><!--T:79--> Utility and Debug Tools</translate> ==
=== /moddb ===
{{GameVersion|1.18.0-pre.7}}
*<code>/moddb [install|remove|list|search|searchcompatible|searchfor|searchforc]</code><br /> <translate><!--T:109--> ModDB utility. To install and remove mods.</translate>
**<code>/moddb install [modid] [gameVersion]</code> : <translate><!--T:110--> Install the specified mod.</translate>
**<code>/moddb remove [modid]</code> : <translate><!--T:111--> Uninstall the specified mod.</translate>
**<code>/moddb list</code> : <translate><!--T:112--> List all installed mods.</translate>
**<code>/moddb search [query]</code> : <translate><!--T:113--> Full-text search on ModDB.</translate>
**<code>/moddb searchcompatible [modid]</code> : <translate><!--T:114--> Search for a mod, filtered for game versions compatible with the current version.</translate>
**<code>/moddb searchfor [gameVersion] [modid]</code> : <translate><!--T:115--> Search for a mod, filtered for the specified game version only.</translate>
**<code>/moddb searchforc [gameVersion] [modid]</code> : <translate><!--T:116--> Search for a mod, filtered for game versions compatible with the specified version.</translate>


*<code>/welcome</code><br />Sets the server's welcome message
=== /fixmapping ===
* <code>/fixmapping applyall</code><br /> <translate><!--T:80--> Applies block and item remapping in order to upgrade to a new version of the game</translate>


*<code>/stop</code><br />Stops the server
=== /genbackup ===
* <code>/genbackup [filename]</code><br /> <translate><!--T:81--> Creates a full copy of the current save game and stores it in the backups folder. Can be run without pausing the server. If no filename is supplied, it will generate one based on the current date and time</translate>


*<code>/list [clients|banned|role|privileges]</code><br />Show various lists of infos
=== /bir ===
**<code>/list clients</code><br /> Show current connected clients</li>
* <code>/bir [getid|getcode|remap]</code><br /> <translate><!--T:82--> Block id remapper tools. Useful to fix broken blocks after removing/updating custom blocks.</translate>
**<code>/list banned</code><br /> Show current list of banned blayers</li>
**<code>/list role</code><br /> Show list of all configured privilege roles</li>
**<code>/list privileges</code><br /> Show list of all configured privileges</li>


[[List of server commands/serverconfig]]
=== /chunk ===
* <code>/chunk [cit|printmap|unload|forceload]</code><br /> <translate><!--T:83--> Chunk commands.</translate>
* <code>/chunk cit</code><br /> <translate><!--T:84--> Current chunk generation info.</translate>
* <code>/chunk printmap</code><br /> <translate><!--T:85--> Export a png file of a map of loaded chunks. Marks call location with a yellow pixel.</translate>
* <code>/chunk unload [0|1]</code><br /> <translate><!--T:86-->  Toggles whether the server should automatically unload chunks that are no longer in range of any players and also send chunk unload commands to the clients.</translate>
* <code>/chunk forceload x1 z1 x2 z2</code><br /> <translate><!--T:87--> Tells the server to load given area and prevents unloading.</translate>


==Utility and Debug Tools== <!--T:13-->
=== /whenwillitstopraining ===
*<code>/bir [getid|getcode|remap]</code><br />Block id remapper tools. Useful to fix broken blocks after removing/updating custom blocks.
* <code>/whenwillitstopraining</code><br /> <translate><!--T:88--> Tells when the rain should stop.</translate>


*<code>/forceloadchunks x1 z1 x2 z2 [sendtoclient]</code><br />Tells the server to load given area and prevents unloading. If the boolean <code>sendtoclient</code> is added it will also forcefully send all these chunks to the client.
=== /roomregdebug ===
Removed and replaced with <code>/debug room</code> as of version 1.19. These commands are kept for archival purposes.


*<code>/sendchunks [0|1]</code><br />Toggles whether to send any new chunks to the client. Forced chunks are still loaded.
* <code>/roomregdebug [list|hi|unhi]</code><br /> <translate><!--T:96--> Room registration debug tools.</translate>
** <code>/roomregdebug list</code><br /> <translate> <!--T:97--> Lists all rooms the player is in.</translate>
** <code>/roomregdebug hi </code><br /> <translate> <!--T:98--> Highlights the space of rooms with color. Unsuitable rooms are in red, eligible rooms are in green.</translate>
** <code>/roomregdebug unhi </code><br /> <translate> <!--T:99--> Removes room highlighting.</translate>


*<code>/chunkunload [0|1]</code><br /> Toggles whether the server should automatically unload chunks that are no longer in range of any players and also send chunk unload commands to the clients.
=== /info ===
{{:List of server commands/info{{#translation:}}}}


*<code>/reloadmods</code><br />Reloads all server mods that support reloading.
=== /debug ===
{{:List of server commands/debug{{#translation:}}}}


*<code>/cit</code><br /> Current chunk generation info
=== /wgen ===
{{:List of server commands/wgen{{#translation:}}}}


[[List of server commands/debug]]
=== /we ===
<translate>
<!--T:100-->
See {{ll|How_to_use_WorldEdit|How to use WorldEdit}}
</translate>
=== /macro ===
{{:List of server commands/macro{{#translation:}}}}
<translate>


[[List of server commands/wgen]]
== See also == <!--T:102-->


[[List of server commands/macro]]


<!--T:103-->
* {{ll|List of client commands|List of client commands}}
* {{ll|World Configuration|World Configuration}}
</translate>
</translate>
{{Game navbox}}
{{Navbox/modding}}
Confirmedusers, editor
1,052

edits