Update README.md

This commit is contained in:
Ben C 2023-07-03 12:55:53 -04:00
parent ca83e46fd2
commit 13503a11b2
No known key found for this signature in database
GPG Key ID: 556064B755159BBC

View File

@ -1,6 +1,5 @@
![new horizons thumbnail 2](https://user-images.githubusercontent.com/22628069/154112130-b777f618-245f-44c9-9408-e11141fc5fde.png) ![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) [![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) [![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) ![Current version](https://img.shields.io/github/manifest-json/v/xen-42/outer-wilds-new-horizons?color=gree&filename=NewHorizons%2Fmanifest.json)
@ -13,12 +12,15 @@
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).
If you want to quickly start a new addon see [the addon template](https://github.com/xen-42/ow-new-horizons-config-template) or [the outer wilds mod template](https://github.com/ow-mods/ow-mod-template) (check "Use New Horizons" when using the mod template).
Check the ship's log for how to use your warp drive to travel between star systems! Check the ship's log for how to use your warp drive to travel between star systems!
<!-- TOC --> <!-- TOC -->
- [Incompatible mods](#incompatible-mods) - [Incompatible mods](#incompatible-mods)
- [Supported mods](#supported-mods) - [Supported Mods](#supported-mods)
- [Features](#features)
- [Development](#development) - [Development](#development)
- [Contact](#contact) - [Contact](#contact)
- [Credits](#credits) - [Credits](#credits)
@ -26,17 +28,21 @@ 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
- Remove or edit existing planets, including what they orbit around - Remove or edit existing planets, including what they orbit around
@ -45,29 +51,34 @@ New Horizons has optional support for a few other mods:
- Add stock planet features to custom ones, such as geysers, cloak fields, meteor-launching volcanoes, rafts, tornados, and Dark Bramble seeds/nodes. - Add stock planet features to custom ones, such as geysers, cloak fields, meteor-launching volcanoes, rafts, tornados, and Dark Bramble seeds/nodes.
- Binary orbits - Binary orbits
- Signalscope signals and custom frequencies - Signalscope signals and custom frequencies
- Surface scatter: rocks, trees, etc, using in-game models, or custom ones - Surface scatter: rocks, trees, etc, using in-game models, or custom ones
- Black hole / white hole pairs - Black hole / white hole pairs
- Custom dialogue, slide-reel projections, translatable text, and custom ship log entries for rumour mode and map mode - 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) - 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 (New Horizons v0.1.0 onwards) - xen (New Horizons v0.1.0 onwards)
- [Bwc9876](https://github.com/Bwc9876) (New Horizons v0.9.0 onwards) - [Bwc9876](https://github.com/Bwc9876) (New Horizons v0.9.0 onwards)
- [Mister_Nebula](https://github.com/misternebula) ([Marshmallow](https://github.com/misternebula/Marshmallow) v0.1 to v1.1.0) - [Mister_Nebula](https://github.com/misternebula) ([Marshmallow](https://github.com/misternebula/Marshmallow) v0.1 to v1.1.0)
New Horizons was made with help from: New Horizons was made with help from:
- [FreezeDriedMangos](https://github.com/FreezeDriedMangos) - [FreezeDriedMangos](https://github.com/FreezeDriedMangos)
- [MegaPiggy](https://github.com/MegaPiggy) - [MegaPiggy](https://github.com/MegaPiggy)
- [JohnCorby](https://github.com/JohnCorby) - [JohnCorby](https://github.com/JohnCorby)
- [Nageld](https://github.com/Nageld) - [Nageld](https://github.com/Nageld)
- [Trifid](https://github.com/TerrificTrifid) - [Trifid](https://github.com/TerrificTrifid)
- [Raicuparta](https://github.com/Raicuparta) - [Raicuparta](https://github.com/Raicuparta)
@ -75,12 +86,14 @@ New Horizons was made with help from:
- And the Outer Wilds modding server. - And the Outer Wilds modding server.
Translation credits: Translation credits:
- Russian: Tlya - Russian: Tlya
- German: Nolram - German: Nolram
- Spanish: Ciborgm9, Ink, GayCoffee - Spanish: Ciborgm9, Ink, GayCoffee
- French: xen - French: xen
Marshmallow was made with help from: Marshmallow was made with help from:
- TAImatem - TAImatem
- AmazingAlek - AmazingAlek
- Raicuparta - Raicuparta