Files

wtclaude 6ce60a82c3 docs(link): the player-vendor marketplace (Protocol 3.0 §8)

Documents order 5b across the four repos, and records what building it changed
about §8 as designed.

- NEW website/MARKETPLACE.md — the operator guide: what the pages must say out
  loud and why, the privacy contract (the player's in-game Vendor Search toggle
  wins, and no admin setting overrides it), the Bridge.cfg knobs and how they
  trade against each other, and the measured sweep costs.
- INTEGRATION.md — catalog entry for vendor.listing / vendor.listing.remove with
  its six consumer gotchas, and the GET /market REST section (the sidecar's only
  paged read, and why it orders by serial rather than shop name).
- BACKEND_DESIGN.md — shard_vendors / shard_vendor_items, the routes, and the
  marketplace search as the only rate-limited public read.
- SHARD_VISIBILITY.md — why the market's fields default to Everyone (the in-game
  gump already shows exactly that set), why location is one setting covering
  four things, and why hiding the owner name without the owner id achieves
  nothing.
- PLAN.md — the amortized round-robin as the one sweep pattern the bridge did not
  previously have, and an update to §7's cliloc note: pushing name resolution to
  the plugin was never an option, because ServUO cannot read a modern client's
  compressed cliloc files either.
- v3.md §8.8 — the four things the build settled differently, chief among them
  that §8.1's FLAT location payload would have made Part A's pre-wired
  market.location rule inert, exactly like the characterName miss one part
  earlier.

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

2026-07-29 09:52:14 -05:00

3.9 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
SHARD_VISIBILITY.md	Who sees which shard data — the admin-configurable audience framework
SPAWN_ATLAS.md	The bestiary / spawn atlas: what the shard contains, parsed from its own ServUO tree
CLILOCS.md	UO's id → name table: converting one from your client so items have names
MARKETPLACE.md	The player-vendor index: how it is gathered, what it costs, how to tune it
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.9 KiB Raw Blame History