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

docs(rust-link): bring INTEGRATION.md up to protocol 14 and name all three helpers

Browse Source 
INTEGRATION.md predated the installer: it said there was no installer
support for Rust, showed protocol-1 samples throughout, listed the uMod
Clans plugin as expected (D47 says it is deliberately not used) and
PopupNotifications as needed (optional, D141), and never mentioned
Carbon or RunicNPC. It now points at INSTALL.md for setting a server up,
takes its pieces from one bundle, and shows protocol 14's samples,
including /health's untyped_frames and --print-config's current shape.

INSTALL.md's component table and by-hand step named two of the plugin's
helpers; the release ships three. RunicGatewayRaids.cs (D204) is now
named in both.

Found while writing the runicgateway.com Rust docs (its PLAN.md §16,
phase 15).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01E14m6SuuY6i1vASFeGDBeY
This commit is contained in:
claude
2026-10-22 15:15:01 -05:00
parent 4f92a13b4b
commit 7b6e198f63
2 changed files with 39 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
rust-link/INSTALL.md
View File

@@ -11,7 +11,7 @@ speaks one protocol, never "the latest of each" — and a third, RunicNPC, which
| Component | What it is | Released from |
|---|---|---|
| **The plugin** | `RunicGateway.cs`, one file that runs unchanged on Oxide and Carbon — and beside it, from protocol 13, the optional **ZoneManager helper** `RunicGatewayZones.cs` (PLAN_FIXES D181, D182), installed by default | [Rust-Plugins](https://gitea.whitlocktech.com/RunicGateway/Rust-Plugins/releases) |
| **The plugin** | `RunicGateway.cs`, one file that runs unchanged on Oxide and Carbon — and beside it three optional helpers, each installed by default: the **ZoneManager helper** `RunicGatewayZones.cs` (from protocol 13, PLAN_FIXES D181, D182), the **domes helper** `RunicGatewayDomes.cs` (PLAN_REDESIGNS D194) and the **raids helper** `RunicGatewayRaids.cs` (PLAN_REDESIGNS D204) | [Rust-Plugins](https://gitea.whitlocktech.com/RunicGateway/Rust-Plugins/releases) |
| **The sidecar** | `rust-link-sidecar`, which the plugin dials on loopback and the website reaches over HTTP | [Rust-Link](https://gitea.whitlocktech.com/RunicGateway/Rust-Link/releases) |
| **RunicNPC** | `RunicNPC.cs`, Runic Gateway's NPC plugin ([`../runicnpc/PLAN.md`](../runicnpc/PLAN.md)), placed beside the bridge: the latest RunicNPC release that answers the API the bridge needs (D224). **Required** since RunicNPC's stage 9 (D310): without it the bridge refuses every NPC an event places, Rust's own scientists included, and Admin → Rust → Servers shows the server as incomplete. It needs **Kits**, like the bridge. Its own guide is [`../runicnpc/INSTALL.md`](../runicnpc/INSTALL.md) | [runicnpc-rust](https://gitea.whitlocktech.com/RunicGateway/runicnpc-rust/releases) |
@@ -179,7 +179,9 @@ history, and the token is unchanged.
events still score everybody, but ZoneManager's own flags miss that player, and an event zone's
flags such as PvpGod or NoBuild may not hold at all. The second is
`RunicGatewayDomes.cs`, which lets the bridge ask ZoneDomes for a dome over an event zone; leave it
out and zones open without one. To name the server, create its config first —
out and zones open without one. The third is `RunicGatewayRaids.cs` (PLAN_REDESIGNS §11.4, D204),
which lets an event spawn a RaidableBases base of its own and despawn only that base when the event
ends; leave it out and such a base despawns on RaidableBases' own timer. To name the server, create its config first —
`oxide/config/RunicGateway.json` or `carbon/configs/RunicGateway.json` — holding
`{ "ServerId": "<id>", "Port": 7799 }`. Without it, the plugin calls the server `main`.
4. **The sidecar:** put the binary somewhere stable and give it a config: