Skip to content

Commit

Permalink
Documentation: extensions: add documentation piece for lightmapped water
Browse files Browse the repository at this point in the history
  • Loading branch information
a1batross committed Aug 26, 2024
1 parent 3ec2e98 commit 12a7b3a
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions Documentation/extensions/litwater.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Lightmapped water

Xash3D FWGS supports lightmapped water, as an extension. It adds three new cvars and new worldspawn key values.

### For level designers:

If you're a level designer and intend to make your level to have lightmapped water, you can put these keyvalues to worldspawn entity description (always first entity in entities list):

| Key | Value | Description |
| ---------------------- | ------- | ----------- |
| `_litwater` | integer | Set to any non-zero value to enable lightmapped water. Overrides `gl_litwater_force` cvar value. |
| `_litwater_minlight` | integer | Minimal lightmap value water surface will receive. Helps to avoid too dark areas when water isn't properly lit. If not set, defaults to zero. |
| `_litwater_scale` | float | Scales up lightmap value for water surfaces. If not set, defaults to 1.0. |

## For players:

Some of the maps already have computed lightmap for water surfaces and sometimes water has been properly lit but the support hasn't been declared by the level designer.

As a player, you can enable it in `Video options` menu or through console with `gl_litwater_force` cvar. There are also `gl_litwater_minlight` and `gl_litwater_scale` cvars that function similar to keys above. The default values has been set to `192` and `1.25` respectively to slightly avoid issues with maps that wasn't intended to have lightmapped water.

0 comments on commit 12a7b3a

Please sign in to comment.