RunicGateway/link
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 4 Wiki Activity

Protocol 2.0 + 2.1 — account provisioning, world-state streams, Town Cryer news #7

Merged
whitlocktech merged 8 commits from feat/protocol2-account-provisioning into main 2026-07-17 16:37:29 +00:00
Conversation 1 Commits 8 Files Changed 18 +2772 -17
wtclaude commented 2026-07-17 16:28:02 +00:00
Member
Copy Link

Implements Protocol 2.0 (account provisioning + social/political world-state streams) and 2.1 (Town Cryer news gump), per docs/PROTOCOL_2.md. All script-layer — no core/stock ServUO edits, no new patches.

Part A — account provisioning & unlinking

  • account.create (POST /accounts/create) — website mints a game account and links it in one step. Reuses the shard's own char-safety validation and per-IP cap (CanCreate/LogAccess), fails closed on a missing/loopback IP, refuses duplicates. Password never logged or echoed.
  • Unlink — account.unlink (DELETE /link/{account}, Owner-floor guarded, clears the sidecar mirror) and an in-game [unlink.
  • Signup modes — Bridge.SignupMode = website / game / hybrid (default), with a boot warning when the core Accounts.AutoCreateAccounts contradicts the mode.
  • Sidecar PROTOCOL_VERSION → 2 (outbound events stay additive; new endpoints require v2).

Part B — social & political world-state streams

Diff-board sweeps mirroring the existing champ board (full-state upsert on change, re-emit on reconnect, served from SQLite so a fresh page / restarted sidecar hydrates without the shard):

  • Guilds — guild.update/remove + real-time guild.join; GET /guilds.
  • Governors ("mayors") — city.update from the City Loyalty system; GET /governors.
  • Presence — presence.online (total + per-facet + per-region) + real-time region.enter; GET /online.
  • Housing registry — house.update/remove (owner/decay/co-owners/price); GET /houses.
  • Titles — a titles block added to char.profile.
  • (Factions/VvV deferred by owner decision.)

Protocol 2.1 — Town Cryer news

  • news.add/news.remove (POST /news, DELETE /news/{id}) — website articles (title, HTML body, image, URL) go into the modern Town Cryer News gump (TownCryerSystem.NewsEntries), and the criers proclaim the title in-world (default on). Pure overlay — inserts into the public list and tracks its own entries, leaving stock news intact. Sidecar re-pushes articles on shard reconnect (website is source of truth).

Verification

  • Sidecar cargo check clean; overlay compiles in the full ServUO Scripts tree (0 errors, 0 warnings).
  • Live smoke test (booted shard + real sidecar, docs/PROTOCOL_2.md §15): Part A create/dup/IP-cap(429 at the shard's real limit)/loopback/unlink all correct; /houses (28), /governors (9 cities), /guilds, /online, /char titles all returned; news add/replace/remove/error + the reconnect replay verified end-to-end.
  • Not exercised (needs a live UO client): presence.online with real players, region.enter, real-time guild.join, char.vitals, and gump rendering (verified by source inspection).

Notes

  • docs/INTEGRATION.md documents every new event/endpoint; docs/PROTOCOL_2.md is the full design + verification log.
  • One operational gotcha documented: the boot-time Dynamic recompile can't replace Scripts.dll while the server holds ServUO.exe locked — build Scripts.csproj with the server stopped, then boot.

🤖 Generated with Claude Code

Implements **Protocol 2.0** (account provisioning + social/political world-state streams) and **2.1** (Town Cryer news gump), per `docs/PROTOCOL_2.md`. All script-layer — **no core/stock ServUO edits, no new patches**. ## Part A — account provisioning & unlinking - **`account.create`** (`POST /accounts/create`) — website mints a game account and links it in one step. Reuses the shard's own char-safety validation and per-IP cap (`CanCreate`/`LogAccess`), fails closed on a missing/loopback IP, refuses duplicates. Password never logged or echoed. - **Unlink** — `account.unlink` (`DELETE /link/{account}`, Owner-floor guarded, clears the sidecar mirror) **and** an in-game `[unlink`. - **Signup modes** — `Bridge.SignupMode` = `website` / `game` / `hybrid` (default), with a boot warning when the core `Accounts.AutoCreateAccounts` contradicts the mode. - Sidecar `PROTOCOL_VERSION` → **2** (outbound events stay additive; new endpoints require v2). ## Part B — social & political world-state streams Diff-board sweeps mirroring the existing champ board (full-state upsert on change, re-emit on reconnect, served from SQLite so a fresh page / restarted sidecar hydrates without the shard): - **Guilds** — `guild.update`/`remove` + real-time `guild.join`; `GET /guilds`. - **Governors** ("mayors") — `city.update` from the City Loyalty system; `GET /governors`. - **Presence** — `presence.online` (total + per-facet + per-region) + real-time `region.enter`; `GET /online`. - **Housing registry** — `house.update`/`remove` (owner/decay/co-owners/price); `GET /houses`. - **Titles** — a `titles` block added to `char.profile`. - *(Factions/VvV deferred by owner decision.)* ## Protocol 2.1 — Town Cryer news - **`news.add`/`news.remove`** (`POST /news`, `DELETE /news/{id}`) — website articles (title, HTML body, image, URL) go into the modern Town Cryer **News gump** (`TownCryerSystem.NewsEntries`), and the criers proclaim the **title** in-world (default on). Pure overlay — inserts into the public list and tracks its own entries, leaving stock news intact. Sidecar re-pushes articles on shard reconnect (website is source of truth). ## Verification - Sidecar `cargo check` clean; overlay compiles in the full ServUO Scripts tree (**0 errors, 0 warnings**). - **Live smoke test** (booted shard + real sidecar, `docs/PROTOCOL_2.md §15`): Part A create/dup/IP-cap(429 at the shard's real limit)/loopback/unlink all correct; `/houses` (28), `/governors` (9 cities), `/guilds`, `/online`, `/char` titles all returned; news add/replace/remove/error + the reconnect replay verified end-to-end. - **Not exercised** (needs a live UO client): `presence.online` with real players, `region.enter`, real-time `guild.join`, `char.vitals`, and gump *rendering* (verified by source inspection). ## Notes - `docs/INTEGRATION.md` documents every new event/endpoint; `docs/PROTOCOL_2.md` is the full design + verification log. - One operational gotcha documented: the boot-time `Dynamic` recompile can't replace `Scripts.dll` while the server holds `ServUO.exe` locked — build `Scripts.csproj` with the server stopped, then boot. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
wtclaude added 8 commits 2026-07-17 16:28:04 +00:00
feat(protocol2): website account provisioning & unlinking (Part A) 808f6ab68b 
Adds the account-provisioning plane from docs/PROTOCOL_2.md Part A: the
website can create game accounts and unlink them, gated by a shard-wide
signup mode. The existing [link flow is unchanged.

Overlay:
- BridgeConfig: SignupMode (website|game|hybrid, default hybrid; unrecognized
  falls back to game), AccountCreateEnabled (mode-following default),
  RequireIpForCreate, name/password caps, and a boot warning when the core
  Accounts.AutoCreateAccounts setting contradicts the mode.
- BridgeAccounts (new): account.create (mode gate, actor required, char-safety
  mirrored from AccountHandler, collision check, per-IP cap via CanCreate/
  LogAccess with fail-closed missing/loopback IP, create + WebsiteUserId link,
  account.audit; password never logged or echoed) and account.unlink (Owner
  floor via BridgeAdmin.Protected, clears the tag).
- BridgeAccountLink: in-game [unlink command, emits account.unlinked.
- BridgeAdmin: Protected / ResolveTargetAccount promoted to public for reuse.

Sidecar:
- POST /accounts/create, DELETE /link/:account, respond_account status mapping
  (409 collision / 429 ip cap / 403 disabled|protected / 404 not-linked / 400).
- store.record_unlink drops the mirrored link row.
- PROTOCOL_VERSION -> 2 (outbound events additive; new endpoints need v2).

Docs: INTEGRATION.md protocol bump, account.* events, endpoints, 409/429;
PROTOCOL_2.md Part A marked built.

Verified: sidecar cargo check clean; overlay compiles in the full ServUO
Scripts tree (0 errors, 0 warnings). Live end-to-end run still pending.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
feat(protocol2): guild and town-governor world-state streams (Part B ph.1) 2ed0b0bd00 
Adds the first Part B streams from docs/PROTOCOL_2.md: guild rosters and
town governors ("mayors"), both outbound diff-board sweeps mirroring the
existing champ board.

Overlay:
- BridgeSocial (new): guild sweep+diff over BaseGuild.List -> guild.update /
  guild.remove (full-state upsert; disband detected via Disbanded), plus a
  real-time guild.join from EventSink.JoinGuild. (EventSink.CreateGuild is only
  the load-time factory, so creation is derived sidecar-side from a first-seen
  id, as champs do.)
- BridgeGovernance (new): city sweep over CityLoyaltySystem.Cities -> city.update
  (governor / governor-elect / election phase), gated on CityLoyaltySystem.Enabled.
- BridgeJson.Actor: shared serial/name/acct/webId/player writer used by both.
- BridgeConfig: GuildSweepSeconds (60s), CitySweepSeconds (300s).
- BridgeBoot: both wired into [bridge reload|sweepnow|status.

Sidecar:
- store: guilds + governors board tables with upsert/delete/all.
- main: route guild.update/remove and city.update into the boards.
- web: GET /guilds, GET /governors served from the store (snapshot-companion
  rule, so a fresh page or a restarted sidecar hydrates without the shard).

Docs: INTEGRATION.md event catalog (guild.*, city.update) + board endpoints;
PROTOCOL_2.md Part B phase 1 marked built.

Verified: sidecar cargo check clean; overlay compiles in the full ServUO
Scripts tree (0 errors, 0 warnings). Live end-to-end run still pending.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
feat(protocol2): presence stream — online population + region transitions (Part B ph.2) d47170581d 
Overlay BridgePresence (new):
- presence.online sweep over online PlayerMobiles: total plus per-facet and
  per-region counts, emitted only when the population changes.
- region.enter real-time from EventSink.OnEnterRegion (player-filtered), the
  cheap location signal PLAN.md prefers over Movement.
- PresenceSweepSeconds (30s); wired into [bridge reload|sweepnow|status.

Sidecar:
- GET /online serves the latest presence.online snapshot from the event store
  (survives restart); population time series via /history?kind=presence.online.

Docs: INTEGRATION.md presence events + /online endpoint; PROTOCOL_2 ph.2 built.

Verified: sidecar cargo check clean; overlay compiles in the full ServUO
Scripts tree (0 errors, 0 warnings). Live run pending.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
feat(protocol2): house registry board (Part B ph.3) b858d526b8 
Overlay BridgeHousing (new): a diff sweep over BaseHouse.AllHouses ->
house.update / house.remove (owner, region, location, decay level, co-owners,
friends, placement price), complementing the existing house.decay transition
feed. HousingSweepSeconds (300s); wired into [bridge reload|sweepnow|status.
Stock ServUO has no "for sale" flag, so this is an owner->houses registry;
price is the placement value, not a listing.

Sidecar: houses board table with upsert/delete/all; main routes house.update/
remove into it; GET /houses served from the store.

Docs: INTEGRATION.md house.* events + /houses endpoint; PROTOCOL_2 ph.3 built.

Verified: sidecar cargo check clean; overlay compiles in the full ServUO
Scripts tree (0 errors, 0 warnings). Live run pending.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
feat(protocol2): titles in char.profile (Part B ph.4) e0445d3f94 
Overlay BridgeProfile: char.profile gains a titles block (selected index,
fameKarma, skill, and the raw reward-title list) read from PlayerMobile's
public title accessors. No new stream, no sidecar change — it rides the
existing char.profile served by GET /char. Reward entries may be a cliloc
number as a string or a literal; resolve numeric ones website-side like item
names.

Docs: INTEGRATION.md char.profile titles field; PROTOCOL_2 ph.4 built. Part B
phase 5 (Factions/VvV) remains deferred by owner decision.

Verified: overlay compiles in the full ServUO Scripts tree (0 errors, 0
warnings). Live run pending.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
docs(protocol2): record live smoke-test results 92374ba15c 
Booted ServUO + the real sidecar (protocol 2, plugin connected) and exercised
every Protocol 2.0 endpoint end-to-end. PROTOCOL_2.md §15 records the results:

- Part A: account.create 200 + link; duplicate 409; per-IP cap enforced at the
  shard's real AccountsPerIp=3 (4th from one IP -> 429); loopback IP -> 400
  (fail-closed); unlink 200 then lookup 404.
- Part B: /houses (28, full data), /governors (9 cities), /guilds ([]),
  /online (count 0, headless), /char titles block present.

Not exercised (needs a live UO client): presence.online with players,
region.enter, real-time guild.join, char.vitals. Also documents the
Scripts.dll boot-recompile lock quirk (build offline with the server stopped).
World save left untouched; test accounts did not persist.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
docs(protocol2): add Town Cryer news-gump integration design (§16) 6f76a8d35f 
Adds §16: sync website news articles into the modern Town Cryer News gump
(TownCryerSystem.NewsEntries), distinct from the Protocol 1.0 scrolling-crier
lines (GlobalTownCrierEntryList). Grounded in the shard's Town Cryer source.

Key findings / decisions:
- NewsEntries is a public mutable List and TownCryerNewsEntry's ctor is public,
  and the display gumps already branch on Title/Body .Number>0 (cliloc) vs
  string (AddLabelCropped / AddHtml with HTML support). So website content
  needs NO gump changes and NO stock patch — the overlay inserts/removes
  directly and tracks its own entries, leaving stock uo.com news intact.
  (Refines the pasted guidance, which proposed adding methods to the stock
  TownCryerSystem.cs = a patch.)
- Ties the two surfaces together: full article -> news gump; crier "says" just
  the title via the existing GlobalTownCrierEntryList path.
- news.add/news.remove verbs (id-correlated, idempotent), POST /news +
  DELETE /news/{id}; website is source of truth, re-synced on shard reconnect
  since NewsEntries isn't persisted across reboot.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
feat(protocol2): Town Cryer news-gump integration (§16, Protocol 2.1) fd9c9fd96a 
Website news articles now land in the modern Town Cryer News gump
(TownCryerSystem.NewsEntries), separate from the scrolling-crier lines.

Overlay BridgeNews (new): news.add / news.remove insert/remove a
TownCryerNewsEntry directly in the public NewsEntries list (no stock edit),
tracking our own id->entry map so stock uo.com news is left intact. Title,
HTML body, image, and URL are all supported (the stock gumps already branch on
TextDefinition.Number, so string content renders). On add the article title is
also proclaimed via GlobalTownCrierEntryList (announce defaults on; set
announce:false to suppress). Config caps: NewsMaxTitleLength/BodyLength/
External, NewsAnnounceDurationSec.

Sidecar: POST /news (add/replace, id-correlated), DELETE /news/{id}; news table
stores each article as its news.add command; on shard server.hello the sidecar
replays the stored set with announce:false (the shard rebuilds NewsEntries each
boot and does not persist ours, so the website is the source of truth).

Docs: PROTOCOL_2 §16 (design + verified), INTEGRATION.md /news endpoints.

Verified live: sidecar cargo check clean; overlay compiles in the full ServUO
Scripts tree (0 errors); booted shard + sidecar and exercised add/replace/
remove/error paths and the reconnect replay end-to-end.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
whitlocktech approved these changes 2026-07-17 16:37:16 +00:00
whitlocktech merged commit 484bc33706 into main 2026-07-17 16:37:29 +00:00
whitlocktech deleted branch feat/protocol2-account-provisioning 2026-07-17 16:37:29 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
whitlocktech
Labels
Clear labels
bug
Something is not working
duplicate
This issue or pull request already exists
enhancement
New feature
help wanted
Need some help
invalid
Something is wrong
question
More information is needed
wontfix
This won't be fixed
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
ksfixitman whitlocktech wtclaude
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: RunicGateway/link#7
No description provided.
Delete Branch "feat/protocol2-account-provisioning"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?