Initial commit

.gitattributes

@@ -0,0 +1,2 @@
+# Prevent paths like .gitignore, .gitattributes, etc from being archived in the release zip.
+.* export-ignore

.github/workflows/create-release.yml

@@ -0,0 +1,36 @@
+name: Create Release
+
+on:
+  push:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repo files
+        uses: actions/checkout@v2
+
+      - name: Create zip with repo files
+        run: git archive --format zip --output ${{ github.event.repository.name }}.zip HEAD
+
+      - name: Read checked out manifest.json
+        id: read-manifest
+        run: echo "::set-output name=manifest::$(< ./manifest.json sed ':a;N;$!ba;s/\n/ /g')"
+
+      - name: Check if version in manifest.json is already released
+        uses: mukunku/[email protected]
+        id: checkTag
+        with:
+          tag: "v${{fromJson(steps.read-manifest.outputs.manifest).version}}"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publish repo zip with version from manifest
+        if: ${{ (fromJson(steps.read-manifest.outputs.manifest).version != '0.0.0') && (steps.checkTag.outputs.exists == 'false') }}
+        uses: softprops/action-gh-release@v1
+        with:
+          files: "${{ github.event.repository.name }}.zip"
+          body: "${{ github.event.head_commit.message }}"
+          tag_name: "v${{fromJson(steps.read-manifest.outputs.manifest).version}}"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 New Horizons Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,37 @@
+# Outer Wilds planet creation template
+ A template project for adding planets to Outer Wilds with [New Horizons](https://github.com/xen-42/outer-wilds-new-horizons).
+
+The source code for the dll used is [here](https://github.com/xen-42/ow-new-horizons-mod-template).
+
+## Prerequisites
+- Outer Wilds Mod Manager (get it from the [Outer Wilds Mods](https://outerwildsmods.com/) website)
+- OWML installed in the Mod Manager
+- A GitHub account (required for forking the repo and for releasing your mod to the public)
+
+## How to use this template
+1. Generate your repository from this template (click on Use This Template above).
+2. Clone your repository to your machine into a new folder in OWML's `Mods` folder. Name this folder [your name].[your unique mod ID]. More on this later. You can use GitHub desktop for this, then click the green "Code" dropdown and select open with GitHub Desktop.
+3. Follow the instructions in [Outer Wilds New Horizons](https://nh.outerwildsmods.com/) on how to create planet config files. Place your config files into the `planets` folder in [your name].[your unique mod ID]. You can delete the `example_config` file in there while you're at it. When you're done you can commit the changes to your repo.
+5. Edit `NewHorizonsTemplate/manifest.json`. It will look like this:
+
+```
+{
+  "filename": "NewHorizonsConfig.dll", 
+  "author": "[your name]",
+  "name": "[your readable mod name]",
+  "uniqueName": "[your name].[your unique mod ID]",
+  "version": "0.1.0",
+  "owmlVersion": "2.1.0",
+  "dependencies": [ "xen.NewHorizons" ]
+}
+```
+
+- Replace `[your name]` with how you want your name to appear in the mod database.
+- Replace `[your readable mod name]` with how you want your mod to appear in the database.
+- Replace `[your unique mod ID]` with whatever you want, as long as it isn't already in use by another mod. Adding `[your name]` as a prefix helps to prevent overlaps but isn't required.
+
+6. Edit the `README.md` file (you can do this on GitHub in your browser) and be sure to add some nice pictures of your planets.
+7. Select "Read and Write Permissions" under the `Actions > General` section of the repository settings![image](https://user-images.githubusercontent.com/25644444/168451761-43d3a0e7-c9a2-4f7f-b942-9aa7d5c3c793.png)
+
+8. Releasing the mod. See the "Releasing the mod" section on the  [Outer Wilds Mod Template](https://github.com/Raicuparta/ow-mod-template) repo for info on how to do this. Be sure to try out the mod by adding it to your OWML mods folder and make sure it works in game before releasing. When you zip your final mod be sure to exclude the README.md file and the config.json file (they aren't needed in the release). The zip file should contain: `planets`, `default-config.json`, `manifest.json`, and `NewHorizonsConfig.dll`. When using the template when you update the manifest version from 0.0.0 to 0.1.0 or whatever you want, it will automatically make a new release.
+9. Updating your mod. You can make any changes to your mod on your computer. Then from Github desktop you can commit and then push those changes to your repo online. When you are ready to release the new version of your mod, just changed the version number in `manifest.json`. Once the `manifest.json` version number is increased and pushed, a new release will automatically be created. 

default-config.json

@@ -0,0 +1,3 @@
+{
+	"enabled": true
+}

manifest.json

@@ -0,0 +1,9 @@
+{
+  "filename": "NewHorizonsConfig.dll",
+  "author": "[your name]",
+  "name": "[your readable mod name]",
+  "uniqueName": "[your name].[your unique mod ID]",
+  "version": "0.0.0",
+  "owmlVersion": "2.1.0",
+  "dependencies": [ "xen.NewHorizons" ]
+}

planets/example_config.json

@@ -0,0 +1,4 @@
+{
+	"name" : "Quantum Moon",
+	"destroy" : true
+}