Files
rivencraft/docs/STATIC_SKY_RESOLUTION.md
T
2026-11-17 18:12:07 -05:00

103 lines
5.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Static Sky resolution — issue #109
Local test builds: **Minecraft 1.21.1 / 1.21.1.0.5** and **Minecraft 26.3 /
26.3.0.8**. Pending player validation; not committed or published.
## Authoring
Place one or more Number Pages **immediately before Static Sky**. Digits are
0–24 in base 25, as with Flooded. No Number Pages means the existing **48 × 48
cells on each of six faces**.
| Written sequence | Resolution on each face |
| --- | --- |
| Static Sky | 48 × 48 |
| Number 0 → Static Sky | 1 × 1 (minimum) |
| Number 8 → Static Sky | 8 × 8 |
| Number 24 → Static Sky | 24 × 24 |
| Number 1 → Number 23 → Static Sky | 48 × 48 |
| Number 5 → Number 3 → Static Sky | 128 × 128 (maximum) |
| Number 24 → Number 24 → Static Sky | 128 × 128 (624 clamps) |
Any intervening non-number Page breaks the digit run. A Number followed by a
color still modifies that color, not the later sky. Other Sky styles do not
consume resolution numbers. Duplicate Sky controllers retain the existing
last-choice recovery and instability rules; the final unnumbered Static Sky
returns to 48. Dangling/misplaced numbers retain their usual diagnostics.
Higher values make smaller cells. Resolution does not change the animation
cadence, colors, celestial geometry, terrain or lighting. Random/unmodified
Static Ages retain 48; no new Page or recipe is added. Creative and JEI use
the existing Static Sky and Number items, with updated tooltips.
## Persistence and synchronization
- **1.21.1:** derive resolution from the persisted ordered semantic writing,
include it in AgeSkyProfile and its server-to-client sky payload.
- **26.3:** freeze resolution in the existing presentation settings record
(PortAgeColors), save optional `static_resolution` in the Age index and
synchronize it with the full Age catalog. Old records without the field
default to 48.
- Require matching updated client/server builds: sky payload protocol is 19
on 1.21.1 and Age catalog protocol is 12 on 26.3.
- No existing chunks or writing are rewritten. Existing unnumbered Static
Ages retain their old appearance. Save/revisit/reconnect/restart preserve
newly authored settings.
## Render bounds and lifecycle
Shared bounds are **1–128** cells per face, including the constructors and
client render entry points. Long digit runs saturate safely before clamping.
The 1.21.1 procedural renderer draws at most 98,304 quads (393,216 vertices),
roughly 6 MiB of position/color vertex data per draw. The bound limits its
existing per-cell work; the normal 48 setting is unchanged.
The 26.3 renderer keeps one 24-vertex cube. Its current noise atlas is at most
768 × 128 RGBA pixels (384 KiB of image data). It creates a replacement only
when the extracted resolution changes, closes the previous texture, invalidates
the frame/tint cache, and reuses the cube. World metadata is read during
extraction, never during drawing. Extracted state resets to 48; renderer close
releases both GPU resources. No growing per-Age texture cache is introduced.
## Automated checks
Run separately, sequentially:
```sh
python3 scripts/regression_static109.py mc1211
python3 scripts/regression_static109.py mc263
```
These use the server lock, isolated startup fixtures and new temporary worlds,
with a 60-second stall handoff. They delete worlds and fixture outputs on
success or failure and retain logs in `build/verification/static109/`.
The probes do not enter the production JAR or default GameTest suite.
Results: 34 checks passed on 1.21.1 and 42 on 26.3 for unmodified/default,
zero, single and multi-digit writing, bounds, ordering, saved plan/codec and
full packet/catalog round trips, independent color, old-save defaults,
non-Static behavior and unchanged Flooded digit grammar. Actual GPU appearance
and preview interactions remain player checks.
## Player checks — both versions
1. Bind fresh Ages with Static Sky alone, Number 8 + Static Sky, Number 24 +
Static Sky, and Number 5 + Number 3 + Static Sky. Prefer the same remaining
Pages and an explicit celestial choice to make comparison straightforward.
2. Look up, down and around: all six faces should show the selected cell size
and keep animating. The plain book retains the previous fine static.
3. Check Number 0 gives the coarse minimum. Compare Number 1 + Number 23 to the
unnumbered default. Oversized values clamp instead of crashing.
4. Add numbered color Pages before the resolution digits; verify the tint and
resolution work independently.
5. Travel between different-resolution Ages, the Overworld and a non-Static
Age. Check book/portal destination views with the installed optional renderer
for leaked settings.
6. Revisit, reconnect and restart; the selected resolution must persist.
Update both ends if using a dedicated server.
## Release validation (2026-11-17)
Player in-game checks passed. Included in releases 1.21.1.0.6 and 26.3.0.10 (Seamless integration applies to 26.3 only). Earlier candidate notes above describe development history. Known Reborn/Seamless acknowledgement and rendering failures remain tracked in [#118](https://git.paddedcell.org/dnorberg/rivencraft/issues/118); this release does not resolve them.