Gittes-archive/new-horizons
2
0
Fork 0
mirror of https://github.com/Outer-Wilds-New-Horizons/new-horizons.git synced 2025-12-11 20:15:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
Minor docs cleanup to address #841
This commit is contained in:
Joshua Thome 2024-04-13 15:48:01 -05:00 committed by GitHub
commit e431ac844c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 25 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/src/content/docs/guides/details.md
View File

@ -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} ```json {5-6}
{ {
"Props": { "Props": {
"Details": [ "details": [
{ {
"assetBundle": "planets/assetbundle/rss", "assetBundle": "planets/assetbundle/rss",
"path": "Assets/RSS/Prefabs/Rover.prefab", "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, "y": -10.83688,
"z": -36.02736 "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 ```json
{ {
"Props": { "Props": {
"Scatter": [ "scatter": [
{ {
"path": "DreamWorld_Body/Sector_DreamWorld/Sector_DreamZone_1/Props_DreamZone_1/OtherComponentsGroup/Trees_Z1/DreamHouseIsland/Tree_DW_M_Var", "path": "DreamWorld_Body/Sector_DreamWorld/Sector_DreamZone_1/Props_DreamZone_1/OtherComponentsGroup/Trees_Z1/DreamHouseIsland/Tree_DW_M_Var",
"count": 12 "count": 12
@ -124,7 +124,7 @@ You can swap these around too. The following would scatter 12 Mars rovers across
```json ```json
{ {
"Props": { "Props": {
"Details": [ "details": [
{ {
"path": "DreamWorld_Body/Sector_DreamWorld/Sector_DreamZone_1/Props_DreamZone_1/OtherComponentsGroup/Trees_Z1/DreamHouseIsland/Tree_DW_M_Var", "path": "DreamWorld_Body/Sector_DreamWorld/Sector_DreamZone_1/Props_DreamZone_1/OtherComponentsGroup/Trees_Z1/DreamHouseIsland/Tree_DW_M_Var",
"position": { "position": {
@ -132,10 +132,10 @@ You can swap these around too. The following would scatter 12 Mars rovers across
"y": -10.83688, "y": -10.83688,
"z": -36.02736 "z": -36.02736
}, },
"alignToNormal": true "alignRadial": true
} }
], ],
"Scatter": [ "scatter": [
{ {
"assetBundle": "planets/assetbundle/rss", "assetBundle": "planets/assetbundle/rss",
"path": "Assets/RSS/Prefabs/Rover.prefab", "path": "Assets/RSS/Prefabs/Rover.prefab",

29
docs/src/content/docs/guides/ship-log.md
View File

@ -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 ### 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} ```json {4}
{ {
"ShipLog": { "initialReveal": ["EXAMPLE_RUMOR_FACT"]
"xmlFile": "planets/example.xml",
"initialReveal": ["EXAMPLE_RUMOR_FACT"]
}
} }
``` ```
### Signal Discovery ### 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 ```json
{ {
"Signal": { "Props": {
"Signals": [ "signals": [
{ {
"Frequency": "Quantum", "frequency": "Quantum",
"Name": "Quantum Planet", "name": "Quantum Planet",
"AudioClip": "OW_QuantumSignal", "audio": "OW_QuantumSignal",
"SourceRadius": 1000, "sourceRadius": 1000,
"Reveals": "EXAMPLE_EXPLORE_FACT" "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
Reveal volumes are triggers/colliders in the world that can unlock facts from a variety of actions. 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 #### Position
@ -503,8 +500,8 @@ trigger the reveal
```json ```json
{ {
"Props": { "Volumes": {
"reveal": [ "revealVolumes": [
{ {
"position": { "position": {
"x": -55.65454, "x": -55.65454,

10
docs/src/content/docs/guides/star-systems.md
View File

@ -23,10 +23,12 @@ A star system config file will look something like this:
"y": [0, 5, 4], "y": [0, 5, 4],
"z": [5, 4, 0, 3, 1] "z": [5, 4, 0, 3, 1]
}, },
"vesselPosition": { "vesselSpawn": {
"x": 0, "position": {
"y": 0, "x": 0,
"z": 8000 "y": 0,
"z": 8000
}
} }
} }
} }