Merge branch 'main' into dev

NewHorizons/External/Configs/TitleScreenConfig.cs

@@ -6,15 +6,24 @@ using Newtonsoft.Json;
 
 namespace NewHorizons.External.Configs
 {
+    /// <summary>
+    /// Allows you to configure the title screen with custom music, skyboxes, and loading props from asset bundles.
+    /// You can define a list of title screen configurations, with different persistent condition/ship log facts required to display them.
+    /// </summary>
     [JsonObject]
     public class TitleScreenConfig
     {
         /// <summary>
-        /// Create title screens
+        /// Create title screens.
+        /// The last title screen in the list with its display conditions (persistent condition and/or ship log) met will be displayed if this mod
+        /// is chosen to be shown on the main menu.
         /// </summary>
         public TitleScreenInfo[] titleScreens = new TitleScreenInfo[0];
     }
 
+    /// <summary>
+    /// A single title screen configuration
+    /// </summary>
     [JsonObject]
     public class TitleScreenInfo
     {

NewHorizons/Schemas/title_screen_schema.json

@@ -2,11 +2,12 @@
   "$schema": "http://json-schema.org/draft-04/schema#",
   "title": "Title Screen Schema",
   "type": "object",
+  "description": "Allows you to configure the title screen with custom music, skyboxes, and loading props from asset bundles.\nYou can define a list of title screen configurations, with different persistent condition/ship log facts required to display them.",
   "additionalProperties": false,
   "properties": {
     "titleScreens": {
       "type": "array",
-      "description": "Create title screens",
+      "description": "Create title screens.\nThe last title screen in the list with its display conditions (persistent condition and/or ship log) met will be displayed if this mod\nis chosen to be shown on the main menu.",
       "items": {
         "$ref": "#/definitions/TitleScreenInfo"
       }
@@ -19,6 +20,7 @@
   "definitions": {
     "TitleScreenInfo": {
       "type": "object",
+      "description": "A single title screen configuration",
       "additionalProperties": false,
       "properties": {
         "menuTextTint": {

NewHorizons/manifest.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://raw.githubusercontent.com/amazingalek/owml/master/schemas/manifest_schema.json",
   "filename": "NewHorizons.dll",
-  "author": "xen, Bwc9876, JohnCorby, MegaPiggy, Trifid, and friends",
+  "author": "xen, Bwc9876, JohnCorby, MegaPiggy, and friends",
   "name": "New Horizons",
   "uniqueName": "xen.NewHorizons",
   "version": "1.27.0",

README.md

@@ -8,7 +8,7 @@
 ![Latest release date](https://img.shields.io/github/release-date/xen-42/outer-wilds-new-horizons)
 [![Build](https://github.com/xen-42/outer-wilds-new-horizons/actions/workflows/build.yaml/badge.svg)](https://github.com/xen-42/outer-wilds-new-horizons/actions/workflows/build.yaml)
 
-_Do you want to create planets using New Horizons?_ Then check out our [website](https://nh.outerwildsmods.com/) for all our documentation!
+_Do you want to create your own story mod using New Horizons?_ Then check out our [website](https://nh.outerwildsmods.com/) for all our documentation!
 
 If you want to see examples of what NH can do check out the [examples add-on](https://github.com/xen-42/ow-new-horizons-examples) or [real solar system add-on](https://github.com/xen-42/outer-wilds-real-solar-system).
 
@@ -26,7 +26,7 @@ Check the ship's log for how to use your warp drive to travel between star syste
 
 ## Incompatible mods
 
-New Horizons conflicts with the mod Common Resources. This mod is a requirement for other mods such as Cheats Mod (we recommend you use the [Cheat and Debug Menu](https://outerwildsmods.com/mods/cheatanddebugmenu/) mod instead) and OW Randomizer.
+New Horizons conflicts with the mod Common Resources. This mod is a requirement for other mods such as OW Randomizer (not to be confused with Archipelago Randomizer) and Difficulty Mod.
 
 Why do these two mods conflict? Common Resources is a mod which reimplements many of the game's features underneath the hood, for one reason or another. For instance, it completely overhauls how the orbits of planets work, as this is a requirement for it to support OW Randomizer. It does this even when you are only using Cheats Mod. In particular, having CR installed seems to, for whatever reason, break character dialogue introduced by New Horizons. As CR is no longer actively maintained, it is unlikely this issue will be resolved any time soon. 
 
@@ -40,25 +40,27 @@ New Horizons has optional support for a few other mods:
 
 ## Features
 
--   Load planet meshes or details from asset bundles
+NH allows you to create planets:
--   Use our [template Unity project](https://github.com/ow-mods/outer-wilds-unity-template) to create assets for use in NH, including all game scripts recovered using UtinyRipper
+- Load planet meshes or details from asset bundles made in Unity
--   Separate solar system scenes accessible via wormhole OR via the ship's new warp drive feature found in the ship's log
+- Create custom planets from heightmaps/texturemaps with support for triplanar mapping
--   Remove or edit existing planets, including their orbits
+- Add stock planet features: dialogue, Nomai text, geysers, cloaking fields, meteor-launching volcanoes, rafts, tornados, Dark Bramble seeds/nodes, black/white holes, funnels, lava/oceans/sand, signalscope signals/frequencies and others.
--   Create custom planets from heightmaps/texturemaps with support for triplanar mapping
+- Edit existing planets: Remove them, alter their orbits, add/delete objects from them.
--   Create stars (and supernovae), comets, asteroid belts, satellites, quantum planets/moons, and custom Dark Bramble dimensions.
+- All these features work in both the main solar system and the Eye of the Universe scene
--   Add stock planet features to custom ones, such as geysers, cloaking fields, meteor-launching volcanoes, rafts, tornados, and Dark Bramble seeds/nodes.
+
--   Binary orbits
+Even if the majority of your story mod is going to be done in Unity, NH still offers useful features which will improve mod-compatibility and stop you reinventing the wheel:
--   Signalscope signals and custom frequencies
+- NH allows you to separate your story mod into its own solar system scene accessible via wormhole OR via the ship's new warp drive feature found in the ship's log.
--   Surface scatter: rocks, trees, etc, using in-game models, or custom ones
+- NH allows you to create custom ship log entries.
--   Black hole / white hole pairs
+- NH allows you to create Inhabitant slide reels with asynchronous loading optimization.
--   Custom dialogue, slide-reel projections, translatable text, and custom ship log entries for rumour mode and map mode
+- NH has a localization system to translate ship logs, dialogue, Nomai text, and custom UI elements.
--   Funnels and variable surface height (can be made of sand/water/lava/star)
+- NH allows you to add new characters to the cosmic-jam-session at the Eye of the Universe while ensuring mod compatibility
+
+Use our [template Unity project](https://github.com/ow-mods/outer-wilds-unity-template) to create assets for use in NH, including all game scripts recovered using UtinyRipper
 
 ## Development
 
-If you want to help (please dear god help us) then check out the [contact](#contact) info below or the [contributing](https://github.com/xen-42/outer-wilds-new-horizons/blob/master/CONTRIBUTING.md) page.
+If you want to help (please dear god help us) then check out the [contact](#contact) info below or the [contributing](https://github.com/Outer-Wilds-New-Horizons/new-horizons/blob/master/CONTRIBUTING.md) page.
 
-The Unity project we use to make asset bundles for this mod is [here](https://github.com/xen-42/new-horizons-unity).
+The Unity project we use to make asset bundles for this mod is [here](https://github.com/Outer-Wilds-New-Horizons/nh-unity).
 
 ## Contact
 
@@ -70,11 +72,10 @@ Main authors:
 
 -   [xen](https://github.com/xen-42)
 -   [Bwc9876](https://github.com/Bwc9876) (New Horizons v0.9.0 onwards)
-
-New Horizons was made with help from:
-
 -   [JohnCorby](https://github.com/JohnCorby)
 -   [MegaPiggy](https://github.com/MegaPiggy)
+  
+New Horizons was made with help from:
 -   [FreezeDriedMangos](https://github.com/FreezeDriedMangos)
 -   [Trifid](https://github.com/TerrificTrifid)
 -   [Hawkbar](https://github.com/Hawkbat)
@@ -89,7 +90,7 @@ Translation credits:
 -   Japanese: TRSasasusu
 -   Portuguese: avengerx, loco-choco
 
-New Horizons was based off [Marshmallow](https://github.com/misternebula/Marshmallow) was made by:
+New Horizons was based off [Marshmallow](https://github.com/misternebula/Marshmallow) made by:
 
 -   [\_nebula](https://github.com/misternebula)