List of client commands: Difference between revisions

From Vintage Story Wiki
fix formatting
(fix formatting)
Line 1: Line 1:
<p>
'''Commands''' offer advanced features and configuration abilities for your game. There are really 2 lists of commands - Client and [[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.
<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>
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 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>
</p>


<p>
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 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>
</p>


== Client Commands ==
=== Cinematic camera ===
* <code>.cam [p|rp|start|stop|clear|load|save|alpha|tp]</code><br /> The cinematic camera tool system.
** <code>.cam p</code><br /> Adds the current position to the list of places to visit.
** <code>.cam rp</code><br /> Removes the last added point.
** <code>.cam clear</code><br /> Removes all points.
** <code>.cam start</code><br /> Starts the cinematic camera, i.e. it will smoothly traverse all points.
** <code>.cam stop</code><br /> Stops the cinematic camera.
** <code>.cam save</code><br /> Exports the current list of points into your clipboard, which you then can paste into any text editor.
** <code>.cam load [data]</code><br /> Import supplied list of points.
** <code>.cam tp [0 or 1]</code><br /> Toggles whether to teleport you back to your previous position after the camera path has been completed.
** <code>.cam alpha [0..1]</code><br /> Modifies how the smoothly the points are traversed by the camera.
=== Clear chat ===
* <code>.clearchat</code><br /> Clears your chat history.
=== Client config ===
{{:List of client commands/clientconfig}}
=== Debug ===
* <code>.debug wireframe chunk</code><br /> Shows chunk borders. [List of server commands/debug] also exists. Use <code>.help debug</code> for more info on debug commands. Running <code>.debug wireframe</code> will give some help info.


== Client Commands ==
=== Reload ===
* <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.
 
=== View distance ===
* <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.


<ul>
=== Z clipping plane ===
<li>
* <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.
<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>.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<br>
&nbsp;
</li>
<li>
<code>.reload textures</code><br>
Reloads all textures from assets/textures. Can be used to quickly test texture changes.<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>


== Not fully documented yet ==
== Not fully documented yet ==
Confirmedusers, Bureaucrats, editor, Administrators
1,522

edits