Fix typos and update references to deprecated fields in docs (#842)

Minor docs cleanup to address #841
Outer-Wilds-New-Horizons · Apr 13, 2024 · e431ac8 · e431ac8
2 parents fe7be24 + 3d630b2
commit e431ac8
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 26 deletions.
diff --git a/docs/src/content/docs/guides/details.md b/docs/src/content/docs/guides/details.md
@@ -88,7 +88,7 @@ To add a Mars rover to the red planet in [RSS](https://github.com/xen-42/outer-w
 ```json {5-6}
 {
     "Props": {
-        "Details": [
+        "details": [
             {
                 "assetBundle": "planets/assetbundle/rss",
                 "path": "Assets/RSS/Prefabs/Rover.prefab",
@@ -97,7 +97,7 @@ To add a Mars rover to the red planet in [RSS](https://github.com/xen-42/outer-w
                     "y": -10.83688,
                     "z": -36.02736
                 },
-                "alignToNormal": true
+                "alignRadial": true
             }
         ]
     }
@@ -109,7 +109,7 @@ To scatter 12 trees from the Dream World around Wetrock in [NH Examples](https:/
 ```json
 {
     "Props": {
-        "Scatter": [
+        "scatter": [
             {
                 "path": "DreamWorld_Body/Sector_DreamWorld/Sector_DreamZone_1/Props_DreamZone_1/OtherComponentsGroup/Trees_Z1/DreamHouseIsland/Tree_DW_M_Var",
                 "count": 12
@@ -124,18 +124,18 @@ You can swap these around too. The following would scatter 12 Mars rovers across
 ```json
 {
     "Props": {
-        "Details": [
+        "details": [
             {
                 "path": "DreamWorld_Body/Sector_DreamWorld/Sector_DreamZone_1/Props_DreamZone_1/OtherComponentsGroup/Trees_Z1/DreamHouseIsland/Tree_DW_M_Var",
                 "position": {
                     "x": 146.5099,
                     "y": -10.83688,
                     "z": -36.02736
                 },
-                "alignToNormal": true
+                "alignRadial": true
             }
         ],
-        "Scatter": [
+        "scatter": [
             {
                 "assetBundle": "planets/assetbundle/rss",
                 "path": "Assets/RSS/Prefabs/Rover.prefab",

diff --git a/docs/src/content/docs/guides/ship-log.md b/docs/src/content/docs/guides/ship-log.md
@@ -404,31 +404,28 @@ Of course, having a custom ship log is neat and all, but what use is it if the p
 
 ### Initial Reveal
 
-You can set facts to reveal as soon as the player enters the system by adding the `initialReveal` property
+You can set facts to reveal as soon as the player enters the system by adding the `initialReveal` property to your **star system config**
 
 ```json {4}
 {
-    "ShipLog": {
-        "xmlFile": "planets/example.xml",
-        "initialReveal": ["EXAMPLE_RUMOR_FACT"]
-    }
+    "initialReveal": ["EXAMPLE_RUMOR_FACT"]
 }
 ```
 
 ### Signal Discovery
 
-You can set a fact to reveal as soon as a signal is identified by editing the signal's `Reveals` attribute
+You can set a fact to reveal as soon as a signal is identified by editing the signal's `reveals` attribute
 
 ```json
 {
-    "Signal": {
-        "Signals": [
+    "Props": {
+        "signals": [
             {
-                "Frequency": "Quantum",
-                "Name": "Quantum Planet",
-                "AudioClip": "OW_QuantumSignal",
-                "SourceRadius": 1000,
-                "Reveals": "EXAMPLE_EXPLORE_FACT"
+                "frequency": "Quantum",
+                "name": "Quantum Planet",
+                "audio": "OW_QuantumSignal",
+                "sourceRadius": 1000,
+                "reveals": "EXAMPLE_EXPLORE_FACT"
             }
         ]
     }
@@ -459,7 +456,7 @@ You can set a fact to reveal in dialogue with the `<RevealFacts>` tag
 ### Reveal Volumes
 
 Reveal volumes are triggers/colliders in the world that can unlock facts from a variety of actions.  
-Reveal volumes are specified in the `Props` module, its key is `reveal`.
+Reveal volumes are specified in the `Volumes` module, its key is `revealVolumes`.
 
 #### Position
 
@@ -503,8 +500,8 @@ trigger the reveal
 
 ```json
 {
-    "Props": {
-        "reveal": [
+    "Volumes": {
+        "revealVolumes": [
             {
                 "position": {
                     "x": -55.65454,

diff --git a/docs/src/content/docs/guides/star-systems.md b/docs/src/content/docs/guides/star-systems.md
@@ -23,10 +23,12 @@ A star system config file will look something like this:
             "y": [0, 5, 4],
             "z": [5, 4, 0, 3, 1]
         },
-        "vesselPosition": {
-            "x": 0,
-            "y": 0,
-            "z": 8000
+        "vesselSpawn": {
+            "position": {
+                "x": 0,
+                "y": 0,
+                "z": 8000
+            }
         }
     }
 }