wtclaude
8963269ff0
Add docs/android/PLAN.md — the design contract for the RunicGateway/Android-app repo (planning only, no app code yet). Scope: native Kotlin + Jetpack Compose client of the website v1 API. Public content + public shard widgets (incl. SSE), native username/password + TOTP login, player self-service via a new role-agnostic /auth/me/* surface, and a player's own shard/game data. Excludes every admin/management console (hero editor, auth/provider admin, Discord bot, shard/uo-link ops). Key decisions captured: stay on v1 (all additions are additive, no v2); registration/invite/reset/SSO are website-handled hand-offs, not native screens; password reset is built on the backend + web front end first; single shard per install; minSdk 29; no telemetry and no offline cache in v1; text-only game data (paperdoll is future); strings externalized from day one; push via a self-hosted ntfy/UnifiedPush service with content-free tickles that keep the relay untrusted; Gitea Actions build on ubuntu:latest with a signed-APK release. Co-Authored-By: Claude <noreply@anthropic.com>
Runic Gateway — Documentation
Central documentation for the Runic Gateway platform. The docs here were extracted from the two code repositories (with full commit history preserved) so they live in one place, independent of either codebase.
Layout
website/ docs from the shard website (Node/Express + MariaDB + React/Vite)
link/ docs from the ServUO bridge (C# plugin + Rust sidecar + Node WS)
website/
| Doc | What it covers |
|---|---|
| BACKEND_DESIGN.md | API contract, DB schema, security model |
| HERO_EDITOR.md | Hero canvas editor feature spec |
| WIKI_UPGRADE.md | Wiki subsystem upgrade notes |
| website-README.md | Snapshot of the website repo's README (setup/run reference) |
link/
| Doc | What it covers |
|---|---|
| INTEGRATION.md | How the website integrates with the uo-link sidecar |
| PROTOCOL_2.md | Protocol 2.0 / 2.1 design |
| ADMIN_CONTROLS.md | Staff write-plane (kick/ban/broadcast, page queue) |
| SHARD_PREREQS.md | Shard-side prerequisites for the bridge |
| PLAN.md | uo-link build plan |
| RESEARCH.md | Research notes |
| link-README.md | Snapshot of the link repo's README |
Provenance
website/*was extracted fromRunicGateway/websiteviagit filter-repo.link/*was extracted fromRunicGateway/linkviagit filter-repo.
Commit history and authorship for each doc are preserved. The two source repos retain a short pointer to this repo in their own READMEs; the authoritative copy of each document now lives here.
License
Runic Gateway's documentation is free: licensed under the GNU General Public License v3.0 or later — see LICENSE.md.
Copyright (C) 2026 Runic Gateway
This documentation is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY. You may redistribute and/or modify it under the terms of
the GNU General Public License as published by the Free Software Foundation,
either version 3 of the License, or (at your option) any later version.
Contributions are welcome — please read CONTRIBUTING.md (note the AI-usage disclosure requirement) and our Code of Conduct.