Initial commit: MkDocs Material scaffold for SC6 UE4SS modding docs

Sets up a Markdown-only documentation site targeting Cloudflare Pages:
- MkDocs + Material theme with tabs/sections/admonitions/code copy
- Section stubs: getting-started, ue4ss, sc6, cookbook, reference
- Contributing guide with explicit rules for AI-agent contributors

Author: FottenSC

.gitignore

@@ -0,0 +1,14 @@
+# MkDocs build output
+site/
+
+# Python
+__pycache__/
+*.pyc
+.venv/
+venv/
+
+# Editors
+.vscode/
+.idea/
+*.swp
+.DS_Store

README.md

@@ -0,0 +1,50 @@
+# SoulCalibur VI Modding Docs
+
+Community documentation for modding **SoulCalibur VI** via the
+[UE4SS](https://github.com/UE4SS-RE/RE-UE4SS) framework.
+
+Built with [MkDocs Material](https://squidfunk.github.io/mkdocs-material/). Every page is plain
+Markdown under `docs/`. To add a page:
+
+1. Create `docs/<section>/<page>.md`
+2. Add it to `nav:` in `mkdocs.yml`
+3. Commit → Cloudflare Pages rebuilds and redeploys automatically
+
+See [`docs/contributing.md`](docs/contributing.md) for the full (short) guide — including the rules
+AI agents should follow when adding pages.
+
+## Local preview
+
+```bash
+pip install -r requirements.txt
+mkdocs serve
+# open http://127.0.0.1:8000
+```
+
+## Deployment — Cloudflare Pages
+
+No CI config is needed in this repo. Cloudflare Pages watches the GitHub repo and builds on every
+push to `main` (and produces a preview URL for every other branch / PR).
+
+One-time setup in the Cloudflare dashboard — **Workers & Pages → Create → Pages → Connect to Git**:
+
+| Setting | Value |
+|---|---|
+| Framework preset | *None* |
+| Build command | `pip install -r requirements.txt && mkdocs build --strict` |
+| Build output directory | `site` |
+| Root directory | *(leave blank)* |
+| Environment variable | `PYTHON_VERSION` = `3.12` |
+
+You'll get a `*.pages.dev` URL after the first build. Add a custom domain under the project's
+**Custom domains** tab if desired.
+
+### Why no GitHub Actions?
+
+Cloudflare Pages does the build itself when it detects a push — adding a GH Actions workflow would
+just duplicate that work. If you ever want to mirror to GitHub Pages as a backup, add a workflow
+back then.
+
+## License / disclaimer
+
+Community project. Not affiliated with BANDAI NAMCO or the UE4SS team.

docs/contributing.md

@@ -0,0 +1,47 @@
+# Contributing
+
+This site is deliberately easy to extend — it's just Markdown and one YAML file. That makes it
+friendly for both human contributors and AI agents.
+
+## Add a new page (the 30-second version)
+
+1. Create a new `.md` file under `docs/` in the right folder (e.g. `docs/cookbook/swap-mesh.md`).
+2. Add it to the `nav:` list in [`mkdocs.yml`](https://github.com/YOUR_USER/SC6ModdingDocs/blob/main/mkdocs.yml) so it shows up in the sidebar.
+3. Open a PR. CI will build the site; GitHub Pages / Cloudflare Pages will redeploy on merge.
+
+That's the whole workflow. You do **not** need to know JavaScript, React, Vue, or Astro.
+
+## Rules of thumb for AI agents
+
+When an AI agent is adding or editing pages, it should:
+
+- **Prefer Markdown primitives** — tables, fenced code blocks, bullet lists — over custom HTML.
+- **Use admonitions** for non-prose content:
+  ```
+  !!! warning "Title"
+      Body text.
+  ```
+  Supported: `note`, `tip`, `info`, `warning`, `danger`, `example`, `question`, `success`, `failure`.
+- **Label code fences** with a language (`lua`, `cpp`, `ini`, `json`, `text`) so syntax highlighting works.
+- **Link relatively** between pages (`../ue4ss/hooks.md`), never absolute URLs for in-site links.
+- **Keep page titles as H1** at the top of the file (`# Title`).
+- **Update `mkdocs.yml` `nav:`** whenever you add a new page — otherwise it's orphaned.
+- **Stub pages are fine**: add an `!!! info "Stub"` admonition and a TODO list so future passes know where to expand.
+- **Cite the source** of reversed info (dumper output, hook trace, disasm at address, etc.) in a `> source:` blockquote beneath the claim.
+
+## Local preview (optional)
+
+```bash
+pip install -r requirements.txt
+mkdocs serve
+```
+
+Open <http://127.0.0.1:8000> — the site live-reloads on save.
+
+## Build
+
+```bash
+mkdocs build   # outputs to ./site
+```
+
+CI does this for you on every push to `main`.

docs/cookbook/index.md

@@ -0,0 +1,32 @@
+# Cookbook
+
+Short, copy-pasteable recipes. Each recipe should be self-contained: what it does, the code, and a
+"verify it works" step.
+
+!!! tip "Adding a recipe"
+    Create a new `.md` file in this folder, add it to `nav:` in `mkdocs.yml`, and follow the template below.
+
+## Recipe template
+
+```markdown
+# Recipe: <Title>
+
+**Goal**: one-sentence description of what the user ends up with.
+
+**Requires**: UE4SS version, any other mods, dumper output, etc.
+
+## Code
+
+```lua
+-- your snippet
+```
+
+## How it works
+
+Short explanation of the hook/UObject used.
+
+## Verify
+
+1. Launch the game.
+2. Expected log line / visual result.
+```

docs/getting-started/first-mod.md

@@ -0,0 +1,54 @@
+# Your First Mod
+
+Goal: get a Lua mod that prints a line to the UE4SS console every time the game reaches the main menu.
+
+## 1. Scaffold the mod folder
+
+Inside `…\Win64\Mods\`, create:
+
+```
+Mods/
+└── HelloSC6/
+    ├── enabled.txt          (empty file — presence = enabled)
+    └── Scripts/
+        └── main.lua
+```
+
+## 2. Enable it in `mods.txt`
+
+Open `Mods\mods.txt` and add a line:
+
+```
+HelloSC6 : 1
+```
+
+The `1` means enabled.
+
+## 3. Write the Lua
+
+=== "main.lua"
+
+    ```lua
+    -- Mods/HelloSC6/Scripts/main.lua
+    local ModName = "HelloSC6"
+
+    print(("[%s] loaded"):format(ModName))
+
+    -- Fires once the first UWorld is ready.
+    RegisterHook("/Script/Engine.PlayerController:ClientRestart", function(PC)
+        print(("[%s] PlayerController ClientRestart"):format(ModName))
+    end)
+    ```
+
+## 4. Launch and verify
+
+1. Start SoulCalibur VI.
+2. Watch the UE4SS console — you should see `[HelloSC6] loaded` early, then the `ClientRestart` line once you're past the splash/title.
+
+!!! tip "Hot reload"
+    Press the configurable hotkey (default `Ctrl+R` in newer UE4SS builds) to re-run Lua mods without restarting the game.
+
+## Next
+
+- Learn the API: [UE4SS Framework → Lua API Overview](../ue4ss/lua-api.md)
+- Hook more events: [UE4SS Framework → Hooks & Events](../ue4ss/hooks.md)

docs/getting-started/index.md

@@ -0,0 +1,18 @@
+# Getting Started
+
+This section walks you from a clean SoulCalibur VI install to a running "hello world" UE4SS Lua mod.
+
+## Prerequisites
+
+- SoulCalibur VI (Steam, up-to-date)
+- Windows 10/11 (UE4SS is Windows-only at time of writing)
+- A text editor — VS Code recommended
+- A current UE4SS release: <https://github.com/UE4SS-RE/RE-UE4SS/releases>
+
+## Path through this section
+
+1. [Install UE4SS](install-ue4ss.md) — drop the loader into the game folder and confirm it loads.
+2. [Your First Mod](first-mod.md) — scaffold a Lua mod, enable it, and see a log line on game launch.
+
+Once both work, jump into the [UE4SS Framework](../ue4ss/index.md) section for API details, or the
+[Cookbook](../cookbook/index.md) for ready-made snippets.

docs/getting-started/install-ue4ss.md

@@ -0,0 +1,42 @@
+# Installing UE4SS into SoulCalibur VI
+
+!!! info "Stub page"
+    This page is a stub. Expand it with exact folder names, version notes, and troubleshooting
+    as the project matures. See [Contributing](../contributing.md).
+
+## 1. Download UE4SS
+
+Grab the latest **zDEV** or release zip from the [UE4SS releases page](https://github.com/UE4SS-RE/RE-UE4SS/releases).
+
+## 2. Locate the game's `Win64` folder
+
+The default Steam path is:
+
+```
+C:\Program Files (x86)\Steam\steamapps\common\SOULCALIBUR VI\SoulcaliburVI\Binaries\Win64\
+```
+
+## 3. Extract UE4SS
+
+Extract the contents of the zip **into that `Win64` folder**, so the following files sit next to the game's `.exe`:
+
+- `dwmapi.dll` (the proxy loader)
+- `UE4SS.dll`
+- `UE4SS-settings.ini`
+- `Mods/` folder
+
+## 4. First launch
+
+Launch the game. On first load you should see:
+
+- A console window titled **UE4SS**
+- A `UE4SS.log` file next to the dll
+- Any default mods (e.g. `BPModLoaderMod`, `shared`) listed as *enabled*
+
+## Troubleshooting
+
+- **No console appears** — ensure `GuiConsoleEnabled = 1` in `UE4SS-settings.ini`.
+- **Game crashes on boot** — try the non-dev build of UE4SS; some AOBs (array-of-bytes scans) can miss on a new game patch.
+- **DLL not loading** — verify the proxy DLL name matches what the game loads; `dwmapi.dll` is the usual default.
+
+Next: [Your First Mod](first-mod.md).

docs/index.md

@@ -0,0 +1,47 @@
+---
+title: SoulCalibur VI Modding Docs
+---
+
+# SoulCalibur VI Modding Docs
+
+Community documentation for modding **SoulCalibur VI** using the
+[UE4SS](https://github.com/UE4SS-RE/RE-UE4SS) (Unreal Engine 4/5 Scripting System) framework.
+
+!!! warning "Unofficial"
+    This project is **not** affiliated with BANDAI NAMCO or the UE4SS maintainers.
+    Mod at your own risk — never mod files online and keep clean backups of your game.
+
+## What you'll find here
+
+<div class="grid cards" markdown>
+
+-   :material-rocket-launch: **[Getting Started](getting-started/index.md)**
+
+    Install UE4SS into SoulCalibur VI and load your first Lua mod.
+
+-   :material-code-braces: **[UE4SS Framework](ue4ss/index.md)**
+
+    Lua API, hooks, UObject reflection, and dumper usage.
+
+-   :material-sword-cross: **[SoulCalibur VI Internals](sc6/index.md)**
+
+    Game-specific structures, character data, and notable functions.
+
+-   :material-book-open-variant: **[Cookbook](cookbook/index.md)**
+
+    Copy-pasteable recipes: modifying move data, swapping meshes, hot-reload loops.
+
+-   :material-library: **[Reference](reference/index.md)**
+
+    Glossary, addresses, and cross-cutting reference material.
+
+-   :material-handshake: **[Contributing](contributing.md)**
+
+    How to add a new page — designed so humans *and* AI agents can contribute.
+
+</div>
+
+## Quick links
+
+- UE4SS upstream: <https://github.com/UE4SS-RE/RE-UE4SS>
+- SoulCalibur VI on Steam: <https://store.steampowered.com/app/544750/>

docs/reference/glossary.md

@@ -0,0 +1,14 @@
+# Glossary
+
+| Term | Meaning |
+|---|---|
+| **AOB** | Array-of-bytes signature. A pattern UE4SS scans for at startup to locate engine functions. |
+| **BP / Blueprint** | Unreal's visual scripting. Packaged as `.uasset`/`.uexp`. |
+| **CDO** | Class Default Object. The template UObject Unreal uses to spawn new instances of a class. |
+| **DataTable** | Unreal asset holding rows of a USTRUCT schema. Common for move/parameter data. |
+| **FName** | Unreal's interned string type, 8 bytes, used for identifiers. |
+| **Pak / PAK** | Packaged content archive. SC6 reads game content from `.pak` files. |
+| **UE4SS** | Unreal Engine 4/5 Scripting System — injects Lua/BP modding into UE games. |
+| **UFunction** | A reflected Unreal function, hookable from Lua via `RegisterHook`. |
+| **UObject** | Root base class of Unreal's reflection system. |
+| **UStruct** | Reflected C++ struct. |

docs/reference/index.md

@@ -0,0 +1,5 @@
+# Reference
+
+Cross-cutting reference material that doesn't fit under a single topic.
+
+- [Glossary](glossary.md)