List of client commands: Difference between revisions

From Vintage Story Wiki
(Created page with " == Client Commands == <p> <span style="font-size:14px;">Commands offer advanced features and configuration abilities for your game. There are really 2 lists of commands - C...")
 
(Show the output of turning on entity boxes)
 
(82 intermediate revisions by 20 users not shown)
Line 1: Line 1:
<languages/>


== Client Commands ==
{{Outdated|<translate>Severely outdated, see protip below for up to date information.</translate>}}
{{GameVersion|1.15}}
<translate>
<!--T:1-->
'''Commands''' offer advanced features and configuration abilities for your game. There are really 2 lists of commands - Client and {{ll|List of server commands|Server}}. The client is what displays your game on the screen, plays the sounds, takes in your controls and lets you connect to a game server (single or multiplayer). Client commands are those that usually just affect the appearance of your game, while server commands allows you to modify the world or configuration of the game.


<p>
<!--T:2-->
<span style="font-size:14px;">Commands offer advanced features and configuration abilities for your game. There are really 2 lists of commands - Client and Server. The client is what displays your game on the screen, plays the sounds, takes in your controls. The client let's you connect to a game server (single or multiplayer), this client commands are those that usually just affect the appearance of your game, while server commands allows you to modify the world or configuration of the game.</span>
All commands are typed in the chat window in order to execute them. A client command always starts with a dot <code>.</code>, while a server command always starts with a slash <code>/</code>.
</p>
</translate>


<p>
{{Protip
<span style="font-size:14px;">All commands are typed in the chat window in order to execute them. A client command always starts with a dot (.), while a server command always starts with a slash (/).</span>
|Icon=Book-normal-brickred.png
</p>
|<translate>It is advised to utilize in-game command handbook available under client command .chb as it is generally up to date with current game version and often has more information than what is available on Wiki. The article has been updated to include the addition of most commands as off 1.19.8, however, some the commands that have been removed or moved since 1.15 may not be correct. If a command does not work, check .chb for alternate commands. </translate>
}}


<p>
<translate>
<span style="font-size:14px;">Here is a list of the most useful ones.</span>
<!--T:14-->
</p>
See also: {{ll|List_of_server_commands|List of server commands}}


<p>
</translate>
<strong><span style="font-size:14px;">Client Commands</span></strong>
__FORCETOC__
</p>
<translate>
== Client Commands == <!--T:4-->
=== .blockitempngexport ===
*<code>.blockitempngexport [inv|all] [imageSize] [domain]</code><br />Export all items and blocks as png images
**<code>[inv|all]</code> is (optionally) the exportRequest
**<code>[imageSize]</code> is an integer number
**<code>[domain]</code> is a string without spaces


<ul>
=== .bsedit ===
<li>
*<code>.bsedit</code><br /> Opens the block selection editor. Alias for {{ll|List_of_client_commands#.dev|<code>.dev bsedit</code>}}
<strong>.fog [density] [minfog]</strong><br>
Sets the density of the world fog. Useful&nbsp;<em>density</em> value are in the range of 0 and 0.1, default value is 0.004<br>
The <em>minfog&nbsp;</em>determines a minimum amount of fog that is always applied, default is 0<br>
&nbsp;
</li>
<li>
<strong>.cam [p|rp|start|stop|clear|load|save|alpha|tp]</strong><br>
The cinematic camera tool system.
<ul>
<li>
<strong>.cam p</strong>: Adds the current position to the list of places to visit
</li>
<li>
<strong>.cam rp</strong>: Removes the last added point&nbsp;
</li>
<li>
<strong>.cam clear</strong>: Removea all points
</li>
<li>
<strong>.cam start</strong>: Starts the cinematic camera, i.e. it will smoothly traverse all points
</li>
<li>
<strong>.cam stop</strong>: Stops the cinematic camera
</li>
<li>
<strong>.cam save</strong>: Exports the current list of points into your Clipboard (which you then can paste into any text editor)
</li>
<li>
<strong>.cam load [data]</strong>: Import supplied list of points&nbsp;
</li>
<li>
<strong>.cam tp [0 or 1]:&nbsp;</strong>Toggles whether to teleport you back to your previous position after the camera path has been completed
</li>
<li>
<strong>.cam alpha</strong> <strong>[0..1]</strong>: Modifies how the points are traversed by the camera (more rounded or more straight)<br>
&nbsp;
</li>
</ul>
</li>
<li>
<strong>.clearchat</strong><br>
Clears your chat history<br>
&nbsp;
</li>
<li>
<strong>.reloadmodels</strong><br>
Reloads all json models from assets/blockshapes. Can be used to quickly test new block shapes.<br>
Notice: The chunks are not redrawn, so you'd have to force a redraw e.g. by placing and removing a block<br>
&nbsp;
</li>
<li>
<strong>.viewdistance</strong><br>
Sets the viewing distance. Same as setting the view distance in the graphics settings but with no upper limit<br>
For viewing distances above 1000 blocks you also have to set the .zfar value above that.&nbsp;<br>
&nbsp;
</li>
<li>
<strong>.zfar [value]</strong><br>
Set's the clipping plane distance, everything beyond given value is no longer visible (default value is 1000)<br>
Very high values will cause Z-Fighting glitches
</li>
</ul>


== Server Commands ==
=== .cam === <!--T:16-->
{{:List of client commands/cam{{#translation:}}}}


<ul>
=== .c[louds] === <!--T:17-->
<li>
*<code>.cdensity</code><br /> Set large and small cloud density
<strong>/kill</strong><br>
*<code>.cdensitylarge</code><br /> Set large cloud density
Kills&nbsp;yourself<br>
*<code>.cdensitysmall</code><br /> Set small cloud density
&nbsp;
*<code>.clight</code><br /> Set Cloud lightness
</li>
*<code>.crand</code><br /> Set large and small cloud noise
<li>
*<code>.cviewdist</code><br /> Sets the cloud view distance. Will be reset when view distance in graphics settings are changed
<strong>/clear</strong><br>
Removes all items from your inventory<br>
&nbsp;
</li>
<li>
<strong>/clearentities</strong><br>
Kills all entities in the loaded chunks (except for players)<br>
&nbsp;
</li>
<li>
<strong>/time [set|get|speed]</strong><br>
Time related functions
<ul>
<li>
<strong>/time </strong><br>
Shows current time
</li>
<li>
<strong>/time set day</strong>&nbsp;<br>
Sets the internal clock to 9 am
</li>
<li>
<strong>/time set night</strong>&nbsp;<br>
Sets the internal clock to 7 pm
</li>
<li>
<strong>/time set [time]</strong><br>
Sets the internal calendar to given time. Examples: /time set 12:00
</li>
<li>
<strong>/time speed</strong>&nbsp;<br>
Shows current game time speed
</li>
<li>
<strong>/time speed 0-99999</strong>&nbsp;<br>
Sets the game time speed (default 60)<br>
&nbsp;
</li>
</ul>
</li>
<li>
<strong>/tp [coordinates]</strong><br>
Teleport yourself to a different position
<ul>
<li>
<strong>/tp x y z</strong><br>
Teleports<strong>&nbsp;</strong>player to given pretty coordinate (visible from the pretty coordinate box when pressing 'C')
</li>
<li>
<strong>/tp =x =y =z</strong><br>
Teleports<strong>&nbsp;</strong>player to given absolute coordinate (visible from the debug screen on ALT + F3)
</li>
<li>
<strong>/tp ~x ~y ~z</strong><br>
Teleports player by a given relative distance (i.e. teleport ~1 ~0 ~0 will teleport the player one block in x direction)<br>
&nbsp;
</li>
</ul>
</li>
<li>
<strong>/tp [playername] [coordinates]</strong><br>
Teleport given player to a different position<br>
&nbsp;
</li>
<li>
<strong>/gamemode [0..4]&nbsp;</strong><br>
Sets your game mode:
<ul>
<li>
<strong>0 =&nbsp;Guest mode.</strong>&nbsp;Cannot place/remove any blocks but can interact with them
</li>
<li>
<strong>1 = Survival mode.&nbsp;</strong>Can slowly break/place blocks. Can die. Cannot fly. Survival inventory.
</li>
<li>
<strong>2 = Creative mode. </strong>Access to all blocks through the creative inventory. Instant block breaking. Cannot die. Can fly.
</li>
<li>
<strong>3 =&nbsp;Spectator&nbsp;mode.</strong>&nbsp;Cannot place/remove blocks and cannot interact with anything. But can fly.<br>
&nbsp;
</li>
</ul>
</li>
<li>
<strong>/gamemode [playername] [0..4]</strong><br>
Sets the gamemode for given player<br>
&nbsp;
</li>
<li>
<strong>/seed</strong><br>
Shows the world seed<br>
&nbsp;
</li>
<li>
<strong>/group&nbsp;[create|disband|rename|invite|acceptinvite|leave|list|kick|op|deop]&nbsp;</strong><br>
Create/manage or destrory a player group
<ul>
<li>
<strong>/group create [groupname]</strong>&nbsp;Creates a new player group (=own chat channel)<br>
While in the this groups chat channel:
<ul>
<li>
<strong>/group invite [playername]&nbsp;</strong>Invites a player to this group
</li>
<li>
<strong>/group acceptinvite [groupname]&nbsp;</strong>Accept an invite to join the group
</li>
<li>
<strong>/group leave</strong>&nbsp;Leaves this player group
</li>
<li>
<strong>/group list</strong>&nbsp;Lists all groups you are currently in
</li>
<li>
<strong>/group rename newgroupname</strong>&nbsp;Renames the group
</li>
<li>
<strong>/group kick [playername]</strong>&nbsp;Removes a player from the group
</li>
<li>
<strong>/group op [playername]</strong>&nbsp;Grants operator status to this player, which allows him to invite other players.
</li>
<li>
<strong>/group deop [playername] </strong>Revokes operator status from this player.
</li>
<li>
<strong>/group disband </strong>Destroy a player group. Must be owner to perform this command<br>
&nbsp;
</li>
</ul>
</li>
</ul>
</li>
<li>
<strong>Server Specific Tools</strong>
<ul>
<li>
<strong>/bir&nbsp;[getid|getcode|remap]</strong>&nbsp;Block id remapper tools. Useful to fix broken blocks after removing/updating custom blocks
</li>
<li>
<strong>/forceloadchunks x1 z1 x2 z1 [sendtoclient]&nbsp;</strong>Tells the server to load given area and prevents unloading. If "sendtoclient" is added it will also forcefully send all these chunks to the client.
</li>
<li>
<strong>/sendchunks [0 or 1]</strong>&nbsp;Toggles whether to send any new chunks to the client (force sending chunks are sent anyway)
</li>
<li>
<strong>/reloadmods</strong>&nbsp;Reloads all server mods that support reloading<br>
&nbsp;
</li>
</ul>
</li>
<li>
<strong>Multiplayer Specific&nbsp;Tools</strong>
<ul>
<li>
<strong>/welcome</strong>&nbsp;Sets the servers welcome message
</li>
<li>
<strong>/stop</strong> Shuts down the server
</li>
<li>
<strong>/privgrp [playername] [groupname]</strong>&nbsp;Puts a player into a privilege group
</li>
<li>
<strong>/op [playername]</strong>&nbsp;Shorthand for <strong>/privgrp Admin [playername]</strong>
</li>
<li>
<strong>/addarea</strong>&nbsp;Add a build permission area
</li>
<li>
<strong>/delarea </strong>Remove a build permission area
</li>
<li>
<strong>/addpriv&nbsp;</strong>Add a privilege to a permission group
</li>
<li>
<strong>/removepriv </strong>Remove a privilge from a permission group
</li>
<li>
<strong>/ban [reason]</strong>&nbsp;Ban a player
</li>
<li>
<strong>/unband&nbsp;[playername]</strong> Unban&nbsp;a player
</li>
<li>
<strong>/kick[reason]</strong> Kick a player
</li>
</ul>
</li>
</ul>
<p>
&nbsp;
</p>


<ul>
=== .charsel===
<li>
*<code>.charsel</code><br /> Opens the character selection menu.
<strong>/macro [addcmd|setcmd|syntax|desc|priv|save|delete|show|list]</strong><br>
 
Create a server side macro that can execute one ore multiple commands
=== .chatsize === <!--T:18-->
<ul>
*<code>.chatsize [width]/default [height]/default</code><br /> Set the chat dialog with custom width and/or height (default 400x160 [Depending on the interface])
<li>
 
<strong>/macro addcmd [command without /]</strong>&nbsp; Add a command to a temporary macro
=== .chb ===
</li>
*<code>.chb</code><br />Opens up command handbook
<li>
 
<strong>/macro setcmd[command without /]</strong>&nbsp; Set a command to a temporary macro (removes previously added ones)
=== .clearchat === <!--T:19-->
</li>
*<code>.clearchat</code><br /> Clears your chat history
<li>
 
<strong>/macro syntax</strong>&nbsp;Sets the syntax help info displayed when using /help
=== .client+ === <!--T:20-->
</li>
*<code>.client+</code><br /> Client+ configuration command
<li>
 
<strong>/macro desc</strong>&nbsp;Sets the description text displayed when using /help
=== .clientconfig === <!--T:6-->
</li>
{{:List of client commands/clientconfig{{#translation:}}}}
<li>
 
<strong>/macro priv</strong>&nbsp;Sets the privilege required to execute this command, e.g. <em>controlserver</em> if only for admins or <em>build</em> for any player with build rights
=== .clientconfigcreate === <!--T:21-->
</li>
*<code>.clientconfigcreate [name] [datatype] [value]</code><br /> Adds a new client configuration key that did not exist before.
<li>
<br />
<strong>/macro show</strong>&nbsp;Shows the contents temporary macro currently being defined by above commands
*<code>.clientconfigcreate overheadLookAt bool true</code><br /> Adds a client configuration key that causes the player's seraph to look at the camera when it is in front of the character. Set to false to disable.
</li>
 
<li>
=== .clients === <!--T:22-->
<strong>/macro save [name]</strong>&nbsp;Saves the temporary macro defined by above command to given command name
*<code>.clients</code><br /> Prints list of online players. Alias for {{ll|List_of_client_commands#.online|<code>.online</code>}}.
</li>
*<code>.clients ping</code><br /> Prints list of online players with their ping. Alias for {{ll|List_of_client_commands#.online|<code>.online ping</code>}}.
<li>
 
<strong>/macro list</strong>&nbsp;Shows a list of all saved macros
=== .cp === <!--T:23-->
</li>
*<code>.cp [posi|aposi|apos|chat]</code><br /> Copy something to your clipboard
<li>
** <code>.cp posi</code><br /> The position below the player as an integer.
<strong>/macro show [name]&nbsp;</strong>Shows the contents of a saved macro
** <code>.cp aposi</code><br /> The absolute player position as an integer in the format <code>X=1,Y=1,Z=1</code>.
</li>
** <code>.cp apos</code><br /> The absolute player position as a float in the format <code>X=1.34,Y=1.34,Z=1.34</code>.
<li>
** <code>.cp chat</code><br /> The chat history.
<strong>/macro delete [name]</strong>&nbsp;Deletes a previously saved macro
 
</li>
=== .crash ===
<li>
*<code>.crash</code><br /> Crashes the game.
<strong>/macro discard [name]</strong> Discards the temporary macro
 
</li>
=== .ctblocks ===
</ul>
*<code>.ctblocks [freezeCtBlocks]</code><br />Lets you to toggle on/off the updating of client ticking blocks. This can be useful when recording waterfalls and such.
</li>
**<code>[freezeCtBlocks]</code> is a boolean, including 1 or 0, yes or no, true or false, or on and off
</ul>
 
<p>
=== .debug === <!--T:7-->
&nbsp;
* <code>.debug normalview</code><br /> Shows vertex normals instead textures, but does not discard transparent pixels.
</p>
* <code>.debug wireframe [value]</code><br /> Running <code>.debug wireframe</code> will give some help info.
** <code>entity</code><br /> Shows entity selection boxes in blue and collision boxes in red.[[File:Debug-wireframe-entity-polarbear.png|thumb|polar bear selection and collision boxes]]
** <code>chunk</code><br /> Shows chunk borders.
** <code>serverchunk</code><br /> Shows server chunk borders.
** <code>region</code><br /> Shows region borders.
** <code>blockentity</code><br /> Shows block entity borders e.g. of large gear.
** <code>ambsounds</code><br /> Shows ambient sound borders e.g. of flowing water.
* <code>.debug talk [value]</code><br /> Plays actions with the character's voice. Running <code>.debug talk</code> will give a list of values.
* <code>.debug [perceptioneffect|pc] [value]</code><br /> Applies effect.
** <code>drunk</code><br /> Makes player drunk.
** <code>damagedfreezing</code><br /> Applies a freezing effect to player.
* <code>.debug tofb [true|false]</code><br /> Toggle offscreen buffer.
* <code>.debug cmr</code><br /> Print a full list of color map rectangles to the client-main.txt.
* <code>.debug us</code><br /> Toggle unbind samplers mode.
* <code>.debug gl [true|false]</code><br /> Toggle OpenGL debug mode.
* <code>.debug uiclick</code><br /> Toggle UI Debug print interactions.
* <code>.debug discovery [value]</code><br /> Show a text on the screen as for lore books.
* <code>.debug soundsummary</code><br /> Print a count of loaded sounds.
* <code>.debug meshsummary</code><br /> Print a full list of block mesh sizes in kilobytes to client-debug.txt.
* <code>.debug chunksummary</code><br /> Print a count of total chunks, packed chunks and free pool objects.
* <code>.debug renderers</code><br /> Print a full list of renderers.
* <code>.debug exptexatlas [block|item|entity]</code><br /> Export an atlas(es) of blocks, items or entities.
* <code>.debug liquidselectable</code><br /> Toggle forced liquid selectable.
* <code>.debug relightchunk</code><br /> Recalculate sunlight and queue for redrawing in the chunk.
* <code>.debug fog [value]</code><br /> Sets fog density.
* <code>.debug fov [value]</code><br /> Sets field of view.
* <code>.debug wgen</code><br /> Print a rainfall and adjusted temperature values.
* <code>.debug redrawall</code><br /> Redraw all chunks.
* <code>.debug ci</code><br /> Display some information on the current chunk the player is in
* <code>.debug shake [value]</code><br /> Shake effect. Insert a higher negative value to remove the effect.
* <code>.debug recalctrav</code><br /> Recalculate traversability of all chunks.
* <code>.debug find [blockName]</code><br /> Specify all or part of the name of a block to find its coordinates.
{{ll|List of server commands/debug}} also exists. Use <code>.help debug</code> for more info on debug commands.
 
=== .dev===
*<code>.dev bsedit</code><br /> Opens The Block Selection Editor. Has alias of {{ll|List_of_client_commands#.bsedit|<code>.bsedit</code>}}.
*<code>.dev reload <assetcategory></code><br /> Asseted reloading utility. Incase of shape reload will also Re-tesselate. Incase of textures will regenerate the texture atlesses. See {{ll|List_of_client_commands#.reload|<code>.reload</code>}} for more information, as command is an alias.
*<code>.dev tfedit [fp/tp/tpo/gui/ground]</code>
** <code>[fp/tp/tpo/gui/ground]</code> is (optionally) the type.
**Opens The transform Editor. Has Alias of {{ll|List_of_client_commands#.tfedit|<code>.tfedit</code>}}.
 
=== .edi === <!--T:24-->
*<code>.edi</code><br /> Show/Hide Extended information on debug screen, e.g. block lighting. Has alias of {{ll|List_of_client_commands#.debug|<code>.debug edi</code>}}.
 
=== .errorreporter===
*<code>.errorreporter</code><br /> Reopens the error reporting dialog
 
=== .exponepng === <!--T:25-->
*<code>.exponepng code [block|item] [exportCode] [size=100]</code><br />Export one item as png image
**<code>[block|item]</code> is the exportType
**<code>[exportCode]</code> is a string without spaces
**<code>[size]</code> is an integer number. Default is 100.
*<code>.exponepng hand [size=100] </code><br />Export icon for currently held item/block.
**<code>[size]</code> is an integer number. Default is 100.
 
=== .fbdeb === <!--T:26-->
*<code>.fbdeb</code><br /> Toggle Framebuffer/WOIT Debug mode
 
=== .fountain === <!--T:27-->
*<code>.fountain [quantity] [quad|cube]</code><br /> Toggle Particle fountain.
 
=== .firstlaunchinfo ===
*<code>.firstlaunchinfo</code><br /> Show the first launch info dialog.
 
=== .freemove === <!--T:28-->
*<code>.freemove [freeMove]</code><br /> Toggle Freemove
**<code>[freeMove]</code> is a boolean, including 1 or 0, yes or no, true or false, or on or off
 
=== .gencraftjson === <!--T:29-->
*<code>.gencraftjson</code><br /> Copies a snippet of json from your currently held item usable as a crafting recipe ingredient
 
=== .gui === <!--T:30-->
*<code>.gui [show_gui]</code><br /> Hide/Show all GUIs
**<code>[show_gui]</code> is a boolean, including 1 or 0, yes or no, true or false, or on or off
 
=== .help === <!--T:31-->
*<code>.help</code><br /> Display list of available client commands. Has options parramameters of [commandname] [subcommand] and [subsubcommand] which are strings without spaces, you can use <code>.help [commandname]</code> to display the information regarding the command in question as well as restrictions on parameters as well as a list of subcommands.
 
=== .lockfly === <!--T:32-->
*<code>.lockfly</code><br /> Locks a movement axis during flying/swimming
**<code>.lockfly 1</code><br /> Locks a movement axis to X
**<code>.lockfly 2</code><br /> Locks a movement axis to Y
**<code>.lockfly 3</code><br /> Locks a movement axis to Z
 
=== .logticks === <!--T:33-->
*<code>.logticks</code><br /> Toggle Tick profiling. Won't log ticks below the threshold.
 
=== .map=== <!--T:34-->
*<code>.map purgedb</code><br /> Purges map DB.
*<code>.map redraw</code><br /> Redraws map.
*<code>.map worldmapsize [mapHeight] [mapWidth]</code><br /> Sets world map size.
 
=== .moon === <!--T:35-->
*<code>.moon</code><br /> Prints the current moon phase.
 
=== .movespeed === <!--T:36-->
*<code>.movespeed [speed]</code><br /> Set Movespeed
**<code>[speed]</code> is a decimal number, for example 0.5
 
=== .music === <!--T:37-->
*<code>.music stop</code><br /> Stops the current music track.
 
=== .netbenchmark === <!--T:38-->
*<code>.netbenchmark</code><br /> Toggles network benchmarking
 
=== .notminecraft ===
*<code>.notminecraft</code><br /> Discription in the command handbook and when <code>.help notminecraft</code> reads: "No, this is not minecraft". Command displays a banner in the top right corner of the game that states "No, this is not minecraft". The banner also displays the minecraft icon with a red "X" marking through the image. To toggle off, run the command again.
 
=== .noclip === <!--T:39-->
*<code>.noclip [noclip]</code><br /> Toggle noclip
 
=== .online === <!--T:40-->
*<code>.online</code><br /> Prints list of online players. Alias for {{ll|List_of_client_commands#.clients|<code>.clients</code>}}.
*<code>.online ping</code><br /> Prints list of online players with their ping. Alias for {{ll|List_of_client_commands#.clients|<code>.clients ping</code>}}.
 
=== .pastemode === <!--T:41-->
*<code>.pastemode [single|multi]</code><br /> Set the chats paste mode. If set to multi pasting multiple lines will produce multiple chat lines.
**<code>[single|mulit]</code> is the mode
 
=== .recomposechat === <!--T:42-->
*<code>.recomposechat</code><br /> Recompose chat dialogs
 
=== .reconnect === <!--T:43-->
*<code>.reconnect</code><br /> Reconnect to server
 
=== .recordingmode === <!--T:44-->
*<code>.recordingmode</code><br /> Makes the game brighter for recording (Sets gamma level to 1.1 and brightness level to 1.5)
 
=== .reload === <!--T:8-->
*This command has alias of Alias for {{ll|List_of_client_commands#.dev|<code>.dev reload</code>}}
*Warning: Some of the commands listed below may have changed, .chb does not list what options are available for testing and not all of the commands would run as tested.
*<code>.reload shapes</code><br /> Reloads all JSON models from assets/blockshapes. Can be used to quickly test new block shapes.<br />Notice: The chunks are not redrawn, so you'd have to force a redraw e.g. by placing and removing a block.
*<code>.reload textures</code><br /> Reloads all textures from assets/textures. Can be used to quickly test texture changes.
*<code>.reload lang</code><br /> Reloads all lang files from assets/lang. Can be used to quickly test translation changes.
*<code>.reloadhandbook</code><br /> Reloads handbook entries. Can be used to quickly test translation etc. changes in handbook.
 
=== .resolution === <!--T:45-->
*<code>.resolution</code><br /> Sets the screen size to given width and height
 
=== .serverinfo === <!--T:46-->
*<code>.serverinfo</code><br /> Display information about server info
 
=== .spawndecal === <!--T:47-->
*<code>.spawndecal</code><br /> Spawn a decal at position
 
=== .tfedit === <!--T:48-->
*<code>.tfedit [fp/tp/tpo/gui/ground]</code> <br /> Opens The transform Editor. Has Alias of {{ll|List_of_client_commands#.dev|<code>.dev tfedit</code>}}.
** <code>[fp/tp/tpo/gui/ground]</code> is (optionally) the type.
 
=== .time === <!--T:49-->
*<code>.time</code><br /> Read local game time or speed
 
=== .timelapse ===
*<code>.timelapse [interval-in-days] [duration-in-months]</code><br /> Takes a set of timelapse photographs of the same spot of several hours, days, or seasons. Images can be found in folder <code>Pictures/Vintagestory/timelapse</code>.<br />Note: As currently implemented, the world does not actually change while the photographs are being taken. For example, crops will not grow, snow will not fall, ect. This is intended only for seeing the visual changes of the changing time of day or changing seasons.
 
=== .tutorial ===
*Interact with the tutorial system.
*<code>.tutorial hud</code><br /> Toggles the tutorial HUD.
*<code>.tutorial restart</code><br /> Restarts the currently selected tutorial .
*<code>.tutorial ship [skip_amount]</code><br /> Skips the currently selected tutorial.
**<code>[skip_amount]</code><br /> Is an integer Number.
 
=== .viewdistance === <!--T:9-->
*<code>.viewdistance</code><br /> Sets the viewing distance. Same as setting the view distance in the graphics settings but with no upper limit. For viewing distances above 1000 blocks you also have to set the <code>.zfar</code> value above that.
 
=== .vrec === <!--T:50-->
*<code>.vrec</code><br /> Video Recorder Tools
 
=== .we === <!--T:51-->
*<code>.we</code><br /> World edit toolbar, see more in {{ll|How_to_use_WorldEdit|How to use WorldEdit}}
 
=== .weather ===
*<code>.weather</code><br /> Shows current weather info.
 
=== .zfar === <!--T:10-->
*<code>.zfar [value]</code><br /> Sets the clipping plane distance, everything beyond given value is no longer visible (default value is 1000). Very high values will cause Z-fighting.
 
</translate>
{{Game navbox}}
{{Navbox/modding|Vintage Story}}

Latest revision as of 02:11, 5 October 2024

Other languages:
Gear-rusty.png

This page is outdated.
Reason: Severely outdated, see protip below for up to date information.
The content on this page is not up to date with the most recent game update. If you do wish to contribute, please request wiki edit access on the Discord.

This page was last verified for Vintage Story version 1.15.

Commands offer advanced features and configuration abilities for your game. There are really 2 lists of commands - Client and Server . The client is what displays your game on the screen, plays the sounds, takes in your controls and lets you connect to a game server (single or multiplayer). Client commands are those that usually just affect the appearance of your game, while server commands allows you to modify the world or configuration of the game.

All commands are typed in the chat window in order to execute them. A client command always starts with a dot ., while a server command always starts with a slash /.

Book-normal-brickred.png Protip: 
It is advised to utilize in-game command handbook available under client command .chb as it is generally up to date with current game version and often has more information than what is available on Wiki. The article has been updated to include the addition of most commands as off 1.19.8, however, some the commands that have been removed or moved since 1.15 may not be correct. If a command does not work, check .chb for alternate commands.


See also: List of server commands


Client Commands

.blockitempngexport

  • .blockitempngexport [inv|all] [imageSize] [domain]
    Export all items and blocks as png images
    • [inv|all] is (optionally) the exportRequest
    • [imageSize] is an integer number
    • [domain] is a string without spaces

.bsedit

  • .bsedit
    Opens the block selection editor. Alias for .dev bsedit

.cam

  • .cam [p|rp|cp|up|goto|start|loop|stop|clear|load|save|alpha|tp]
    The cinematic camera tool system.
    • .cam p
      Adds the current position to the list of places to visit.
    • .cam rp
      Removes the last added point.
    • .cam cp
      "Close path". Connects the path to the first position in the list. Useful in combination with .cam loop to create a looping camera path.
    • .cam up [num]
      Update the position and viewing angle of point num to the current location.
    • .cam goto [num]
      Go to point num by teleport.
    • .cam clear
      Clears the list of all points.
    • .cam start [time]
      Starts the cinematic camera, the camera will complete the path in the given number of seconds.
    • .cam rec [real seconds] [video seconds]
      Play path and record to .avi file.
    • .cam stop
      Stops the cinematic camera.
    • .cam save
      Exports the current list of points into your clipboard, which you then can paste into any text editor.
    • .cam load [data]
      Import supplied list of points.
    • .cam tp [0 or 1]
      Toggles whether to teleport you back to your previous position after the camera path has been completed.
    • .cam alpha [0..1]
      Modifies how the smoothly the points are traversed by the camera.
    • .cam gui [0 or 1]
      If one, will disable the guis during the duration of the recording (default on).


.c[louds]

  • .cdensity
    Set large and small cloud density
  • .cdensitylarge
    Set large cloud density
  • .cdensitysmall
    Set small cloud density
  • .clight
    Set Cloud lightness
  • .crand
    Set large and small cloud noise
  • .cviewdist
    Sets the cloud view distance. Will be reset when view distance in graphics settings are changed

.charsel

  • .charsel
    Opens the character selection menu.

.chatsize

  • .chatsize [width]/default [height]/default
    Set the chat dialog with custom width and/or height (default 400x160 [Depending on the interface])

.chb

  • .chb
    Opens up command handbook

.clearchat

  • .clearchat
    Clears your chat history

.client+

  • .client+
    Client+ configuration command

.clientconfig

  • .clientconfig [parameterName] [parameterValue]
    Changes client configuration at runtime. It can change any value in the clientsettings.json file. parametername may seem like subcommands, but is actually a dynamic list of options. This means that mods can change the list of options.
    • floatyGuis [1|0]
      Enables/disables the experimental feature where chest dialogs float above the chests
    • showentitydebuginfo [0|1]
      Displays arbitrary debug information above entities
      May require corresponding server command /entity debug 1
    • ssaa [0.5|2]
      Controls Screen Space Anti-Aliasing. 0.5 value enables 0.5x Sampling rate and may give a performance gain at the cost of reduced graphics quality for low end hardware. 2 value enables 2-4x Sampling rate.
    • gammaLevel [level]
      Allows to set gamma level in survival mode. Value 1 is the default 100%, 1.5 is brighter.


.clientconfigcreate

  • .clientconfigcreate [name] [datatype] [value]
    Adds a new client configuration key that did not exist before.


  • .clientconfigcreate overheadLookAt bool true
    Adds a client configuration key that causes the player's seraph to look at the camera when it is in front of the character. Set to false to disable.

.clients

  • .clients
    Prints list of online players. Alias for .online .
  • .clients ping
    Prints list of online players with their ping. Alias for .online ping .

.cp

  • .cp [posi|aposi|apos|chat]
    Copy something to your clipboard
    • .cp posi
      The position below the player as an integer.
    • .cp aposi
      The absolute player position as an integer in the format X=1,Y=1,Z=1.
    • .cp apos
      The absolute player position as a float in the format X=1.34,Y=1.34,Z=1.34.
    • .cp chat
      The chat history.

.crash

  • .crash
    Crashes the game.

.ctblocks

  • .ctblocks [freezeCtBlocks]
    Lets you to toggle on/off the updating of client ticking blocks. This can be useful when recording waterfalls and such.
    • [freezeCtBlocks] is a boolean, including 1 or 0, yes or no, true or false, or on and off

.debug

  • .debug normalview
    Shows vertex normals instead textures, but does not discard transparent pixels.
  • .debug wireframe [value]
    Running .debug wireframe will give some help info.
    • entity
      Shows entity selection boxes in blue and collision boxes in red.
      polar bear selection and collision boxes
    • chunk
      Shows chunk borders.
    • serverchunk
      Shows server chunk borders.
    • region
      Shows region borders.
    • blockentity
      Shows block entity borders e.g. of large gear.
    • ambsounds
      Shows ambient sound borders e.g. of flowing water.
  • .debug talk [value]
    Plays actions with the character's voice. Running .debug talk will give a list of values.
  • .debug [perceptioneffect|pc] [value]
    Applies effect.
    • drunk
      Makes player drunk.
    • damagedfreezing
      Applies a freezing effect to player.
  • .debug tofb [true|false]
    Toggle offscreen buffer.
  • .debug cmr
    Print a full list of color map rectangles to the client-main.txt.
  • .debug us
    Toggle unbind samplers mode.
  • .debug gl [true|false]
    Toggle OpenGL debug mode.
  • .debug uiclick
    Toggle UI Debug print interactions.
  • .debug discovery [value]
    Show a text on the screen as for lore books.
  • .debug soundsummary
    Print a count of loaded sounds.
  • .debug meshsummary
    Print a full list of block mesh sizes in kilobytes to client-debug.txt.
  • .debug chunksummary
    Print a count of total chunks, packed chunks and free pool objects.
  • .debug renderers
    Print a full list of renderers.
  • .debug exptexatlas [block|item|entity]
    Export an atlas(es) of blocks, items or entities.
  • .debug liquidselectable
    Toggle forced liquid selectable.
  • .debug relightchunk
    Recalculate sunlight and queue for redrawing in the chunk.
  • .debug fog [value]
    Sets fog density.
  • .debug fov [value]
    Sets field of view.
  • .debug wgen
    Print a rainfall and adjusted temperature values.
  • .debug redrawall
    Redraw all chunks.
  • .debug ci
    Display some information on the current chunk the player is in
  • .debug shake [value]
    Shake effect. Insert a higher negative value to remove the effect.
  • .debug recalctrav
    Recalculate traversability of all chunks.
  • .debug find [blockName]
    Specify all or part of the name of a block to find its coordinates.

List of server commands/debug also exists. Use .help debug for more info on debug commands.

.dev

  • .dev bsedit
    Opens The Block Selection Editor. Has alias of .bsedit .
  • .dev reload <assetcategory>
    Asseted reloading utility. Incase of shape reload will also Re-tesselate. Incase of textures will regenerate the texture atlesses. See .reload for more information, as command is an alias.
  • .dev tfedit [fp/tp/tpo/gui/ground]
    • [fp/tp/tpo/gui/ground] is (optionally) the type.
    • Opens The transform Editor. Has Alias of .tfedit .

.edi

  • .edi
    Show/Hide Extended information on debug screen, e.g. block lighting. Has alias of .debug edi .

.errorreporter

  • .errorreporter
    Reopens the error reporting dialog

.exponepng

  • .exponepng code [block|item] [exportCode] [size=100]
    Export one item as png image
    • [block|item] is the exportType
    • [exportCode] is a string without spaces
    • [size] is an integer number. Default is 100.
  • .exponepng hand [size=100]
    Export icon for currently held item/block.
    • [size] is an integer number. Default is 100.

.fbdeb

  • .fbdeb
    Toggle Framebuffer/WOIT Debug mode

.fountain

  • .fountain [quantity] [quad|cube]
    Toggle Particle fountain.

.firstlaunchinfo

  • .firstlaunchinfo
    Show the first launch info dialog.

.freemove

  • .freemove [freeMove]
    Toggle Freemove
    • [freeMove] is a boolean, including 1 or 0, yes or no, true or false, or on or off

.gencraftjson

  • .gencraftjson
    Copies a snippet of json from your currently held item usable as a crafting recipe ingredient

.gui

  • .gui [show_gui]
    Hide/Show all GUIs
    • [show_gui] is a boolean, including 1 or 0, yes or no, true or false, or on or off

.help

  • .help
    Display list of available client commands. Has options parramameters of [commandname] [subcommand] and [subsubcommand] which are strings without spaces, you can use .help [commandname] to display the information regarding the command in question as well as restrictions on parameters as well as a list of subcommands.

.lockfly

  • .lockfly
    Locks a movement axis during flying/swimming
    • .lockfly 1
      Locks a movement axis to X
    • .lockfly 2
      Locks a movement axis to Y
    • .lockfly 3
      Locks a movement axis to Z

.logticks

  • .logticks
    Toggle Tick profiling. Won't log ticks below the threshold.

.map

  • .map purgedb
    Purges map DB.
  • .map redraw
    Redraws map.
  • .map worldmapsize [mapHeight] [mapWidth]
    Sets world map size.

.moon

  • .moon
    Prints the current moon phase.

.movespeed

  • .movespeed [speed]
    Set Movespeed
    • [speed] is a decimal number, for example 0.5

.music

  • .music stop
    Stops the current music track.

.netbenchmark

  • .netbenchmark
    Toggles network benchmarking

.notminecraft

  • .notminecraft
    Discription in the command handbook and when .help notminecraft reads: "No, this is not minecraft". Command displays a banner in the top right corner of the game that states "No, this is not minecraft". The banner also displays the minecraft icon with a red "X" marking through the image. To toggle off, run the command again.

.noclip

  • .noclip [noclip]
    Toggle noclip

.online

  • .online
    Prints list of online players. Alias for .clients .
  • .online ping
    Prints list of online players with their ping. Alias for .clients ping .

.pastemode

  • .pastemode [single|multi]
    Set the chats paste mode. If set to multi pasting multiple lines will produce multiple chat lines.
    • [single|mulit] is the mode

.recomposechat

  • .recomposechat
    Recompose chat dialogs

.reconnect

  • .reconnect
    Reconnect to server

.recordingmode

  • .recordingmode
    Makes the game brighter for recording (Sets gamma level to 1.1 and brightness level to 1.5)

.reload

  • This command has alias of Alias for .dev reload
  • Warning: Some of the commands listed below may have changed, .chb does not list what options are available for testing and not all of the commands would run as tested.
  • .reload shapes
    Reloads all JSON models from assets/blockshapes. Can be used to quickly test new block shapes.
    Notice: The chunks are not redrawn, so you'd have to force a redraw e.g. by placing and removing a block.
  • .reload textures
    Reloads all textures from assets/textures. Can be used to quickly test texture changes.
  • .reload lang
    Reloads all lang files from assets/lang. Can be used to quickly test translation changes.
  • .reloadhandbook
    Reloads handbook entries. Can be used to quickly test translation etc. changes in handbook.

.resolution

  • .resolution
    Sets the screen size to given width and height

.serverinfo

  • .serverinfo
    Display information about server info

.spawndecal

  • .spawndecal
    Spawn a decal at position

.tfedit

  • .tfedit [fp/tp/tpo/gui/ground]
    Opens The transform Editor. Has Alias of .dev tfedit .
    • [fp/tp/tpo/gui/ground] is (optionally) the type.

.time

  • .time
    Read local game time or speed

.timelapse

  • .timelapse [interval-in-days] [duration-in-months]
    Takes a set of timelapse photographs of the same spot of several hours, days, or seasons. Images can be found in folder Pictures/Vintagestory/timelapse.
    Note: As currently implemented, the world does not actually change while the photographs are being taken. For example, crops will not grow, snow will not fall, ect. This is intended only for seeing the visual changes of the changing time of day or changing seasons.

.tutorial

  • Interact with the tutorial system.
  • .tutorial hud
    Toggles the tutorial HUD.
  • .tutorial restart
    Restarts the currently selected tutorial .
  • .tutorial ship [skip_amount]
    Skips the currently selected tutorial.
    • [skip_amount]
      Is an integer Number.

.viewdistance

  • .viewdistance
    Sets the viewing distance. Same as setting the view distance in the graphics settings but with no upper limit. For viewing distances above 1000 blocks you also have to set the .zfar value above that.

.vrec

  • .vrec
    Video Recorder Tools

.we

.weather

  • .weather
    Shows current weather info.

.zfar

  • .zfar [value]
    Sets the clipping plane distance, everything beyond given value is no longer visible (default value is 1000). Very high values will cause Z-fighting.


Wiki Navigation
Vintage Story Guides[[::Category:Guides| ]] • Frequently Asked Questions • Soundtrack • Versions • Controls
Game systems Crafting • Knapping • Clay forming • Smithing • Cooking • Temperature • Hunger • Mining • Temporal stability • Mechanical power • Trading • Farming • Animal husbandry
World World generation • Biomes • Weather • Temporal storms
Items Tools • Weapons • Armor • Clothing • Bags • Materials • Food
Blocks Terrain • Plants • Decorative • Lighting • Functional • Ore
Entities Hostile entities • Animals • NPCs • Players
Miscellaneous List of client commands • List of server commands • Creative Starter Guide • Bot System • WorldEdit • Cinematic Camera • Adjustable FPS Video Recording • ServerBlockTicking


Icon Sign.png

Wondering where some links have gone?
The modding navbox is going through some changes! Check out Navigation Box Updates for more info and help finding specific pages.

Modding
Modding Introduction Getting Started • Theme Pack
Content Modding Content Mods • Developing a Content Mod • Basic Tutorials • Intermediate Tutorials • Advanced Tutorials • Content Mod Concepts
Code Modding Code Mods • Setting up your Development Environment
Property Overview Item • Entity • Entity Behaviors • Block • Block Behaviors • Block Classes • Block Entities • Block Entity Behaviors • Collectible Behaviors • World properties
Workflows & Infrastructure Modding Efficiency Tips • Mod-engine compatibility • Mod Extensibility • VS Engine
Additional Resources Community Resources • Modding API Updates • Programming Languages • List of server commands • List of client commands • Client startup parameters • Server startup parameters
Example Mods • API Docs • GitHub Repository


Retrieved from "https://wiki.vintagestory.at/index.php?title=List_of_client_commands&oldid=189972"