Update Docs Workflow

.github/pull_request_template.md

@@ -1,15 +1,23 @@
 <!-- A new module or something else important -->
+
 ## Major features
+
 -
 
 <!-- A new parameter added to a module, or API feature -->
+
 ## Minor features
+
 -
 
 <!-- Some improvement that requires no action on the part of add-on creators i.e., improved star graphics -->
+
 ## Improvements
+
 -
 
 <!-- Be sure to reference the existing issue if it exists -->
+
 ## Bug fixes
+
 -

.github/workflows/build.yaml

@@ -19,55 +19,51 @@ on:
         type: string
     outputs:
       schemas_changed:
-        description: 'Have the schemas been updated?'
+        description: "Have the schemas been updated?"
         value: ${{ jobs.Build.outputs.schemas_changed }}
 
-
-  
 jobs:
   Build:
     runs-on: windows-latest
     outputs:
       schemas_changed: ${{ steps.changed_files.outputs.files_changed }}
     steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
 
-    - name: Checkout Repo
-      uses: actions/checkout@v3
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v3
 
-    - name: Setup .NET
-      uses: actions/setup-dotnet@v3
+      # Disable Strong Name Verification to let us pull a switch-a-roo
+      - name: Disable strong name validation
+        run: "C:\\\"Program Files (x86)\"\\\"Microsoft SDKs\"\\Windows\\v10.0A\\bin\\\"NETFX 4.8 Tools\"\\x64\\sn.exe -Vr *"
 
-    # Disable Strong Name Verification to let us pull a switch-a-roo
-    - name: Disable strong name validation
-      run: "C:\\\"Program Files (x86)\"\\\"Microsoft SDKs\"\\Windows\\v10.0A\\bin\\\"NETFX 4.8 Tools\"\\x64\\sn.exe -Vr *"
+      - name: Remove .csproj.user
+        run: "rm .\\NewHorizons\\NewHorizons.csproj.user"
 
-    - name: Remove .csproj.user
-      run: "rm .\\NewHorizons\\NewHorizons.csproj.user"
+      - name: Build Project
+        run: dotnet build -c ${{ inputs.build_type }}
 
-    - name: Build Project
-      run: dotnet build -c ${{ inputs.build_type }}
+      - name: Generate Schemas
+        run: .\SchemaExporter\bin\${{ inputs.build_type }}\SchemaExporter.exe
 
-    - name: Generate Schemas
-      run: .\SchemaExporter\bin\${{ inputs.build_type }}\SchemaExporter.exe
+      - name: Delete XML documentation
+        run: rm .\NewHorizons\bin\${{ inputs.build_type }}\NewHorizons.xml
 
-    - name: Delete XML documentation
-      run: rm .\NewHorizons\bin\${{ inputs.build_type }}\NewHorizons.xml
+      - name: Upload Mod Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: xen.NewHorizons.${{ inputs.build_type }}
+          path: .\NewHorizons\bin\${{ inputs.build_type }}
 
-    - name: Upload Mod Artifact
-      uses: actions/upload-artifact@v3
-      with:
-        name: xen.NewHorizons.${{ inputs.build_type }}
-        path: .\NewHorizons\bin\${{ inputs.build_type }}
-        
-    - name: Upload Schemas Artifact
-      uses: actions/upload-artifact@v3
-      with:
-        name: NewHorizons-Schemas-${{ inputs.build_type }}
-        path: .\NewHorizons\Schemas
-
-    - name: Verify Changed Schemas
-      uses: tj-actions/verify-changed-files@v12
-      id: changed_files
-      with:
-        files: NewHorizons/Schemas/**
+      - name: Upload Schemas Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: NewHorizons-Schemas-${{ inputs.build_type }}
+          path: .\NewHorizons\Schemas
 
+      - name: Verify Changed Schemas
+        uses: tj-actions/verify-changed-files@v12
+        id: changed_files
+        with:
+          files: NewHorizons/Schemas/**

.github/workflows/debug_build.yml

@@ -13,14 +13,14 @@ on:
 
 jobs:
   Build:
-    uses: './.github/workflows/build.yaml'
+    uses: "./.github/workflows/build.yaml"
     with:
       build_type: Debug
   Update_Schemas:
-    name: 'Update Schemas'
+    name: "Update Schemas"
     needs: Build
     if: ${{ needs.Build.outputs.schemas_changed == 'true' }}
-    uses: './.github/workflows/update_schemas.yml'
+    uses: "./.github/workflows/update_schemas.yml"
     with:
       artifact_name: NewHorizons-Schemas-Debug
     secrets: inherit

.github/workflows/docs_build.yml

@@ -36,7 +36,7 @@ jobs:
           name: ${{ inputs.schemas_artifact }}
           path: NewHorizons/Schemas
       - name: Build Site
-        uses: withastro/action@v0
+        uses: withastro/action@v1
         with:
           path: ./docs
 
@@ -50,4 +50,3 @@ jobs:
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v1
-

.github/workflows/release_build.yml

@@ -33,8 +33,8 @@ jobs:
         id: read-manifest
         uses: notiz-dev/github-action-json-property@release
         with:
-          path: './NewHorizons/manifest.json'
-          prop_path: 'version'
+          path: "./NewHorizons/manifest.json"
+          prop_path: "version"
       - name: Print version numbers
         run: |
           echo "Manifest version: $MANIFEST_VERSION"

.github/workflows/update_release.yml

@@ -1,29 +1,29 @@
 name: Create/Update Release
 
 on:
-    pull_request:
-        branches: [main]
-        types:
-            - ready_for_review
-            - edited
-            - labeled
+  pull_request:
+    branches: [main]
+    types:
+      - ready_for_review
+      - edited
+      - labeled
 
 jobs:
-    Update_Release:
-        name: Create/Update Release
-        if: contains(github.event.pull_request.labels.*.name, 'update-pr')
-        runs-on: ubuntu-latest
-        steps:
-            - name: Create/Update Release
-              uses: ncipollo/release-action@v1
-              with:
-                  allowUpdates: true
-                  name: Version ${{ github.event.pull_request.title }}
-                  tag: v${{ github.event.pull_request.title }}
-                  commit: main
-                  body: |
-                      ${{ github.event.pull_request.body }} 
+  Update_Release:
+    name: Create/Update Release
+    if: contains(github.event.pull_request.labels.*.name, 'update-pr')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create/Update Release
+        uses: ncipollo/release-action@v1
+        with:
+          allowUpdates: true
+          name: Version ${{ github.event.pull_request.title }}
+          tag: v${{ github.event.pull_request.title }}
+          commit: main
+          body: |
+            ${{ github.event.pull_request.body }} 
 
-                      **Generated From PR: ${{ github.event.pull_request.html_url }}**
-                  draft: true
-                  prerelease: false
+            **Generated From PR: ${{ github.event.pull_request.html_url }}**
+          draft: true
+          prerelease: false

.github/workflows/update_schemas.yml

@@ -5,7 +5,7 @@ on:
     inputs:
       artifact_name:
         required: true
-        description: 'Name of the artifact to download and check against'
+        description: "Name of the artifact to download and check against"
         type: string
 
 # Prevents schemas from trying to update on old commits

.vscode/settings.json

@@ -1,5 +1,5 @@
 {
-    "yaml.schemas": {
-        "https://json.schemastore.org/github-workflow.json": "vscode-vfs://github%2B7b2276223a312c22726566223a7b2274797065223a342c226964223a226465766f70732f6e65772d776f726b666c6f7773227d7d/xen-42/outer-wilds-new-horizons/.github/workflows/build.yaml"
-    }
+  "yaml.schemas": {
+    "https://json.schemastore.org/github-workflow.json": "vscode-vfs://github%2B7b2276223a312c22726566223a7b2274797065223a342c226964223a226465766f70732f6e65772d776f726b666c6f7773227d7d/xen-42/outer-wilds-new-horizons/.github/workflows/build.yaml"
+  }
 }

CODE_OF_CONDUCT.md

@@ -17,24 +17,24 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
+-   Demonstrating empathy and kindness toward other people
+-   Being respectful of differing opinions, viewpoints, and experiences
+-   Giving and gracefully accepting constructive feedback
+-   Accepting responsibility and apologizing to those affected by our mistakes,
+    and learning from the experience
+-   Focusing on what is best not just for us as individuals, but for the
+    overall community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
+-   The use of sexualized language or imagery, and sexual attention or
+    advances of any kind
+-   Trolling, insulting or derogatory comments, and personal or political attacks
+-   Public or private harassment
+-   Publishing others' private information, such as a physical or email
+    address, without their explicit permission
+-   Other conduct which could reasonably be considered inappropriate in a
+    professional setting
 
 ## Enforcement Responsibilities
 
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within

CONTRIBUTING.md

@@ -19,6 +19,7 @@ To save yourself the pain of decoding where in a function an error occured, you
 Then (so long as you build targeting `Debug`), line numbers will be shown in any error that comes from New Horizons
 
 ## Provide examples
+
 When adding a new feature, include a complete set of planet config files that will sufficiently demonstrate the functionality of the feature/bug fix/improvement. This way reviewers can just copy paste these files into the New Horizons planets folder.
 
 ## Updating The Schema

README.md

@@ -1,6 +1,5 @@
 ![new horizons thumbnail 2](https://user-images.githubusercontent.com/22628069/154112130-b777f618-245f-44c9-9408-e11141fc5fde.png)
 
-
 [![Support me on Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Downh%26type%3Dpatrons&style=flat)](https://patreon.com/ownh)
 [![Donate](https://img.shields.io/badge/Donate-PayPal-blue.svg)](https://www.paypal.com/paypalme/xen42)
 ![Current version](https://img.shields.io/github/manifest-json/v/xen-42/outer-wilds-new-horizons?color=gree&filename=NewHorizons%2Fmanifest.json)
@@ -9,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 planets 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).
 
@@ -17,72 +16,84 @@ Check the ship's log for how to use your warp drive to travel between star syste
 
 <!-- TOC -->
 
-- [Incompatible mods](#incompatible-mods)
-- [Supported mods](#supported-mods)
-- [Development](#development)
-- [Contact](#contact)
-- [Credits](#credits)
+-   [Incompatible mods](#incompatible-mods)
+-   [Supported mods](#supported-mods)
+-   [Development](#development)
+-   [Contact](#contact)
+-   [Credits](#credits)
 
 <!-- /TOC -->
 
 ## Incompatible mods
-- Quantum Space Buddies.
-- OW Randomizer.
+
+-   Quantum Space Buddies.
+-   OW Randomizer.
 
 ## Supported Mods
+
 New Horizons has optional support for a few other mods:
-- [Discord Rich Presence](https://outerwildsmods.com/mods/discordrichpresence/): Showcase what New Horizons worlds you're exploring in your Discord status!
-- [Voice Acting Mod](https://outerwildsmods.com/mods/voiceactingmod/): Characters in NH can be given voice lines which will work with this mod installed. Try it out by downloading NH Examples and talking to Ernesto!
-- [Achievements+](https://outerwildsmods.com/mods/achievements/): New Horizons and its addons have achievements you can unlock with this mod installed!
+
+-   [Discord Rich Presence](https://outerwildsmods.com/mods/discordrichpresence/): Showcase what New Horizons worlds you're exploring in your Discord status!
+-   [Voice Acting Mod](https://outerwildsmods.com/mods/voiceactingmod/): Characters in NH can be given voice lines which will work with this mod installed. Try it out by downloading NH Examples and talking to Ernesto!
+-   [Achievements+](https://outerwildsmods.com/mods/achievements/): New Horizons and its addons have achievements you can unlock with this mod installed!
 
 ## Features
-- Load planet meshes or details from asset bundles 
-- Use our [template Unity project](https://github.com/xen-42/outer-wilds-unity-template) to create assets for use in NH, including all game scripts recovered using UtinyRipper
-- Separate solar system scenes accessible via wormhole OR via the ship's new warp drive feature accessible via the ship's log
-- Remove or edit existing planets, including what they orbit around
-- Create custom planets from heightmaps/texturemaps
-- Create stars (and supernovae), comets, asteroid belts, satellites, quantum planets/moons, and custom Dark Bramble dimensions.
-- Add stock planet features to custom ones, such as geysers, cloak fields, meteor-launching volcanoes, rafts, tornados, and Dark Bramble seeds/nodes.
-- Binary orbits
-- Signalscope signals and custom frequencies
-- Surface scatter: rocks, trees, etc, using in-game models, or custom ones 
-- Black hole / white hole pairs 
-- Custom dialogue, slide-reel projections, translatable text, and custom ship log entries for rumour mode and map mode
-- Funnels and variable surface height (can be made of sand/water/lava/star)
+
+-   Load planet meshes or details from asset bundles
+-   Use our [template Unity project](https://github.com/xen-42/outer-wilds-unity-template) to create assets for use in NH, including all game scripts recovered using UtinyRipper
+-   Separate solar system scenes accessible via wormhole OR via the ship's new warp drive feature accessible via the ship's log
+-   Remove or edit existing planets, including what they orbit around
+-   Create custom planets from heightmaps/texturemaps
+-   Create stars (and supernovae), comets, asteroid belts, satellites, quantum planets/moons, and custom Dark Bramble dimensions.
+-   Add stock planet features to custom ones, such as geysers, cloak fields, meteor-launching volcanoes, rafts, tornados, and Dark Bramble seeds/nodes.
+-   Binary orbits
+-   Signalscope signals and custom frequencies
+-   Surface scatter: rocks, trees, etc, using in-game models, or custom ones
+-   Black hole / white hole pairs
+-   Custom dialogue, slide-reel projections, translatable text, and custom ship log entries for rumour mode and map mode
+-   Funnels and variable surface height (can be made of sand/water/lava/star)
 
 ## 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.
 
 The Unity project we use to make asset bundles for this mod is [here](https://github.com/xen-42/new-horizons-unity).
 
 ## Contact
+
 Join the [Outer Wilds Modding Discord](https://discord.gg/MvbCbBz6Q6) if you have any questions or just want to chat about modding! Theres a New Horizons category there dedicated to discussion of this mod.
 
 ## Credits
+
 Main authors:
-- [xen](https://github.com/xen-42)
-- [Bwc9876](https://github.com/Bwc9876) (New Horizons v0.9.0 onwards)
+
+-   [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)
-- [FreezeDriedMangos](https://github.com/FreezeDriedMangos)
-- [Trifid](https://github.com/TerrificTrifid)
-- [Hawkbar](https://github.com/Hawkbat)
-- And many others, see the [contributors](https://github.com/Outer-Wilds-New-Horizons/new-horizons/graphs/contributors) page.
+
+-   [JohnCorby](https://github.com/JohnCorby)
+-   [MegaPiggy](https://github.com/MegaPiggy)
+-   [FreezeDriedMangos](https://github.com/FreezeDriedMangos)
+-   [Trifid](https://github.com/TerrificTrifid)
+-   [Hawkbar](https://github.com/Hawkbat)
+-   And many others, see the [contributors](https://github.com/Outer-Wilds-New-Horizons/new-horizons/graphs/contributors) page.
 
 Translation credits:
-- Russian: Tlya
-- German: Nolram
-- Spanish: Ciborgm9, Ink, GayCoffee
-- French: xen
-- Japanese: TRSasasusu
+
+-   Russian: Tlya
+-   German: Nolram
+-   Spanish: Ciborgm9, Ink, GayCoffee
+-   French: xen
+-   Japanese: TRSasasusu
 
 New Horizons was based off [Marshmallow](https://github.com/misternebula/Marshmallow) was made by:
-- [_nebula](https://github.com/misternebula)
+
+-   [\_nebula](https://github.com/misternebula)
 
 with help from:
-- TAImatem
-- AmazingAlek
-- Raicuparta
-- and the Outer Wilds discord server.
+
+-   TAImatem
+-   AmazingAlek
+-   Raicuparta
+-   and the Outer Wilds discord server.