List of client commands: Difference between revisions

From Vintage Story Wiki
m
Added game navbox.
m (Added game navbox.)
 
(75 intermediate revisions by 17 users not shown)
Line 1: Line 1:
<languages/>


== Client Commands ==
{{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>


<p>
<!--T:14-->
<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>
See also: {{ll|List_of_server_commands|List of server commands}}
</p>


<p>
</translate>
<span style="font-size:14px;">Here is a list of the most useful ones.</span>
__FORCETOC__
</p>
<translate>
== Client Commands == <!--T:4-->
=== .blockitempngexport ===
*<code>.blockitempngexport [inv|all] [imageSize] [domain]</code><br /> Export all items and blocks as png images


<p>
=== .cam === <!--T:16-->
<strong><span style="font-size:14px;">Client Commands</span></strong>
{{:List of client commands/cam{{#translation:}}}}
</p>


<ul>
=== .c[louds] === <!--T:17-->
<li>
*<code>.cdensity</code><br /> Set large and small cloud density
<strong>.fog [density] [minfog]</strong><br>
*<code>.cdensitylarge</code><br /> Set large cloud density
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>
*<code>.cdensitysmall</code><br /> Set small cloud density
The <em>minfog&nbsp;</em>determines a minimum amount of fog that is always applied, default is 0<br>
*<code>.clight</code><br /> Set Cloud lightness
&nbsp;
*<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
<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 ==
=== .chatsize === <!--T:18-->
*<code>.chatsize [width]/default [height]/default</code><br /> Set the chat dialog with custom width and/or height (default 400x160 [Depending on the interface])


<ul>
=== .clearchat === <!--T:19-->
        <li>
*<code>.clearchat</code><br /> Clears your chat history
<strong>/ci</strong><br/>
Current chunk info<br/>
&nbsp;
</li>
<li>
<strong>/seed</strong><br>
Shows the world seed<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>/clear</strong><br>
Removes all items from your inventory<br>
&nbsp;
</li>
        <li>
<strong>/kill</strong><br>
Kills&nbsp;yourself<br>
&nbsp;
</li>
<li>
<strong>/clearentities</strong><br/>
Kills all entities in the loaded chunks (except for players)<br/>
&nbsp;
</li>
<li>
<strong>/serverconfig</strong><br>
                Modify the server config<br/>
<ul>
                        <li>
<strong>/serverconfig maxchunkradius (integer)</strong><br/>
Displays the max chunk radius. If an integer value is passed it will set the max chunk radius.
</li>
                        <li>
<strong>/serverconfig maxclients (integer)</strong><br/>
Displays the maxclients. If an integer value is passed it will set the maxclients.
</li>
                        <li>
<strong>/serverconfig password</strong><br/>
Sets the server password
</li>
                        <li>
<strong>/serverconfig antiabuse (Off|Basic|Pedantic)</strong><br/>
Sets antiabuse level
</li>
                        <li>
<strong>/serverconfig onlywhitelist (bool)</strong><br/>
Sets or shows the onlywhitelist value
</li>
                        <li>
<strong>/serverconfig entityspawning (bool)</strong><br/>
Sets or shows the value of entityspawning
</li>


=== .client+ === <!--T:20-->
*<code>.client+</code><br /> Client+ configuration command


</ul>
=== .clientconfig === <!--T:6-->
{{:List of client commands/clientconfig{{#translation:}}}}


</li>
=== .clientconfigcreate === <!--T:21-->
*<code>.clientconfigcreate [name] [datatype] [value]</code><br /> Adds a new client configuration key that did not exist before.
<br />
*<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>
=== .clients === <!--T:22-->
<strong>/time [set|get|speed]</strong><br>
*<code>.clients</code><br /> List of connected players.
Time related functions
*<code>.clients ping</code><br /> List of connected players with their ping.
<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>/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>
=== .cp === <!--T:23-->
<li>
*<code>.cp [posi|aposi|apos|chat]</code><br /> Copy something to your clipboard
<strong>/macro [addcmd|setcmd|syntax|desc|priv|save|delete|show|list]</strong><br>
** <code>.cp posi</code><br /> The position below the player as an integer.
Create a server side macro that can execute one ore multiple commands
** <code>.cp aposi</code><br /> The absolute player position as an integer in the format <code>X=1,Y=1,Z=1</code>.
<ul>
** <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 addcmd [command without /]</strong>&nbsp; Add a command to a temporary macro
 
</li>
=== .debug === <!--T:7-->
<li>
* <code>.debug normalview</code><br /> Shows vertex normals instead textures, but does not discard transparent pixels.
<strong>/macro setcmd[command without /]</strong>&nbsp; Set a command to a temporary macro (removes previously added ones)
* <code>.debug wireframe [value]</code><br /> Running <code>.debug wireframe</code> will give some help info.
</li>
** <code>entity</code><br /> Shows entity collision boxes.
<li>
** <code>chunk</code><br /> Shows chunk borders.
<strong>/macro syntax</strong>&nbsp;Sets the syntax help info displayed when using /help
** <code>serverchunk</code><br /> Shows server chunk borders.
</li>
** <code>region</code><br /> Shows region borders.
<li>
** <code>blockentity</code><br /> Shows block entity borders e.g. of large gear.
<strong>/macro desc</strong>&nbsp;Sets the description text displayed when using /help
** <code>ambsounds</code><br /> Shows ambient sound borders e.g. of flowing water.
</li>
* <code>.debug talk [value]</code><br /> Plays actions with the character's voice. Running <code>.debug talk</code> will give a list of values.
<li>
* <code>.debug [perceptioneffect|pc] [value]</code><br /> Applies effect.
<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
** <code>drunk</code><br /> Makes player drunk.
</li>
** <code>damagedfreezing</code><br /> Applies a freezing effect to player.
<li>
* <code>.debug tofb [true|false]</code><br /> Toggle offscreen buffer.
<strong>/macro show</strong>&nbsp;Shows the contents temporary macro currently being defined by above commands
* <code>.debug cmr</code><br /> Print a full list of color map rectangles to the client-main.txt.
</li>
* <code>.debug us</code><br /> Toggle unbind samplers mode.
<li>
* <code>.debug gl [true|false]</code><br /> Toggle OpenGL debug mode.
<strong>/macro save [name]</strong>&nbsp;Saves the temporary macro defined by above command to given command name
* <code>.debug uiclick</code><br /> Toggle UI Debug print interactions.
</li>
* <code>.debug discovery [value]</code><br /> Show a text on the screen as for lore books.
<li>
* <code>.debug soundsummary</code><br /> Print a count of loaded sounds.
<strong>/macro list</strong>&nbsp;Shows a list of all saved macros
* <code>.debug meshsummary</code><br /> Print a full list of block mesh sizes in kilobytes to client-debug.txt.
</li>
* <code>.debug chunksummary</code><br /> Print a count of total chunks, packed chunks and free pool objects.
<li>
* <code>.debug renderers</code><br /> Print a full list of renderers.
<strong>/macro show [name]&nbsp;</strong>Shows the contents of a saved macro
* <code>.debug exptexatlas [block|item|entity]</code><br /> Export an atlas(es) of blocks, items or entities.
</li>
* <code>.debug liquidselectable</code><br /> Toggle forced liquid selectable.
<li>
* <code>.debug relightchunk</code><br /> Recalculate sunlight and queue for redrawing in the chunk.
<strong>/macro delete [name]</strong>&nbsp;Deletes a previously saved macro
* <code>.debug fog [value]</code><br /> Sets fog density.
</li>
* <code>.debug fov [value]</code><br /> Sets field of view.
<li>
* <code>.debug wgen</code><br /> Print a rainfall and adjusted temperature values.
<strong>/macro discard [name]</strong> Discards the temporary macro
* <code>.debug redrawall</code><br /> Redraw all chunks.
</li>
* <code>.debug ci</code><br /> Display some information on the current chunk the player is in
</ul>
* <code>.debug shake [value]</code><br /> Shake effect. Insert a higher negative value to remove the effect.
</li>
* <code>.debug recalctrav</code><br /> Recalculate traversability of all chunks.
</ul>
* <code>.debug find [blockName]</code><br /> Specify all or part of the name of a block to find its coordinates.
<p>
{{ll|List of server commands/debug}} also exists. Use <code>.help debug</code> for more info on debug commands.
&nbsp;
 
</p>
=== .edi === <!--T:24-->
*<code>.edi</code><br /> Show/Hide Extended information on debug screen, e.g. block lighting.
 
=== .exponepng === <!--T:25-->
*<code>.exponepng [code|hand] [block|item] [size=100] [code]</code><br /> Export one item as png image.
 
=== .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.
 
=== .freemove === <!--T:28-->
*<code>.freemove</code><br /> Toggle Freemove
 
=== .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</code><br /> Hide/Show all GUIs
 
=== .help === <!--T:31-->
*<code>.help</code><br /> Display list of available client commands
 
=== .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>.purgedb</code><br /> Purges map DB.
*<code>.redraw</code><br /> Redraws map.
*<code>.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</code><br /> Set Movespeed
 
=== .music === <!--T:37-->
*<code>.music</code><br /> Shows current music track
 
=== .netbenchmark === <!--T:38-->
*<code>.netbenchmark</code><br /> Toggles network benchmarking
 
=== .noclip === <!--T:39-->
*<code>.noclip</code><br /> Toggle noclip
 
=== .online === <!--T:40-->
*<code>.online</code><br /> Prints list of online players.
*<code>.online ping</code><br /> Prints list of online players with their ping.
 
=== .pastemode === <!--T:41-->
*<code>.pastemode</code><br /> Set the chats paste mode. If set to multi pasting multiple lines will produce multiple chat lines.
 
=== .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-->
*<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</code><br /> Opens the Transform Editor
 
=== .time === <!--T:49-->
*<code>.time</code><br /> Read local game time or speed
 
=== .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}}
 
=== .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}}
Confirmedusers
538

edits