Show Local Storage save progress in the dashboard #3

New issue

Closed

opened 2026-09-25 09:19:34 +02:00 by kyuubi · 1 comment

kyuubi commented

2026-09-25 09:19:34 +02:00

Owner

Show the progress of Local Storage saves in the dashboard's sync indicator ("All Synced"), in place of the cloud status while a save runs. Placement decided: dash only.

Design

RecordSyncStatus.OnCommonUpdate postfix writes StatusMessage in vanilla's two-line style: Saving Locally / Cosmic Defender · 34/120 assets · 812 MB. The text refreshes 4×/s and goes back to the vanilla text when saves end.
SaveProgressBoard (engine-free, unit-tested) tracks running saves: one save shows its name, assets written/total and size; several show N saves · total size; the last step shows finishing.
The asset total is counted from the graph's URL nodes with the same filter PackageCreator.CollectAssets uses; the written count is RecordPackage.AssetCount, and the size is the package file's length on disk.
Covers item saves, Save As / Save Copy of worlds, and plain Save of a Local Storage world.

Limits

The world snapshot at the start is one blocking engine call; it shows no progress.
An asset that isn't cached is downloaded during packing; the count pauses on it.

Plan

Progress board + tests
Wire into package writing, pending saves and overwrite saves
Dashboard patch
Build, tests, install, commit + push
In-game check with a big world

Show the progress of Local Storage saves in the dashboard's sync indicator ("All Synced"), in place of the cloud status while a save runs. Placement decided: dash only. ## Design - `RecordSyncStatus.OnCommonUpdate` postfix writes `StatusMessage` in vanilla's two-line style: `Saving Locally` / `Cosmic Defender · 34/120 assets · 812 MB`. The text refreshes 4×/s and goes back to the vanilla text when saves end. - `SaveProgressBoard` (engine-free, unit-tested) tracks running saves: one save shows its name, assets written/total and size; several show `N saves · total size`; the last step shows `finishing`. - The asset total is counted from the graph's URL nodes with the same filter `PackageCreator.CollectAssets` uses; the written count is `RecordPackage.AssetCount`, and the size is the package file's length on disk. - Covers item saves, Save As / Save Copy of worlds, and plain Save of a Local Storage world. ## Limits - The world snapshot at the start is one blocking engine call; it shows no progress. - An asset that isn't cached is downloaded during packing; the count pauses on it. ## Plan - [x] Progress board + tests - [x] Wire into package writing, pending saves and overwrite saves - [x] Dashboard patch - [x] Build, tests, install, commit + push - [x] In-game check with a big world

kyuubi referenced this issue from a commit

2026-09-25 09:19:35 +02:00

Show Local Storage save progress in the dashboard

kyuubi commented

2026-09-25 09:29:14 +02:00

Author

Owner

The first version showed nothing: the dash facet (template SyncStatus) never displays RecordSyncStatus.StatusMessage. A dump of the live facet showed its ProtoFlux picking a state from RecordQueueCount, AssetVariantQueueCount, CurrentTaskProgress and LastError, with locale drivers for the text and the bar/percentage driven by CurrentTaskProgress. Since e9c4f02 (v0.3.1), local saves are reported through those outputs: the pill shows vanilla's "Syncing N Items" with the bar filling (asset packing = 90%, writing the data = the rest). The name/size detail line is gone, because the facet has nowhere to show it.

The first version showed nothing: the dash facet (template `SyncStatus`) never displays `RecordSyncStatus.StatusMessage`. A dump of the live facet showed its ProtoFlux picking a state from `RecordQueueCount`, `AssetVariantQueueCount`, `CurrentTaskProgress` and `LastError`, with locale drivers for the text and the bar/percentage driven by `CurrentTaskProgress`. Since e9c4f02 (v0.3.1), local saves are reported through those outputs: the pill shows vanilla's "Syncing N Items" with the bar filling (asset packing = 90%, writing the data = the rest). The name/size detail line is gone, because the facet has nowhere to show it.

kyuubi referenced this issue

2026-09-25 09:29:14 +02:00

Save and open worlds in Local Storage #2

kyuubi referenced this issue from a commit

2026-09-25 09:29:16 +02:00

Feed save progress to the dash facet; let the saver go right away

kyuubi closed this issue

2026-09-25 13:08:17 +02:00