docs(modules): phase 7b as built — configuration from the site, and the undo that makes it safe
PROTOCOL.md §11 specifies protocol 5: the walk rooted at the framework's own config directory, the version a write must present back, the set-shaped write, the watched reload and the automatic restore. PLAN.md §21 is the phase as built — four org-lead decisions, the float trap and what avoiding it cost, and four defects a browser found that 179 green tests did not. PLAYER_WALK.md gains the configuration walk, because the acceptance line needs the sidecar and the game on one host and the rig cannot reach one yet. INTEGRATION.md gains the four things an operator should know before they edit a plugin's settings from a web page. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PMH6bw1jXMgbyF3ZWGEzSM
This commit is contained in:
@@ -260,6 +260,29 @@ side:
|
||||
`rg.perms` at the server console prints what the last sync did, which is the fastest way to tell
|
||||
"that permission does not exist here" from "that player has never been seen here".
|
||||
|
||||
**From protocol 5 you can edit your plugins' settings from the website**, in Admin → Rust mod
|
||||
config. It reads the configuration directory your framework actually uses — `oxide/config` or
|
||||
`carbon/configs`, or wherever you moved it — and generates a form from the values it finds, so it
|
||||
works for whatever you have installed. Four things worth knowing before you use it:
|
||||
|
||||
- **A save reloads the plugin and watches the reload.** If the plugin does not come back within four
|
||||
seconds, the old file is **restored automatically** and the site shows you the log line that says
|
||||
why. A typo costs you a few seconds, not a plugin.
|
||||
- **Your data directory is not listed, deliberately.** `oxide/data` (or `carbon/data`) holds live
|
||||
state — kit cooldowns, zone definitions, the permission store itself — not settings. Editing it
|
||||
from a web form edits your players' cooldowns, and a running plugin overwrites the change on its
|
||||
next save anyway.
|
||||
- **Which plugin gets reloaded is your choice, with a guess filled in.** A folder name is
|
||||
convention, not contract, so the site suggests one and lets you change it. The suggestion is right
|
||||
nearly always and wrong silently when it is wrong, which is why it is a field rather than an
|
||||
assumption.
|
||||
- **This bridge's own `Host`, `Port` and `ServerId` are read-only there.** Changing them from the
|
||||
website would cut the link carrying the change, or strand every row the site holds for this
|
||||
server. Edit them on the host; everything else in that file is editable from the site.
|
||||
|
||||
`rg.config` at the server console prints which directory the site is reading and what the last write
|
||||
from it did.
|
||||
|
||||
**Every row carries its wipe.** The plugin derives a `wipeId` from the save's creation time and
|
||||
stamps it on every frame, so a wipe splits the history rather than ending it. That is also why
|
||||
**the sidecar's database must never be in a wipe script's delete list** — see the Pterodactyl egg's
|
||||
|
||||
Reference in New Issue
Block a user