add offset note

Kopernicus · May 20, 2024 · 419bc3f · 419bc3f
1 parent 6367eb9
commit 419bc3f
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/content/Ocean.md b/content/Ocean.md
@@ -3,7 +3,7 @@ layout: default
 title: Ocean
 ---
 
-The `Ocean { }` subnode contains all of the information needed to produce an ocean for the specified body. Note that the ocean is one of the two Procedural Quad Spheres on the body it is applied to. This means that some PQS Settings can be applied to Oceans.
+The `Ocean { }` subnode contains all of the information needed to produce an ocean for the specified body. Note that the ocean is one of the two Procedural Quad Spheres on the body it is applied to. This means that some PQS Settings can be applied to Oceans. If you want to set a certain ocean height, see [the note  regarding Height Map offsets]({{ site.baseurl }}{% link content/PQSMods/VertexHeightMap.md %}).
 
 **Subnodes**
 * Material { }
@@ -22,7 +22,7 @@ Body
         density = 1.25
         minLevel = 1
         maxLevel = 6
-        minDetailDistance = 8
+        minDetailDistance = 6
         maxQuadLengthsPerFrame = 0.03
         Material
         {

diff --git a/content/PQSMods/VertexHeightMap.md b/content/PQSMods/VertexHeightMap.md
@@ -5,6 +5,12 @@ title: VertexHeightMap
 
 The `VertexHeightMap` PQSMod is a mod that *adds* a given height map to the terrain. This means that height mods are additive, i.e. heightmaps don't set a fixed height.
 
+**Notes on Heightmaps**
+A common desire for planets with oceans is to set the ocean to a certain height relative to the terrain to make spots like shorelines be in the correct places. This is simple to do in 2 main steps:
+
+1. Make sure your heghtmap is normalized (darkest value is 0 and highest is 255).
+2. Set `offset` in VertexHeightMap to `-1 * (deformity * travel)`, where `travel` is the percentage of the deformity up from the lowest point of the height map that you want the sea surface to be at. For example, a `travel` of 0.5 would mean the ocean surface is at 50% grey on the height map. 
+
 **Example**
 ```
 PQS
@@ -36,6 +42,6 @@ PQS
 |Property|Format|Description|
 |--------|------|-----------|
 |map|File Path|The texture containing the height map in greyscale. Black is the `offset` height, and White is the `deformity + offset` height.|
-|offset|Decimal|The offset of the height map from the body's radius.|
+|offset|Decimal|The offset of the height map.|
 |deformity|Decimal|The deformity of the height map (difference between lowest and highest point).|
-|scaleDeformityByRadius|Boolean|Whether to multiply the deformity by the planet's radius (in case the deformity is in radii or something).|
+|scaleDeformityByRadius|Boolean|Unknown|