Files

wtclaude afcdb373ec docs(website): an operator runbook for extracting from your own UO client

CLILOCS.md and SPAWN_ATLAS.md each explain WHY the operator has to supply
something out of their own client, but neither says how. UOFIDDLER.md is the
missing procedure: where to get UOFiddler, which two files in the zip matter,
which runtime it needs, where Cliloc.enu actually lives, the conversion, how to
point the site at the result, and how to confirm it took.

Verified end to end on a stock Windows box: UOFiddler 4.22.2 (Ultima.dll is
net10.0), .NET SDK 9.0.312 building the net8.0 converter, RollForward carrying
it onto runtime 10.0.8, and the site's own parser reading the output back.

Corrects one claim while doing it. CLILOCS.md said a UOFiddler GUI export
"works equally well"; it does not. Its Cliloc tab writes `Number;Text;Flag` --
three columns, flag LAST -- and parseClilocText splits on the first separator
only, so the flag is absorbed into the name and every item renders as
`quarter staff;0`. The parser already handles `number,flag,text` with the flag
in the middle, but a trailing `;0` is indistinguishable from a name that
genuinely ends that way, so this stays a documented `sed` on the operator's
side rather than a heuristic that would corrupt real names.

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

2026-07-30 03:34:29 -05:00

4.0 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
UOFIDDLER.md	Operator runbook — step-by-step extraction from your own UO client (cliloc table, creature art)
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.

4.0 KiB Raw Blame History