diff --git a/docs/content/pages/tutorials/details.md b/docs/content/pages/tutorials/details.md index d4517922..93390d5c 100644 --- a/docs/content/pages/tutorials/details.md +++ b/docs/content/pages/tutorials/details.md @@ -1,6 +1,6 @@ --- Title: Detailing -Sort_Priority: 90 +Sort_Priority: 85 --- # Details/Scatterer diff --git a/docs/content/pages/tutorials/star_system.md b/docs/content/pages/tutorials/star_system.md new file mode 100644 index 00000000..734a9b61 --- /dev/null +++ b/docs/content/pages/tutorials/star_system.md @@ -0,0 +1,46 @@ +--- +Title: Star System +Description: A guide to editing a custom star system in New Horizons +Sort_Priority: 90 +--- + +# Intro + +Welcome! This page outlines how to edit a custom star system. + +## 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 }}) + +### 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 }}) \ No newline at end of file diff --git a/docs/content/static/images/star_system/hearthian_solar_system_coordinates.webp b/docs/content/static/images/star_system/hearthian_solar_system_coordinates.webp new file mode 100644 index 00000000..17730df0 Binary files /dev/null and b/docs/content/static/images/star_system/hearthian_solar_system_coordinates.webp differ diff --git a/docs/content/static/images/star_system/nomai_coordinate_indexes.webp b/docs/content/static/images/star_system/nomai_coordinate_indexes.webp new file mode 100644 index 00000000..5bc128dd Binary files /dev/null and b/docs/content/static/images/star_system/nomai_coordinate_indexes.webp differ