From 9e374e2a6cc7446d63a91d3708ada71aa66b0e6b Mon Sep 17 00:00:00 2001 From: Nick Date: Fri, 17 Dec 2021 23:17:10 -0500 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 80f10295..210221da 100644 --- a/README.md +++ b/README.md @@ -4,12 +4,40 @@ A planet creator for Outer Wilds. Planets are created using a JSON file format structure, and placed in the `planets` folder. -## Credits : +## 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. + +## How to use New Horizons in other mods: + +First create the following interface in your mod: + +``` +public interface INewHorizons +{ + void Create(Dictionary config); + + 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("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 : +Marshmallow was made with help from: - TAImatem - AmazingAlek - Raicuparta