List of client commands

From Vintage Story Wiki
Jump to navigation Jump to search

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 (/).

Here is a list of the most useful ones. See the temporarily attached full list from at the bottom of the page. You can use .help [command] to see its help.

Client Commands

  • .cam [p|rp|start|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 clear: Removea all points
    • .cam start: Starts the cinematic camera, i.e. it will smoothly traverse all points
    • .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 points are traversed by the camera (more rounded or more straight)
  • .clearchat
    Clears your chat history
  • .clientconfig [parameterName] [parameterValue]
    Changes client configuration at runtime, lets you set any parameter value that is available in the clientsettings.json file
    • .clientconfig floatyGuis [1|0]: Enables/disables the experimental feature where chest dialogs float above the chests
    • .clientconfig set showentitydebuginfo [0|1]: Displays arbitrary debug information above entities
      May require corresponding server command /entity debug 1
    • .clientconfig set ssaa [0.5|2]: Controls Sampling Pixel Rate.
      0.5 value enables 0.5x Sampling rate and gives 50% performance gain at the cost of reduced graphics quality for ultra low end hardware.
      2 value enables 2-4x Sampling rate. Very laggy but allows making massive screenshots (e.g. 7680x4320 pixels) and is supposed to be used with .clientconfig set scaleScreenshot 0
    • .clientconfig gammaLevel [level]: Allows to set gamma level in survival mode.
      Value 1 is the default 100%, 1.5 is good amount brighter.
      Use Macros Manager (Ctrl-M) in game to assign these commands to hotkeys.
      Depending on your operating system setup, you might have to use comma instead of dot as the decimal delimiter.

  • .debug wireframe chunk
    Shows chunk borders. /debug also exists.
    Use .help debug for more info on debug commands.
    Also typing just .debug wireframe will give some help info. Same for other commands.
  • .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.
  • .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. 
  • .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 glitches

Not fully documented yet

.blockitempngexport - Export all items and blocks as png images
.cam - Cinematic camera tools
.cdensity - Set large and small cloud density
.cdensitylarge - Set large cloud density
.cdensitysmall - Set small cloud density
.chatsize - Set the chat dialog width and height (default 400x160)
.clearchat - Clear all chat history
.client+ - Client+ configuration command.
.clientconfig - Set/Gets a client setting
.clients - List of connected players
.clight - Set Cloud lightness
.cp - Copy something to your clipboard
.crand - Set large and small cloud noise.
.cviewdist - Sets the cloud view distance. Will be reset when view distance in graphics settings are changed.
.debug - Debug utilities
.edi - Show/Hide Exented information on debug screen, e.g. block lighting.
.fbdeb - Toggle Framebuffer/WOIT Debug mode
.fountain - Toggle Particle fountain
.freemove - Toggle Freemove
.gencraftjson - Copies a snippet of json from your currently held item usable as a crafting recipe ingredient
.gui - Hide/Show all GUIs
.help - Display list of availble client commands
.lockfly - Locks a movement axis during flying/swimming
.logticks - Toggle Tick profiling. Won't log ticks below the thresholf.
.moon - Prints the current moon phase.
.movespeed - Set Movespeed
.music - Shows current music track
.netbenchmark - Toggles network benchmarking
.noclip - Toggle noclip
.online - Prints list of online players.
.pastemode - Set the chats paste mode. If set to multi pasting multiple lines will produce multiple chat lines.
.recomposechat - Recompose chat dialogs
.reconnect - Reconnect to server
.reload - Asseted reloading utility. Incase of shape reload will also Re-tesselate. Incase of textures will regenerate the texture atlasses.
.resolution - Sets the screen size to given width and height
.serverinfo - Display information about server info
.spawndecal - Spawn a decal at position
.tfedit - Opens the Transform Editor
.time - Read local game time or speed
.viewdistance - Set view distance
.vrec - Video Recorder Tools
.we - World edit toolbar
.zfar - Sets the zfar clipping plane. Useful when up the limit of 1km view distance.