mirror of
https://github.com/Outer-Wilds-New-Horizons/new-horizons.git
synced 2025-12-11 20:15:44 +01:00
Update Docs Workflow
This commit is contained in:
parent
7980a38eda
commit
13d4c8d554
8
.github/pull_request_template.md
vendored
8
.github/pull_request_template.md
vendored
@ -1,15 +1,23 @@
|
|||||||
<!-- A new module or something else important -->
|
<!-- A new module or something else important -->
|
||||||
|
|
||||||
## Major features
|
## Major features
|
||||||
|
|
||||||
-
|
-
|
||||||
|
|
||||||
<!-- A new parameter added to a module, or API feature -->
|
<!-- A new parameter added to a module, or API feature -->
|
||||||
|
|
||||||
## Minor features
|
## Minor features
|
||||||
|
|
||||||
-
|
-
|
||||||
|
|
||||||
<!-- Some improvement that requires no action on the part of add-on creators i.e., improved star graphics -->
|
<!-- Some improvement that requires no action on the part of add-on creators i.e., improved star graphics -->
|
||||||
|
|
||||||
## Improvements
|
## Improvements
|
||||||
|
|
||||||
-
|
-
|
||||||
|
|
||||||
<!-- Be sure to reference the existing issue if it exists -->
|
<!-- Be sure to reference the existing issue if it exists -->
|
||||||
|
|
||||||
## Bug fixes
|
## Bug fixes
|
||||||
|
|
||||||
-
|
-
|
||||||
|
|||||||
6
.github/workflows/build.yaml
vendored
6
.github/workflows/build.yaml
vendored
@ -19,18 +19,15 @@ on:
|
|||||||
type: string
|
type: string
|
||||||
outputs:
|
outputs:
|
||||||
schemas_changed:
|
schemas_changed:
|
||||||
description: 'Have the schemas been updated?'
|
description: "Have the schemas been updated?"
|
||||||
value: ${{ jobs.Build.outputs.schemas_changed }}
|
value: ${{ jobs.Build.outputs.schemas_changed }}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
Build:
|
Build:
|
||||||
runs-on: windows-latest
|
runs-on: windows-latest
|
||||||
outputs:
|
outputs:
|
||||||
schemas_changed: ${{ steps.changed_files.outputs.files_changed }}
|
schemas_changed: ${{ steps.changed_files.outputs.files_changed }}
|
||||||
steps:
|
steps:
|
||||||
|
|
||||||
- name: Checkout Repo
|
- name: Checkout Repo
|
||||||
uses: actions/checkout@v3
|
uses: actions/checkout@v3
|
||||||
|
|
||||||
@ -70,4 +67,3 @@ jobs:
|
|||||||
id: changed_files
|
id: changed_files
|
||||||
with:
|
with:
|
||||||
files: NewHorizons/Schemas/**
|
files: NewHorizons/Schemas/**
|
||||||
|
|
||||||
|
|||||||
6
.github/workflows/debug_build.yml
vendored
6
.github/workflows/debug_build.yml
vendored
@ -13,14 +13,14 @@ on:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
Build:
|
Build:
|
||||||
uses: './.github/workflows/build.yaml'
|
uses: "./.github/workflows/build.yaml"
|
||||||
with:
|
with:
|
||||||
build_type: Debug
|
build_type: Debug
|
||||||
Update_Schemas:
|
Update_Schemas:
|
||||||
name: 'Update Schemas'
|
name: "Update Schemas"
|
||||||
needs: Build
|
needs: Build
|
||||||
if: ${{ needs.Build.outputs.schemas_changed == 'true' }}
|
if: ${{ needs.Build.outputs.schemas_changed == 'true' }}
|
||||||
uses: './.github/workflows/update_schemas.yml'
|
uses: "./.github/workflows/update_schemas.yml"
|
||||||
with:
|
with:
|
||||||
artifact_name: NewHorizons-Schemas-Debug
|
artifact_name: NewHorizons-Schemas-Debug
|
||||||
secrets: inherit
|
secrets: inherit
|
||||||
|
|||||||
3
.github/workflows/docs_build.yml
vendored
3
.github/workflows/docs_build.yml
vendored
@ -36,7 +36,7 @@ jobs:
|
|||||||
name: ${{ inputs.schemas_artifact }}
|
name: ${{ inputs.schemas_artifact }}
|
||||||
path: NewHorizons/Schemas
|
path: NewHorizons/Schemas
|
||||||
- name: Build Site
|
- name: Build Site
|
||||||
uses: withastro/action@v0
|
uses: withastro/action@v1
|
||||||
with:
|
with:
|
||||||
path: ./docs
|
path: ./docs
|
||||||
|
|
||||||
@ -50,4 +50,3 @@ jobs:
|
|||||||
- name: Deploy to GitHub Pages
|
- name: Deploy to GitHub Pages
|
||||||
id: deployment
|
id: deployment
|
||||||
uses: actions/deploy-pages@v1
|
uses: actions/deploy-pages@v1
|
||||||
|
|
||||||
|
|||||||
4
.github/workflows/release_build.yml
vendored
4
.github/workflows/release_build.yml
vendored
@ -33,8 +33,8 @@ jobs:
|
|||||||
id: read-manifest
|
id: read-manifest
|
||||||
uses: notiz-dev/github-action-json-property@release
|
uses: notiz-dev/github-action-json-property@release
|
||||||
with:
|
with:
|
||||||
path: './NewHorizons/manifest.json'
|
path: "./NewHorizons/manifest.json"
|
||||||
prop_path: 'version'
|
prop_path: "version"
|
||||||
- name: Print version numbers
|
- name: Print version numbers
|
||||||
run: |
|
run: |
|
||||||
echo "Manifest version: $MANIFEST_VERSION"
|
echo "Manifest version: $MANIFEST_VERSION"
|
||||||
|
|||||||
2
.github/workflows/update_schemas.yml
vendored
2
.github/workflows/update_schemas.yml
vendored
@ -5,7 +5,7 @@ on:
|
|||||||
inputs:
|
inputs:
|
||||||
artifact_name:
|
artifact_name:
|
||||||
required: true
|
required: true
|
||||||
description: 'Name of the artifact to download and check against'
|
description: "Name of the artifact to download and check against"
|
||||||
type: string
|
type: string
|
||||||
|
|
||||||
# Prevents schemas from trying to update on old commits
|
# Prevents schemas from trying to update on old commits
|
||||||
|
|||||||
@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
|
|||||||
Examples of behavior that contributes to a positive environment for our
|
Examples of behavior that contributes to a positive environment for our
|
||||||
community include:
|
community include:
|
||||||
|
|
||||||
* Demonstrating empathy and kindness toward other people
|
- Demonstrating empathy and kindness toward other people
|
||||||
* Being respectful of differing opinions, viewpoints, and experiences
|
- Being respectful of differing opinions, viewpoints, and experiences
|
||||||
* Giving and gracefully accepting constructive feedback
|
- Giving and gracefully accepting constructive feedback
|
||||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
- Accepting responsibility and apologizing to those affected by our mistakes,
|
||||||
and learning from the experience
|
and learning from the experience
|
||||||
* Focusing on what is best not just for us as individuals, but for the
|
- Focusing on what is best not just for us as individuals, but for the
|
||||||
overall community
|
overall community
|
||||||
|
|
||||||
Examples of unacceptable behavior include:
|
Examples of unacceptable behavior include:
|
||||||
|
|
||||||
* The use of sexualized language or imagery, and sexual attention or
|
- The use of sexualized language or imagery, and sexual attention or
|
||||||
advances of any kind
|
advances of any kind
|
||||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
- Trolling, insulting or derogatory comments, and personal or political attacks
|
||||||
* Public or private harassment
|
- Public or private harassment
|
||||||
* Publishing others' private information, such as a physical or email
|
- Publishing others' private information, such as a physical or email
|
||||||
address, without their explicit permission
|
address, without their explicit permission
|
||||||
* Other conduct which could reasonably be considered inappropriate in a
|
- Other conduct which could reasonably be considered inappropriate in a
|
||||||
professional setting
|
professional setting
|
||||||
|
|
||||||
## Enforcement Responsibilities
|
## Enforcement Responsibilities
|
||||||
|
|||||||
@ -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
|
Then (so long as you build targeting `Debug`), line numbers will be shown in any error that comes from New Horizons
|
||||||
|
|
||||||
## Provide examples
|
## 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.
|
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
|
## Updating The Schema
|
||||||
|
|||||||
17
README.md
17
README.md
@ -1,6 +1,5 @@
|
|||||||

|

|
||||||
|
|
||||||
|
|
||||||
[](https://patreon.com/ownh)
|
[](https://patreon.com/ownh)
|
||||||
[](https://www.paypal.com/paypalme/xen42)
|
[](https://www.paypal.com/paypalme/xen42)
|
||||||

|

|
||||||
@ -9,7 +8,7 @@
|
|||||||

|

|
||||||
[](https://github.com/xen-42/outer-wilds-new-horizons/actions/workflows/build.yaml)
|
[](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).
|
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,16 +25,20 @@ Check the ship's log for how to use your warp drive to travel between star syste
|
|||||||
<!-- /TOC -->
|
<!-- /TOC -->
|
||||||
|
|
||||||
## Incompatible mods
|
## Incompatible mods
|
||||||
|
|
||||||
- Quantum Space Buddies.
|
- Quantum Space Buddies.
|
||||||
- OW Randomizer.
|
- OW Randomizer.
|
||||||
|
|
||||||
## Supported Mods
|
## Supported Mods
|
||||||
|
|
||||||
New Horizons has optional support for a few other 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!
|
- [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!
|
- [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!
|
- [Achievements+](https://outerwildsmods.com/mods/achievements/): New Horizons and its addons have achievements you can unlock with this mod installed!
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Load planet meshes or details from asset bundles
|
- 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
|
- 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
|
- Separate solar system scenes accessible via wormhole OR via the ship's new warp drive feature accessible via the ship's log
|
||||||
@ -51,19 +54,24 @@ New Horizons has optional support for a few other mods:
|
|||||||
- Funnels and variable surface height (can be made of sand/water/lava/star)
|
- Funnels and variable surface height (can be made of sand/water/lava/star)
|
||||||
|
|
||||||
## Development
|
## 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/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).
|
The Unity project we use to make asset bundles for this mod is [here](https://github.com/xen-42/new-horizons-unity).
|
||||||
|
|
||||||
## Contact
|
## 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.
|
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
|
## Credits
|
||||||
|
|
||||||
Main authors:
|
Main authors:
|
||||||
|
|
||||||
- [xen](https://github.com/xen-42)
|
- [xen](https://github.com/xen-42)
|
||||||
- [Bwc9876](https://github.com/Bwc9876) (New Horizons v0.9.0 onwards)
|
- [Bwc9876](https://github.com/Bwc9876) (New Horizons v0.9.0 onwards)
|
||||||
|
|
||||||
New Horizons was made with help from:
|
New Horizons was made with help from:
|
||||||
|
|
||||||
- [JohnCorby](https://github.com/JohnCorby)
|
- [JohnCorby](https://github.com/JohnCorby)
|
||||||
- [MegaPiggy](https://github.com/MegaPiggy)
|
- [MegaPiggy](https://github.com/MegaPiggy)
|
||||||
- [FreezeDriedMangos](https://github.com/FreezeDriedMangos)
|
- [FreezeDriedMangos](https://github.com/FreezeDriedMangos)
|
||||||
@ -72,6 +80,7 @@ New Horizons was made with help from:
|
|||||||
- And many others, see the [contributors](https://github.com/Outer-Wilds-New-Horizons/new-horizons/graphs/contributors) page.
|
- And many others, see the [contributors](https://github.com/Outer-Wilds-New-Horizons/new-horizons/graphs/contributors) page.
|
||||||
|
|
||||||
Translation credits:
|
Translation credits:
|
||||||
|
|
||||||
- Russian: Tlya
|
- Russian: Tlya
|
||||||
- German: Nolram
|
- German: Nolram
|
||||||
- Spanish: Ciborgm9, Ink, GayCoffee
|
- Spanish: Ciborgm9, Ink, GayCoffee
|
||||||
@ -79,9 +88,11 @@ Translation credits:
|
|||||||
- Japanese: TRSasasusu
|
- Japanese: TRSasasusu
|
||||||
|
|
||||||
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) was made by:
|
||||||
- [_nebula](https://github.com/misternebula)
|
|
||||||
|
- [\_nebula](https://github.com/misternebula)
|
||||||
|
|
||||||
with help from:
|
with help from:
|
||||||
|
|
||||||
- TAImatem
|
- TAImatem
|
||||||
- AmazingAlek
|
- AmazingAlek
|
||||||
- Raicuparta
|
- Raicuparta
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user