Merge pull request #484 from ow-mods/dev

2.7.1

Author: Raicuparta

.github/workflows/docs_build.yml

@@ -0,0 +1,79 @@
+name: Build Docs
+
+on:
+  push:
+    branches: [master]
+    paths:
+      - docs/**
+      - schemas/*.json
+
+env:
+  URL_PREFIX: '/'
+  PIPENV_VENV_IN_PROJECT: 1
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+  
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build Docs
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v2
+      
+      - uses: szenius/set-timezone@v1.0
+        with:
+          timezoneLinux: "America/New York"
+      
+      - run: mkdir ./.venv
+      
+      - run: cp -r docs/** .
+          
+      - name: Cache Dependencies
+        uses: actions/cache@v2
+        id: cache-dependencies
+        with:
+          path: ./.venv
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/Pipfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-pipenv
+
+      - name: Install dependecies
+        uses: VaultVulp/action-pipenv@v2.0.1
+        with:
+          command: install --dev
+          
+      - name: Copy Schemas
+        run: cp -rf schemas content/pages/
+          
+      - name: Build Site
+        uses: VaultVulp/action-pipenv@v2.0.1
+        with:
+          command: run menagerie generate
+          
+      - name: Upload Artifact
+        if: success() && github.ref == 'refs/heads/master'
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: out/
+          
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    name: Deploy Docs
+    needs: build
+    if: github.ref == 'refs/heads/master'
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1
+          

.github/workflows/main.yml

@@ -3,6 +3,8 @@ name: CI
 on:
   push:
     branches: [ master ]
+    paths-ignore:
+      - docs/**
   pull_request:
   workflow_dispatch:
 

.gitignore

@@ -355,3 +355,8 @@ healthchecksdb
 MigrationBackup/
 
 # End of https://www.gitignore.io/api/visualstudio
+
+# Docs Site
+
+docs/.m_cache/
+docs/out/

.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+    "cSpell.words": [
+        "decompiler",
+        "decompiling",
+        "Dependants",
+        "everytime",
+        "Untarget"
+    ]
+}

Readme.md

@@ -42,15 +42,7 @@ Refer to the sample mods in the source code for examples. These mods are not inc
 
 ### Get started
 
-1. Create a C# class library project targeting .Net Framework 4.8.
-2. Install the [OWML Nuget package](https://www.nuget.org/packages/OWML/).
-3. Reference the following files in {gamePath}\OuterWilds_Data\Managed:
-    * Assembly-CSharp.dll
-    * UnityEngine.CoreModule.dll
-    * More Unity DLLs if needed
-4. Inherit from ModBehaviour.
-	
-For more info, see [For modders](https://github.com/amazingalek/owml/wiki/For-modders).
+To get started, check out [our tutorial on the docs]("https://owml.outerwildsmods.com/guides/getting_started.html")
 
 ## Compatibility
 

docs/.env

@@ -0,0 +1,2 @@
+URL_PREFIX=/
+ENABLE_VIRTUAL_TERMINAL_PROCESSING=1

docs/Pipfile

@@ -0,0 +1,12 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+menagerie-docs = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.10"