Files

wtclaude 6622afe4bd docs(link): add the Protocol 3.0 design

Surveys the live ServUO tree against everything the bridge already
surfaces and records the full gap list (17 items), then specs the four
features scoped for 3.0.

3.0 has three scope areas:

- A: the visibility framework. Admin-configurable, per-feature and
  per-field audience control over all ten shard-derived surfaces (the
  four new ones plus the six that already ship), on an
  anonymous -> logged_in -> player -> staff -> admin ladder. Every
  default reproduces today's behavior, so the retrofit is a no-op until
  an admin changes something. Two rules an admin cannot override: acct
  and webId are admin-only always, and an unmapped event kind is never
  broadcast below admin. This also fixes a verified leak - guild leader
  acct/webId are readable today on the anonymous /public/shard/guilds.
- B: three new wire streams - world.ruleset, points.board, and
  vendor.listing/vendor.listing.remove.
- C: the spawn atlas, built from static ServUO data files with no wire
  involvement.

Visibility lives entirely on the website; the sidecar stays a dumb
forwarder that defines no access parameters and advertises no
capabilities.

PROTOCOL_VERSION goes 2 -> 3 once, at the end: every part PRs into an
edge branch per repo, and the coordinated edge -> main merge is the
cutover. A schema migration moves uo_link_config.protocol so operators
don't have to.

Co-Authored-By: Claude <noreply@anthropic.com>

2026-07-28 09:28:04 -05:00

3.4 KiB

Raw Blame History

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)
android/   docs from the native Android client (Kotlin + Jetpack Compose)
ci/        cross-cutting CI/quality notes

`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)
PROJECT_TREE.md	Auto-generated snapshot of the repo's tracked file layout

`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
v3.md	Protocol 3.0 design — shard content/standings streams + the visibility framework
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
PROJECT_TREE.md	Auto-generated snapshot of the repo's tracked file layout

`android/`

Doc	What it covers
PLAN.md	Android client build plan / milestones
COVERAGE_PLAN.md	Test-coverage rollout plan
APP_LINKS.md	Android App Links / deep-link setup
theme-plan.md	Theming plan
TRUSTED_DEVICES_APP_HANDOFF.md	Trusted-devices app handoff notes
PROJECT_TREE.md	Auto-generated snapshot of the repo's tracked file layout

Provenance

website/* was extracted from RunicGateway/website via git filter-repo.
link/* was extracted from RunicGateway/link via git 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.

3.4 KiB Raw Blame History