List of client commands: Difference between revisions
Craluminum (talk | contribs) m (Add arguments to fountain command) |
m (Added game navbox.) |
||
(13 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
<languages/> | <languages/> | ||
{{GameVersion|1.15}} | |||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
'''Commands''' offer advanced features and configuration abilities for your game. There are really 2 lists of commands - Client and | '''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. | ||
<!--T:2--> | <!--T:2--> | ||
Line 11: | Line 10: | ||
<!--T:14--> | <!--T:14--> | ||
See also: | See also: {{ll|List_of_server_commands|List of server commands}} | ||
< | </translate> | ||
__FORCETOC__ | __FORCETOC__ | ||
<translate> | |||
== Client Commands == <!--T:4--> | == Client Commands == <!--T:4--> | ||
=== .blockitempngexport === | === .blockitempngexport === | ||
*<code>.blockitempngexport | *<code>.blockitempngexport [inv|all] [imageSize] [domain]</code><br /> Export all items and blocks as png images | ||
=== .cam === <!--T:16--> | === .cam === <!--T:16--> | ||
{{:List of client commands/cam}} | {{:List of client commands/cam{{#translation:}}}} | ||
=== .c[louds] === <!--T:17--> | === .c[louds] === <!--T:17--> | ||
Line 32: | Line 31: | ||
=== .chatsize === <!--T:18--> | === .chatsize === <!--T:18--> | ||
*<code>.chatsize</code><br /> Set the chat dialog width and height (default 400x160) | *<code>.chatsize [width]/default [height]/default</code><br /> Set the chat dialog with custom width and/or height (default 400x160 [Depending on the interface]) | ||
=== .clearchat === <!--T:19--> | === .clearchat === <!--T:19--> | ||
Line 41: | Line 40: | ||
=== .clientconfig === <!--T:6--> | === .clientconfig === <!--T:6--> | ||
{{:List of client commands/clientconfig}} | {{:List of client commands/clientconfig{{#translation:}}}} | ||
=== .clientconfigcreate === <!--T:21--> | === .clientconfigcreate === <!--T:21--> | ||
*<code>.clientconfigcreate [name] [datatype] [value]</code><br /> Adds a new client configuration key that did not exist before. | *<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. | |||
=== .clients === <!--T:22--> | === .clients === <!--T:22--> | ||
*<code>.clients</code><br /> List of connected players | *<code>.clients</code><br /> List of connected players. | ||
*<code>.clients ping</code><br /> List of connected players with their ping. | |||
=== .cp === <!--T:23--> | === .cp === <!--T:23--> | ||
Line 90: | Line 92: | ||
* <code>.debug recalctrav</code><br /> Recalculate traversability of all chunks. | * <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. | * <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--> | === .edi === <!--T:24--> | ||
Line 118: | Line 120: | ||
=== .lockfly === <!--T:32--> | === .lockfly === <!--T:32--> | ||
*<code>.lockfly</code><br /> Locks a movement axis during flying/swimming | *<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--> | === .logticks === <!--T:33--> | ||
*<code>.logticks</code><br /> Toggle Tick profiling. Won't log ticks below the threshold. | *<code>.logticks</code><br /> Toggle Tick profiling. Won't log ticks below the threshold. | ||
=== . | === .map=== <!--T:34--> | ||
*<code>. | *<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--> | === .moon === <!--T:35--> | ||
Line 142: | Line 149: | ||
=== .online === <!--T:40--> | === .online === <!--T:40--> | ||
*<code>.online</code><br /> Prints list of online players. | *<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--> | === .pastemode === <!--T:41--> | ||
Line 183: | Line 191: | ||
=== .we === <!--T:51--> | === .we === <!--T:51--> | ||
*<code>.we</code><br /> World edit toolbar, see more in | *<code>.we</code><br /> World edit toolbar, see more in {{ll|How_to_use_WorldEdit|How to use WorldEdit}} | ||
=== .zfar === <!--T:10--> | === .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. | *<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}} | {{Navbox/modding|Vintage Story}} | ||
Revision as of 17:32, 10 March 2024
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 /
.
See also: List of server commands
Client Commands
.blockitempngexport
.blockitempngexport [inv|all] [imageSize] [domain]
Export all items and blocks as png images
.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 pointnum
to the current location..cam goto [num]
Go to pointnum
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
.chatsize
.chatsize [width]/default [height]/default
Set the chat dialog with custom width and/or height (default 400x160 [Depending on the interface])
.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 chestsshowentitydebuginfo [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. Value1
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
List of connected players..clients ping
List of connected players with their 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 formatX=1,Y=1,Z=1
..cp apos
The absolute player position as a float in the formatX=1.34,Y=1.34,Z=1.34
..cp chat
The chat history.
.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 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.
.edi
.edi
Show/Hide Extended information on debug screen, e.g. block lighting.
.exponepng
.exponepng [code|hand] [block|item] [size=100] [code]
Export one item as png image.
.fbdeb
.fbdeb
Toggle Framebuffer/WOIT Debug mode
.fountain
.fountain [quantity] [quad|cube]
Toggle Particle fountain.
.freemove
.freemove
Toggle Freemove
.gencraftjson
.gencraftjson
Copies a snippet of json from your currently held item usable as a crafting recipe ingredient
.gui
.gui
Hide/Show all GUIs
.help
.help
Display list of available client commands
.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
.purgedb
Purges map DB..redraw
Redraws map..worldmapsize [mapHeight] [mapWidth]
Sets world map size.
.moon
.moon
Prints the current moon phase.
.movespeed
.movespeed
Set Movespeed
.music
.music
Shows current music track
.netbenchmark
.netbenchmark
Toggles network benchmarking
.noclip
.noclip
Toggle noclip
.online
.online
Prints list of online players..online ping
Prints list of online players with their ping.
.pastemode
.pastemode
Set the chats paste mode. If set to multi pasting multiple lines will produce multiple chat lines.
.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
.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
Opens the Transform Editor
.time
.time
Read local game time or speed
.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
.we
World edit toolbar, see more in How to use WorldEdit
.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 • 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 |
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 |