Documentation tm

.github/workflows/pages.yml

@@ -0,0 +1,44 @@
+on:
+  push:
+    branches:
+      - main
+      - documentation-tm # for testing
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  actions: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  publish-docs:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Dotnet Setup
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: 8.x
+
+    - run: dotnet tool update -g docfx
+    - run: docfx docs/docfx.json
+
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        # Upload entire repository
+        path: 'docs/_site'
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

FodyWeavers.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
+  <Costura>
+    <IncludeAssemblies>
+            Scriban
+        </IncludeAssemblies>
+  </Costura>
+</Weavers>

PolyMod.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
         <TargetFramework>net6.0</TargetFramework>
         <ImplicitUsings>enable</ImplicitUsings>
@@ -20,6 +20,10 @@
 
     <ItemGroup>
         <PackageReference Include="BepInEx.Unity.IL2CPP" Version="6.0.0-be.738" />
+        <PackageReference Include="Costura.Fody" Version="6.0.0">
+          <PrivateAssets>all</PrivateAssets>
+        </PackageReference>
+        <PackageReference Include="Scriban" Version="6.2.1" />
         <PackageReference Include="TheBattleOfPolytopia" Version="$(PolytopiaVersion)-738" />
         <EmbeddedResource Include="resources\*.*" />
     </ItemGroup>
@@ -29,9 +33,9 @@
             <GeneratedText><![CDATA[
 namespace PolyMod
 {
-    public partial class Plugin
+    public partial class Constants
     {
-        internal const string VERSION = "$(Version)"%3B
+        internal const string POLYMOD_VERSION = "$(Version)"%3B
         internal static readonly Version POLYTOPIA_VERSION = new("$(PolytopiaVersion)")%3B
     }
 }

docs/.gitignore

@@ -0,0 +1,2 @@
+_site/
+api/

docs/MinorDatas.md

@@ -0,0 +1,126 @@
+# Minor Data Structures
+
+This page documents the smaller data structures found in the game's data file, including terrain, resources, tasks, skins, and diplomacy settings.
+
+---
+
+## Terrain Data (`terrainData`)
+
+Defines all possible terrain types in the game. Each terrain is an object within the `terrainData` section, keyed by its name. To add a new terrain, simply add a new entry with a unique name and `idx`.
+
+### Syntax
+
+```json
+"terrainData": {
+  "water": {
+    "idx": 1
+  },
+  "field": {
+    "idx": 3
+  }
+}
+```
+
+### Properties
+
+| Property | Type    | Description                                                                                                                                                             | Example Value |
+| :------- | :------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------ |
+| `idx`    | Integer | A unique integer index for the terrain type. When adding a new entry, it is recommended to set this value to **-1** to ensure uniqueness and prevent conflicts with game updates. | `"idx": 1`    |
+
+---
+
+## Resource Data (`resourceData`)
+
+Defines all possible resource types that can spawn on the map.
+
+### Syntax
+
+```json
+"resourceData": {
+  "game": {
+    "resourceTerrainRequirements": [
+      "forest"
+    ],
+    "idx": 1
+  }
+}
+```
+
+### Properties
+
+| Property                        | Type             | Description                                                                                                                                                               | Example Value                  |
+| :------------------------------ | :--------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :----------------------------- |
+| `resourceTerrainRequirements` | Array of Strings | An array of terrain IDs where this resource can naturally spawn.                                                                                                            | `["forest"]`                   |
+| `idx`                           | Integer          | A unique integer index for the resource type. When adding a new entry, it is recommended to set this value to **-1** to ensure uniqueness and prevent conflicts with game updates. | `"idx": 1`                     |
+
+---
+
+## Task Data (`taskData`)
+
+Defines special in-game achievements or "tasks" that unlock unique monuments upon completion.
+
+### Syntax
+
+```json
+"taskData": {
+  "pacifist": {
+    "improvementUnlocks": [
+      "monument1"
+    ],
+    "idx": 1
+  }
+}
+```
+
+### Properties
+
+| Property               | Type             | Description                                                                                                                                                            | Example Value         |
+| :--------------------- | :--------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------- |
+| `improvementUnlocks` | Array of Strings | An array of improvement IDs (usually a monument) unlocked when this task is completed.                                                                                 | `["monument1"]`       |
+| `idx`                  | Integer          | A unique integer index for the task. When adding a new entry, it is recommended to set this value to **-1** to ensure uniqueness and prevent conflicts with game updates. | `"idx": 1`            |
+
+---
+
+## Skin Data (`skinData`)
+
+Defines alternate appearances (skins) for tribes. A tribe must list the skin's key in its `skins` array to use it.
+
+### Syntax
+
+```json
+"skinData": {
+  "swamp" : {
+    "color" : 6786096,
+    "language": "bub,ly,sq,ee,to,ad"
+  }
+}
+```
+
+### Properties
+
+| Property   | Type    | Description                                                                         | Example Value                        |
+| :--------- | :------ | :---------------------------------------------------------------------------------- | :----------------------------------- |
+| `color`    | Integer | An integer representing the skin's primary color, overriding the tribe's default.   | `"color": 6786096`                   |
+| `language` | String  | A comma-separated string of syllables, overriding the tribe's default language.     | `"language": "bub,ly,sq,ee,to,ad"` |
+
+---
+
+## Diplomacy Data (`diplomacyData`)
+
+Contains key-value pairs that define the global game mechanics for diplomacy, such as embassies.
+
+### Syntax
+
+```json
+"diplomacyData": {
+  "embassyCost" : 5,
+  "embassyIncome" : 2,
+  "embassyMaxLevel" : 3,
+  "embassyUpgradeCost" : 20
+}
+```
+
+### Properties
+
+| Property               | Type    | Description                                                       | Example Value          |
+| :--------------------- | :------ | :--------------------------------------------------------

docs/articles/introduction.md

@@ -0,0 +1,7 @@
+# Introduction
+
+Polymod is the modding framework for The Battle Of Polytopia.
+
+If you would like information about how to **develop** mods, go to [modding](modding/your-first-mod.md).
+
+If you would like information about how to use and configure PolyMod and its mods, go to [using](using/installing.md)