chore: documentation

Author: BenMcAvoy

.github/workflows/docs.yml

@@ -0,0 +1,85 @@
+name: Docs
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+  pull_request:
+    branches: [ main ]
+    paths:
+      - 'docs/**'
+      - '.github/workflows/docs.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    outputs:
+      pages_enabled: ${{ steps.pages.outputs.enabled }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v2
+        with:
+          mdbook-version: latest
+
+      - name: Build docs
+        run: mdbook build docs
+
+      - name: Check Pages status
+        if: github.event_name == 'push'
+        id: pages
+        uses: actions/github-script@v7
+        with:
+          script: |
+            try {
+              await github.rest.repos.getPages({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+              });
+              core.setOutput('enabled', 'true');
+            } catch (error) {
+              if (error.status === 404) {
+                core.notice('GitHub Pages is not enabled. Enable it in Settings -> Pages with Source set to GitHub Actions, then rerun this workflow.');
+                core.setOutput('enabled', 'false');
+              } else {
+                throw error;
+              }
+            }
+
+      - name: Setup Pages
+        if: github.event_name == 'push' && steps.pages.outputs.enabled == 'true'
+        uses: actions/configure-pages@v5
+
+      - name: Upload Pages artifact
+        if: github.event_name == 'push' && steps.pages.outputs.enabled == 'true'
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/book
+
+  deploy:
+    if: github.event_name == 'push' && needs.build.outputs.pages_enabled == 'true'
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -3,4 +3,9 @@ x64
 *.vcxproj.*
 RivetDoorstop.ini
 vcpkg_installed
-.idea
+.idea
+.scratch/
+.cargo/
+.tools/
+docs/book/
+docs/*.log

README.md

@@ -1,26 +1,23 @@
 # Rivet
 
-Rivet is a modding toolkit for Scrap Mechanic. It gives you a clean way to inject DLLs into the game process and to load mods in a structured, discoverable way.
+Rivet is a native modding toolkit for Scrap Mechanic. It injects a loader into the game process, loads mod DLLs from a configured directory, and gives mods shared event and hook APIs so they can coordinate without overwriting each other.
 
-At a high level Rivet consists of:
+Rivet consists of:
 
-- `RivetDoorstop`: gets a DLL into the game as early as possible using DLL hijacking. You can imagine this alike to [Unity Doorstop](https://github.com/NeighTools/UnityDoorstop).
-- `RivetLoader`: discovers and loads mods, using metadata and interfaces where available. You can imagine this like [BepInEx](https://github.com/BepInEx/BepInEx).
-- `RivetLib`: the library that mods use to integrate with Rivet, similar in spirit to how BepInEx and Harmony are used for Unity. You can imagine this like [BepInEx's API](https://docs.bepinex.dev/api/index.html) and [Harmony](https://github.com/pardeike/Harmony).
+- `RivetDoorstop`: a `version.dll` proxy that loads Rivet into the game process.
+- `RivetLoader`: the runtime loader that discovers mods, owns hooks, and dispatches events.
+- `RivetLib`: the public headers mods include to use Rivet APIs.
 
-If you just want to get started, the [Installation Guide](./docs/installation.md) walks through setting up Rivet for a game, and the [Overview](./docs/overview.md) explains how these pieces fit together.
+Documentation lives in [`docs/`](./docs/src/introduction.md), is built with mdBook, and publishes to GitHub Pages.
 
 > [!WARNING]
 > Currently under heavy development, not ready for real use.
 
-> [!NOTE]
-> Please refer to the [Installation Guide](./docs/installation.md) to set up Rivet for Scrap Mechanic. There is also an [Overview](./docs/overview.md) document that explains how Rivet works and what each component does.
-
 ## Thanks
 
 This project would not exist without the help and feedback of many people.
 
 - [@VeraDev0](https://github.com/VeraDev0): For contributing to the repository and helping development
 - [@QuestionableM](https://github.com/QuestionableM): For helping with proxying knowledge (e.g. for prompting me to look into asm thunks for proxying DLL exports).
 - [@crackx02](https://github.com/crackx02): For helping debug various issues with the DLL loading process.
-- Everyone in the [@ReDoIngMods](https://github.com/ReDoIngMods) organization for ideas, testing, and general support.
+- Everyone in the [@ReDoIngMods](https://github.com/ReDoIngMods) organization for ideas, testing, and general support.

docs/book.toml

@@ -0,0 +1,27 @@
+[book]
+title = "Rivet"
+description = "A modding framework"
+authors = ["Ben McAvoy"]
+language = "en"
+src = "src"
+
+[output.html]
+default-theme = "navy"
+preferred-dark-theme = "navy"
+git-repository-url = "https://github.com/ReDoIngMods/Rivet"
+edit-url-template = "https://github.com/ReDoIngMods/Rivet/edit/main/docs/src/{path}"
+no-section-label = true
+
+[output.html.fold]
+enable = true
+level = 1
+
+[output.html.search]
+enable = true
+limit-results = 30
+use-boolean-and = true
+boost-title = 2
+boost-hierarchy = 1
+boost-paragraph = 1
+expand = true
+heading-split-level = 3

docs/config.md

@@ -0,0 +1,27 @@
+# Summary
+
+[Introduction](introduction.md)
+
+# Getting Started
+
+- [Installation](getting-started/installation.md)
+- [Writing Your First Mod](getting-started/writing-your-first-mod.md)
+
+# Guides
+
+- [The Event System](guides/events.md)
+- [The Hook System](guides/hooks.md)
+- [Mod Lifecycle](guides/mod-lifecycle.md)
+
+# Reference
+
+- [Built-in Events](reference/built-in-events.md)
+- [Configuration](reference/configuration.md)
+- [Versioning](reference/versioning.md)
+
+# Internals
+
+- [Architecture](internals/architecture.md)
+- [The Loader](internals/loader.md)
+- [Doorstop](internals/doorstop.md)
+- [Cross-DLL Type Identity](internals/type-identity.md)

docs/installation.md

@@ -0,0 +1,23 @@
+# Installation
+
+This page is for end users who want to play modded games. If you are writing a mod, see [Writing Your First Mod](writing-your-first-mod.md).
+
+## Steps
+
+1. **Download Rivet.** Grab the latest release from the [releases page](https://github.com/ReDoIngMods/Rivet/releases) (e.g. `Rivet_0.1.0-alpha.zip`).
+2. **Extract the archive** to a temporary location.
+3. **Copy the files into your game's directory.** This is the folder containing the game's `.exe`. In Steam you can find it via *right-click the game in your library -> Properties -> Installed Files -> Browse*.
+4. **Launch the game.** Rivet will automatically create a `Rivet.ini` file in the game directory on first run.
+5. **(Optional) Configure Rivet** by editing `Rivet.ini` or by passing CLI flags. See [Configuration](../reference/configuration.md) for the full list of options.
+
+## Verifying it worked
+
+When Rivet starts, it opens a console window logging the loader status and any mods that were found. If the console does not appear, check that:
+
+- The game directory contains both `version.dll` (Doorstop) and `Rivet.dll` (the loader).
+- `Doorstop.enable=true` is set in `Rivet.ini`, or `-rivetEnable` is passed on the command line.
+- No antivirus is quarantining the DLLs (Rivet's hooking can look suspicious to some scanners).
+
+## Updating
+
+To update, replace the Rivet files in the game directory with the new release. Your `Rivet.ini` and the `Mods` directory are not touched.