Compare commits
11 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 79cc611ee0 | |||
| d57d9aad84 | |||
| 8c6db9f0d5 | |||
| 65562eea40 | |||
| cc4f58317e | |||
| 0eda2d3a97 | |||
| 48b16dc70e | |||
| c045bdd566 | |||
| 8828382e41 | |||
| 7fa8953ffa | |||
| 4720a214a2 |
@@ -51,18 +51,22 @@
|
||||
#
|
||||
# Prerequisites (Settings → Actions → Secrets on RunicGateway/servuo-plugins):
|
||||
# REGISTRY_TOKEN — Gitea access token with `write:repository`, to push the
|
||||
# tag and create the release.
|
||||
# tag and create the release. The final step also dispatches
|
||||
# RunicGateway/installer's bundle workflow, so the token
|
||||
# ideally has write there too — a nicety, not a requirement:
|
||||
# without it the step warns and that repo's nightly cron
|
||||
# picks the release up instead.
|
||||
# REGISTRY_USER — the Gitea username that token belongs to.
|
||||
#
|
||||
# These are checked by an explicit preflight step rather than left to fail
|
||||
# wherever they happen to be used first — see the comment on that step for why
|
||||
# an absent token does NOT simply fail the tag push.
|
||||
#
|
||||
# TODO (Phase 0 item 3): once the installer repo's bundle workflow exists, append
|
||||
# a final step here that POSTs to its workflow-dispatch endpoint, so a new
|
||||
# overlay release recomposes the bundle immediately instead of waiting for the
|
||||
# nightly cron (PLAN.md §7.2). Deliberately absent until there is something to
|
||||
# dispatch — a step that 404s every release is worse than no step.
|
||||
# The final step POSTs to the installer repo's bundle workflow, so a new overlay
|
||||
# release recomposes the compat matrix immediately instead of waiting for that
|
||||
# repo's nightly cron (PLAN.md §7.2). It was deliberately absent until Phase 0
|
||||
# item 3 landed something to dispatch — a step that 404s on every release is
|
||||
# worse than no step.
|
||||
|
||||
name: Release overlay
|
||||
|
||||
@@ -84,6 +88,9 @@ env:
|
||||
# house style set by link (pre-1.0; the release version is independent of the
|
||||
# protocol version, which lives in overlay.toml).
|
||||
SEED_VERSION: "0.1.0"
|
||||
# Notified after a release so the installer's compat matrix picks up this
|
||||
# overlay immediately rather than at its next nightly run (PLAN.md §7.2).
|
||||
INSTALLER_REPO: RunicGateway/installer
|
||||
|
||||
jobs:
|
||||
release:
|
||||
@@ -256,6 +263,10 @@ jobs:
|
||||
# needing the target files present.
|
||||
# • each patch's companion .cs must exist, since it references symbols
|
||||
# the patch introduces and is meaningless without it (PLAN.md §2.2).
|
||||
# • patches/tier.json must describe every .patch and nothing but. That
|
||||
# table is what tells the installer which patches form one unit, which
|
||||
# companion follows which, and whether a CORE rebuild is needed — a
|
||||
# patch added without it would be shipped and silently never offered.
|
||||
- name: Validate the overlay and patch tier
|
||||
if: ${{ steps.plan.outputs.release == 'true' }}
|
||||
run: |
|
||||
@@ -276,11 +287,46 @@ jobs:
|
||||
git apply --stat "$p" || fail "${p} is not a parseable unified diff"
|
||||
done
|
||||
|
||||
# Companion files that can only be copied after their patch lands.
|
||||
for f in patches/BridgeVendorSale.cs patches/BridgeModerationAudit.cs; do
|
||||
[ -f "$f" ] || fail "${f} is missing (a patch's companion source)"
|
||||
# The tier table, checked in BOTH directions. A patch missing from
|
||||
# tier.json ships but is never offered to an operator; a tier.json
|
||||
# entry naming a file that is not there makes the installer report a
|
||||
# feature it cannot apply. Neither surfaces until someone runs the
|
||||
# tier on a live shard, so both fail the release here instead.
|
||||
[ -f patches/tier.json ] || fail "patches/tier.json is missing (the patch-tier declaration)"
|
||||
jq -e . patches/tier.json >/dev/null || fail "patches/tier.json is not valid JSON"
|
||||
|
||||
DESCRIBED="$(jq -r '.features[].patches[].file' patches/tier.json | LC_ALL=C sort)"
|
||||
PRESENT="$(cd patches && ls *.patch | LC_ALL=C sort)"
|
||||
if [ "$DESCRIBED" != "$PRESENT" ]; then
|
||||
echo "described by tier.json:"; echo "$DESCRIBED" | sed 's/^/ /'
|
||||
echo "present in patches/:"; echo "$PRESENT" | sed 's/^/ /'
|
||||
fail "patches/tier.json and patches/*.patch disagree — every patch must be described by exactly one feature"
|
||||
fi
|
||||
|
||||
# Each patch's declared target must be the file its diff actually
|
||||
# edits. The installer cross-checks the same pair at install time and
|
||||
# refuses on a mismatch, so catching it here saves an operator the run.
|
||||
while IFS=$'\t' read -r PFILE PTARGET; do
|
||||
DIFF_TARGET="$(sed -n 's|^+++ b/||p' "patches/${PFILE}" | head -1 | tr -d '\r')"
|
||||
[ "$DIFF_TARGET" = "$PTARGET" ] \
|
||||
|| fail "patches/${PFILE} edits ${DIFF_TARGET} but tier.json declares ${PTARGET}"
|
||||
done < <(jq -r '.features[].patches[] | [.file, .target] | @tsv' patches/tier.json)
|
||||
|
||||
# Companions can only be copied after their feature's patches land, so
|
||||
# they live here rather than in overlay/ — and a missing one turns a
|
||||
# successfully patched shard into one that does not compile.
|
||||
for f in $(jq -r '.features[].companions[].file' patches/tier.json); do
|
||||
[ -f "patches/${f}" ] || fail "patches/${f} is missing (a feature's companion source)"
|
||||
done
|
||||
|
||||
for r in $(jq -r '.features[].rebuild' patches/tier.json); do
|
||||
case "$r" in
|
||||
core|scripts) ;;
|
||||
*) fail "tier.json declares rebuild=\"${r}\"; only \"core\" or \"scripts\" are understood" ;;
|
||||
esac
|
||||
done
|
||||
echo "patch tier: $(jq -r '.features | length' patches/tier.json) feature(s), $(echo "$PRESENT" | wc -l) patch(es)"
|
||||
|
||||
[ -f overlay.toml ] || fail "overlay.toml is missing (protocol + ServUO declarations)"
|
||||
|
||||
# ── OVERLAY ADAPTER: stage, manifest, package ────────────────────────
|
||||
@@ -303,6 +349,12 @@ jobs:
|
||||
cp -r overlay "${STAGE}/overlay"
|
||||
cp -r patches "${STAGE}/patches"
|
||||
|
||||
# tier.json is folded into manifest.json below, so the staged copy is
|
||||
# removed: shipping it twice would give the tarball two statements of
|
||||
# the same table, one of which nothing reads and both of which are
|
||||
# free to drift.
|
||||
rm -f "${STAGE}/patches/tier.json"
|
||||
|
||||
# Declarations from overlay.toml. Read, don't hardcode — the point of
|
||||
# that file is that the protocol number lives in one place.
|
||||
PROTOCOL="$(grep -m1 -E '^protocol[[:space:]]*=' overlay.toml | sed -E 's/[^0-9]//g')"
|
||||
@@ -313,6 +365,18 @@ jobs:
|
||||
[ -n "$PATCHED_AGAINST" ] || { echo "::error::could not read patches_verified_against from overlay.toml"; exit 1; }
|
||||
echo "==> protocol=${PROTOCOL} min_servuo=${MIN_SERVUO} patches_verified_against=${PATCHED_AGAINST}"
|
||||
|
||||
# The patch tier, folded in verbatim minus its comment block. Paths are
|
||||
# rewritten to be relative to the tarball root (`patches/<file>`), which
|
||||
# is where the installer will find them after extraction — tier.json
|
||||
# names them relative to patches/ because that is where a maintainer
|
||||
# editing it is looking.
|
||||
TIER="$(jq '
|
||||
del(._comment)
|
||||
| .features |= map(
|
||||
.patches |= map(.file |= "patches/" + .)
|
||||
| .companions |= map(.file |= "patches/" + .)
|
||||
)' patches/tier.json)"
|
||||
|
||||
# Per-file SHA256 of everything shipped, as a {path: sha} object. The
|
||||
# installer records these in install.json so a later `doctor` can tell
|
||||
# "operator edited a deployed file" from "the overlay drifted".
|
||||
@@ -336,6 +400,7 @@ jobs:
|
||||
--argjson protocol "${PROTOCOL}" \
|
||||
--arg min_servuo "${MIN_SERVUO}" \
|
||||
--arg patched_against "${PATCHED_AGAINST}" \
|
||||
--argjson tier "${TIER}" \
|
||||
--argjson files "${FILES}" \
|
||||
'{
|
||||
component: $component,
|
||||
@@ -347,6 +412,7 @@ jobs:
|
||||
min_version: $min_servuo,
|
||||
patches_verified_against: $patched_against
|
||||
},
|
||||
patch_tier: $tier,
|
||||
files: $files
|
||||
}' > "${STAGE}/manifest.json"
|
||||
|
||||
@@ -425,3 +491,45 @@ jobs:
|
||||
-F "attachment=@dist/${f}" >/dev/null
|
||||
echo " uploaded ${f}"
|
||||
done
|
||||
|
||||
# ── Recompose the installer's bundle manifest ────────────────────────
|
||||
# The installer does not resolve "latest" at run time — it deploys the
|
||||
# exact overlay named by a published bundle (docs/installer/PLAN.md §7.1).
|
||||
# An overlay release that nobody recomposes around is therefore a release
|
||||
# no operator will ever be offered. This tells the installer repo to
|
||||
# rebuild that manifest now rather than leaving the new version invisible
|
||||
# until its nightly cron.
|
||||
#
|
||||
# That job re-reads this tarball's manifest.json and checks its declared
|
||||
# `protocol` against the sidecar's PROTOCOL_VERSION before publishing
|
||||
# anything (PLAN.md §7.1, gate 1) — which is the check this repo cannot
|
||||
# perform for itself, since the C# plugin announces no version on the wire.
|
||||
#
|
||||
# DISPATCH, DON'T WAIT (PLAN.md §7.3). Gitea's workflow-dispatch endpoint
|
||||
# returns no run handle, so there is nothing to poll: a waiting step would
|
||||
# have to guess which run is its own and hold a runner idle to do it.
|
||||
#
|
||||
# A failure here is a WARNING, never a failure of this job. The release is
|
||||
# already published and correct by this point, and failing the run would
|
||||
# misreport that. The installer's nightly cron recomposes from whatever the
|
||||
# latest releases actually are, so a dropped dispatch costs latency, not
|
||||
# correctness.
|
||||
- name: Ask the installer repo to recompose its bundle
|
||||
if: ${{ steps.plan.outputs.release == 'true' }}
|
||||
env:
|
||||
REGISTRY_TOKEN: ${{ secrets.REGISTRY_TOKEN }}
|
||||
run: |
|
||||
set -euo pipefail
|
||||
CI_TOKEN="$(printf '%s' "${REGISTRY_TOKEN}" | tr -d '\r\n')"
|
||||
HTTP="$(curl -s -o /dev/null -w '%{http_code}' -X POST \
|
||||
-H "Authorization: token ${CI_TOKEN}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"ref":"main"}' \
|
||||
"https://${GITEA_HOST}/api/v1/repos/${INSTALLER_REPO}/actions/workflows/bundle.yml/dispatches" || echo 000)"
|
||||
case "$HTTP" in
|
||||
20*) echo "Dispatched ${INSTALLER_REPO} bundle.yml (HTTP ${HTTP}) — not waiting for it." ;;
|
||||
403|404)
|
||||
echo "::warning::Could not dispatch ${INSTALLER_REPO} bundle.yml (HTTP ${HTTP}). REGISTRY_TOKEN likely lacks write:repository on that repo. Release ${{ steps.plan.outputs.tag }} is published and fine; its bundle will be composed by the installer's nightly cron instead." ;;
|
||||
*)
|
||||
echo "::warning::Dispatching ${INSTALLER_REPO} bundle.yml returned HTTP ${HTTP}. Release ${{ steps.plan.outputs.tag }} is published and fine; the nightly cron will recompose the bundle." ;;
|
||||
esac
|
||||
|
||||
@@ -33,6 +33,13 @@ under `overlay/` (or `patches/` for changes to stock ServUO files) and deploy:
|
||||
.\deploy.ps1 -ServerPath C:\path\to\servuo
|
||||
```
|
||||
|
||||
`deploy.ps1` deploys from *this working tree*, which is what you want while
|
||||
developing. It is not how a shard is set up: operators run the
|
||||
[Runic Gateway installer](https://gitea.whitlocktech.com/RunicGateway/installer),
|
||||
which syncs the released overlay tarball and installs the sidecar alongside it.
|
||||
Changes here reach shards through a [release](README.md#releases), so a change
|
||||
that only works when `deploy.ps1` copies it is a change that does not ship.
|
||||
|
||||
- `overlay/` — copied over an install (the only thing `deploy.ps1` deploys).
|
||||
- `patches/` — unified diffs against stock ServUO for files we must modify.
|
||||
- `tools/` — never deployed: test scaffolding and stub sidecars.
|
||||
|
||||
41
README.md
41
README.md
@@ -26,7 +26,7 @@ integration guide, protocol spec, research — with full history preserved).
|
||||
| `overlay/` | Mirrors the ServUO server root. Everything here — and **only** this — copies over an install. |
|
||||
| `patches/` | Unified diffs against stock ServUO for files we must modify rather than add. |
|
||||
| `tools/` | Never deployed. Test scaffolding (C# probes + PowerShell stub sidecars) and anything else that must not reach a server. |
|
||||
| `deploy.ps1` | Copies `overlay/` into a server root. `-Verify` diffs instead of writing. |
|
||||
| `deploy.ps1` | **Developer tool** — copies `overlay/` from this working tree into a server root. `-Verify` diffs instead of writing. Operators use the [installer](https://gitea.whitlocktech.com/RunicGateway/installer); see [Deploy](#deploy). |
|
||||
| `overlay.toml` | Release metadata: the wire-protocol version this overlay speaks, and its ServUO compatibility. Read by CI into the release manifest — see [Releases](#releases). |
|
||||
| `.gitea/workflows/release.yml` | Publishes `runicgateway-overlay-<ver>.tar.gz` on every merge to `main`. |
|
||||
| [INTEGRATION.md](https://gitea.whitlocktech.com/RunicGateway/docs/src/branch/main/link/INTEGRATION.md) | **Website integration guide** — the WebSocket feed, REST endpoints, auth, event catalog, and examples. |
|
||||
@@ -39,14 +39,17 @@ Anything under `overlay/` is authoritative. Do not edit files in the server tree
|
||||
## Sidecar & deployment
|
||||
|
||||
The Rust sidecar is the other half of the bridge and lives in **[RunicGateway/link](https://gitea.whitlocktech.com/RunicGateway/link)**.
|
||||
The two are deployed **together** but built **independently**:
|
||||
The two are deployed **together** — by the
|
||||
[installer](https://gitea.whitlocktech.com/RunicGateway/installer), in one run — but built
|
||||
**independently**:
|
||||
|
||||
- **This plugin** is deployed as *source* — `deploy.ps1` copies `overlay/` into the ServUO server
|
||||
root, and ServUO compiles it at boot (`Scripts.csproj`; see [Phase 0](#phase-0--what-it-fixes)).
|
||||
There is **no CI build** — it cannot be compiled standalone without the ServUO reference
|
||||
assemblies. CI does publish a *source* tarball for the installer to fetch; see
|
||||
- **This plugin** is deployed as *source*: `overlay/` is copied into the ServUO server root and
|
||||
ServUO compiles it at boot (`Scripts.csproj`; see [Phase 0](#phase-0--what-it-fixes)). There is
|
||||
**no CI build** — it cannot be compiled standalone without the ServUO reference assemblies. CI
|
||||
publishes a *source* tarball, which is what the installer fetches and syncs; see
|
||||
[Releases](#releases).
|
||||
- **The sidecar** is a standalone Rust binary, released from its own repo.
|
||||
- **The sidecar** is a standalone Rust binary, released from its own repo and installed from that
|
||||
release.
|
||||
|
||||
The **only** coupling is the loopback JSON protocol (the shard dials out to the sidecar on
|
||||
`127.0.0.1`). Compatibility is a **protocol** concern, not a build-order one: keep the event/command
|
||||
@@ -57,14 +60,32 @@ without the sidecar running.
|
||||
|
||||
## Deploy
|
||||
|
||||
**On a shard, use the [Runic Gateway installer](https://gitea.whitlocktech.com/RunicGateway/installer).**
|
||||
One binary syncs this overlay from the release tarball below, offers the patch tier, installs the
|
||||
uo-link sidecar as a service, and prints the values your website needs — cross-platform, with a
|
||||
`doctor` afterwards to tell a copied file from a working bridge:
|
||||
|
||||
```bash
|
||||
sudo ./runicgateway-installer-linux-x86_64 install
|
||||
```
|
||||
|
||||
Guide: [installer/INSTALL.md](https://gitea.whitlocktech.com/RunicGateway/docs/src/branch/main/installer/INSTALL.md).
|
||||
To place the overlay yourself instead — a host that cannot run the binary, or you want to see every
|
||||
file land — [Appendix A2](https://gitea.whitlocktech.com/RunicGateway/docs/src/branch/main/installer/INSTALL.md#a2-deploy-the-plugin-overlay)
|
||||
is the same copy done by hand, and stays supported.
|
||||
|
||||
### `deploy.ps1` — the developer path
|
||||
|
||||
`deploy.ps1` deploys from a **working tree**, which is what you want while writing plugin code and
|
||||
is the one thing the installer cannot do (it deploys from a release):
|
||||
|
||||
```powershell
|
||||
.\deploy.ps1 -ServerPath <servuo> -Verify # show what would change
|
||||
.\deploy.ps1 -ServerPath <servuo> # write
|
||||
```
|
||||
|
||||
`deploy.ps1` is the **developer-facing** tool and stays that way. Operators get the
|
||||
[Runic Gateway installer](https://gitea.whitlocktech.com/RunicGateway/installer), which does the
|
||||
same sync cross-platform from the release tarball below.
|
||||
It is Windows-only and stays developer-facing; it never installs the sidecar, registers a service,
|
||||
or checks the protocol pairing. Nothing shipped to an operator depends on it.
|
||||
|
||||
## Releases
|
||||
|
||||
|
||||
@@ -23,8 +23,8 @@
|
||||
# manual duty: when the protocol changes, bump it here in the same PR that
|
||||
# changes the emitters, exactly as link bumps PROTOCOL_VERSION.
|
||||
#
|
||||
# Current: 3 — see docs/link/v3.md (world.ruleset, points.board, vendor.listing).
|
||||
protocol = 3
|
||||
# Current: 4 — see docs/link/v4.md (guild.roster, guild.leave).
|
||||
protocol = 4
|
||||
|
||||
# ── ServUO compatibility ─────────────────────────────────────────────────────
|
||||
#
|
||||
|
||||
@@ -34,6 +34,18 @@ PageSweepSeconds=5
|
||||
# interval (emit guild.update / guild.remove). Guild membership moves slowly; 60s is ample.
|
||||
GuildSweepSeconds=60
|
||||
|
||||
# Members per guild.roster frame (Protocol 4). A roster is the only fat frame the bridge emits
|
||||
# (~69 bytes per member) and the sidecar reads a line with no length bound, so this caps it; a
|
||||
# guild over the cap is split across continuation frames carrying seq/more. 500 members is ~35 KB,
|
||||
# past any realistic guild, so the split path is an edge case rather than the norm.
|
||||
GuildRosterMembersPerLine=500
|
||||
|
||||
# Guilds that may emit a roster in one sweep. Every guild looks changed right after a sidecar
|
||||
# reconnect, and building hundreds of fat frames in a single Core-thread pass is exactly the stall
|
||||
# the bridge exists to avoid. The sweep re-arms itself every 2s while a baseline is draining, so
|
||||
# lowering this slows the catch-up without making the site wait a full sweep interval per batch.
|
||||
GuildRosterGuildsPerTick=25
|
||||
|
||||
# Town-governor poll. Each city's Governor / election is diffed on this interval to emit
|
||||
# city.update on change. Governors turn over on the order of weeks, so a slow sweep is fine.
|
||||
# Idle (emits nothing) unless the City Loyalty system is enabled (CityLoyalty.Enabled).
|
||||
|
||||
@@ -38,6 +38,10 @@ namespace Server.Custom.Bridge
|
||||
public static int PointsSweepSeconds { get; private set; }
|
||||
public static int MarketSweepSeconds { get; private set; }
|
||||
|
||||
// ---- guild rosters (Protocol 4) ----
|
||||
public static int GuildRosterMembersPerLine { get; private set; }
|
||||
public static int GuildRosterGuildsPerTick { get; private set; }
|
||||
|
||||
// ---- player-vendor market index (https://gitea.whitlocktech.com/RunicGateway/docs/src/branch/main/link/v3.md §8) ----
|
||||
public static bool MarketEnabled { get; private set; }
|
||||
public static int MarketSweepBatch { get; private set; }
|
||||
@@ -114,6 +118,24 @@ namespace Server.Custom.Bridge
|
||||
if (GuildSweepSeconds < 1)
|
||||
GuildSweepSeconds = 1;
|
||||
|
||||
// A roster line is the only fat frame this plugin emits — measured at roughly 69 bytes
|
||||
// per member — and the sidecar reads a line with no length bound. The cap turns an
|
||||
// unbounded frame into a bounded one; a guild above it is split across continuation
|
||||
// lines. 500 members is ~35 KB, comfortably past any real guild, so the split path is
|
||||
// an edge case rather than the norm.
|
||||
GuildRosterMembersPerLine = Config.Get("Bridge.GuildRosterMembersPerLine", 500);
|
||||
if (GuildRosterMembersPerLine < 16)
|
||||
GuildRosterMembersPerLine = 16;
|
||||
|
||||
// How many guilds may emit a roster in a single sweep. Every guild re-emits after a
|
||||
// reconnect (the diff caches are cleared), and building a few hundred fat JSON frames in
|
||||
// one Core-thread pass is exactly the stall this bridge exists to avoid. The sweep
|
||||
// re-arms itself promptly while a baseline is still draining, so this throttles the work
|
||||
// without making the site wait a full sweep interval per batch.
|
||||
GuildRosterGuildsPerTick = Config.Get("Bridge.GuildRosterGuildsPerTick", 25);
|
||||
if (GuildRosterGuildsPerTick < 1)
|
||||
GuildRosterGuildsPerTick = 1;
|
||||
|
||||
CitySweepSeconds = Config.Get("Bridge.CitySweepSeconds", 300);
|
||||
if (CitySweepSeconds < 1)
|
||||
CitySweepSeconds = 1;
|
||||
|
||||
@@ -85,14 +85,153 @@ namespace Server.Custom.Bridge
|
||||
public static StringBuilder Actor(this StringBuilder sb, string name, Mobile m)
|
||||
{
|
||||
sb.Append(",\"").Append(name).Append("\":");
|
||||
WriteActor(sb, m);
|
||||
return sb;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Writes a named array of actor objects — a guild roster (Protocol 4) being the first
|
||||
/// caller. Every other outbound helper here emits a leading `,"name":`, so an array
|
||||
/// element needs the bare object; that is why <see cref="WriteActor"/> exists separately
|
||||
/// rather than <see cref="Actor"/> being reused.
|
||||
///
|
||||
/// `count` bounds how many are written, because a roster frame must stay a bounded line
|
||||
/// (Bridge.GuildRosterMembersPerLine). A null entry in the sequence is skipped rather
|
||||
/// than written as null, so the array is always a list of real members and a caller can
|
||||
/// trust its length.
|
||||
///
|
||||
/// `withGuildRank` adds each member's guild rank to their object. It is a parameter
|
||||
/// rather than always-on because rank is a property of a mobile's membership of THIS
|
||||
/// guild, not of the mobile — every other actor this bridge writes is a bystander,
|
||||
/// a killer, a governor, and guild rank is meaningless on all of them.
|
||||
/// </summary>
|
||||
public static StringBuilder Actors(
|
||||
this StringBuilder sb, string name, IList<Mobile> mobiles, int start, int count,
|
||||
bool withGuildRank = false)
|
||||
{
|
||||
sb.Append(",\"").Append(name).Append("\":[");
|
||||
|
||||
if (mobiles != null)
|
||||
{
|
||||
var end = Math.Min(start + count, mobiles.Count);
|
||||
bool first = true;
|
||||
|
||||
for (int i = start; i < end; i++)
|
||||
{
|
||||
var m = mobiles[i];
|
||||
|
||||
if (m == null)
|
||||
continue;
|
||||
|
||||
if (!first)
|
||||
sb.Append(',');
|
||||
|
||||
if (withGuildRank)
|
||||
WriteGuildMember(sb, m);
|
||||
else
|
||||
WriteActor(sb, m);
|
||||
|
||||
first = false;
|
||||
}
|
||||
}
|
||||
|
||||
sb.Append(']');
|
||||
return sb;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// A roster member: the standard actor object plus the member's rank in their guild.
|
||||
///
|
||||
/// **Only the raw rank is emitted, never a resolved label.** ServUO names the five
|
||||
/// standard ranks with cliloc ids (1062959–1062963) and ships no text for them, so the
|
||||
/// shard cannot produce "Warlord" without a client-file table it does not have. The
|
||||
/// website module does have one, and resolving a game term is its job in any case.
|
||||
///
|
||||
/// `rank` is the numeric rank, 0–4, with 4 being Leader (`RankDefinition.Ranks`). A
|
||||
/// custom rank definition may carry a literal string instead of a cliloc, so `rankName`
|
||||
/// is written when there is one and `rankCliloc` when there is not; a shard that has
|
||||
/// replaced the rank table therefore keeps its own naming rather than being flattened
|
||||
/// into the stock five.
|
||||
///
|
||||
/// A member with no readable rank — a mobile that is not a PlayerMobile, or one whose
|
||||
/// GuildRank is null — is written with no rank fields at all rather than a fabricated
|
||||
/// default. Absent means "not known", and a consumer that treated a missing rank as 0
|
||||
/// would silently demote them.
|
||||
///
|
||||
/// **Staff are deliberately written with no rank, and this is not a rounding error.**
|
||||
/// `PlayerMobile.GuildRank` returns `RankDefinition.Leader` for anyone at GameMaster or
|
||||
/// above, whatever their actual rank — a gameplay convenience so staff can operate a
|
||||
/// guild stone, and emphatically not a claim about who leads the guild. The true value
|
||||
/// is in a private field with no accessor, so the only honest options are "Leader" and
|
||||
/// "not known", and publishing a staff member as a guild leader on a public roster is
|
||||
/// the worse of the two by a wide margin. A staff account that genuinely leads its guild
|
||||
/// shows as an unranked member, which is a visible gap rather than a false claim.
|
||||
/// </summary>
|
||||
private static void WriteGuildMember(StringBuilder sb, Mobile m)
|
||||
{
|
||||
if (m == null)
|
||||
{
|
||||
sb.Append("null");
|
||||
return sb;
|
||||
return;
|
||||
}
|
||||
|
||||
sb.Append("{\"serial\":\"0x").Append(m.Serial.Value.ToString("X")).Append('"');
|
||||
sb.Append('{');
|
||||
WriteActorFields(sb, m);
|
||||
|
||||
var pm = m as Server.Mobiles.PlayerMobile;
|
||||
var rank = pm == null || pm.AccessLevel >= AccessLevel.GameMaster ? null : pm.GuildRank;
|
||||
|
||||
if (rank != null)
|
||||
{
|
||||
sb.Append(",\"rank\":").Append(rank.Rank);
|
||||
|
||||
if (!string.IsNullOrEmpty(rank.Name.String))
|
||||
{
|
||||
sb.Append(",\"rankName\":");
|
||||
Escape(sb, rank.Name.String);
|
||||
}
|
||||
else if (rank.Name.Number > 0)
|
||||
{
|
||||
sb.Append(",\"rankCliloc\":").Append(rank.Name.Number);
|
||||
}
|
||||
}
|
||||
|
||||
sb.Append('}');
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// One bare actor object, with no leading field name: serial, name, account (when there
|
||||
/// is one), the linked webId (when the account is linked), and the player flag. A `null`
|
||||
/// mobile writes null.
|
||||
///
|
||||
/// `acct` and `webId` are the site-identity fields, and they are emitted here
|
||||
/// unconditionally by design — the sidecar is a forwarder, and deciding who may see them
|
||||
/// is the website's job (it projects per the shard visibility rungs). Note that `acct` is
|
||||
/// genuinely optional: a PlayerMobile can have no Account at all.
|
||||
/// </summary>
|
||||
private static void WriteActor(StringBuilder sb, Mobile m)
|
||||
{
|
||||
if (m == null)
|
||||
{
|
||||
sb.Append("null");
|
||||
return;
|
||||
}
|
||||
|
||||
sb.Append('{');
|
||||
WriteActorFields(sb, m);
|
||||
sb.Append('}');
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The actor fields, with no braces, so a caller can add its own.
|
||||
///
|
||||
/// Split out for <see cref="WriteGuildMember"/>, which is the same object plus guild
|
||||
/// rank. Note the first field is written WITHOUT a leading comma and every later one
|
||||
/// with, so this must be the first thing inside its object.
|
||||
/// </summary>
|
||||
private static void WriteActorFields(StringBuilder sb, Mobile m)
|
||||
{
|
||||
sb.Append("\"serial\":\"0x").Append(m.Serial.Value.ToString("X")).Append('"');
|
||||
|
||||
sb.Append(",\"name\":");
|
||||
Escape(sb, m.Name ?? "");
|
||||
@@ -112,8 +251,6 @@ namespace Server.Custom.Bridge
|
||||
}
|
||||
|
||||
sb.Append(",\"player\":").Append(m.Player ? "true" : "false");
|
||||
sb.Append('}');
|
||||
return sb;
|
||||
}
|
||||
|
||||
/// <summary>Closes the object. The trailing newline is the frame delimiter.</summary>
|
||||
|
||||
@@ -15,10 +15,14 @@ namespace Server.Custom.Bridge
|
||||
/// A guild that vanishes (or disbands — Disbanded == leader gone) leaves via `guild.remove`.
|
||||
///
|
||||
/// On top of the board we emit a real-time `guild.join` from EventSink.JoinGuild, so a "so-and-
|
||||
/// so joined" feed does not wait for the next sweep. A membership change also moves the board
|
||||
/// signature (member count + serial sum), so a *leave* surfaces as the member count dropping in
|
||||
/// the next `guild.update`; per-member leave events would need a core tap and are a later
|
||||
/// refinement (§10.1).
|
||||
/// so joined" feed does not wait for the next sweep.
|
||||
///
|
||||
/// Protocol 4 adds the membership half that §10.1 deferred. The sweep holds each guild's
|
||||
/// member serial **set** rather than a sum of it, so a change is detected by set comparison
|
||||
/// (no hash collisions, unlike the old sum where two offsetting changes could cancel) and the
|
||||
/// departures are recoverable by difference — which is what makes a per-member `guild.leave`
|
||||
/// possible without a core tap. A changed set also re-emits `guild.roster`, the full member
|
||||
/// list, so the board self-corrects and nothing downstream has to replay deltas to stay right.
|
||||
///
|
||||
/// "Created" is derived sidecar-side from a first-seen id (as champs derive it), rather than a
|
||||
/// wire event — otherwise a sidecar reconnect, which clears the diff cache and re-emits every
|
||||
@@ -32,7 +36,16 @@ namespace Server.Custom.Bridge
|
||||
// was cleared on reconnect), so its next sweep counts as a change.
|
||||
private static readonly Dictionary<int, string> _last = new Dictionary<int, string>();
|
||||
|
||||
private static long _sweeps, _emitted, _removed, _joins;
|
||||
// guild id -> last-emitted member serial set (Protocol 4). Held rather than summed so a
|
||||
// departure can be recovered as a set difference; see the class remarks.
|
||||
private static readonly Dictionary<int, HashSet<int>> _members =
|
||||
new Dictionary<int, HashSet<int>>();
|
||||
|
||||
private static long _sweeps, _emitted, _removed, _joins, _rosters, _leaves;
|
||||
|
||||
// Set while a post-reconnect baseline is still draining, so the sweep re-arms promptly
|
||||
// instead of leaving the site a sweep interval behind. See GuildSweep.
|
||||
private static bool _draining;
|
||||
|
||||
public static void Initialize()
|
||||
{
|
||||
@@ -52,6 +65,7 @@ namespace Server.Custom.Bridge
|
||||
private static void OnConnected()
|
||||
{
|
||||
_last.Clear();
|
||||
_members.Clear();
|
||||
}
|
||||
|
||||
/// <summary>Stops and recreates the timer from current config. Called by `[bridge reload`.</summary>
|
||||
@@ -72,8 +86,9 @@ namespace Server.Custom.Bridge
|
||||
|
||||
public static string Status()
|
||||
{
|
||||
return String.Format("guilds(sweeps={0} emitted={1} removed={2} joins={3} tracked={4})",
|
||||
_sweeps, _emitted, _removed, _joins, _last.Count);
|
||||
return String.Format(
|
||||
"guilds(sweeps={0} emitted={1} removed={2} joins={3} rosters={4} leaves={5} tracked={6} draining={7})",
|
||||
_sweeps, _emitted, _removed, _joins, _rosters, _leaves, _last.Count, _draining);
|
||||
}
|
||||
|
||||
/// <summary>Runs one sweep now. Wired into `[bridge sweepnow`.</summary>
|
||||
@@ -93,6 +108,12 @@ namespace Server.Custom.Bridge
|
||||
|
||||
var seen = new HashSet<int>();
|
||||
|
||||
// Guilds whose roster this sweep is still allowed to emit. Every guild looks changed
|
||||
// right after a reconnect, and a roster is this plugin's only fat frame, so the
|
||||
// baseline is spread over several passes rather than built in one Core-thread tick.
|
||||
var rosterBudget = BridgeConfig.GuildRosterGuildsPerTick;
|
||||
var deferred = false;
|
||||
|
||||
foreach (var bg in BaseGuild.List.Values)
|
||||
{
|
||||
var g = bg as Guild;
|
||||
@@ -104,15 +125,64 @@ namespace Server.Custom.Bridge
|
||||
|
||||
seen.Add(g.Id);
|
||||
|
||||
var current = MemberSerials(g);
|
||||
|
||||
HashSet<int> priorMembers;
|
||||
var known = _members.TryGetValue(g.Id, out priorMembers);
|
||||
var membersChanged = !known || !priorMembers.SetEquals(current);
|
||||
|
||||
var sig = Signature(g);
|
||||
|
||||
string prior;
|
||||
if (_last.TryGetValue(g.Id, out prior) && prior == sig)
|
||||
var sigChanged = !_last.TryGetValue(g.Id, out prior) || prior != sig;
|
||||
|
||||
if (!sigChanged && !membersChanged)
|
||||
continue; // unchanged since last emit
|
||||
|
||||
_last[g.Id] = sig;
|
||||
BridgeLink.Emit(WriteGuild(g));
|
||||
_emitted++;
|
||||
if (sigChanged)
|
||||
{
|
||||
_last[g.Id] = sig;
|
||||
BridgeLink.Emit(WriteGuild(g));
|
||||
_emitted++;
|
||||
}
|
||||
|
||||
if (!membersChanged)
|
||||
continue;
|
||||
|
||||
// Over budget: leave _members untouched so this guild is still "changed" next
|
||||
// pass and gets its roster then. The guild.update above has already gone, so the
|
||||
// board's counts are current either way.
|
||||
if (rosterBudget <= 0)
|
||||
{
|
||||
deferred = true;
|
||||
continue;
|
||||
}
|
||||
|
||||
rosterBudget--;
|
||||
|
||||
// Departures, per member, before the roster that supersedes them: a consumer
|
||||
// building a "so-and-so left" feed needs the individual events, while a consumer
|
||||
// holding the membership table only needs the roster. On the very first sweep for
|
||||
// a guild there is no prior set, so nothing is reported as having left — an
|
||||
// unknown roster becoming known is not 155 people leaving.
|
||||
if (known)
|
||||
{
|
||||
foreach (var serial in priorMembers)
|
||||
{
|
||||
if (current.Contains(serial))
|
||||
continue;
|
||||
|
||||
BridgeLink.Emit(BridgeJson.Begin("guild.leave")
|
||||
.Num("id", g.Id)
|
||||
.Str("name", g.Name)
|
||||
.Ser("who", (Serial)serial)
|
||||
.End());
|
||||
_leaves++;
|
||||
}
|
||||
}
|
||||
|
||||
EmitRoster(g);
|
||||
_members[g.Id] = current;
|
||||
}
|
||||
|
||||
// Anything tracked last sweep but not seen now has disbanded or been removed.
|
||||
@@ -120,9 +190,19 @@ namespace Server.Custom.Bridge
|
||||
foreach (var id in gone)
|
||||
{
|
||||
_last.Remove(id);
|
||||
_members.Remove(id);
|
||||
BridgeLink.Emit(BridgeJson.Begin("guild.remove").Num("id", id).End());
|
||||
_removed++;
|
||||
}
|
||||
|
||||
// Re-arm promptly while a baseline is still draining. Without this the remaining
|
||||
// guilds would each wait a full GuildSweepSeconds, so a 200-guild shard would take
|
||||
// hours to publish its rosters after a reconnect instead of seconds. The sweep is
|
||||
// idempotent, so an extra pass that finds nothing changed costs a few field reads.
|
||||
_draining = deferred;
|
||||
|
||||
if (deferred)
|
||||
Timer.DelayCall(TimeSpan.FromSeconds(2.0), GuildSweep);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
@@ -130,14 +210,15 @@ namespace Server.Custom.Bridge
|
||||
}
|
||||
}
|
||||
|
||||
// The volatile fields that define a meaningful change: name, abbreviation, leader, member
|
||||
// count, the member set (order-independent serial sum), and alliance.
|
||||
private static string Signature(Guild g)
|
||||
/// <summary>
|
||||
/// The guild's live member serials. Held per guild between sweeps so a membership change
|
||||
/// yields both the fact that it changed and *who* left (Protocol 4).
|
||||
/// </summary>
|
||||
private static HashSet<int> MemberSerials(Guild g)
|
||||
{
|
||||
long memberSum = 0;
|
||||
int count = 0;
|
||||
|
||||
var set = new HashSet<int>();
|
||||
var members = g.Members;
|
||||
|
||||
if (members != null)
|
||||
{
|
||||
for (int i = 0; i < members.Count; i++)
|
||||
@@ -145,8 +226,28 @@ namespace Server.Custom.Bridge
|
||||
var m = members[i];
|
||||
if (m == null)
|
||||
continue;
|
||||
count++;
|
||||
unchecked { memberSum += (uint)m.Serial.Value; }
|
||||
set.Add(m.Serial.Value);
|
||||
}
|
||||
}
|
||||
|
||||
return set;
|
||||
}
|
||||
|
||||
// The volatile fields that define a meaningful change to the *board row*: name, abbreviation,
|
||||
// leader, member count and alliance. Membership is no longer folded in here as a serial sum —
|
||||
// the sweep compares the real member set instead, which cannot collide the way a sum can when
|
||||
// one member joins and another leaves between two passes.
|
||||
private static string Signature(Guild g)
|
||||
{
|
||||
int count = 0;
|
||||
|
||||
var members = g.Members;
|
||||
if (members != null)
|
||||
{
|
||||
for (int i = 0; i < members.Count; i++)
|
||||
{
|
||||
if (members[i] != null)
|
||||
count++;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -157,7 +258,6 @@ namespace Server.Custom.Bridge
|
||||
g.Abbreviation ?? "", "|",
|
||||
leaderSerial.ToString(), "|",
|
||||
count.ToString(), "|",
|
||||
memberSum.ToString(), "|",
|
||||
g.Alliance == null ? "" : (g.AllianceName ?? ""));
|
||||
}
|
||||
|
||||
@@ -191,6 +291,55 @@ namespace Server.Custom.Bridge
|
||||
return sb.End();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Emits the guild's full member list as one or more `guild.roster` frames (Protocol 4).
|
||||
///
|
||||
/// A roster is the only fat frame this plugin produces — roughly 69 bytes per member — and
|
||||
/// the sidecar reads a line with no length bound, so the member count per line is capped
|
||||
/// (Bridge.GuildRosterMembersPerLine). A guild over the cap is split, and each frame
|
||||
/// carries `seq` plus `more` so a consumer can tell a complete roster from a partial one:
|
||||
/// `seq` 0 begins a roster and replaces whatever was held, and `more` false ends it. A
|
||||
/// guild inside the cap — every realistic one — emits exactly one frame with `seq` 0 and
|
||||
/// `more` false, which is the same shape as if chunking did not exist.
|
||||
/// </summary>
|
||||
private static void EmitRoster(Guild g)
|
||||
{
|
||||
var members = g.Members;
|
||||
var total = members == null ? 0 : members.Count;
|
||||
var perLine = BridgeConfig.GuildRosterMembersPerLine;
|
||||
|
||||
var seq = 0;
|
||||
var start = 0;
|
||||
|
||||
// do/while, not while: a guild with no members must still emit one empty roster frame,
|
||||
// or a consumer could never learn that a roster it holds has emptied.
|
||||
do
|
||||
{
|
||||
var more = start + perLine < total;
|
||||
|
||||
var sb = BridgeJson.Begin("guild.roster")
|
||||
.Num("id", g.Id)
|
||||
.Str("name", g.Name)
|
||||
.Str("abbr", g.Abbreviation)
|
||||
.Num("total", total)
|
||||
.Num("seq", seq)
|
||||
.Bool("more", more);
|
||||
|
||||
// `withGuildRank` — the roster is the one place a member's rank in THIS guild is
|
||||
// meaningful, and the only frame that carries it. Leadership is rank 4
|
||||
// (RankDefinition.Ranks), and a guild can have several members at it, which is why
|
||||
// the board's single `leader` field was never enough to answer "who leads this".
|
||||
sb.Actors("members", members, start, perLine, withGuildRank: true);
|
||||
|
||||
BridgeLink.Emit(sb.End());
|
||||
_rosters++;
|
||||
|
||||
start += perLine;
|
||||
seq++;
|
||||
}
|
||||
while (start < total);
|
||||
}
|
||||
|
||||
// ---- real-time join ----
|
||||
|
||||
private static void OnJoinGuild(JoinGuildEventArgs e)
|
||||
|
||||
@@ -9,6 +9,14 @@ git apply --check patches/<name>.patch # dry run
|
||||
git apply patches/<name>.patch
|
||||
```
|
||||
|
||||
## `tier.json` — adding or changing a patch
|
||||
|
||||
A `.patch` file does not say enough on its own. The Runic Gateway installer's patch tier also has to know which patches form **one all-or-nothing unit**, which companion `.cs` may only be copied once that unit has landed, whether the change needs a **core** solution rebuild or just the dynamic script build, and what the operator loses by declining. None of that is derivable from a diff, so it is declared in [`tier.json`](tier.json).
|
||||
|
||||
**Adding a patch means adding it there in the same PR.** The release workflow checks the table in both directions — every `.patch` described by exactly one feature, every named patch and companion present, every `target` equal to the file the diff actually edits — so a patch without an entry fails the release rather than shipping a tier that silently never offers it.
|
||||
|
||||
`tier.json` is folded into the tarball's `manifest.json` as `patch_tier` and removed from the staged `patches/` directory, so the artifact carries exactly one copy of the table and it is the one the installer reads. Installers older than this key ignore it; an installer newer than the overlay it is deploying falls back to a built-in copy. See `docs/installer/PLAN.md` §2.2 and §7.0.
|
||||
|
||||
## Phase 7 — player-vendor sale (a coupled unit)
|
||||
|
||||
Player-vendor purchases raise **no** EventSink. `ValidVendorPurchase` / `ValidVendorSell` cover NPC vendors only. The commit point is `PlayerVendorBuyGump.OnResponse`, the only place where buyer, vendor **owner**, price, and commission are all in scope — exactly what cheat detection needs. See [PLAN.md](https://gitea.whitlocktech.com/RunicGateway/docs/src/branch/main/link/PLAN.md) §6.
|
||||
|
||||
69
patches/tier.json
Normal file
69
patches/tier.json
Normal file
@@ -0,0 +1,69 @@
|
||||
{
|
||||
"_comment": [
|
||||
"The patch tier, described for the Runic Gateway installer.",
|
||||
"",
|
||||
"A .patch file on its own does not say enough to run the tier safely. The installer",
|
||||
"additionally has to know which patches form ONE all-or-nothing unit (the two",
|
||||
"vendor-sale patches are useless apart), which companion .cs may only be copied once",
|
||||
"that unit has landed, whether the change needs a CORE solution rebuild or just the",
|
||||
"dynamic script build, and what capability the operator loses by declining. None of",
|
||||
"that is derivable from the diffs, so it is declared here.",
|
||||
"",
|
||||
"This file is the maintainer-facing source of truth. release.yml folds it into",
|
||||
"manifest.json as `patch_tier` and removes it from the staged patches/ directory, so",
|
||||
"the tarball carries exactly one copy and it is the one the installer reads",
|
||||
"(docs/installer/PLAN.md §7.0). CI also asserts that every .patch here is named by",
|
||||
"exactly one feature and every named patch and companion exists — adding a patch",
|
||||
"without describing it fails the release rather than shipping a tier that silently",
|
||||
"ignores it.",
|
||||
"",
|
||||
"Older installers ignore `patch_tier` entirely, and an installer newer than the",
|
||||
"overlay it is deploying falls back to its own built-in copy of this table."
|
||||
],
|
||||
|
||||
"features": [
|
||||
{
|
||||
"name": "vendor-sale",
|
||||
"summary": "vendor.sale events — player-vendor purchases with buyer, owner, item, price and commission",
|
||||
"lost": "no vendor.sale events",
|
||||
"rebuild": "core",
|
||||
"patches": [
|
||||
{
|
||||
"name": "playervendor-sale-eventsink",
|
||||
"file": "playervendor-sale-eventsink.patch",
|
||||
"target": "Server/EventSink.cs"
|
||||
},
|
||||
{
|
||||
"name": "playervendor-sale-gump",
|
||||
"file": "playervendor-sale-gump.patch",
|
||||
"target": "Scripts/Gumps/PlayerVendorGumps.cs"
|
||||
}
|
||||
],
|
||||
"companions": [
|
||||
{
|
||||
"file": "BridgeVendorSale.cs",
|
||||
"install_to": "Scripts/Custom/Bridge/BridgeVendorSale.cs"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "moderation-audit",
|
||||
"summary": "in-game moderation actions ([ban, [kick, [bcast) forwarded to the website as admin.audit",
|
||||
"lost": "no in-game moderation audit forwarding",
|
||||
"rebuild": "scripts",
|
||||
"patches": [
|
||||
{
|
||||
"name": "commandlogging-event",
|
||||
"file": "commandlogging-event.patch",
|
||||
"target": "Scripts/Commands/Logging.cs"
|
||||
}
|
||||
],
|
||||
"companions": [
|
||||
{
|
||||
"file": "BridgeModerationAudit.cs",
|
||||
"install_to": "Scripts/Custom/Bridge/BridgeModerationAudit.cs"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user