List of client commands: Difference between revisions

From Vintage Story Wiki
m
Added game navbox.
m (Added game navbox.)
 
(50 intermediate revisions by 13 users not shown)
Line 1: Line 1:
<p>
<languages/>
<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 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.</span>
</p>


<p>
{{GameVersion|1.15}}
<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>
<translate>
</p>
<!--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;">Here is a list of the most useful ones. See the temporarily attached full list from 1.5.1.4 at the bottom of the page. You can use '''.help [command]''' to see its help.</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>


<!--T:14-->
See also: {{ll|List_of_server_commands|List of server commands}}


== Client Commands ==
</translate>
__FORCETOC__
<translate>
== Client Commands == <!--T:4-->
=== .blockitempngexport ===
*<code>.blockitempngexport [inv|all] [imageSize] [domain]</code><br /> Export all items and blocks as png images


<ul>
=== .cam === <!--T:16-->
<li>
{{:List of client commands/cam{{#translation:}}}}
<code>.fog [density] [minfog]</code><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>
<code>.cam [p|rp|start|stop|clear|load|save|alpha|tp]</code><br>
The cinematic camera tool system.
<ul>
<li>
<code>.cam p</code>: Adds the current position to the list of places to visit
</li>
<li>
<code>.cam rp</code>: Removes the last added point&nbsp;
</li>
<li>
<code>.cam clear</code>: Removea all points
</li>
<li>
<code>.cam start</code>: Starts the cinematic camera, i.e. it will smoothly traverse all points
</li>
<li>
<code>.cam stop</code>: Stops the cinematic camera
</li>
<li>
<code>.cam save</code>: Exports the current list of points into your Clipboard (which you then can paste into any text editor)
</li>
<li>
<code>.cam load [data]</code>: Import supplied list of points&nbsp;
</li>
<li>
<code>.cam tp [0 or 1]:&nbsp;</code>Toggles whether to teleport you back to your previous position after the camera path has been completed
</li>
<li>
<code>.cam alpha</code> <code>[0..1]</code>: Modifies how the points are traversed by the camera (more rounded or more straight)<br>
&nbsp;
</li>
</ul>
</li>
<li>
<code>.clearchat</code><br>
Clears your chat history<br>
&nbsp;
</li>
<li>
<code>.clientconfig [parameterName] [parameterValue]</code><br>
Changes client configuration at runtime, lets you set any parameter value that is available in the clientsettings.json file<br>
                Examples:<br>
<ul>
<li>
<code>.clientconfig floatyGuis [1|0]</code>: Enables/disables the experimental feature where chest dialogs float above the chests
</li>
<li>
<code>.clientconfig set showentitydebuginfo [0|1]</code>: Displays arbitrary debug information above entities<br>
May require corresponding server command <code>/entity debug 1</code>
</li>
<li>
<code>.clientconfig set ssaa [0.5|2]</code>: Controls Sampling Pixel Rate.<br>
<code>0.5</code> value enables 0.5x Sampling rate and gives 50% performance gain at the cost of reduced graphics quality for ultra low end hardware.<br>
<code>2</code> value enables 2-4x Sampling rate. Very laggy but allows making massive screenshots (e.g. 7680x4320 pixels) and is supposed to be used with <code>.clientconfig set scaleScreenshot 0</code><br>
</li>
<li>
<code>.clientconfig gammaLevel [level]</code>: Allows to set gamma level in survival mode.<br>
Value <code>1</code> is the default 100%, <code>1.5</code> is good amount brighter.<br>
Use Macros Manager (Ctrl-M) in game to assign these commands to hotkeys.<br>
Depending on your operating system setup, you might have to use comma instead of dot as the decimal delimiter.
</li>
</ul><br>
</li>
<li>
<code>.debug wireframe chunk</code><br>
Shows chunk borders. /debug also exists.<br>
                Use <code>.help debug</code> for more info on debug commands.<br>
                Also typing just <code>.debug wireframe</code> will give some help info. Same for other commands.<br>
&nbsp;
</li>
<li>
<code>.reloadmodels</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<br>
&nbsp;
</li>
<li>
<code>.viewdistance</code><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>
<code>.zfar [value]</code><br>
Sets 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<br>
&nbsp;
</li>
</ul>


== Server Commands ==
=== .c[louds] === <!--T:17-->
*<code>.cdensity</code><br /> Set large and small cloud density
*<code>.cdensitylarge</code><br /> Set large cloud density
*<code>.cdensitysmall</code><br /> Set small cloud density
*<code>.clight</code><br /> Set Cloud lightness
*<code>.crand</code><br /> Set large and small cloud noise
*<code>.cviewdist</code><br /> Sets the cloud view distance. Will be reset when view distance in graphics settings are changed


See [[List of multiplayer 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])


== Full client command list from 1.5.1.4 ==
=== .clearchat === <!--T:19-->
*<code>.clearchat</code><br /> Clears your chat history


.blockitempngexport - Export all items and blocks as png images<br>
=== .client+ === <!--T:20-->
.cam - Cinematic camera tools<br>
*<code>.client+</code><br /> Client+ configuration command
.cdensity - Set large and small cloud density<br>
 
.cdensitylarge - Set large cloud density<br>
=== .clientconfig === <!--T:6-->
.cdensitysmall - Set small cloud density<br>
{{:List of client commands/clientconfig{{#translation:}}}}
.chatsize - Set the chat dialog width and height (default 400x160)<br>
 
.clearchat - Clear all chat history<br>
=== .clientconfigcreate === <!--T:21-->
.client+ - Client+ configuration command.<br>
*<code>.clientconfigcreate [name] [datatype] [value]</code><br /> Adds a new client configuration key that did not exist before.
.clientconfig - Set/Gets a client setting<br>
<br />
.clients - List of connected players<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.
.clight - Set Cloud lightness<br>
 
.cp - Copy something to your clipboard<br>
=== .clients === <!--T:22-->
.crand - Set large and small cloud noise.<br>
*<code>.clients</code><br /> List of connected players.
.cviewdist - Sets the cloud view distance. Will be reset when view distance in graphics settings are changed.<br>
*<code>.clients ping</code><br /> List of connected players with their ping.
.debug - Debug utilities<br>
 
.edi - Show/Hide Exented information on debug screen, e.g. block lighting.<br>
=== .cp === <!--T:23-->
.fbdeb - Toggle Framebuffer/WOIT Debug mode<br>
*<code>.cp [posi|aposi|apos|chat]</code><br /> Copy something to your clipboard
.fountain - Toggle Particle fountain<br>
** <code>.cp posi</code><br /> The position below the player as an integer.
.freemove - Toggle Freemove<br>
** <code>.cp aposi</code><br /> The absolute player position as an integer in the format <code>X=1,Y=1,Z=1</code>.
.gencraftjson - Copies a snippet of json from your currently held item usable as a crafting recipe ingredient<br>
** <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>.
.gui - Hide/Show all GUIs<br>
** <code>.cp chat</code><br /> The chat history.
.help - Display list of availble client commands<br>
 
.lockfly - Locks a movement axis during flying/swimming<br>
=== .debug === <!--T:7-->
.logticks - Toggle Tick profiling. Won't log ticks below the thresholf.<br>
* <code>.debug normalview</code><br /> Shows vertex normals instead textures, but does not discard transparent pixels.
.moon - Prints the current moon phase.<br>
* <code>.debug wireframe [value]</code><br /> Running <code>.debug wireframe</code> will give some help info.
.movespeed - Set Movespeed<br>
** <code>entity</code><br /> Shows entity collision boxes.
.music - Shows current music track<br>
** <code>chunk</code><br /> Shows chunk borders.
.netbenchmark - Toggles network benchmarking<br>
** <code>serverchunk</code><br /> Shows server chunk borders.
.noclip - Toggle noclip<br>
** <code>region</code><br /> Shows region borders.
.online - Prints list of online players.<br>
** <code>blockentity</code><br /> Shows block entity borders e.g. of large gear.
.pastemode - Set the chats paste mode. If set to multi pasting multiple lines will produce multiple chat lines.<br>
** <code>ambsounds</code><br /> Shows ambient sound borders e.g. of flowing water.
.recomposechat - Recompose chat dialogs<br>
* <code>.debug talk [value]</code><br /> Plays actions with the character's voice. Running <code>.debug talk</code> will give a list of values.
.reconnect - Reconnect to server<br>
* <code>.debug [perceptioneffect|pc] [value]</code><br /> Applies effect.
.reload - Asseted reloading utility. Incase of shape reload will also Re-tesselate. Incase of textures will regenerate the texture atlasses.<br>
** <code>drunk</code><br /> Makes player drunk.
.resolution - Sets the screen size to given width and height<br>
** <code>damagedfreezing</code><br /> Applies a freezing effect to player.
.serverinfo - Display information about server info<br>
* <code>.debug tofb [true|false]</code><br /> Toggle offscreen buffer.
.spawndecal - Spawn a decal at position<br>
* <code>.debug cmr</code><br /> Print a full list of color map rectangles to the client-main.txt.
.tfedit - Opens the Transform Editor<br>
* <code>.debug us</code><br /> Toggle unbind samplers mode.
.time - Read local game time or speed<br>
* <code>.debug gl [true|false]</code><br /> Toggle OpenGL debug mode.
.viewdistance - Set view distance<br>
* <code>.debug uiclick</code><br /> Toggle UI Debug print interactions.
.vrec - Video Recorder Tools<br>
* <code>.debug discovery [value]</code><br /> Show a text on the screen as for lore books.
.we - World edit toolbar<br>
* <code>.debug soundsummary</code><br /> Print a count of loaded sounds.
.zfar - Sets the zfar clipping plane. Useful when up the limit of 1km view distance.<br>
* <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.
 
=== .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