Merge branch 'docs-star-system'

This commit is contained in:
Noah Pilarski 2022-06-30 21:08:49 -04:00
commit 2fb9e93399
4 changed files with 37 additions and 6 deletions

View File

@ -1,6 +1,6 @@
---
Title: Detailing
Sort_Priority: 90
Sort_Priority: 85
---
# Details/Scatterer

View File

@ -1,15 +1,46 @@
---
Title: Star System
Description: A guide to creating new star systems
Sort_Priority: 70
Description: A guide to editing a custom star system in New Horizons
Sort_Priority: 90
---
# Intro
Welcome! this page outlines how to create a custom star system.
Welcome! This page outlines how to edit a custom star system.
## Vessel Coordinates
## Getting Started
Star Systems are placed in a folder called systems within your mod folder.
The name of your star system config must be the same as the unique id used in the `starSystem` field of your planet configs. Example: `xen.RealSolarSystem.json`.
A star system config file will look something like this:
```json
{
"$schema": "https://raw.githubusercontent.com/xen-42/outer-wilds-new-horizons/main/NewHorizons/Schemas/star_system_schema.json",
"coords": {
"x": [ 4, 0, 3, 1 ],
"y": [ 0, 5, 4 ],
"z": [ 5, 4, 0, 3, 1 ]
},
"vesselPosition": {
"x": 0,
"y": 0,
"z": 8000
}
}
```
To see all the different things you can put into a config file check out the [Star System Schema]({{ 'Star System Schema'|route}}).
# Vessel Coordinates
You can warp to custom star systems via the Nomai vessel. Each coordinate has to be 2-6 points long.
These are the points for each coordinate node. When making your unique coordinate you should only use each point once.
![nomaiCoordinateIndexes]({{ "images/star_system/nomai_coordinate_indexes.webp"|static }})
![entryLocationExample]({{ "images/star_system/coordinates.webp"|static }})
## Hearthian Solar System Vessel Coordinates
You can use these coordinates to warp back to the hearthian solar system.
![hearthianSolarSystemCoordinates]({{ "images/star_system/hearthian_solar_system_coordinates.webp"|static }})

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 79 KiB

After

Width:  |  Height:  |  Size: 79 KiB