mirror of
https://github.com/Outer-Wilds-New-Horizons/new-horizons.git
synced 2025-12-11 20:15:44 +01:00
59 lines
2.1 KiB
Markdown
59 lines
2.1 KiB
Markdown
|
|
|
|
A planet creator for Outer Wilds.
|
|
|
|
Planets are created using a JSON file format structure, and placed in the `planets` folder.
|
|
|
|
## Roadmap
|
|
- Procedurally terrain generation (started)
|
|
- Asteroid belts (started, needs more customization)
|
|
- "Quantum" orbits
|
|
- Better terrain and water LOD
|
|
- Support satellites (using custom models in the assets folder or in-game ones)
|
|
- Surface scatter (rocks, trees, etc, using custom models or in-game ones)
|
|
- Stars
|
|
- Binary orbits
|
|
- Load planet meshes from asset bundle
|
|
- Comets
|
|
- Edit existing planet orbits
|
|
- Black hole / white hole pairs
|
|
|
|
## How to create your own planets using configs:
|
|
|
|
Coming soon
|
|
|
|
There is a template [here](https://github.com/xen-42/ow-new-horizons-config-template) if you want to release your own planet mod using configs. You can learn how the configs work by picking apart the [Real Solar System](https://github.com/xen-42/outer-wilds-real-solar-system) mod or the [New Horizons Examples](https://github.com/xen-42/ow-new-horizons-examples) mod.
|
|
|
|
## How to use New Horizons in other mods:
|
|
|
|
First create the following interface in your mod:
|
|
|
|
```
|
|
public interface INewHorizons
|
|
{
|
|
void Create(Dictionary<string, object> config, IModBehaviour mod);
|
|
|
|
void LoadConfigs(IModBehaviour mod);
|
|
|
|
GameObject GetPlanet(string name);
|
|
}
|
|
```
|
|
|
|
In your main `ModBehaviour` class you can get the NewHorizons API like so:
|
|
```
|
|
INewHorizons NewHorizonsAPI = ModHelper.Interaction.GetModApi<INewHorizons>("xen.NewHorizons")
|
|
```
|
|
|
|
You can then use the API's `LoadConfigs()` method to load from a "planets" folder, or use the `Create()` and `GetPlanet` methods to create planets and do whatever with them. Just make sure you create planets in the `Start()` method or at least before the SolarSystem scene loads, or they will not be created.
|
|
|
|
## Credits:
|
|
Authors:
|
|
- xen (from New Horizons v0.1.0 onwards)
|
|
- Mister_Nebula (created original titled Marshmallow)
|
|
|
|
Marshmallow was made with help from:
|
|
- TAImatem
|
|
- AmazingAlek
|
|
- Raicuparta
|
|
- and the Outer Wilds discord server.
|