Files
rivencraft/docs/ACCELERATED_MACHINES.md
T
2026-11-18 16:43:39 -05:00

82 lines
4.7 KiB
Markdown

# Accelerated server machines — issue #112
Introduced in development candidates **1.21.1.0.7** and **26.3.0.11**.
Player in-game checks passed; included in releases **1.21.1.0.12** and **26.3.0.15**.
## Behavior
Each authored Accelerated Page requests one extra tick per server-side ticking
block entity in that Age, in addition to its normal tick. One Page targets 2x
normal ticker calls; four target 5x, before budgets. Identical Pages stack.
The normal registered bound ticker is reused, including optional modded machines.
Its own state validity, chunk-ticking and NeoForge error-handling rules remain active.
Entities, scheduled block ticks and the global clock are not accelerated.
Extra work respects removed/rebound tickers, loaded chunks, normal block-ticking
range, world border and server tick freeze. No new chunk tickets are created.
Machines in normally ticking force-loaded Age chunks may run without a nearby
player. Random-block acceleration remains restricted to its existing player-nearby
chunks. The Overworld and Ages without Accelerated Pages receive no extra work.
The existing authored-plan/page-count save data is unchanged. Existing Accelerated
Ages gain machine ticking after installing this build; no new Age is required.
Page counts persist through the existing save/reload/reseed paths. Work cursors
are transient and reset on reload; they do not alter the saved Page count.
## Independent budgets
Both targets expose these settings under accelerated_age:
| Setting | Default | Meaning |
| --- | --- | --- |
| max_machine_candidates_per_tick | 1024 | Maximum registered ticker entries inspected in one Age tick, rotating across the list. |
| max_machine_ticks_per_tick | 4096 | Maximum extra machine ticker calls per Age tick. Zero disables only machines. |
| max_random_tick_attempts_per_tick | 16384 | Existing random block samples; zero disables only random-block acceleration. |
| max_loaded_chunks | 8 | Existing random-block chunk cap; not a machine chunk-loading setting. |
The selected machine window is snapshotted before executing tickers. Work is
distributed round-robin across eligible machines rather than letting the first
machine use every repeated Page. Removal/replacement/freeze is checked again
before each call. Large installations can hit the cap and run slower than the
requested multiplier. Both machine settings have an upper bound of 65536.
## Compatibility limits
Additional ticker calls also consume normal fuel, energy, inputs and durability.
The effect does not synthesize power or bypass recipe requirements. Machines that
compare global game time, use once-per-tick guards, async jobs or scheduled work
may remain limited to their ordinary rate. Transport may bottleneck independently.
No optional machine mod is required or hard-coded.
## Validation and manual checks
Run sequentially:
python3 scripts/regression_machine112.py mc1211
python3 scripts/regression_machine112.py mc263
These use new disposable worlds and remove them on pass or fail. A 60-second
stall stops the run and hands remaining checks to the player, without a retry.
Fixtures remain outside shipping artifacts.
In-game checks, on each target:
1. In Survival, compare fuelled furnaces in Ages with zero, one and four Pages.
Smelting should be about 10, 5 and 2 seconds per ordinary 200-tick recipe,
before machine budgets; use the same input/fuel and avoid other speed effects.
2. Repeat with a ticking modded machine (Create on 1.21.1 if available). Record
the machine type if it does not accelerate; game-time guards may be a limit.
3. Remove and replace a working machine, leave its chunks, return, then restart.
No ghost ticking or force-loading should occur. Existing Page counts remain.
4. Confirm an ordinary Overworld furnace stays at its normal rate and random-tick
crops still accelerate in an Accelerated Age.
5. With two players in the same Age, confirm the effect is not doubled by player
count. Test tick freeze; machines must stop along with the normal world.
Automated probes test registered vanilla furnace recipes, zero/one/repeated Pages,
freeze, removal/replacement, nonloaded/border guards, a custom registered ticker,
Overworld event exclusion, bounded fair work, and saved Page-count decoding.
They do not constitute a real modded-machine or two-client/restart pass.
### Automated result
Sequential probes passed: **25 checks on 1.21.1**, **26 checks on 26.3**. The freeze check initially exposed a cached runsNormally value immediately after setFrozen; the adapter now checks both the current freeze flag and the tick manager's run state. No test stalled. Both temporary worlds were removed. Player in-game checks subsequently passed; no independent real-mod-machine or two-client/restart result is claimed.