Water Mod Commands

Introduction
Commands are primarily used to adjust the settings with the Water Mod. To input commands, open the chat menu (Enter Key); you should see a text box open like in the image below (Figure 1). There is also an UI you can use for client settings, information on that is in the Client Settings section.

The basic structure of commands is similar to other video games like Minecraft, where commands are prefixed by a forward slash with spaces for delimiters. One thing I should point out is the brackets in the command examples; these are not required, but they are filtered out regardless.

Figure 1: Command Box

This is where all text commands are run, the first command you're likely to ever run would be /wcreate. The command creates water at the planet closest to the camera, if the camera is not in the gravity of the planet, it will not work. Further adjustments for the water surface will be in the Server Settings Section(Radius, Wave Height, etc... ).


Client Settings
These commands will run only client side and will not affect anything related to the server. These are here for performance, debugging, and generally setting up the Water Mod for the best user experience.

There is a UI available for client-settings! Press F2 while you have the chat menu open.


/wquality [0.4-1.5]
This command determines how detailed the Water Mod will look, and will overall determine how good performance you will get. It affects the Level of Detail in the water surface and a higher number will make the detail increased at a cost of performance.

/wcob
This command is used by builders to help determine whether their build is balanced or not. It renders a red dot at the center of buoyancy of the ship, like center of mass. Basically, if the center of buoyancy is above the center of mass, the ship is passively balanced and will not tip over. Additionally, having the center of buoyancy closer to the center of mass will improve the stability of the ship overall.

/wdepth
This command is to be used in conjunction with Text Hud API. Default enabled, it renders text on the screen that represents how deep the camera is below the surface of water. It will not render if the camera is above water.

/waltitude
Like /wdepth, this command requires Text Hud API to function. It operates differently in that it renders the altitude you are above the surface of water. It's a great feature to use if you struggle to tell the distance from the surface.

/wversion
This command repeats the welcome message of the Water Mod, telling the version.

/wvolume [0.0-1.0]
This command is pretty self-explanatory, it changes the volume of water related sounds like splashing and ambience.

/wdebug
This command's rarely ever used; it just enables debug mode for when I need to use it.

/wsettings
This command prints all the settings a planet currently has in a somewhat readable format. I'm not sure why people needed it, but it's here.

/wfog
This command only works in creative and for admins, it's specifically for building scenarios underwater. The command toggles fog and as such, it's really useful for the previously mentioned reason.

/wexport
This command is used by planet modders to export all the settings. If you want more information on this, join the Discord Server[discord.gg] and see the pins in #water-api[discord.com].

/wdiscord
Opens the Water Mod discord link in the steam overlay.
https://discord.gg/GrPK8cB



Server Settings
These commands will affect the entire server and may require administrator permissions to run. Physics and visuals will be affected by these commands. To get the value of the setting, leave the parameter empty and it will return it.

/wcreate
The first command you'll likely ever run, this command creates water at the closest planet relative to the camera. If the camera is not in a field of gravity, it won't be able to detect the planet and will fail.

/wradius [0.1-2.0]
This command is used to set the radius/depth of the water. While you may be inclined to increment by a huge value, it's not a good idea. The radius is a ratio to the minimum altitude of voxel on the planet, meaning that 1.0 is the smallest value before you have to dig to reach it. I highly suggest incrementing by very small values (hundredth places)

/wrradius
Gets the approximate radius that is relative to the camera, helps you not have to guess radius.

/wwaveheight [Height]
This command is used in conjunction with the latter wave commands; this one in particular sets the height of the waves using meters as a unit. Keep in mind that waves go both negative and positive, meaning that setting the wave height to 2 meters will cause the waves to go both up 2 and down 2 meters.

/wwavespeed [0.0-1.0]
This command is used in conjunction with the other wave commands; this one sets how fast the waves move in no particular unit. The smaller the value, the faster the waves.

/wwavescale [Height]
This command is used in conjunction with the prior wave commands; this one sets the frequency of the waves. The larger the value, the smaller the waves.

/wremove
This command removes any water at the planet closest to the camera.

/wreset
This command resets most values to default in-case a user messed up customizing the settings, it changes everything but radius.

/wbuoyancy [0.0-10.0]
This command is a multiplier for the closest water. Setting the value to zero disables buoyancy completely.

/wbird
This command toggles whether or not seagulls exist at the planet. Seagulls only exist for immersion.

/wfish
This command toggles whether or not fish exist at the planet. Fish only exist for immersion.

/wtexture [Texture]
This command sets the surface texture of the water using a TransparentMaterial's Subtype ID. The default water textures are JWater, JWaterFull, JWaterDark, JWaterLight, JCheese, JLava, and JDebug. If you want information on how to create custom textures, join the Discord Server[discord.gg] and see the pins in #water-api[discord.com].

/wtextures
Lists all available textures.

/wcrush [Damage]
This command sets the amount of damage that is done to grids or players when they are below their crush depth. Crush depth is determined dynamically by the hydrostatic pressure around the block and the maximum pressure the block can take.

/wpdrag
This command toggles player drag. It's mostly obsolete.

/wtransparent
This command is used to toggle whether the surface of water is rendered as transparent. It can improve performance at the cost of graphical fidelity.

/wlit
This command is used to toggle whether the surface of water is lit. Disabling lighting on the surface can make it appear emissive like lava.

/wrate [Multiplier]
This command sets the multiplier rate at which ice is collected underwater. Collectors can collect ice underwater.

/wcolor [Red] [Green] [Blue]
This command sets the color of the underwater fog. The values inputted should be between the ranges 0 and 1. To convert a value that is out of 255, just divide it by 255.

/wtideheight [Height]
This command is used to set the height of tide. Google what tide is if you don't know.

/wtidespeed [Speed]
This command is used to set how frequently tide changes. There isn't really an unit.

/wfoam
This command toggles whether sea foam is rendered. It can improve performance but at the cost of lesser visuals.

/wmaterials
Lists all available physics material types (Lava, Water, etc..)

/wmaterial [Material]
Sets the physics material of the closest water.

/wcurrentspeed
The speed of the water current in m/s.

/wcurrentscale
The size of the current noise generator, smaller numbers makes it less frequent. You can preview the currents with /wdebug.


Complete Command List
Use player chat box to input commands, default key is 'Enter.'
- /wquality [0.4-1.5] The render quality of water
- /wcreate Creates water at your closest planet
- /wradius [0.1-2.0] Radius of the water at your closest planet, increment in small values (<1 is below surface)
- /wwaveheight [∞] The wave height of water at your closest planet in meters
- /wwavespeed [0.0-1.0] The wave speed of water at your closest planet
- /wremove Removes water from your closest planet
- /wcob Toggles rendering of center of buoyancy
- /wdepth Toggles rendering of depth.
- /wversion Tells the version number of the mod
- /wreset Resets all settings of water at your closest planet
- /wbuoyancy [0.0-10.0] Sets the buoyancy multiplier at your closest planet
- /wexport Exports data for planet modders.
- /wbird Toggles birds at your closest planet
- /wfish Toggles fish at your closest planet
- /wfog Toggles rendering fog for building underwater scenarios
- /wvolume [0.0-1.0] Sets the volume of all sounds in the water mod
- /wdebug Toggles debug mode
- /wtexture [Material] Sets the material of the water (TransparentMaterial SubtypeId)
- /wwavescale [Scale] Sets the horizontal frequency of waves
- /wcrush [Depth] Sets the amount of damage that occurs when pressure is too great
- /wpdrag Toggles player drag
- /wtransparent Toggles water transparency
- /wlit Toggles lighting on the surface
- /wrate [Multiplier] The rate at which ice is collected underwater
- /wcolor [r] [g] The color of the underwater fog
- /wtideheight [Height] The height of tide
- /wtidespeed [Speed] How frequently the tide changes
- /wsettings Prints the settings of the nearest water in a readable format
- /wfoam Toggles sea foam
- /waltitude Toggles whether altitude is shown on the hud when in a cockpit
- /whelp Opens steam help guide