Skip to content

docs: describe infusion table persistence and recovery #268

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryanbarlow97 merged 3 commits into from
Oct 15, 2026
Merged

docs: describe infusion table persistence and recovery #268

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f54eee
docs: describe infusion table persistence and recovery
ryanbarlow97 Oct 15, 2026
094dade
docs: explain durable snapshots and cleanup retries
ryanbarlow97 Oct 15, 2026
95ff55f
docs: clarify restart after repairing retained infusion tables
ryanbarlow97 Oct 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions projects/GemInfusion/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,23 @@ definitions for hits, materials, tiers, qualities and projects. It loads
persisted stations, flushes them periodically and on shutdown, and registers
socket/unsocket listeners.

Infusion tables save their gem IDs and hit progress after each deposit or hit in
`plugins/GemInfusion/data/infusion-stations/<world-uuid>_<x>_<y>_<z>.yml`.
Completed batches also save the rolled items awaiting delivery. Startup restores
unfinished batches and resumes remaining drops without requiring the player to
be online. Tables stay occupied until delivery finishes. Autosave and shutdown
also save active tables.

A failed deposit or hit save leaves the gem or infusion token with the player and
keeps the previous progress. Unreadable snapshots, missing worlds and unknown
gem IDs are logged and retained; the affected table refuses new deposits until
staff repair the snapshot or restore the missing configuration. Stop the server
before repairing saved files; restart after restoring configuration to retry
retained snapshots. Snapshots are flushed to disk before atomic
replacement, then the directory is flushed. A directory flush failure after
replacement is logged without rolling back the committed deposit. Finished
tables retry failed snapshot deletion before accepting a new batch.

`/geminfusion reload` reloads definitions and stations.
`/geminfusion select <projectId>` selects a project on an empty table the player
is looking at within six blocks. Both commands require `geminfusion.admin`. Goldsmithing gameplay uses
Expand Down