Compare commits

..
36 Commits
Author SHA1 Message Date
dnorberg 4f07f675a4 Refresh public links and include development screenshots
Build / build (push) Canceled after 0s
2026-10-26 14:25:18 -04:00
dnorberg b8be99606f Add configurable random Page lists and safe fallbacks (#95) 2026-10-26 14:25:13 -04:00
dnorberg 98595c83ea Complete Milestone 7 acceptance and binder diagnostics (#84)
Build / build (push) Canceled after 0s
2026-10-22 22:32:12 -04:00
dnorberg e7e2cf7e5a Add Milestone 7 regression and documentation review (#83)
Build / build (push) Canceled after 0s
2026-10-22 21:37:50 -04:00
dnorberg 77f15f8599 Use number pages for celestial modifiers (#94)
Build / build (push) Canceled after 0s
2026-10-22 15:33:37 -04:00
dnorberg 2b2605b277 Add optional authored Ruins structures to Ages (#91)
Build / build (push) Canceled after 0s
2026-10-22 15:17:17 -04:00
dnorberg 2f1e6bd6f2 Clear book receptacle model when removing book
Build / build (push) Canceled after 0s
2026-10-22 03:51:42 -04:00
dnorberg 9d5ff2a2cb Complete authored sky colors and eclipses (#44)
Build / build (push) Canceled after 0s
2026-10-22 03:40:10 -04:00
dnorberg 3ac4c499ab Add authored Age skies and celestial pages (#44)
Build / build (push) Canceled after 0s
2026-10-21 23:56:58 -04:00
dnorberg 9044835ec5 Support horizontal portals and visible receptacle books (#93)
Build / build (push) Canceled after 0s
2026-10-21 23:02:32 -04:00
dnorberg 7ae41da23e Add Legacy-style symbol portfolios (#92)
Build / build (push) Canceled after 0s
2026-10-21 14:13:34 -04:00
dnorberg 9cb63e6994 Align Writing Desk numerals with Legacy glyphs (#43)
Build / build (push) Canceled after 0s
2026-10-21 14:01:02 -04:00
dnorberg 6337b5aa10 Restore Legacy link modifier travel behavior
Build / build (push) Canceled after 0s
2026-10-21 13:36:30 -04:00
dnorberg b9faa28dd5 Refine Cave terrain environment and spawning (#14)
Build / build (push) Canceled after 0s
2026-10-21 08:38:23 -04:00
dnorberg 09d2b0800c Complete Link Modifier controls and seed-driven Age generation (#90)
Build / build (push) Canceled after 0s
2026-10-21 08:11:26 -04:00
dnorberg ee905cab68 Add Legacy missing items and OP Link Modifier (#90)
Build / build (push) Canceled after 0s
2026-10-20 17:50:09 -04:00
dnorberg 5c08f391a2 Update optional Serene Seasons compatibility to 10.1.0.9
Build / build (push) Canceled after 0s
2026-10-20 17:33:07 -04:00
dnorberg b8d26a9036 Update optional JEI compatibility to 19.69.0.457
Build / build (push) Canceled after 0s
2026-10-20 17:12:21 -04:00
dnorberg d0af75239a Match Legacy handheld book drops with model entity (#85)
Build / build (push) Canceled after 0s
2026-10-19 16:41:07 -04:00
dnorberg 2e5d6e0427 Adopt NeoForge 21.1.264 after compatibility testing
Build / build (push) Canceled after 0s
2026-10-19 05:37:46 -04:00
dnorberg 54c10cca6c Default automatic Return Links to disabled and review compatibility
Build / build (push) Canceled after 0s
2026-10-19 05:21:00 -04:00
dnorberg c39ebd78ba Add Milestone 7 progression advancements
Build / build (push) Canceled after 0s
2026-10-19 04:57:15 -04:00
dnorberg 1ff62e9aaa Polish Milestone 7 models textures and link effects
Build / build (push) Canceled after 0s
2026-10-19 04:32:35 -04:00
dnorberg b154455563 Complete Milestone 7 crafting and portal guide (#79)
Build / build (push) Canceled after 0s
2026-10-19 04:01:03 -04:00
dnorberg 4a87c9fae6 Harden crystal portals across restart and protected travel
Build / build (push) Canceled after 0s
2026-10-18 23:17:16 -04:00
dnorberg 350d137d9e Render fallback crystal portals as two-sided surfaces
Build / build (push) Canceled after 0s
2026-10-18 00:22:56 -04:00
dnorberg 59bd1c7f6c Implement crystal portals with optional Immersive Portals view (#77)
Build / build (push) Canceled after 0s
2026-10-17 12:13:12 -04:00
dnorberg 644d242bba Generate Legacy-style libraries in Ages (#76)
Build / build (push) Canceled after 0s
2026-10-17 11:34:57 -04:00
dnorberg 3423dd25bf Audit Legacy Milestone 7 parity for issue 75
Build / build (push) Canceled after 0s
2026-10-17 02:30:35 -04:00
dnorberg c560e328de Update Gitea URLs after server move
Build / build (push) Canceled after 0s
2026-10-16 16:21:32 -04:00
dnorberg 34ffd317aa Record verified Milestone 6 closure (#74)
Build / build (push) Canceled after 0s
2026-10-12 15:10:17 -04:00
dnorberg c2c2d7a6f8 Complete Milestone 6 acceptance and runtime cleanup (#74)
Build / build (push) Canceled after 0s
2026-10-12 15:07:58 -04:00
dnorberg 44205f80e0 Complete instability regression slice and ordered modifiers (#73)
Build / build (push) Canceled after 0s
2026-10-12 14:47:15 -04:00
dnorberg 4f464dbe60 Extend Legacy instability parity and accelerated ages
Build / build (push) Canceled after 0s
2026-10-11 17:14:46 -04:00
dnorberg 783a33456d Added live instability for block generation
Build / build (push) Canceled after 0s
2026-10-10 15:16:08 -04:00
dnorberg 7b5597dd47 Expose instability controls and diagnostics (#72)
Build / build (push) Canceled after 0s
2026-10-10 14:39:38 -04:00
291 changed files with 11853 additions and 648 deletions

No files matched your search

+4
View File
@@ -19,6 +19,10 @@ under the same license; desk wood and inlay textures are cropped from desk.png.
The Ink Mixer GUI atlas and block textures are copied from Legacy's
assets/mystcraft/gui/inkmixer.png and textures/blocks/inkmixer_*.png under
the same license. Rivencraft's block model is original and uses those textures.
The bundled mystcraft_library.nbt structure template is a block-layout adaptation
of Mystcraft Legacy's ComponentScatteredFeatureSmallLibrary.java at commit
9bc8ddc061845df0cd5ea47f4fdef773cff786ae, under LGPL-3.0. The conversion
script at scripts/generate_legacy_library_template.py is included to rebuild it.
The initial build layout is derived from the official NeoForge 1.21.1
ModDevGradle MDK: https://github.com/NeoForgeMDKs/MDK-1.21.1-ModDevGradle
+93 -229
View File
@@ -1,253 +1,117 @@
# Rivencraft
Rivencraft is a clean, incremental port of the ideas and gameplay of
[Mystcraft Legacy](https://github.com/Mystcraft/Mystcraft-Legacy) to Minecraft
1.21.1 on NeoForge.
Write a book. Name an Age. Step into a world that did not exist before.
The bootstrap, books/linking, Ages, writing-system, and Age-grammar milestones are complete.
The writing system uses a data-pack symbol catalog and persistent
ordered-writing model. Linking Books and Descriptive Books create persistent
Ages from either authored supported symbols or seeded random completion.
Milestone 6 instability work is in progress: Ages persist frozen instability
scores and provider plans, and the bounded runtime implements status effects,
colored decay, lightning, explosions, meteors, burning, and erosion. The
[Milestone 5 acceptance record](docs/MILESTONE_5_ACCEPTANCE.md) lists the
supported grammar, optional integrations, and limits; the
[instability runtime policy](docs/INSTABILITY_RUNTIME.md) records the current
effects and modern safety boundaries.
Rivencraft brings the books, writing stations, symbols, and unpredictable Ages
of [Mystcraft Legacy](https://github.com/Mystcraft/Mystcraft-Legacy) to
Minecraft 1.21.1 on NeoForge. Mystcraft veterans will recognize the writing
flow, D'ni-inspired glyphs, libraries, crystals, and instability. Rivencraft
also lets you author modern terrain, biomes, structures, seasons, and celestial
bodies. It is an active pre-public-release project, not a byte-for-byte copy of
the 1.12.2 mod.
Milestone 4 now includes stackable blank Pages plus server-created symbol,
unresolved-symbol, and baseline link-panel states. Page visuals follow the
legacy runtime-composition rules. Craft an Ink Vial from two black dye, a glass
bottle, and a water bucket; the bucket is returned. Hold vanilla paper in one
hand and use the Ink Vial in the other to prepare a baseline Link Panel Page.
Each vial holds 16 ink units, and the default link-panel cost is two units.
The spent vial returns a glass bottle. Server owners can adjust the symbol-copy
and link-panel costs in the `writing` section of `rivencraft-server.toml`.
The Ink Mixer now offers a Legacy-style station for producing Link Panels:
insert paper and Ink Vials, then take a Link Panel from the result slot. Each
vial fills its 16-unit basin and returns a glass bottle; taking one Link Panel
uses the full vial. No server tick is needed. The earlier paper-in-one-hand
method still uses the configurable link-panel ink cost. Ink Mixer
additives can roll Disarm, Maintain Momentum, and Intra Linking onto a Link
Panel. Descriptive Books retain Disarm and Momentum; Intra Linking is only
meaningful for same-dimension travel with a Linking Book.
TerraBlender 1.21.1 integration is optional: registered modded biomes receive
Biome pages, with cave and Nether biomes in a separate Cave Biome creative tab.
TerraBlender Overworld/Nether regions extend compatible Age
biome pools. See [the compatibility matrix](docs/TERRABLENDER_COMPATIBILITY.md)
for supported versions and in-game verification.
Serene Seasons 1.21.1 can maintain separate season progress in an Age dimension.
Rivencraft automatically whitelists loaded Ages without a restart when Serene is installed;
season pages can instead opt an Age out or hold it in one season.
See [the optional compatibility guide](docs/SERENE_SEASONS_COMPATIBILITY.md)
for the supported manual configuration and current limits; Rivencraft does not
require Serene Seasons or GlitchCore.
The Writing Desk can copy a selected written page from its collection tabs.
The Writing Desk is now craftable from planks, a glass bottle, and a feather.
It occupies two adjacent blocks, with one shared inventory; loaded paper and
the selected page appear on its Legacy-inspired model.
Desks placed before 0.3.6.1 keep their old one-block footprint until broken
and placed again; leave an adjacent space when replacing one.
Its 88 collection tabs, paper input, ink vial input, empty glass-bottle return,
16-unit ink meter, and inventory persist
through world saves; breaking it drops stored contents. The desk screen is a
functional foundation using Legacy's original desk and scrollbar textures.
Four tabs are visible at once; the controls above and below them move by four
(1–4, 5–8, through 85–88). Each viewer can browse a different group. Existing
four-tab desks retain their collections and supplies when upgraded.
With a notebook selected, pick up a Page from your inventory and click an empty
position on the left surface to store one page there. Clear search/filter/sort
and turn off `ALL` to place pages at specific positions; occupied positions are
never overwritten. A notebook tab exposes all 27 notebook positions (scroll to
reach the rest); a loose-page tab exposes only its one occupied position.
Empty tabs have no page storage until a notebook or page is put in the tab slot.
Click a page on the desk surface to select it for copying. Drag a page from one
notebook position to an empty position to move it, or onto another page to swap
their positions. This also works between notebooks shown in the `ALL` view.
Drag a page out of the panel to turn it back into an item. Drop it over a player
inventory slot or desk tab to place it there; a tab with a notebook adds it to
the first open position. Dropping elsewhere leaves the page on the cursor for
normal inventory placement. The source notebook or tab loses the page only after
a valid drop.
Put vanilla paper in the
upper-left slot and Ink Vials in the upper-right; a copy appears in the
lower-left result slot when the selected page is valid. Taking it consumes one
paper and, by default, one ink. An available vial refills an empty ink meter
when inserted or when copying uses its last ink, and returns a vanilla glass
bottle to the lower-right slot. Removing a bottle also retries a blocked refill.
Refilling waits if that slot is full or contains another item. The `AZ` control sorts
visible pages by name; `ALL` shows pages held across every desk tab. Search and
category filtering narrow the view without granting new pages, and cross-tab
copy selection is checked by the server.
Selecting a stored page on the desk surface shows its Legacy-proportioned
portrait preview and name above the player inventory.
## Getting started
## Book Binder
1. Make an Ink Vial from two black dyes, a glass bottle, and a water bucket.
Craft an Ink Mixer, Writing Desk, and Book Binder.
2. Put paper and an Ink Vial in the Ink Mixer and take a Link Panel Page. Add
ingredients to the basin first if you want a chance of link modifiers.
3. Put leather or an empty Notebook and the Link Panel in the Book Binder.
Name the Age and take the Descriptive Book. A book with only a Link Panel
creates a seeded random Age; add Symbol Pages to author its features.
4. Open the book to create its Age, then click the destination preview to
travel. Bring a bound Linking Book for the return trip: automatic Return
Links are off by default.
For a new survival Age: craft an Ink Vial, an Ink Mixer, a Writing Desk, and a Book Binder.
Put vanilla paper and an Ink Vial in the Ink Mixer to make a Link Panel
Page. Place leather (or an empty Notebook) and the Link Panel in the Book Binder,
enter an Age name, and take the finished Descriptive Book. Written symbol Pages
are optional; without them, the book creates a random Age. To duplicate a Page
you already own, store it in a Writing Desk tab, select it, supply paper and ink,
and take the copied Page from the output. A Notebook can hold and transfer a
larger ordered collection of Pages between desks and the binder.
Find new Symbol Pages in Age libraries, or copy pages you already own with
paper and ink at the Writing Desk. The Notebook stores ordered pages, including
intentional gaps. Written pages can control terrain, biome distribution,
weather, lighting, seasons, sky color, suns and moons, decorations, structures,
and more. Incorrect or excessive writing can make an Age unstable; instability
may bring decay, lightning, explosions, meteors, burning, erosion, and other
hazards. Some combinations are still unsupported and the Binder reports them
before consuming ingredients.
With JEI installed, Rivencraft displays the Ink Mixer operation in its own
category and the hand-use, copying, binding, and Linking Book crafting flows in a Writing category.
The Link Panel and individual symbol Pages, including registered vanilla biome
pages, appear as separately searchable JEI ingredients.
Creative inventory separates Link Pages and each symbol category into their own
tabs, including distinct Biome and Biome Generation tabs. Blank Pages are hidden
from creative inventory and JEI.
JEI is optional; vanilla crafting
recipes and all writing interactions work without it. For a development client
with JEI, run `./gradlew runClient -PwithJei=true`.
Place a Rivencraft book or page on a vanilla Lectern to convert it to a Book
Stand. Crystal formations yield shards for Crystal Blocks. A connected crystal
frame with a Book Receptacle and a bound book forms a portal; frames can stand
upright or lie flat. Libraries, Book Stands, and portals use Legacy-inspired
assets and sounds. Handheld travel drops the used book at the departure point,
so plan how you will retrieve it.
Craft a Book Binder from three iron ingots and five planks. Put leather or an
empty Notebook in the left cover slot. Enter a title, then place a Link Panel
Page first in the horizontal page strip. Click a page in the strip with a
written Page on the cursor to insert it before that position; click it with an
empty cursor to take it out. The arrows or mouse wheel scroll through up to
27 written Pages. Clicking the strip with a filled Notebook imports its Pages
at that position and leaves the emptied Notebook on the cursor. The right slot
outputs a Descriptive Book once the title, cover, and Link Panel are present.
Inputs are consumed only when the result is taken.
## Requirements and optional integrations
The completed book receives its Age identity when assembled. With only a Link
Panel, it describes a randomly generated Age. Authored writing is compiled once
into a versioned, server-owned Age plan. The plan freezes the Age seed, resolved
symbol meanings, page order, and runtime profile, so later data-pack changes do
not reinterpret an existing Age. An authored terrain page selects its runtime
profile. Built-in pages cover Standard, Amplified, Cave, Island, Flat, and Void;
authored biome, environment, and supported feature pages also affect new Ages.
The
writing is also stored on the book; the Descriptive Book screen's turned pages
show ordered symbols and unresolved IDs. The Descriptive Book screen follows
Legacy's book spread: the title and Age details are on the left, the destination
preview is on the right, and clicks in the bottom corners turn pages. Ordered
symbol pages appear before the final blank spread with their runtime-rendered
pictograms. Link-panel-only books use Rivencraft glyphs for their generated
Age description.
Install the same gameplay mods on the client and server:
## Linking Book
- Minecraft **1.21.1**, NeoForge **21.1.264 or newer in the 21.1 line**, and
Java 21.
- **Dynamic Dimensions AR Edition 0.9.1** and its **Bad Packets 0.8.2**
dependency. These are required for Age dimensions.
Craft an unwritten Linking Book from one Link Panel Page and one leather in any
two crafting-grid positions. An unbound book opens a screen where it can be named and bound to the
current location. A bound book opens its destination screen and travels when
its preview panel is clicked. The destination is stored on the item and
survives inventory and world saves. Travel only succeeds if the target
dimension is loaded and a non-fluid, passable landing position can be found
nearby.
The Linking Book uses the same Legacy page layout and bottom-corner page turns
as the Descriptive Book, but without the Descriptive Book's gold cover edges.
Both screens play Minecraft's book-page-turn sound when a page is turned.
Rivencraft works without any of these optional integrations:
Successful book travel plays Mystcraft Legacy's original linking sound at both
the departure and arrival locations.
| Mod | What it adds |
| --- | --- |
| JEI | Searchable Pages and guides for the Ink Mixer, Writing Desk, Book Binder, and Linking Book crafting. |
| Create (bundles Ponder) | Ponder book snapshots and a crystal-portal construction guide. |
| Immersive Portals | Live destination views in book previews and crystal portals. In `AUTO` preview mode it takes priority over Ponder. |
| TerraBlender | Eligible biomes from mods using its Overworld/Nether regions become Age biome candidates and Pages. Biomes O' Plenty is one example; it is not hard-coded or required. |
| Serene Seasons (with GlitchCore) | Independent per-Age seasons, including normal seasons, no seasons, and four eternal-season modes. |
| Ruins | Authorable Ruins-template Pages and Ruins structures in Ages. |
Right-click an empty vanilla lectern with a Rivencraft book to convert it into
a Book Stand and place the book on it. Use a Linking Book on the stand by
right-clicking with an empty hand. Sneak-right-click with an empty hand to take
the book back and restore the vanilla lectern. Breaking a Book Stand drops both
the stored book and a vanilla lectern.
The optional builds used in the latest development checks are JEI
19.69.0.457, Create 6.0.10, Immersive Portals 6.0.7, TerraBlender 4.1.0.8,
Serene Seasons 10.1.0.9, and Ruins 1.21.1.2NF. See the
[compatibility review](docs/MILESTONE_7_COMPATIBILITY_REVIEW.md) for the
evidence and limits of those combinations.
Bound Linking Books show a rotating Ponder snapshot when Create is installed.
Without Create, they use a built-in animated linking panel tinted by the
destination sky. The server independently validates every link.
Without Create or Immersive Portals, book previews use Rivencraft's built-in
Legacy-style animation. Ecliptic Seasons is **not supported**: its 1.21.1 API
does not offer the live dimension/season control Rivencraft needs.
## Descriptive Book
## Saves, settings, and current limits
Open a page-free Descriptive Book, name its Age, and press Create. Rivencraft
assigns the book a permanent Age UUID, selects a deterministic base terrain,
creates a dedicated runtime dimension, and prepares a five-by-five cobblestone
arrival platform at the
highest suitable nearby terrain. Solid blocks and tree leaves are valid
footing. Candidate columns are scanned from the top down so cave floors are not
selected, and fluid-covered columns are excluded. If no suitable surface is
available, the platform is generated at Y=63. Reopen the book and click its preview to travel.
The book cannot reopen while its Age is being generated, whether held or on a
Book Stand. Once creation finishes, reopening shows the written book.
Copies of the written book continue to resolve to the same persistent Age
across server restarts.
Ages and bound books use persistent UUIDs. Back up the **entire world folder**
before changing mod versions, data packs, or optional biome mods: the Age
registry and dimension data must be restored together. Rivencraft preserves
known older save formats where possible, but pre-public-release worlds are not
promised universal compatibility. Missing custom symbols retain their IDs in
books; missing registry entries or dimension providers can still prevent an
Age from loading. See [current implementation](docs/CURRENT_IMPLEMENTATION.md)
for supported behavior and deliberate limits.
New Age dimension folders use a Minecraft-safe lowercase form of the assigned
name. Conflicts receive incrementing suffixes such as `_2` and `_3`; existing
Age folders are never renamed.
Server settings include `descriptive_books.return_link_mode` (default
`DISABLED`), `libraries.loot_mode` (`LEGACY` or `AGE_ONLY`), writing ink costs,
season enrollment, and instability controls. The client setting
`book_preview.mode` chooses `AUTO`, `IMMERSIVE_PORTALS`, `PONDER`, or `LEGACY`.
An operator can inspect Ages and instability with `/rivencraft age` and find
libraries with `/rivencraft library nearest`. The creative-only Link Modifier
can edit link properties and retire an Age; use it carefully and keep backups.
Binder status messages are off by default. An OP can run
`/rivencraft binder messages enable` or `/rivencraft binder messages disable`
to control them; only OPs see the diagnostics even when enabled.
Page-free Ages deterministically select one of six base terrains inspired by
Mystcraft Legacy: Standard, Amplified, Island, Cave, Flat, or Void. The chosen
profile is saved with the Age and does not change when the server restarts.
## Project and development
Linking creates a bound Return Link to the exact source position and orientation
according to the configured Return Link policy.
This repository is the development source. See the [current implementation](docs/CURRENT_IMPLEMENTATION.md),
[milestone summaries](docs/MILESTONES.md), [technical document index](docs/README.md),
and [issues](https://git.paddedcell.org/dnorberg/rivencraft/issues).
Help build the [Rivencraft wiki](https://git.paddedcell.org/dnorberg/rivencraft/wiki)
with guides for Ages, pages, and crafting, or open an issue with documentation
suggestions and corrections.
Milestone 7 is complete in 1.0.0.2. Its [acceptance record](docs/MILESTONE_7_ACCEPTANCE.md)
and [regression matrix](docs/MILESTONE_7_REGRESSION.md) distinguish automated
checks from manual evidence and known limitations.
Server owners can set `descriptive_books.return_link_mode` in Rivencraft's
server config to `ON_CREATION` (default), `ALWAYS`, or `DISABLED`.
Age creation, persistence, lifecycle commands, configuration, backups, and
administrator recovery are documented in [docs/AGES.md](docs/AGES.md).
Data-pack runtime profiles are documented in
[docs/AGE_PROFILES.md](docs/AGE_PROFILES.md).
## Requirements
- A Java 21 JDK
- Minecraft 1.21.1
- NeoForge 21.1.251 or newer in the 21.1 line
- Dynamic Dimensions AR Edition 0.9.1 and Bad Packets 0.8.2 (client and server)
Create is optional. When installed, Rivencraft uses its Ponder renderer for
book previews when Immersive Portals is absent. Immersive Portals is also
optional and takes priority in the default `AUTO` mode, providing a live
rotating destination view. Its Explore button enables WASD and jump/sneak
camera movement plus left-drag camera look; right-click returns to the rotating
view. Without either integration, Rivencraft uses its built-in animated linking
panel. Clients can set `book_preview.mode` in
`rivencraft-client.toml` to `AUTO`, `IMMERSIVE_PORTALS`, `PONDER`, or `LEGACY`.
Unavailable optional renderers safely fall back to `LEGACY`.
The complete backend matrix, supported combinations, cleanup behavior, and
known upstream limits are documented in
[docs/PREVIEW_COMPATIBILITY.md](docs/PREVIEW_COMPATIBILITY.md).
## Build and run
```shell
```sh
./gradlew build
./gradlew runClient
./gradlew runGameTestServer
```
The built mod is written to `build/libs/`.
The default dedicated-server GameTest run is deliberately small. Use
`./gradlew runGameTestServer -PwithArchivedGameTests=true` for the complete
regression suite before a release or when investigating a related issue. See
[docs/GAMETESTS.md](docs/GAMETESTS.md).
The JAR is written to `build/libs/`. Development runs need the required mods;
see [GameTest guidance](docs/GAMETESTS.md) for focused archived suites.
Versions use `x.y.z.b`: major release, completed milestone, release slice,
then fixes/additional work within that slice.
## Versioning
Rivencraft versions use `x.y.z.b`:
- `x` changes for a major public release.
- `y` changes when a development milestone is completed.
- `z` changes for each release slice within the current milestone.
- `b` changes for bug fixes and additional work within that release slice.
The build component resets to zero when a new release slice begins. Completing
a milestone increments `y` and resets both `z` and `b` to zero. For example,
milestone 2 development can progress from `0.1.1.0` to `0.1.1.1`, then
`0.1.2.0`; completing the milestone produces `0.2.0.0`.
## Porting approach
Mystcraft Legacy targets Forge for Minecraft 1.12.2. Rivencraft therefore
ports one subsystem at a time onto current registries, codecs, data packs, and
NeoForge APIs instead of importing the legacy source tree wholesale.
See [docs/PORTING.md](docs/PORTING.md) for the roadmap, live Gitea tracking
links, architectural direction, and provenance rules.
## License
Rivencraft is licensed under LGPL-3.0-or-later. Mystcraft Legacy is also
LGPL-3.0; copied or adapted upstream code must retain its copyright and license
notices. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
Rivencraft is licensed under LGPL-3.0-or-later. Legacy-derived material is
credited in [NOTICE](NOTICE) and [asset provenance](docs/ASSET_PROVENANCE.md).
+8 -1
View File
@@ -17,7 +17,7 @@ tasks.named('wrapper', Wrapper).configure {
version = mod_version
group = mod_group_id
List<String> archivedGameTestSuites = ['linking', 'environment', 'writing', 'grammar', 'generation', 'desk', 'binder', 'mixer', 'recipe']
List<String> archivedGameTestSuites = ['linking', 'environment', 'writing', 'grammar', 'generation', 'desk', 'binder', 'mixer', 'recipe', 'instability']
List<String> selectedArchivedGameTestSuites = providers.gradleProperty('withArchivedGameTests')
.map { it.toBoolean() }.orElse(false).get() ? archivedGameTestSuites
: providers.gradleProperty('archivedGameTestSuites').orElse('').get()
@@ -132,6 +132,8 @@ neoForge {
server {
server()
// Keep dedicated compatibility runs away from the normal dev world.
gameDirectory = project.file(project.findProperty('serverRunDir') ?: 'run')
programArgument '--nogui'
systemProperty 'neoforge.enabledGameTestNamespaces', project.mod_id
}
@@ -243,6 +245,11 @@ dependencies {
// Keep them on the compile classpath without forcing either mod at runtime.
compileOnly "net.createmod.ponder:ponder-neoforge:${ponder_version}+mc${minecraft_version}"
compileOnly "maven.modrinth:immersive-portals-neoforge:${immersive_portals_version}"
// Ruins is optional; its pre-spawn event is only registered when Ruins is loaded.
compileOnly 'curse.maven:ruins-227873:6391825'
if (providers.gradleProperty('withRuins').map { it.toBoolean() }.orElse(false).get()) {
localRuntime 'curse.maven:ruins-227873:6391825'
}
// TerraBlender's region API is only used by the guarded compat adapter.
compileOnly "com.github.glitchfiend:TerraBlender-neoforge:${minecraft_version}-${terrablender_version}"
if (providers.gradleProperty('withTerraBlender').map { it.toBoolean() }.orElse(false).get()) {
Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 854 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 204 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.0 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 215 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 510 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 572 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 592 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 216 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 162 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 673 KiB

+13 -13
View File
@@ -11,7 +11,7 @@ suffixes such as `_2` and `_3`.
The selected terrain profile, biome distribution, lighting, weather, celestial
period, celestial angle, and phase are deterministic and become part of the
saved definition. A five-by-five cobblestone platform with clear headroom is
saved definition. A five-by-five non-dropping Crystal Platform with clear headroom is
prepared at a safe arrival point. The completed book and every copy carrying
the same UUID resolve to that definition.
@@ -42,10 +42,11 @@ on demand when an administrator previously unloaded it. Unloading retains the
definition and world folder, so existing books continue to reference the same
Age and later reload the same terrain.
Rivencraft does not automatically delete Ages. Safe permanent deletion needs a
complete reference index for books in inventories, containers, Book Stands,
and unloaded chunks. Until that exists, retaining the definition prevents an
administrator action from silently orphaning books.
Rivencraft does not automatically delete Ages. The operator-only creative Link
Modifier can deliberately retire an unoccupied Age: it unloads the dimension,
moves its data to a sibling `<world>-retired-ages/<uuid>` archive, and records
the UUID as dead so existing books cannot silently regenerate it. Back up the
whole world first.
Destination-preview chunk loaders are temporary. Rivencraft releases them when
the book closes, the player travels, the player disconnects, the destination
@@ -69,10 +70,9 @@ definition.
Rivencraft writes gameplay settings to the world/server configuration managed
by NeoForge. `descriptive_books.return_link_mode` accepts:
- `ON_CREATION` (default): create one Return Link the first time a player
enters each Age.
- `DISABLED` (default): never create Return Links automatically.
- `ON_CREATION`: create one Return Link the first time a player enters each Age.
- `ALWAYS`: create a Return Link after every successful Descriptive Book trip.
- `DISABLED`: never create Return Links automatically.
Each client has a separate `rivencraft-client.toml`. Its `book_preview.mode`
setting accepts `AUTO`, `IMMERSIVE_PORTALS`, `PONDER`, or `LEGACY`. This changes
@@ -102,8 +102,8 @@ Use this sequence when a book cannot load an existing Age:
matching dimension data and authoritative world saved data from the same
backup generation. Do not combine them from different backups.
There is intentionally no delete command in Milestone 3. Do not manually
delete an Age definition or rename its dimension folder: books may exist in
inventories, containers, Book Stands, or unloaded chunks, and would be
orphaned. `/rivencraft age unload` is the supported reversible maintenance
operation.
Do not manually delete an Age definition or rename its dimension folder:
books may exist in inventories, containers, Book Stands, or unloaded chunks.
`/rivencraft age unload` remains the reversible maintenance operation. The
Link Modifier's retirement control is not reversible through a book UI;
recover its archived data and registry together from a full-world backup.
+3 -3
View File
@@ -1,7 +1,7 @@
# Age arrival cloud platform
# Age arrival platform
Newly created Ages now place a 5×5 solid cloud platform instead of cobblestone at their saved spawn. The block has full collision, passes skylight, renders translucently, has no loot table, and cannot be obtained with pick-block. Existing Ages retain their already-placed platform; this change does not overwrite a player's saved world.
Newly created Ages place a 5×5 solid platform instead of cobblestone at their saved spawn. The block has full collision, renders as an opaque full block, breaks as easily as glass (0.3 hardness), has no loot table, and cannot be obtained with pick-block. Existing Ages retain their already-placed platform blocks, which adopt the new appearance and hardness without altering saved terrain.
The block texture is `assets/rivencraft/textures/block/cloud_platform.png`, verified at exactly 16×16 RGBA. Legacy's supplied assets contain no cloud-block texture, so this one was generated with the built-in image tool, then reduced by nearest-neighbor sampling. The final prompt requested a seamless Minecraft block-face pixel-art tile with 2–3 chunky white, icy-blue, and powder-blue cloud swirls, genuine transparent holes between them, strong 16×16-scale contrast, and no background or text.
The model reuses `assets/rivencraft/textures/block/crystal_block.png`, the 16×16 Legacy crystal tile. The former generated cloud texture is removed. The internal block ID remains `rivencraft:cloud_platform` to preserve saved worlds.
The separate [decay provider](INSTABILITY_DECAY.md) protects the saved spawn area by position, so its protection remains in force regardless of the platform's material.
+21
View File
@@ -40,6 +40,27 @@ profiles, not claims that Legacy had identically named terrain symbols.
Every family retains a safe cobblestone arrival platform. An omitted terrain
page still uses the deterministic seed-selected profile.
### Cave terrain and Legacy
Legacy's closest terrain generator is its Nether terrain symbol: it owns an
Age-seeded octave-noise generator, accepts terrain/sea materials, and sets a
sea level of 32. Legacy's separate Caves symbol instead registers a terrain
alteration that carves additional caves; it is not a terrain generator.
Minecraft 1.21.1 no longer has Legacy's 1.12.2 height and generation pipeline,
so Rivencraft Cave terrain uses `minecraft:caves` noise and the modern Cave,
Nether, and tagged modded Nether biome decorations. It cannot reproduce the
exact Legacy noise or its older vertical layout. The Caves feature page
remains a separate additive carver for other suitable terrain.
Cave Ages search for safe spawn footing from Y=64 downward rather than using
the cave roof; if necessary, the usual cloud platform is placed at Y=63.
Weather is clear and Serene Seasons is disabled in Cave terrain. Authored
Weather, Season, and Celestial pages (including time modifiers) are retained
in the book but have no effect on the Cave Age; each adds 100 base instability.
The same policy applies to randomly selected Cave terrain and persists through
save/reload. Cave biome selections remain limited to Cave and Nether biomes;
surface-biome completion is not used for Cave terrain.
The separate **Floating Islands** feature page adds rare high-altitude island
clusters above Standard, Amplified, Sky Islands, Flat, or Void terrain; it does
not replace the terrain page. The feature is seeded by the Age and saved with the written
+7 -2
View File
@@ -19,16 +19,21 @@ project's GNU LGPL v3 license. Rivencraft itself uses the same license.
| `assets/rivencraft/textures/block/book_binder_press.png` | `assets/mystcraft/textures/entity/bookbinder/press_part.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; Book Binder model uses this press texture |
| `assets/rivencraft/textures/gui/book_binder_legacy.png` | `assets/mystcraft/gui/pagebinder.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; Book Binder GUI uses the original 176×181 panel |
| `assets/rivencraft/textures/gui/ink_mixer_legacy.png` | `assets/mystcraft/gui/inkmixer.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; Ink Mixer GUI uses the original 176×181 panel |
| `assets/rivencraft/textures/block/ink_mixer_top.png`, `ink_mixer_side.png`, `ink_mixer_bottom.png` | `assets/mystcraft/textures/blocks/inkmixer_top.png`, `inkmixer_side.png`, `inkmixer_bottom.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; Rivencraft supplies its own block model |
| `assets/rivencraft/textures/block/inkwell_base.png`, `inkwell_cup.png`, `ink.png`, `ink_glass.png` | `assets/mystcraft/textures/entity/inkwell/` counterparts | Legacy 0.13.7.06 local extraction | Byte-identical copies used by the ported Ink Mixer geometry; the paper overlay uses vanilla white concrete instead of Legacy's black surface |
| `assets/rivencraft/textures/item/linking_book_unwritten.png` | `assets/mystcraft/textures/items/unlinked.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only |
| `assets/rivencraft/textures/item/page_link_panel.png` | `page_background.png` and `PageBuilder.BasicPageSprite` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Reproduces the legacy 160 px scale, black panel at `(25,30)`–`(135,75)`, and 128 px resample |
| `assets/rivencraft/textures/gui/symbolcomponents.png` | `assets/mystcraft/textures/symbolcomponents.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Byte-identical shared 512×512 component sheet for client-side page composition |
| Runtime-composed symbol pages (`SymbolPageTextures`) | `page_background.png`, `textures/symbolcomponents.png`, `WordData`, `ModSymbols`, and `PageBuilder.PageSprite` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Replaces the six pre-generated symbol PNGs; layers four poem words on the shared page background and caches bounded client textures |
| `assets/rivencraft/textures/block/crystal_block.png` | `assets/mystcraft/textures/blocks/crystal.png` | Legacy 0.13.7.06 local extraction | Exact 16×16 blue tile shared by Crystal Block and Budding Crystal models after removing a byte-identical duplicate |
| `assets/rivencraft/textures/block/crystal_block.png` | `assets/mystcraft/textures/blocks/crystal.png` | Legacy 0.13.7.06 local extraction | Exact 16×16 blue tile shared by Crystal Block, Budding Crystal, and the non-dropping Age arrival platform; its former cloud sprite is removed |
| `assets/rivencraft/textures/block/{small,medium,large}_crystal_bud.png`, `crystal_cluster.png` | Minecraft 1.21.1 `textures/block/{small,medium,large}_amethyst_bud.png`, `amethyst_cluster.png` | Minecraft 1.21.1 | Original 16×16 alpha masks and silhouettes preserved; hue shifted toward Legacy blue, with brighter saturation; exported as 8-bit RGBA (not indexed PNG) |
| `assets/rivencraft/textures/item/crystal_shard.png` | Original sprite generated with OpenAI ImageGen from the Legacy crystal palette | 2026-10-05 | Cropped and nearest-neighbor scaled to 16×16 |
| `assets/rivencraft/sounds/linking/link-fissure.ogg` | `assets/mystcraft/sounds/linking/link-fissure.ogg` | Legacy 0.13.7.06 local extraction | Namespace/path rename only; plays when a Star Fissure returns an entity home |
| `assets/rivencraft/sounds/entity/meteor/roar.ogg` | `assets/mystcraft/sounds/entity/meteor/roar.ogg` | Legacy 0.13.7.06 local extraction | Byte-identical copy under the Rivencraft namespace; plays during the bounded meteor descent |
| `assets/rivencraft/textures/block/book_receptacle.png` | `assets/mystcraft/textures/blocks/book_receptacle.png` | Legacy 0.13.7.06 local extraction | Byte-identical 16×16 face tile; modern block model recreates the Legacy thin slab |
| `assets/rivencraft/textures/block/crystal_portal.png` and `.mcmeta` | `assets/mystcraft/textures/blocks/portal.png` and `.mcmeta` | Legacy 0.13.7.06 local extraction | Byte-identical texture and line-ending-normalized animation metadata, used when Immersive Portals is absent |
| `assets/rivencraft/sounds/linking/link-portal.ogg` | `assets/mystcraft/sounds/linking/link-portal.ogg` | Legacy 0.13.7.06 local extraction | Byte-identical portal-link sound |
| `assets/rivencraft/sounds/linking/link-disarm.ogg` | `assets/mystcraft/sounds/linking/link-disarm.ogg` | Legacy 0.13.7.06 local extraction | Byte-identical disarm-link sound; takes precedence over the portal sound as in Legacy |
| `assets/rivencraft/sounds/linking/link-intra.ogg` | `assets/mystcraft/sounds/linking/link-intra.ogg` | Legacy 0.13.7.06 local extraction | Byte-identical intra-link sound for Linking Books |
Mystcraft Legacy identifies XCompWiz as its project developer and includes the
full LGPL v3 text in its root `LICENSE` file. Rivencraft's root `LICENSE`
+98
View File
@@ -0,0 +1,98 @@
# Current implementation (Milestone 7 development)
This is the maintained technical overview of Rivencraft as of the 1.0.0.2
slice. It describes implemented behavior, not every behavior in Mystcraft
Legacy. [The README](../README.md) is the player introduction;
[milestone summaries](MILESTONES.md) explain how the implementation arrived
here. The linked deep dives are retained as historical audits and should be
read with their version dates in mind.
## Books, linking, and previews
- Linking Books bind a named position and direction. Same-dimension use needs
Intra Linking. Descriptive Books refer to a persistent Age UUID and keep
their authored page order. Copies keep that identity.
- Book screens use Legacy-inspired page spreads and destination panels. `AUTO`
selects optional Immersive Portals first, then Create/Ponder, then the built-in
animation. Travel is validated on the server regardless of renderer.
- Handheld travel drops the active book at its departure point as a visible
book entity. Book Stands and crystal portals keep the book in place. Disarm
drops carried items; Maintain Momentum rotates and carries velocity.
- A vanilla Lectern converts to a Book Stand when given a Rivencraft book or
page. A Book Receptacle in a connected Crystal Block frame activates a
vertical or horizontal portal. Immersive Portals can display a live view;
otherwise the Legacy-style animated surface remains. Portal arrivals use
existing safe footing; a Descriptive portal does not generate a platform.
- Automatic Return Links default to `DISABLED`, with `ON_CREATION` and `ALWAYS`
server options. Linking Books do not generate platforms by default; a
creative Link Modifier can explicitly enable that property.
See [preview modes](PREVIEW_COMPATIBILITY.md), [Legacy M7 audit](LEGACY_M7_AUDIT.md),
and [Age administration](AGES.md).
## Ages, writing, and structures
- Dynamic Dimensions AR Edition creates Age worlds. Each Age has a saved UUID,
safe dimension ID, seed, spawn, traits, versioned generation plan, and
optional season mode. Page-free or Link-Panel-only books get seeded random
choices. Authored supported pages override the appropriate choices.
- Terrain choices are Standard, Amplified, Island, Cave, Flat, and Void. Cave
terrain uses cave/Nether biomes and an appropriate spawn search; normal
terrain starts from exposed surfaces. If no safe arrival site exists, the
Age-creation path can construct a non-dropping Crystal Platform at Y=63.
- The server catalog accepts typed data-pack symbols. The Binder preserves
written order and diagnoses conflicts. Its status readout is off by default;
`/rivencraft binder messages enable` makes it visible only to OPs. Symbol
Pages are composed at runtime from Legacy glyph assets. Number pages 0–24
set color strength or, immediately before a Length, Angle, Phase, or Size
modifier, its numeric value.
Celestial pages can create multiple suns/moons with independent color, size,
angle, period, phase, and direction; authored eclipses affect light.
- The Writing Desk stores tabs and copies known Symbol Pages with paper and
ink. Notebooks hold ordered pages; the Binder consumes a Link Panel and cover
to make a finished Descriptive Book. The Ink Mixer makes Link Panels and
rolls Disarm, Intra Linking, and Maintain Momentum from additives. Blank
Pages are internal bases, not a craftable or JEI-listed output.
- Features include terrain additions, decorations, configurable block/fluid
materials, ores, vanilla structures including newer 1.21 structures,
Legacy-style libraries, crystals, obelisks, and star fissures. Optional Ruins
templates gain authorable pages. Some biome/terrain combinations or feature
placements are deliberately unsupported and are diagnosed during binding.
See [symbol semantics](SYMBOL_SEMANTICS.md), [writing data](WRITING_DATA.md),
[generation profiles](AGE_PROFILES.md), and [library/Ruins rules](RUINS_COMPATIBILITY.md).
## Instability and optional mods
Invalid or excessive writing and valuable generated blocks can add
instability. Block abundance is profiled in loaded chunks, so its contribution
and selected effects can change as the Age is explored; the authored plan is
not rewritten. Effects are bounded to loaded Ages and include status effects,
colored decay, lightning, explosions, meteors, burning, and erosion. Operator
commands expose the score and providers; the book GUI does not. See
[scoring](INSTABILITY_SCORE.md) and [runtime policy](INSTABILITY_RUNTIME.md).
JEI, Create/Ponder, Immersive Portals, TerraBlender, Serene Seasons with
GlitchCore, and Ruins are optional. TerraBlender can supply biomes from any mod
using its eligible regions; Biomes O' Plenty is a test example. Serene Seasons
has per-Age normal/no/eternal modes and live Age enrollment. Ecliptic Seasons
is not integrated because its 1.21.1 API lacks supported live registration and
per-Age calendar control. See the [optional-mod matrix](MILESTONE_7_REGRESSION.md).
## Persistence and boundaries
An Age registry definition and its dimension folder belong to the **same
whole-world backup**. Known older book/writing, plan, workstation, and Age
formats have migration or stable-default handling. Unknown symbol IDs remain
in books; missing registry objects or removed dimension mods can still prevent
world loading. The OP-only Link Modifier can retire an unoccupied Age. That
operation marks its UUID dead and moves its dimension data to a sibling
`<world>-retired-ages/<uuid>` folder; it is not ordinary book maintenance.
Do not use it without a backup.
This is not an exact port of every Legacy generator, page, hazard, or client
renderer. Modern safety budgets and NeoForge's dimension/biome APIs require
adaptations. The [Milestone 7 regression matrix](MILESTONE_7_REGRESSION.md)
separates tested behavior from unverified multiplayer/restart/optional-mod
combinations. The [Milestone 7 acceptance record](MILESTONE_7_ACCEPTANCE.md)
records release evidence and remaining validation limits.
+10 -4
View File
@@ -1,5 +1,9 @@
# GameTest suites
The current Milestone 7 results and manual handoffs are in the
[regression matrix](MILESTONE_7_REGRESSION.md). This file documents the test
mechanics and older scenario-specific handoffs.
The default dedicated-server run is a small smoke suite. Its Rivencraft tests
cover core linking, deterministic Age definition, writing persistence, legacy
data migration, workstation transactions, and forged/replayed menu actions.
@@ -18,12 +22,13 @@ core tests when investigating an issue:
./gradlew runGameTestServer -ParchivedGameTestSuites=desk
./gradlew runGameTestServer -ParchivedGameTestSuites=grammar,binder
./gradlew runGameTestServer -ParchivedGameTestSuites=generation
./gradlew runGameTestServer -ParchivedGameTestSuites=instability
```
Available suite names are `linking`, `environment`, `writing`, `grammar`,
`generation`, `desk`, `binder`, `mixer`, and `recipe`. The `generation` archive
`generation`, `desk`, `binder`, `mixer`, `recipe`, and `instability`. The `generation` archive
keeps the detailed feature, structure, ore, crystal, and fissure regressions
out of the default smoke run. Three checks formerly registered twice in the
out of the default smoke run. The `instability` archive adds multi-player loaded-chunk selection, policy gates, and protected-block checks without rerunning the default scoring and migration tests. Three checks formerly registered twice in the
core and their archives now run only through the core wrapper. Run all
Rivencraft tests before a
release or after broad cross-system changes:
@@ -84,8 +89,9 @@ With optional JEI installed, search for the Ink Mixer category. It should show
the base paper/ink/vial operation and separate entries for Gunpowder, Mushroom
Stew, Experience Bottle, Ender Pearl, Feather, and Fire Charge,
with their property chances. Black Dye and Clay Ball should not appear: the
former had no working Legacy effect, while Generate Platform is redundant
with default Age arrival. Without JEI, Rivencraft should still
former had no working Legacy effect, while Clay Ball remains unsupported by
the mixer. The creative Link Modifier can enable a single arrival platform for
Linking Books; they do not create one by default. Without JEI, Rivencraft should still
start and the mixer should work normally.
Put paper and an Ink Vial in the mixer. Hold Gunpowder on the cursor and
+1 -1
View File
@@ -27,4 +27,4 @@ Implementation requirements: keep the mixer server-authoritative; persist mixtur
The built-in vanilla-item rows above are supported except black dye and clay balls. Legacy ignores black dye's empty effect key, so Rivencraft does not consume or advertise it in JEI. Clay Balls are omitted because Age arrival already builds a safe platform by default and a separate Generate Platform link modifier would be redundant. Right-clicking the Ink Mixer basin with a carried item adds one; left-clicking adds the carried stack. The mixture is persistent and its next panel is deterministic. The visual basin tooltip shows current probabilities. Only taking the virtual Link Panel consumes paper/ink and clears the mixture. The Link Panel's property component is copied to a Linking Book by the leather recipe or a Descriptive Book by the Binder. JEI's optional Ink Mixer category lists the base panel and each supported additive interaction with its per-property chance; Rivencraft does not require JEI to run.
Disarm and Maintain Momentum are applied by the server after confirming a safe destination. Disarm spawns each inventory stack as an item entity at the departure point, including for Descriptive Books. Intra Linking is required only for a Linking Book whose destination is in the player's current dimension; ordinary cross-dimensional Linking Books still work. The Binder treats an Intra Linking panel as an ordinary Link Panel and omits that flag from the resulting Descriptive Book, while retaining Disarm and Maintain Momentum. Automatic Return Links remain enabled under the existing configuration, as requested. The old Generate Platform bit remains readable on pre-0.4.7.1 test items but is neither rolled nor applied. Optional dust-tag mappings remain outside this built-in subset until their cross-mod tags and gameplay meaning are agreed.
Disarm and Maintain Momentum are applied by the server after confirming a safe destination. Disarm spawns each inventory stack as an item entity at the departure point, including for Descriptive Books. Intra Linking is required only for a Linking Book whose destination is in the player's current dimension; ordinary cross-dimensional Linking Books still work. The Binder treats an Intra Linking panel as an ordinary Link Panel and omits that flag from the resulting Descriptive Book, while retaining Disarm and Maintain Momentum. Automatic Return Links remain enabled under the existing configuration, as requested. The Ink Mixer still does not roll Generate Platform, but since 0.6.7.1 the creative Link Modifier can explicitly enable it for Linking Books; their default remains off. Optional dust-tag mappings remain outside this built-in subset until their cross-mod tags and gameplay meaning are agreed.
+11
View File
@@ -0,0 +1,11 @@
# Instability controls and diagnostics (Milestone 6, issue #72)
The world-specific NeoForge server config (`serverconfig/rivencraft-server.toml`) is the global policy. `instability.enabled` stops all scheduled effects without changing a saved Age. `instability_providers.<id>` switches each Legacy card independently; these switches do not reroll frozen provider levels. The existing `instability_status_effects`, `instability_decay`, `instability_hazards`, `instability_meteor`, `instability_scorching`, and `instability_erosion` groups provide category policy and action limits. `instability.world_mutation`, hazard/meteor `block_damage`, `player_damage`, and `fire` settings control destructive behavior. `mobGriefing` and `doFireTick` still apply. Defaults retain the Legacy-active hazards; the scheduler, spawn protection, loaded-chunk checks, and per-effect caps remain Rivencraft safety adaptations. The dormant-in-Legacy erosion effect remains enabled for project testing but can be switched off.
Configuration values are read during server operation, but editing the TOML on disk does not guarantee NeoForge will reload it. Restart the server or world after changing the file; `/reload` reloads data packs, not this server config. Per-Age commands below take effect on the next scheduler pass without a restart. A stopped provider does not refund or change the Age's score or saved plan. Existing owned status-effect leases are revoked on their next 20-tick check after global, category, provider, or Age disablement. In-flight meteors are cancelled when their Age or meteor provider is disabled. Existing block changes are not rolled back.
Operators can inspect `/rivencraft age instability [dimension]`. The argument accepts an Age name (quote names containing spaces), a short path such as `fort`, or a full ID such as `rivencraft:age/fort`. Duplicate names require the full ID shown by `/rivencraft age list`. The command reports the frozen score and each saved contribution, the frozen provider IDs/levels and their *current* runtime eligibility, config limits, and whether this Age is enabled. "Eligible" does not promise an effect on the next tick: chance, cooldowns, loaded chunks, player presence, and protection still apply. An unavailable handler is reported as such instead of being mistaken for an active provider. Pre-scoring Ages remain neutral, and missing provider plans from older scored saves are migrated once as described in [runtime policy](INSTABILITY_RUNTIME.md). `/rivencraft age instability disable <dimension>` and `enable <dimension>` are operator-only and persist for that Age alone. Unknown dimensions are rejected. Neither command mutates a book, score, or provider plan.
Newly bound Descriptive Books carry only a server-written numerical potential-instability summary for their tooltip and cover. The details and live enablement stay server-side in the operator command. Older written books receive the summary when opened through the server-approved book screen; until then, an absent tooltip score means "not yet synchronized," not zero. The score does not indicate whether effects are currently enabled.
Manual check: create two scored Ages, disable one with the command, and inspect both. Only the selected Age should show "Age disabled"; its saved breakdown and plan should remain identical. Re-enable it, then switch an individual provider in the world config and restart. Its plan should remain identical while diagnostics show "provider config off." An old neutral Age should report score zero and no selected providers. A non-operator should be unable to invoke the mutation commands. Test tooltips both on a newly bound book and an older book after opening it once.
+11
View File
@@ -4,10 +4,21 @@ Each new Age stores an `InstabilityPlan` beside its frozen `Instability` score.
The saved provider IDs are independent of installed handlers. A missing optional handler leaves its ID and level intact and is skipped at runtime. A syntactically invalid saved ID or unsupported plan version fails loading explicitly; an unknown but valid ID is preserved and logged once when encountered. Disabling instability or world mutation never rewrites a saved score or provider plan. Saves from #64 with a frozen score but no provider plan are selected once from that score and Age seed, then marked dirty for persistence. Older pre-score Ages remain neutral and inert.
From 0.5.8.11, [live block profiling](LIVE_BLOCK_INSTABILITY.md) adds a separate
effective score and provider plan once 400 Age and Overworld chunks have been
sampled. The authored score/plan described above remain saved as the base;
the effective provider selection can change as block abundance is observed.
The server scheduler runs only for loaded `rivencraft:age/*` levels with a player present and an Age definition. It uses only chunks already loaded near those players, never requests a chunk, and rotates among eligible Ages when the per-tick cap is reached. Configuration bounds the cooldown (minimum 20 ticks), active Ages, handlers and actions per Age, effective provider level, and examined loaded chunks. A handler must claim a shared action permit before each effect. A throwing handler is logged and quarantined temporarily without stopping the server. World-mutating handlers are enabled by default to match Legacy; the setting can still disable them. These limits are guards for upcoming providers, not proof that an arbitrary third-party handler cannot misuse world APIs.
Issue #67 registers the non-world-mutating potion handlers; see [status-effect policy](INSTABILITY_STATUS_EFFECTS.md). Issue #68 adds configurable [colored decay](INSTABILITY_DECAY.md), enabled by default for newly generated configs. Issue #69 adds lightning and explosions; issue #70 adds [meteor, scorching, and erosion](INSTABILITY_ENVIRONMENTAL.md). The runtime rejects Overworld and preview dimension IDs; its player requirement excludes unattended snapshot chunk loaders. GameTests cover deterministic selection, save round-trips, score-only migration, unknown IDs, scope checks, fair admission, and action caps.
Issue #72 adds [server config, per-Age controls, diagnostics, and book feedback](INSTABILITY_DIAGNOSTICS.md). Its operator controls never rewrite a frozen score or provider plan.
The Milestone 6 [regression and migration record](MILESTONE_6_REGRESSION.md)
maps the automated acceptance checks and lists the in-game restart, optional-mod,
and hazard-visual scenarios still requiring verification.
# Lightning and explosions (#69)
The `lightning` and `explosions` cards now run only in loaded Rivencraft Ages with players. Legacy rolled once per chunk per tick: explosions at 1/1000 and lightning at 1/5000 during thunder or 1/100000 otherwise. Each selected hazard card gets an independent roll every scheduler pass, rather than waiting for the rotating two-provider sample. The roll uses up to 81 already-loaded chunks near Age players and the exact probability of at least one Legacy opportunity over that many chunk-ticks. It permits at most one event per hazard type per pass. A per-Age saved sequence and last-event time prevent the same roll/event from replaying after a restart. Lightning also skips an existing bolt at the target.
+11 -1
View File
@@ -1,11 +1,21 @@
# Frozen Age instability score (Milestone 6, issue #64)
The original issue #64 notes below describe the frozen authored score. Later
Milestone 6 slices added a separate live block-profile score. For new
version-4 plans, ordered period/phase modifiers combine until consumed by a
celestial page; each modifier kind left dangling at the end adds +100. Saved
version-3 plans keep their earlier stage-sorted meaning and writing cost.
Every newly created Age now gets a version-1 `Instability` compound inside its server-owned `rivencraft_ages` saved definition. It contains the total `Score` and an ordered `Breakdown` of reason, original page index (zero-based, or -1 for an Age-wide cause), points, and explanation. `AgeRegistrySavedData.instability(UUID)` is the read-only server query. No client tooltip or live data-pack lookup is needed to read a saved score.
The baseline is explicitly zero for page-free and Link-Panel-only random Ages, and for authored Ages. Incomplete writing receives seed-based completion and a zero-point explanatory entry. Supported writing defects use the provisional Milestone 6 grammar costs: duplicate/conflicting single-choice pages +500, out-of-order or misplaced pages +100. Legacy's audited Bright Lighting symbol adds +500 for every occurrence, including a seed-generated controller. Mineshafts, Nether Fortresses, Strongholds, and Villages add +100 for the fourth and every later occurrence. By project balance decision, Bastions, Trial Chambers, Ancient Cities, Shipwrecks, Ocean Ruins, Pillager Outposts, Ruined Portals, Nether Fossils, Buried Treasure, and Trail Ruins follow that same rule. The first three occurrences and all other audited Legacy feature symbols have no direct page cost. An authored structure may override its vanilla biome eligibility; every structure-page occurrence adds +100 if **any** selected biome is unsupported, even when another selected biome is compatible. Seed completion still prefers compatible biomes and therefore avoids that cost when it can. Other modern-only features remain neutral. The frozen score selects a deterministic, persisted provider plan through the Milestone 6 runtime. Registered handlers apply that plan only inside loaded Rivencraft Ages and remain subject to the documented scheduler and effect-specific safety bounds.
The score is calculated after the Age plan and effective traits are chosen, then saved with the Age identity before its dimension is generated. The same UUID returns the existing definition, including the same score, on repeated use. Spawn updates preserve it. Reload only deserializes the frozen breakdown; it never reruns the current grammar or catalog. An older Age definition without `Instability` is migrated to a persisted version-1 neutral score of zero, rather than retroactively scoring its writing. A future scoring-rule change must introduce an explicit new schema/migration policy, not silently reinterpret existing Ages. Issue #66 added the frozen provider selection; issues #67–#70 added the current handlers. See the [runtime policy](INSTABILITY_RUNTIME.md).
This is now the **authored base** score. [Live block profiling](LIVE_BLOCK_INSTABILITY.md)
keeps its sample counts separately and may add a changing effective block score
without rewriting the authored breakdown or its saved base provider plan.
Unknown or unsupported pages remain invalid for *new* Ages. Their absence from a later registry does not change an already saved score. Focused GameTests cover stable/defective writing, random baseline and bright lighting, repeated identity, save round-trip, and missing-symbol/old-save behavior.
`/rivencraft age instability` inspects the Age containing the command source; an optional dimension ID inspects an unloaded or different registered Age. It reports immutable base score, stability bonus, runtime penalty, and effective score. The pinned Legacy tree defines player-death and player-presence bonus classes but does not register them as default providers, so Rivencraft leaves player-driven modifiers disabled: bonus and penalty are zero and effective equals base. There is therefore no mutable bonus save to migrate in this release. No death, PvP event, player identity, or dimension transition can transfer stability between Ages. Any future opt-in mechanic must persist separately from `Instability`, define caps and reset behavior, and must not rewrite the generation plan or frozen provider plan.
`/rivencraft age instability` inspects the Age containing the command source; an optional dimension ID inspects an unloaded or different registered Age. It reports immutable authored base score, stability bonus, runtime penalty, profiled-block contribution, and difficulty-scaled effective score. The pinned Legacy tree defines player-death and player-presence bonus classes but does not register them as default providers, so Rivencraft leaves player-driven modifiers disabled: bonus and penalty are zero. The live block contribution may still change as chunks are profiled. There is no mutable player-bonus save to migrate in this release. No death, PvP event, player identity, or dimension transition can transfer stability between Ages. Any future opt-in player mechanic must persist separately from `Instability`, define caps and reset behavior, and must not rewrite the generation plan or frozen provider plan.
+9 -2
View File
@@ -2,9 +2,16 @@
This is the behavior contract used to implement Milestone 6. It is pinned to [Mystcraft Legacy source at commit `9bc8ddc`](https://github.com/Mystcraft/Mystcraft-Legacy/tree/9bc8ddc061845df0cd5ea47f4fdef773cff786ae). Values below are source defaults, not a claim that every historical config or server used them. Rivencraft now persists frozen writing-instability scores and provider plans and runs the implemented providers through a bounded, Age-scoped scheduler. The audit remains authoritative for Legacy behavior; the linked runtime documents identify modern adaptations and remaining gaps.
Current new Age plans (schema 4) also implement Legacy's ordered period/phase
consumption and +100 for each modifier kind still pending after the last
celestial page. Repeated same-kind pages combine before consumption rather
than charging a replacement penalty. Older plans keep their saved score and
earlier stage-sorted time interpretation. The older #65 implementation notes
below are historical where they mention a generic misplaced-modifier cost.
## Score, grammar, and selection in Legacy
Legacy's [`AgeController`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/world/AgeController.java) calculates `debug + symbol + block + book/base + bonus`, then applies difficulty 0/1/2/3 multipliers of 0.25/0.5/1/1.75. Global instability is enabled by default; an Age also has its own enable flag. The unmodified score is not simply “number of bad pages.” Block profiling may delay a usable score: `blockinstability` is null until **more than** 400 Age chunks are profiled, and `getInstabilityScore()` returns zero until then. It is recalculated after additional profiling. [`ChunkProfiler`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/world/profiling/ChunkProfiler.java) compares watched block abundance with a baseline, subtracting only positive excess above each baseline. The baseline is profiled or read from balance config; [`InstabilityDataCalculator`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/world/profiling/InstabilityDataCalculator.java) sets its default tolerance to 1.05, and default `useconfigs=false`. We should not copy its 400-chunk profiling delay or dynamic block scan into 1.21.1 without a separate performance case.
Legacy's [`AgeController`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/world/AgeController.java) calculates `debug + symbol + block + book/base + bonus`, then applies difficulty 0/1/2/3 multipliers of 0.25/0.5/1/1.75. Global instability is enabled by default; an Age also has its own enable flag. The unmodified score is not simply “number of bad pages.” Block profiling may delay a usable score: `blockinstability` is null until **more than** 400 Age chunks are profiled, and `getInstabilityScore()` returns zero until then. It is recalculated after additional profiling. [`ChunkProfiler`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/world/profiling/ChunkProfiler.java) compares watched block abundance with a baseline, subtracting only positive excess above each baseline. The baseline is profiled or read from balance config; [`InstabilityDataCalculator`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/world/profiling/InstabilityDataCalculator.java) sets its default tolerance to 1.05, and default `useconfigs=false`. Rivencraft's later [bounded implementation](LIVE_BLOCK_INSTABILITY.md) retains the threshold and tolerance, but not Legacy's spatial accessibility formula or unbounded profiling.
| Input | Verified Legacy behavior | Rivencraft M6 interpretation |
| --- | --- | --- |
@@ -15,7 +22,7 @@ Legacy's [`AgeController`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9b
| Unsupported/unmatched page | Legacy logs unmatched symbols during reconstruction and skips their logic; its `AgeData.getBaseInstability()` still has a TODO for calculating instability from pages. This is not a sound compatibility contract. | Remains fatal for *new* books until semantic and runtime support exists; never silently erase the page or pretend its effect applied. Existing saved books retain their IDs. |
| Other penalties/bonuses | `AgeController.addInstability(int)` is available to symbol logic. The base/book score is persisted as a `short`; Legacy's [`InstabilityBonusManager`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/instability/bonus/InstabilityBonusManager.java) also has dynamic player death/behavior components. | Persist a versioned score breakdown for Age writing and environmental contributions. Do not infer death/troll mechanics from the mere existence of Legacy classes. |
The complete Legacy `instabilityModifier` audit found direct feature-page costs only for Mineshafts, Nether Fortresses, Strongholds, and Villages. Their first three occurrences cost zero; the fourth and every later occurrence adds 100. Every other Legacy feature class inherited `SymbolBase`'s zero modifier. Rivencraft applies that exact rule to the four matching pages. By project balance decision, Bastions, Trial Chambers, Ancient Cities, Shipwrecks, Ocean Ruins, Pillager Outposts, Ruined Portals, Nether Fossils, Buried Treasure, and Trail Ruins use the same repeat rule. Matching Legacy features such as Caves, Crystal Formations, Dense Ores, Dungeons, Floating Islands, Huge Trees, Deep/Surface Lakes, Obelisks, Ravines, Skylands, Spheres, Spikes, Star Fissures, and Tendrils have no direct page cost. Legacy could still derive instability later from excess profiled blocks, especially ores, but that separate 400-chunk profiling system is intentionally not ported. Other modern-only Rivencraft features remain neutral.
The complete Legacy `instabilityModifier` audit found direct feature-page costs only for Mineshafts, Nether Fortresses, Strongholds, and Villages. Their first three occurrences cost zero; the fourth and every later occurrence adds 100. Every other Legacy feature class inherited `SymbolBase`'s zero modifier. Rivencraft applies that exact rule to the four matching pages. By project balance decision, Bastions, Trial Chambers, Ancient Cities, Shipwrecks, Ocean Ruins, Pillager Outposts, Ruined Portals, Nether Fossils, Buried Treasure, and Trail Ruins use the same repeat rule. Matching Legacy features such as Caves, Crystal Formations, Dense Ores, Dungeons, Floating Islands, Huge Trees, Deep/Surface Lakes, Obelisks, Ravines, Skylands, Spheres, Spikes, Star Fissures, and Tendrils have no direct page cost. Legacy could still derive instability later from excess profiled blocks, especially ores. From 0.5.8.11, Rivencraft has a [bounded live block-profile adaptation](LIVE_BLOCK_INSTABILITY.md) using the 400-chunk threshold, including diamond blocks as a deliberate non-Legacy extension. Other modern-only Rivencraft features remain neutral unless they increase watched-block abundance.
Bright Lighting adds 500 for every authored occurrence. A generated Bright Lighting controller also adds 500. This is independent of the 500-point extra-controller cost, so two authored Bright Lighting pages produce 1,500 total: 500 for each symbol and 500 for the repeated controller.
+67
View File
@@ -0,0 +1,67 @@
# Milestone 7 Legacy audit
Baseline: [Mystcraft Legacy source at `9bc8ddc` (0.13.7.06)](https://github.com/Mystcraft/Mystcraft-Legacy/tree/9bc8ddc061845df0cd5ea47f4fdef773cff786ae), checked against the local 0.13.7.06 asset/class extraction. Source and reused assets are LGPL-3.0; see [asset provenance](ASSET_PROVENANCE.md). This records behavior targets, not byte-for-byte 1.12.2 world generation.
## Already implemented
Rivencraft has books, Ages, symbol writing, book stands, a desk, binder, Ink Mixer, link modifiers, safe travel, and optional previews. Crystal Formations, the blue Crystal Block, budding crystals, shards, and Star Fissures were completed in Milestone 5; #76 and #77 must not reimplement them. Vanilla and modern structures are separately page-gated. The Mystcraft library below is neither one of those structures nor a player-authorable page.
## Libraries: target for #76
- [`ChunkProviderMyst`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/world/ChunkProviderMyst.java#L46-L47) installs a scattered-library generator in every Age. [`MapGenScatteredFeatureMyst`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/world/gen/structure/MapGenScatteredFeatureMyst.java#L34-L103) picks one candidate per 32×32-chunk region with 0–23 chunk offsets and salt `14357617`. Its biome restriction is commented out. There is no Library page and no nearest-structure implementation. Keep automatic sparse placement, modernized for current structure spacing and height APIs, without forcing distant chunks.
- [`ComponentScatteredFeatureSmallLibrary`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/world/gen/structure/ComponentScatteredFeatureSmallLibrary.java#L19-L70) makes one randomly rotated 11×10×11 building at average ground height, with downward cobblestone supports. Its palette is cobblestone, stone stairs/slabs, cobble walls, planks, bookshelves, webs, and air. Preserve its recognizable shape and interior; define safe placement for Cave/Void/Sky Island terrain rather than fabricating ground.
- [Loot placement](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/world/gen/structure/ComponentScatteredFeatureSmallLibrary.java#L762-L791) puts one chest at local `(4,1,2)` and up to five book-bearing lecterns at `(6,2,2)`, `(8,2,4..6)`, `(6,2,8)`. The [treasure table](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/resources/assets/mystcraft/loot_tables/mystcraft_treasure.json) rolls 4–8 plus 1–2 bonus rolls: dynamically registered symbol pages and static vial/booster/leather/paper. [`LootTableHandler`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/treasure/LootTableHandler.java#L69-L94) rerolls lectern contents up to 100 times and requires symbol rank ≥3. Use data-driven server loot, document substitutes for unavailable items, and prevent loot duplication after restart.
- The attempted hook into desert pyramid, jungle temple, stronghold library, and dungeon loot uses [`TreasureGenWrapper`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/treasure/TreasureGenWrapper.java), whose `addLoot` is empty in this revision. It is not evidence that those vanilla chests actually yield pages.
## Crystal portals: targets for #77–#78
Issue #77 now has a craftable Book Receptacle (eight Crystal Blocks around an empty center), a bounded loaded-chunk crystal-network validator, persistent book holder/source pointers, animated Legacy portal cells, and portal collision routed through the existing Linking/Descriptive Book travel services. A book is only taken after a nonempty frame plan and destination dimension are validated. Removing the book or breaking its support removes the portal; portal cells validate on neighboring block changes, like vanilla portals, rather than self-destructing on recurring ticks during chunk loading. The Descriptive Book path preserves the configured automatic Return Link policy and link modifiers. Crystal-portal arrival does not generate a landing platform, matching Legacy's external travel semantics. A normal Linking Book still needs Intra Linking for same-dimension travel.
When Immersive Portals is present, render-only, non-teleporting IP portal entities show the book's destination through both faces of each coplanar opening; individual crystal cells are combined into one shaped surface so the destination is not repeated tile by tile. The view's central camera is aligned to the same safe arrival position and yaw/pitch used by book travel (at standing eye height). Perspective still changes naturally as the observer moves in front of a live portal. Each live view is recessed inside the opening; the animated fallback texture stays visible until the live view is established, and crystal blocks render after the IP view so the frame appears on top. Without IP, the animated Legacy portal texture remains visible. Rivencraft portal-block contact remains the travel authority. This is an optional compile-only integration. The first placement of a Descriptive Book can generate/load its Age to establish a view destination. If the optional view is absent after restart, the holder's maintenance pass recreates it. Portal contact uses IP's instant transfer only if the destination's 3×3 chunk area was already loaded; otherwise it uses vanilla Minecraft's dimension transfer.
Issue #78 hardening: placing each new portal cell fires a NeoForge entity-place protection event attributed to the player who inserted the book. If any cell is rejected, portal placement rolls back and the book remains with the player. Cells are placed without intermediate neighbor notifications so the frame validator cannot remove the first cells before the whole opening exists. Unattended maintenance never generates missing cells or tears down a saved portal during restart: block-change validation handles local frame damage, while the book remains retrievable. Portal owner positions are NBT integer arrays (not compound tags); the reader now matches that format, live-view state changes preserve the block entity's owner, and an intact saved surface with ownerless cells can recover its pointers from the adjacent book receptacle without placing new blocks. A missing neighboring chunk is treated as unknown, not as a broken frame. Portal cooldowns are per-player and session-only, never saved against a server tick counter that resets on restart. A Descriptive Book portal now searches for existing safe footing without creating a platform; Linking Books retain their intentionally floor-optional destination rule. Missing destination dimensions keep the book retrievable and remove any stale Immersive Portals view. Portal blocks and crystal frames are explicitly decay-protected. Book-GUI preview chunk loaders close on GUI exit, travel, logout, and server stop, with a five-minute fail-safe if a release packet is lost; crystal portals themselves add no Rivencraft chunk tickets.
Manual #78 matrix (use two players where noted): restart with an active portal and confirm the book, surface, and destination view return once its chunk loads; walk through it immediately and after 10 seconds without reinserting the book. Then unload/reload the Age and repeat. With destination chunks loaded, contact should transfer instantly; with them unloaded, it should use Minecraft's normal dimension transfer while the animated fallback remains visible until the live view is ready. Have both players enter the same portal, return through separately bound books, and confirm each cooldown is independent and neither loops immediately. Test a Descriptive Book destination with unsafe feet/head space and with no existing footing: it must choose another footed spot or refuse travel, never generate a platform. Deny a portal cell with a block-protection mod and confirm activation consumes no book and leaves no partial surface. Break one cell and confirm it does not silently reappear. Remove or unload the destination dimension and confirm no crash or stale live view, while the book can still be retrieved. Open a book preview with Immersive Portals, close it, and confirm its temporary chunk loader is released; an abandoned preview should expire within five minutes. Repeat with Immersive Portals absent to confirm the fallback texture and book travel.
Manual #77 check: build a 3×3 vertical Crystal Block ring, put the Receptacle on one frame crystal's outward face, then insert a bound Linking Book. The center should animate and link on contact; the book stays in the Receptacle. Confirm unbound books and incomplete frames do not consume items; empty-hand right-click retrieves the book and clears the surface. Repeat with a Descriptive Book and with Immersive Portals installed: the latter should show the destination live. Restart with the portal active and confirm the surface/view returns; break the support crystal and confirm book/portal cleanup.
## Library implementation (#76)
The operator-only test controls are `/rivencraft library test-spacing 8` (roughly 16× normal candidate density in newly generated chunks), `/rivencraft library test-spacing` (show the current setting), and `/rivencraft library test-spacing reset` (return to Legacy spacing). The override affects only the current Age, lasts only until server restart, and never retroactively places libraries in existing chunks. Normal sites remain eligible. A spacing of `1` attempts a candidate in every new chunk and may be expensive. `/rivencraft library nearest` searches nearby test sites while the override is active. `/rivencraft library test-place` is a separate OP-only manual test: it places a library about 13 blocks ahead of the player in the current Age if an 11×11×11 volume is clear, building a one-block cobblestone platform below it. The command reports the chest coordinates; it does not alter natural spawning or make the manual library a locate candidate. Move to open ground if the command rejects the site.
Libraries now use Legacy's 32×32-chunk region and 0–23 offset with salt `14357617`, one candidate per region. A candidate builds only on a dry, sturdy, nearly level 11×11 surface with clear headroom; its entire rotated footprint stays in that one chunk. Cave terrain is skipped, Void naturally fails the ground check, and Sky Islands can host a library only on a suitable island top. Rejected candidate sites are not retried elsewhere in the region. This is intentionally safer and sparser than cutting through a modern village, tree, ocean, or cliff. The building now places `data/rivencraft/structure/mystcraft_library.nbt`, generated from all 694 ordered Legacy block placements. The old two-block lectern locations are emptied in the template and replaced at runtime by one-block Rivencraft Book Stands with page loot. The chest is also populated at runtime. Regenerate the template with `python scripts/generate_legacy_library_template.py`; the script pins and checksums the Legacy source.
The cobblestone supports, stone stairs/slabs, planks, shelves, webs, one chest, and five book stands now follow Legacy's block layout via the packaged template. Players can also place a page on an empty vanilla Lectern, converting it to a Rivencraft Book Stand; sneak-use retrieves the page. The stand renders the page item and its symbol name rather than a book model. `libraries.loot_mode` is a server config with `LEGACY` (default) and `AGE_ONLY` choices. In `LEGACY`, the chest uses `data/rivencraft/loot_table/chests/mystcraft_library.json`, with 4–8 main and 1–2 bonus rolls; Rivencraft Ink Vials replace Legacy vials, and ordinary books/experience bottles replace its unavailable booster item. Stands use random catalog symbol pages, excluding generated block/biome entries. In `AGE_ONLY`, the chest and stands contain only pages from the Age's frozen authored active symbols, or its selected random terrain/features/biome pool; there are no supplies. If an Age has no eligible symbols, the stand falls back to an ordinary book. The Legacy rank ≥3 gate cannot be carried over because Rivencraft symbols have no rank field. A stand's page and Age-only chest pages are saved in block entities; Legacy chests keep their assigned loot table/seed. Neither rerolls on player interaction or restart. Config changes affect only future libraries; existing generated chunks are never retroactively populated.
For a manual check, create a fresh surface Age and run `/rivencraft library nearest` as an operator. It examines up to 128 deterministic candidates in a six-region radius, one candidate chunk per server tick; this can generate those chunks. It teleports only to a marked intact library with clear floor/headroom, or reports that none was found. Confirm one chest and up to five page-bearing stands, take a page and chest contents, leave/restart, and confirm they do not reappear. Right-click an empty vanilla Lectern with a Symbol Page; it should become a stand displaying that page and symbol name. Sneak-right-click with an empty hand to retrieve it and restore the vanilla Lectern. Switch `libraries.loot_mode` to `AGE_ONLY`, create another fresh Age, and confirm its new library contains only pages that describe that Age (no paper, books, ink or bottles); switching modes must not refill an existing library. Repeat with a second player and with Flat, Cave, Void, and Sky Island Ages: only suitable exposed surfaces should host a library. The archived generation GameTest checks deterministic spacing, negative-coordinate regions, the single-chunk footprint, Age-only page filtering, stand storage, and locator marker detection.
- A [Book Receptacle](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/block/BlockBookReceptacle.java#L58-L173) attaches to a Crystal Block on any face except downward and holds a Linking or Descriptive Book. The Legacy recipe is eight Crystal Blocks around an empty center. Removing the book or its crystal support deactivates the portal; breaking the receptacle drops the book. [`TileEntityBookReceptacle`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/tileentity/TileEntityBookReceptacle.java#L23-L40) activates/shuts down on server-side book changes.
- [`PortalUtils`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/portal/PortalUtils.java#L23-L104) grows portal cells through a connected crystal network. Its tension test requires opposing crystal/portal neighbors on at least two axes; this is more flexible than a single fixed rectangular frame. Active cells trace a path to one receptacle. Modernize the unbounded flood/path walks with loaded-chunk and volume bounds, server validation, and persistent block-entity state.
- [`BlockLinkPortal`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/block/BlockLinkPortal.java#L208-L256) is translucent, non-solid, lit, validated on neighbor changes/random ticks, tinted by the book destination, and routes collisions to the receptacle's book. [`ItemLinking.onPortalCollision`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/item/ItemLinking.java#L106-L119) marks travel external, maintains momentum, disables platform generation, and uses the portal sound. The book remains in the receptacle. #77 owns core behavior; #78 owns restart recovery, protection, multiplayer, cooldowns, chunk tickets, and deleted destinations. A buildable portal is distinct from the existing Star Fissure.
- [Legacy portal assets](https://github.com/Mystcraft/Mystcraft-Legacy/tree/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/resources/assets/mystcraft) include `textures/blocks/book_receptacle.png`, `crystal.png`, animated `portal.png` with its `.mcmeta`, receptacle/crystal/portal block models and blockstates, `textures/entity/linkbook.png`, and `sounds/linking/link-portal.ogg`. Check these before creating art for #80, and add each reused file to [provenance](ASSET_PROVENANCE.md). Legacy's rendering pipeline itself cannot be copied unchanged to 1.21.1.
## Handheld books and Return Links
[`ItemLinking.activate`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/item/ItemLinking.java#L79-L103) calls `onLink` before travel. If the player uses the exact book in the selected main-hand slot and the Following flag is absent, it removes the book and spawns an [`EntityLinkbook`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/entity/EntityLinkbook.java#L48-L65) in the **origin** world. Following books stay in hand. The entity can be opened, picked up by sneaking with an empty hand, damaged, and collected by a hopper minecart.
Issue #75's comment calls this a despawning drop. The code differs subtly: [`EntityLinkbook`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/entity/EntityLinkbook.java#L190-L224) explicitly cannot despawn, but takes one starvation damage every 10,000 ticks and damage while wet. It can eventually be destroyed if left unattended; a vanilla item entity's fixed five-minute timeout is not parity. A modern equivalent should retain the visible book and avoid silently deleting its Age identity at that timeout.
Legacy's travel path creates no automatic Return Link. Rivencraft now defaults to `DISABLED` in new server configs while retaining `ON_CREATION` and `ALWAYS` as opt-ins. Existing saved server configs keep their explicit value. Issue #85 adds the active-book drop only to hand-held Linking and Descriptive Book travel. On a successful link, the exact active stack becomes a dedicated `DroppedBookEntity` at the departure point, rendered with the same open `BookModel` and textures as the book stand; a rejected link restores it to the original hand. Stand and portal use leave their books in place. The entity has unlimited vanilla lifetime and loses one of its five item-health points every 10,000 loaded ticks, plus one per wet tick, matching Legacy's slow/wet decay. Unlike Legacy's custom entity, the modern book is picked up by ordinary contact, not sneaking with an empty hand, and remains subject to ordinary item hazards. Following is not yet a Rivencraft modifier, so no Following exception is exposed or silently simulated. Both hands can activate a book, whereas Legacy's explicit stack removal tested only its selected main-hand slot.
## Crafting, sounds, and progression
| Area | Legacy evidence and modern boundary |
| --- | --- |
| Crafting | [Legacy recipes](https://github.com/Mystcraft/Mystcraft-Legacy/tree/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/resources/assets/mystcraft/recipes) specify the Receptacle, Binder, Mixer, Folder, Desk, and other writing blocks. [`RecipeLinkingbook`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/data/RecipeLinkingbook.java#L28-L60) combines one Link Panel and leather anywhere in the grid. Rivencraft has Binder, Mixer, Ink Vial, Notebook, Desk, Crystal Block, Linking Book, and Receptacle recipes. #79 keeps these data-driven and adds recipe-book unlocks for Crystal Block, Receptacle, and Ink Vial. The Legacy potion-based ink variant is omitted: in 1.21.1 a simple potion ingredient does not return its glass bottle, while the existing water-bucket recipe returns its bucket. The Legacy Folder/Portfolio use Rivencraft's Notebook; the old two-part Desk is one item; the old Lectern/Book Stand recipes use a vanilla Lectern converted in-world by adding a Rivencraft book or page. Blank Pages remain noncraftable and Link Panels remain outside the Desk. JEI automatically displays the JSON crafting recipes; its existing optional categories cover Mixer, Desk, and Binder processes. The lectern interaction intentionally has no JEI guide. With Create installed, an optional Ponder scene attached to the Receptacle item demonstrates frame construction and book insertion; the core mod still runs without Create. |
| Sounds | [`Sounds`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/data/Sounds.java#L8-L26) registers pop, link, disarm, following, intra-link, fissure-link, portal-link, and meteor roar. The matching OGGs are in the local extraction. Rivencraft already carries link, fissure-link, and meteor roar. #80 should reuse and credit available Legacy files before creating alternatives. |
| Advancements | [Legacy advancement JSONs](https://github.com/Mystcraft/Mystcraft-Legacy/tree/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/resources/assets/mystcraft/advancements) have inventory milestones for a symbol page, unlinked Linking Book, and Age Book; a Writing Desk trigger; a safe Age-travel trigger; and a hidden Quinn trigger. #81 should use modern server-owned criteria. Quinn has no established Rivencraft equivalent and should be documented or deliberately omitted, not awarded on preview. |
## Test boundaries and modern adaptations
- #76: deterministic sparse, automatic libraries with the 11×10×11 shape, chest and up to five book stands; test restart and nonstandard terrain without forcing distant chunks.
- #77: receptacle/crystal activation, connected-frame validation, sound/color, travel through the existing book/Age service, and rejection of invalid books or frames.
- #78: full-restart recovery, multiplayer, protection events, loop prevention, destination deletion, and bounded chunk activity.
- #79–#81: data-driven recipes/optional JEI, then assets/audio, then advancements. #82–#83 verify NeoForge 1.21.1 compatibility and a focused manual/automated matrix.
- #85: drop active non-Following books at origin, disable Return Links for **new** configs, preserve existing config choices, and separately test held, stand, and portal travel.
The 1.21.1 world height, biome/structure APIs, dynamic Age lifecycle, NeoForge protection events, and dedicated-server rendering boundaries preclude direct transplantation of Legacy's 1.12 generator, metadata, and fixed-function portal renderer. Keep those adaptations explicit in follow-up tests and documentation.
+94
View File
@@ -0,0 +1,94 @@
# Live block-instability profiling (0.5.8.11–0.5.8.17)
Mystcraft Legacy measures the abundance of watched blocks in generated chunks,
compares that abundance with a baseline, and adds only positive excess to the
Age's instability. Its `InstabilityBlockManager` and `ChunkProfiler` are
available in the user's local 0.13.7.06 archive. Legacy's Age-side threshold
is more than 400 profiled chunks; its default tolerance is 1.05. The Legacy watched
blocks include coal, lapis, iron, emerald, redstone, gold and diamond ores,
quartz ore, glowstone, and crystal blocks. Diamond **blocks** are not on that
default list, but are included here at the player's request.
Rivencraft samples up to 1,024 distinct loaded chunks per dimension,
at most four per server tick. While a player is in an Age, it also gradually
generates unsampled chunks around that Age's spawn and the Overworld spawn,
at most one chunk per second across both dimensions, until their minimum
sample counts are reached.
The Overworld is sampled as the baseline; an Age needs 401 samples and the
baseline needs 500 before the live block component contributes points. Counts and sampled chunk
positions persist per dimension, preventing reloads from double-counting.
For each watched block, Rivencraft compares average blocks per sampled chunk
and charges `max(0, Age average − 1.05 × Overworld average) × weight`, rounded
to the nearest point. The block component is capped at 100,000 points.
Legacy weights are used for its watched blocks: coal/lapis 5, iron 60, emerald
200, redstone 250, gold 750, diamond 4,000, quartz/crystal 20, and glowstone
50. Deepslate variants inherit their ore's weight. Modern/high-value extensions
include diamond, emerald, gold, iron, raw gold, raw iron and netherite storage
blocks, plus ancient debris. Netherite blocks cost 8,000 per excess block per
sampled chunk; ancient debris costs 4,000.
Other mods remain optional. When an installed mod registers common-tagged ores
or storage blocks, recognizable `*_ore` blocks, or source-fluid blocks,
Rivencraft automatically includes those blocks in live profiling. The source
fluid weight is 1.25; common mineral names such as tin,
lead, zinc, silver, uranium, platinum, and iridium have explicit tiers, while
other tagged ores use 60 and other tagged storage blocks use 120. The optional
`instability_modded_materials.block_weight_overrides` list accepts a full-block
`modid:block_id=points` entry to cover a block without common tags or replace
its inferred weight; zero excludes it. Block entities and non-source fluid
plants are excluded. Rivencraft never requires any particular content mod.
Profiles written before 0.5.8.17 did not retain all modded material
counts, so their block sample data resets and is collected again after upgrade.
The saved Age definition and authored score are not changed. Later config
changes can rescore materials already captured in the profile; a newly added
override for a block that was not previously recognized needs fresh samples.
The authored score and provider plan remain saved as the Age's immutable base.
Only Ages created with instability schema v2 participate; existing v1 Ages
retain their previously frozen scores/plans, including neutral pre-scoring
Ages. This avoids silently rescoring existing worlds.
The live block component creates a deterministic **effective** score and
provider plan from that base plus the persisted profile; new cards can become
active as sampled abundance rises. The command `/rivencraft age instability`
shows both the saved base and the currently profiled block component. An
unloaded Age has no active profile view until its dimension is loaded again.
Turning an effect off does not delete counts or reroll the same effective plan.
This is not byte-for-byte Legacy profiling. Legacy has a spatial accessibility
map and two factors per block, actively builds a dummy-world baseline, and can
recompute after subsequent chunk profiling. Rivencraft uses a simpler
per-chunk abundance metric, a real-world Overworld baseline, a sample/work cap,
and a saved authored base so modern servers remain bounded and restart-safe.
The greater-than-400-chunk activation delay is retained. Already-explored
chunks count when reloaded, but the bounded spawn-area pass can generate
additional terrain. A mod that mutates blocks after the chunk-load event may
not be reflected in the first sample.
## Manual check handed to the player
The first focused GameTest run after adding the chunk-load listener stalled in
its initial 50-test batch and was stopped. It is **not** a passing test result.
Do not retry that stalled scenario automatically. In a disposable world:
1. Create one Age with an authored Diamond Block + Rocks (or Floating Islands)
combination and a comparison Age using Stone for the same feature. Explore
enough distinct chunks in each Age for `/rivencraft age instability` to show
a profiled-block contribution. Explore the Overworld too if its baseline has
not reached 400 chunks. The diamond Age should score higher and can gain
provider cards; the stone Age should not get a diamond-block contribution.
2. Leave and restart the world. Re-enter both Ages and compare their scores and
provider IDs/levels. Reloading old chunks must not increase the sample
count or score by itself. Generating more diamond-rich chunks may change the
effective score and provider set; disabling instability must suppress their
effects without erasing the profile.
3. Check a naturally generated diamond-ore Age without authored diamond-block
features. If its ore abundance is near the Overworld baseline, it should
receive little or no ore contribution. Check that profiling does not make
chunk loading noticeably stall, and report any exception or server hang.
Do not use a valued save for this check. The player reported an in-game pass
for the 0.5.8.18 candidate on 2026-10-12. The three detailed scenarios above
remain useful for future regression runs; the report does not establish that
each was exercised individually.
+66
View File
@@ -0,0 +1,66 @@
# Milestones at a glance
This is the condensed milestone history. The [current implementation](CURRENT_IMPLEMENTATION.md)
is authoritative for what the latest development build does; older acceptance
and audit files remain available as dated evidence, not competing current
instructions. [Gitea milestones](https://truenas-scale.tail180fb1.ts.net:8443/dnorberg/rivencraft/milestones)
hold the live issue status.
## 1 — Bootstrap (complete)
Established the NeoForge 1.21.1/Java 21 project, mod identity, registries,
assets, build, and first automated checks. The port deliberately shares
Mystcraft's concepts while maintaining its own modern package and data model.
See [porting principles](PORTING.md) and [asset provenance](ASSET_PROVENANCE.md).
## 2 — Books and linking (complete)
Introduced persistent Linking and Descriptive Books, conversion of vanilla
Lecterns into Book Stands, named books and Ages, safe travel, destination
previews, and a configurable Return Link policy. Later milestones refined
renderer selection and portal travel. See [preview compatibility](PREVIEW_COMPATIBILITY.md).
## 3 — Ages (complete)
Added persistent runtime dimensions, deterministic random Age traits,
name-derived unique dimension folders, terrain/biome choices, spawn recovery,
and Age lifecycle commands. See [Age administration](AGES.md),
[runtime profiles](AGE_PROFILES.md), and [random weights](RANDOM_AGE_WEIGHTS.md).
## 4 — Writing system (complete)
Introduced Symbol Pages, Link Panels, Notebooks, the Writing Desk, Book Binder,
and Ink Mixer. Writing order and unknown symbol references persist instead of
being inferred from UI text. See [writing data](WRITING_DATA.md),
[descriptive-book presentation](DESCRIPTIVE_BOOK_PRESENTATION.md), and
[Ink Mixer audit](INK_MIXER_MODIFIER_AUDIT.md).
## 5 — Age grammar (complete for the supported subset)
Compiled supported pages into frozen Age plans: terrain, biome distribution,
environment, features, block/fluid materials, structures, crystals, and
fissures. Added optional TerraBlender and Serene Seasons adapters. This was
not a claim of complete Legacy grammar parity. See [M5 acceptance](MILESTONE_5_ACCEPTANCE.md),
[Legacy grammar audit](LEGACY_AGE_GRAMMAR_AUDIT.md),
[symbol schema](SYMBOL_SEMANTICS.md), [TerraBlender](TERRABLENDER_COMPATIBILITY.md),
and [Serene Seasons](SERENE_SEASONS_COMPATIBILITY.md).
## 6 — Instability (complete)
Added authored and live block-abundance scoring, frozen provider plans,
operator diagnostics, bounded status effects, decay, lightning, explosions,
meteors, burning, and erosion. Safety budgets are deliberate modern
adaptations. See [M6 acceptance](MILESTONE_6_ACCEPTANCE.md),
[Legacy instability audit](LEGACY_INSTABILITY_AUDIT.md), and
[runtime policy](INSTABILITY_RUNTIME.md).
## 7 — Structures and polish (complete in 1.0.0.2)
Added Legacy-layout Age libraries, page-bearing stands, crystal portals and
receptacles, the handheld dropped-book entity, data-driven recipes,
advancements, asset/audio polish, optional Ruins, compatibility updates, and
expanded sky/glyph pages. Issue #83 covered regression, migration, and document
consolidation; issue #84 records the final milestone acceptance. See the
[M7 acceptance](MILESTONE_7_ACCEPTANCE.md), [M7 Legacy audit](LEGACY_M7_AUDIT.md),
[M7 regression matrix](MILESTONE_7_REGRESSION.md), and
[M7 compatibility review](MILESTONE_7_COMPATIBILITY_REVIEW.md).
+1 -1
View File
@@ -1,6 +1,6 @@
# Milestone 5 acceptance: Age grammar
This is the completion record for [Gitea issue #42](https://gitea.tail180fb1.ts.net/dnorberg/rivencraft/issues/42) and release 0.5.0.0. Issues #28–#41, #45–#59, #61, and #62 are closed. #39 was closed with an explicit Ecliptic Seasons limitation, not with a working Ecliptic adapter. #42 is the final gate. Issues #43, #44, and #60 are separate open follow-ups, not hidden Milestone 5 completion claims.
This is the completion record for [Gitea issue #42](https://truenas-scale.tail180fb1.ts.net:8443/dnorberg/rivencraft/issues/42) and release 0.5.0.0. Issues #28–#41, #45–#59, #61, and #62 are closed. #39 was closed with an explicit Ecliptic Seasons limitation, not with a working Ecliptic adapter. #42 is the final gate. Issues #43, #44, and #60 are separate open follow-ups, not hidden Milestone 5 completion claims.
## Authoring and generation contract
+110
View File
@@ -0,0 +1,110 @@
# Milestone 6 acceptance review (issue #74)
Milestone 6 covers authored and live block instability, deterministic provider
selection, bounded Age effects, diagnostics, and migration. Its required issues
#63–#73 are closed. This document records acceptance of **0.6.0.0**, not a
claim of exact Mystcraft 1.12.2 parity or a claim that every optional-mod
combination was tested. The player reported an in-game pass for the 0.6.0.0
candidate on 2026-10-12; the broader manual matrix remains a future checklist.
## Scoring and writing
The [pinned Legacy audit](LEGACY_INSTABILITY_AUDIT.md) records source defaults
and the Rivencraft mapping. Authored score/breakdown and provider plan are
saved per Age; seed-completed missing branches cost zero. Extra single-choice
controllers cost +500, and out-of-order non-modifier pages cost +100.
Version-4 Age plans consume period/phase modifiers in written order; repeated
modifiers combine, while each kind left unconsumed after the last celestial
page costs +100. Bright Lighting costs +500 per occurrence. The fourth and
later occurrences of each of the four Legacy structure pages cost +100; the
same rule applies to named modern structure pages as a project balance
extension. Forcing a structure into an unsupported selected biome costs +100
per occurrence. Accelerated and Corrupted pages retain their audited costs.
Unknown or unrepresentable new writing remains a clear binding error, rather
than a silent no-op. See [score details](INSTABILITY_SCORE.md).
The [live block profile](LIVE_BLOCK_INSTABILITY.md) samples generated chunks
gradually and contributes only after the Age and Overworld-baseline thresholds.
It can change the effective score and active provider selection as new chunks
are profiled, without rewriting authored score or writing. Diamond storage
blocks are an intentional addition to Legacy's watched blocks. Ores, mineral
storage blocks, and source fluids supplied by installed mods are recognized
automatically through common tags and material names; those mods are **not**
Rivencraft dependencies. Exact weight overrides are optional configuration.
## Effects, safety, and diagnostics
The [runtime policy](INSTABILITY_RUNTIME.md) documents saved deck order,
provider costs/levels, per-Age cooldown, rotating Age admission, loaded-chunk
selection, and server-side action budgets. Defaults allow four Ages per tick,
two provider calls and one effect action per Age run, up to 16 loaded chunk
candidates, and a 20-tick per-Age cooldown. These caps and protected
spawn/portal/platform areas are modern safety adaptations, not Legacy's
unrestricted execution. Global, per-Age, provider, and world-mutation controls
suppress execution without rerolling a saved authored plan.
Implemented effect families include bounded status effects, four active
colored decay variants, lightning, explosions, meteors, ordinary burning,
and guarded erosion. Erosion is deliberately enabled by default for testing
although Legacy did not register its provider in the active deck. Dormant
Legacy black/green/yellow decay variants, global burning, and bedrock crumble
are **not** claimed as working. Potion targeting excludes Creative/Spectator
players; hostile buffs target hostile mobs. The [effect audit](LEGACY_INSTABILITY_AUDIT.md)
records those differences. [Operator diagnostics](INSTABILITY_DIAGNOSTICS.md)
report authored and live block contributions, selected providers, enabled
state, and budget suppression; raw score is not shown in book UI.
## Migration and validation
Pre-scoring Ages migrate to neutral instability. Score-only Ages receive a
deterministic saved provider plan. Existing plan-v3 Ages keep their old
stage-sorted celestial behavior and writing cost; new plans use schema 4.
Block profile schema 2 resets old samples once to capture modded materials,
and preserves unknown material IDs if an optional mod is later removed.
Missing symbol definitions do not reinterpret a saved authored score, but
removing required biome/worldgen registry entries may still prevent world
loading. General old-save compatibility is tracked separately in issue #60.
The [Milestone 6 regression record](MILESTONE_6_REGRESSION.md) distinguishes
the passing 0.5.8.10 focused archive, the later storage-stalled archive, the
0.5.8.18 build, and the player's reported in-game pass. Its expanded manual
matrix is a repeatable future checklist, **not** an individually signed-off
pass for every optional mod, multiplayer, restart, and hazard combination.
For this completion candidate, verify build, diff check, jar checksum, and a
fresh in-game pass before publication. Do not rerun the known stalling archive
as a release gate; hand any newly stalled GameTest scenario to the player.
The completion review also replaced repeated linear scans of saved active
symbol indices with one lookup map per call, and shares one effective provider
plan across the scheduler, hazard, and environmental lanes of an admitted Age
tick. Live-profile scoring within that plan also uses one sample evaluation
instead of two. These are
behavior-preserving cleanups; no provider rates or budgets were raised.
## NeoForge decision
The project currently develops against NeoForge **21.1.251** for Minecraft
1.21.1. The [official 21.1.259 changelog](https://maven.neoforged.net/releases/net/neoforged/neoforge/21.1.259/neoforge-21.1.259-changelog.txt)
lists mostly loader/Mixin dependency updates, a GUI slot-index API change,
and targeted fixes since 21.1.251. None addresses a known Rivencraft defect.
Upgrading the development and minimum runtime version during this acceptance
gate would force an additional optional-integration test pass for little clear
benefit. Keep 21.1.251 for 0.6.0.0; evaluate 21.1.259 in a separate later
slice with Create/Ponder, Immersive Portals, Dynamic Dimensions, JEI, and the
season/biome integrations. This is a release-risk judgment, not a claim that
21.1.259 is incompatible.
## Gate status
- Required implementation issues #63–#73: closed.
- Known unsupported effects and broader save compatibility: explicitly scoped
above, not counted as working Milestone 6 behavior.
- Candidate `./gradlew build --offline --no-daemon --quiet`: passed; the
compiler reported only existing GameTest helper deprecation warnings.
Local JAR SHA-256: `6eed828156dd1e2679b013c3c5bf8e692a20d9ab80ae27417b3cafe1c26422c7`.
- Player in-game acceptance of completion candidate: reported pass on
2026-10-12; individual optional-mod and multiplayer matrix rows were not
separately signed off.
- [Gitea V0.6.0.0 release](https://truenas-scale.tail180fb1.ts.net:8443/dnorberg/rivencraft/releases/tag/V0.6.0.0):
published with changelog and jar; downloaded asset SHA-256 matched the local
build. Issue #74 and Milestone 6 were closed with all 12 milestone issues
closed and zero remaining open.
+158
View File
@@ -0,0 +1,158 @@
# Milestone 6 instability regression and migration check (#73)
This is the release-slice acceptance record for instability, not a promise of
general old-save compatibility. The latter remains issue #60. Run the focused
archive with `./gradlew build runGameTestServer -ParchivedGameTestSuites=instability`;
it includes the default smoke suite.
For 0.5.8.10 on 2026-10-10, that dedicated GameTest server passed all 55 required tests
with no optional content/client integrations installed (the required Dynamic
Dimensions and Bad Packets dependencies were present). The full archive was not run;
it has a previously documented storage stall, so do not count it as passing.
The 0.5.8.11 run with live block profiling stalled in its initial batch and
was stopped; it is **not** a passing result. The live profiling scenario is
handed to the player in [the block-profile checklist](LIVE_BLOCK_INSTABILITY.md).
## Automated coverage
| Requirement | Existing default test or focused archive |
| --- | --- |
| Stable writing, defective writing, score explanations, repeated use of the same book | `AgePersistenceGameTests.instabilitySeparatesStableAndDefectiveWriting` |
| Frozen score, age-scoped writing cost, random baseline | `AgePersistenceGameTests.randomBaselineAndBrightBalanceAreFrozen`, `auditedSymbolCostsAreCountedAndAgeScoped` |
| Complete Age definition, score and provider-plan save/load | `AgePersistenceGameTests.authoredPlanRetainsResolvedMeaningAndAgeIdentity`; `AgeInstabilityRuntimeGameTests.selectionIsDeterministicAndFrozen` |
| Old pre-scoring Ages, score-only saves, removed symbols, unavailable handlers | `AgePersistenceGameTests.missingRegistryEntryDoesNotReinterpretAnOldAge`, `instabilitySeparatesStableAndDefectiveWriting`; `AgeInstabilityRuntimeGameTests.savedPlanSurvivesAgeUpdatesAndMissingHandlers` |
| Per-Age controls and changed config without score/plan reroll | `AgeInstabilityRuntimeGameTests.perAgeControlsPersistWithoutChangingScoresOrOtherAges`; `Milestone6RegressionGameTests.disablingEffectsCannotRerollFrozenPlan` |
| Hazard cooldown and attempt sequence across saved-state reload | `AgeInstabilityRuntimeGameTests.hazardCooldownAndAttemptSequenceSurviveReload` |
| Active-Age rotation, action/tick budget | `AgeInstabilityRuntimeGameTests.ageScopeRotationAndActionBudgetAreBounded` |
| Multiplayer loaded-chunk-only candidate selection, deduplication and cap | `Milestone6RegressionGameTests.multiplayerCandidatesStayLoadedDeduplicatedAndCapped` |
| Decay loaded-chunk target and spawn protection | `AgeDecayGameTests.targetMustRemainInChosenLoadedChunk`, `savedSpawnAndPlatformAreProtected` |
| Explosion policy gates and protected blocks | `Milestone6RegressionGameTests.disabledGriefAndProtectedBlocksStayUntouched` |
| No Overworld status or decay provider | `AgeStatusEffectGameTests.overworldCannotRunAnAgeStatusProvider`; `AgeDecayGameTests.overworldCannotRunDecayProvider` |
| Optional-mod material weights, block overrides, and old profile migration | `Milestone6RegressionGameTests.commonModdedMaterialWeightsStayBounded`, `blockProfileSamplesPersistWithoutDoubleCounting` |
| Ordered celestial modifier consumption, repeated modifiers, and dangling +100 per kind | `WritingGrammarGameTests.orderedGrammarAcceptsPartialWritingAndDiagnosesInvalidSequences`; `EnvironmentWritingGameTests.celestialModifiersFollowWrittenOrder` |
These tests exercise saved-data serialization and deterministic policies. They
do **not** simulate a complete process restart, an actual multiplayer server,
optional-mod installation, or real terrain and hazard visuals. The three new
checks live only in the `instability` archive to avoid duplicating default tests.
## Migration outcome and known gaps
- Pre-scoring Milestone 5 Ages load with a neutral score and no effects; they
are not retroactively rescored under current writing rules.
- Score-only Ages receive a deterministic provider plan once from their saved
score and Age seed. An already-saved score and plan retain their meaning when
pages, handlers, or runtime config change. Unknown but syntactically valid
provider IDs are preserved and skipped if their handler is unavailable.
- Missing symbol definitions do not reinterpret a frozen instability score.
That check is narrower than arbitrary missing biome, block, or worldgen
registry entries: loading a world with removed data packs is not guaranteed.
Broad save compatibility and migration remain tracked in #60.
- Version-3 plans keep their previous stage-sorted celestial interpretation and
frozen writing cost. Only new version-4 plans consume period/phase modifiers
in authored order and charge a trailing modifier once per pending kind.
- In-process roundtrips cannot prove that Age dimensions reload correctly
after a full stop/start. Check that in a real client/server world. Do not add
another GameTest for it if it hits the documented storage stall; hand the
exact scenario to the player instead.
- The dedicated GameTest run establishes classloading with no optional runtime
flags. It does not establish classloading with every optional integration
installed, nor the reverse of removing one from an existing save.
## Manual in-game matrix
Use a fresh test world, then keep one save for the restart and data-pack checks.
Record the seed, mod list, age name, and `/rivencraft age instability` output
before and after each change. Do not deliberately remove a required registry
entry from a valued world; copy the test save first.
1. Bind a low-instability book and a deliberately unstable book. Reuse each
book and verify the Age name, dimension ID, score, selected providers and
provider levels remain unchanged. Exit the Ages, stop Minecraft completely,
restart and re-enter; compare the same diagnostic values.
2. With two survival players in one unstable Age and a third player in the
Overworld, verify effects stay in the Age, follow the Age players, and do
not appear in the Overworld. Move both Age players away, let old chunks
unload, and confirm hazards do not keep remote chunks loaded or operate
there. Confirm controls on one Age do not alter a second Age.
3. Disable global instability, then world mutation, then one provider. Verify
the suppressed effect stops and the frozen score/plan do not change after
re-enabling or restarting. With block destruction disabled, trigger an
explosion in an expendable Age; check that arrival platforms, portals,
block entities and protected blocks survive. Check lightning, explosion,
decay, status-effect, burning, meteor and erosion visuals where selected.
4. With Biomes O' Plenty or another TerraBlender biome mod, confirm recognized
biome pages still author an Age and the instability diagnostics remain
stable after restart. Repeat with Serene Seasons installed, then absent in
a disposable copy; confirm its Age season behavior and that Rivencraft
itself still loads. JEI should display the relevant pages and recipes when
installed, while the mod works without it.
Separately, install a mod with common-tagged ores/storage blocks or source
fluids. Compare a material-rich Age with an ordinary Age after the profile
thresholds are reached; the installed mod's recognized blocks should affect
the result without a Rivencraft allowlist. Then remove that optional mod in
a disposable copy and confirm Rivencraft still starts. Test a single
`block_weight_overrides` entry and a zero-weight exclusion. This remains a
player-run scenario, not an automated pass.
5. Check the book preview separately with its fallback animation, Ponder/Create,
and Immersive Portals when available. Opening a book should not change
player location, instability diagnostics, or ambient audio in the actual
Age. Do not install both season mods together for this matrix.
6. On a copied save, remove or alter a **nonessential** data pack providing
a writing symbol or optional handler, then reload. Existing saved scores
and provider plans must not reroll. If a referenced worldgen registry entry
prevents load, record it against issue #60 rather than treating #73's
frozen-instability guarantee as general missing-registry support.
The matrix is guidance for a player-run pass; none of these six scenarios is
claimed as completed by the automated result above.
The player reported an in-game pass for the 0.5.8.18 candidate on 2026-10-12.
That is a release-slice acceptance report, not a claim that every expanded
matrix row below was individually exercised.
### Regression run record
For each row, record pass/fail, world seed, Age name, Rivencraft version,
optional-mod versions, and a short observation. "Not run" is intentional
until a player completes the in-game check; a successful build is not a pass.
| Area | Specific manual observation | Status |
| --- | --- | --- |
| New vs reused book | Dimension ID, score, and providers do not reroll | Not run |
| Full process restart | Re-enter two Ages; saved traits, score, plan, and cooldowns persist | Not run |
| Multiplayer isolation | Two Age players receive effects; Overworld player does not | Not run |
| Loaded-chunk scope | Departing players permit unloading; hazards do not reach old chunks | Not run |
| Controls | Global, per-Age, mutation, and provider toggles suppress effects without reroll | Not run |
| Protected blocks | Explosion/decay/erosion spare arrival platforms, portals, and block entities | Not run |
| Hazard visuals | Lightning, explosions, decay, status, burning, meteor, and erosion each behave when selected | Not run |
| Third-party biomes | TerraBlender biome pages and cave classification survive Age creation/restart | Not run |
| Optional integrations absent | Mod launches without JEI, Create/Ponder, Immersive Portals, Serene Seasons, or biome mods | Not run |
| Optional integrations present | JEI pages/recipes, preview backends, seasonal behavior, and ambient sound work | Not run |
| Optional-mod materials | Tagged ore/storage/source-fluid samples change live profile automatically | Not run |
| Material overrides | Positive and zero `block_weight_overrides` values affect only named blocks | Not run |
| Removed optional mod | Disposable copy launches without the mod; unknown sampled IDs stay serialized | Not run |
| Removed symbol/handler | Frozen score and provider plan survive when nonessential data is removed | Not run |
| Ordered modifiers | Five book-order cases below produce expected time and dangling costs | Not run |
### Focused ordered-writing and optional-material checks for 0.5.8.18
Use `/rivencraft age instability` in each newly bound Age; old Ages retain
their original plan and score. Record each row as pass/fail with the Age name,
world seed, installed optional mods, and the command output. The ordered
modifier assertions are archived, not a claim that the stalled GameTest suite ran.
| Book pages after Link Panel, in exact order | Expected result | Result |
| --- | --- | --- |
| Half Length, Double Length, Normal Time | Length combines to 1.25×, no dangling cost | Not run in game |
| Normal Time, Zero Length | Sun keeps normal motion; one dangling +100 | Not run in game |
| Rising, Normal Time, Setting | Rising start phase; Setting dangles +100 | Not run in game |
| Half Length, Double Length, no celestial page | One combined pending length dangles +100; seeded clock remains | Not run in game |
| Normal Time, Zero Length, Normal Time | Last sun consumes Zero Length; duplicate celestial cost remains separate | Not run in game |
With a common-tagged ore/storage-block or source-fluid mod installed, bind
comparable material-rich and ordinary Ages and wait for profiling thresholds.
Verify the modded material contributes automatically, then restart and confirm
the score/profile remains consistent. On a disposable copy, remove the mod and
confirm Rivencraft launches without it; restore the mod before judging the
world's registry-dependent terrain. Also check a zero-weight override and a
positive override. These are optional-mod compatibility checks, not a new
required dependency.
+72
View File
@@ -0,0 +1,72 @@
# Milestone 7 acceptance — 1.0.0.2
Milestone 7 is complete for the supported NeoForge 1.21.1 feature set. This is
not a claim of total Mystcraft Legacy parity or exhaustive optional-mod
certification. The [current implementation](CURRENT_IMPLEMENTATION.md) is the
up-to-date behavior summary; the [regression matrix](MILESTONE_7_REGRESSION.md)
separates automated evidence from manual scenarios.
## Scope and issue gate
The Gitea audit for issue #84 found no other open issues. Required existing
#14 (cave terrain), #43 (glyph numbers), #44 (sky), and #60 (old-save policy)
were closed. M7 implementation and review issues #75–#83, #85–#90, and
later additions #91–#94 were closed before this acceptance. No required
issue was silently deferred.
| Legacy concept | Rivencraft implementation or deliberate difference |
| --- | --- |
| Cave terrain and writing | Cave terrain uses its cave/Nether biome set and a modern Y=64-start spawn search. Existing non-cave terrain still supports caves as features. See [Age profiles](AGE_PROFILES.md) and [grammar](WRITING_GRAMMAR.md). |
| Libraries | The recognizable Legacy small-library layout and sparse candidate spacing are ported as a structure template with a chest and up to five page-bearing Book Stands. It generates only in Ages and only on suitable surfaces; player-selectable Legacy or Age-only loot is supported. See [Legacy M7 audit](LEGACY_M7_AUDIT.md). |
| Crystal portal and Receptacle | Connected Crystal Blocks support vertical and horizontal portals. The held book stays in the Receptacle; removing it removes the surface. Rivencraft validates loaded bounds and block protection, saves owner pointers, and uses book-travel rules. Optional Immersive Portals supplies a live destination view, with an animated fallback while unavailable. |
| Handheld Linking/Descriptive Books | The used book remains behind as a rendered book entity at the origin. The exact Legacy entity pickup rule is not copied: modern contact pickup is used. Return Links default to disabled but remain configurable. |
| Recipes and discovery | JSON crafting recipes and recipe-book unlocks cover the supported writing/crystal progression. Optional JEI covers the Binder, Writing Desk, and Ink Mixer; a Lectern conversion has no JEI guide. Blank Pages are not craftable. Optional Create/Ponder teaches portal construction. See [JEI review](MILESTONE_7_JEI_REVIEW.md). |
| Models, sounds, and advancements | Legacy-sourced assets are credited in [asset provenance](ASSET_PROVENANCE.md); 1.21.1-compatible models and renderer adaptations are documented in the [visual audit](MILESTONE_7_VISUAL_AUDIT.md). Server-owned advancements cover book, writing, Age, and portal progress; the unimplemented Quinn equivalent is explicitly omitted in [advancement notes](MILESTONE_7_ADVANCEMENTS.md). |
| Numbers, sky, and extra items | Base-25 number glyphs, celestial modifiers and eclipses, Symbol Portfolios, the OP-only Link Modifier, and optional Ruins pages were follow-up additions. Legacy page semantics are adapted to the modern authoring plan rather than a binary copy of 1.12.2 worldgen. |
## Compatibility and migration
NeoForge **21.1.264** is the minimum 21.1 build. A player passed the
singleplayer client with the optional stack, then a local dedicated server
including Immersive Portals, before the minimum was raised. See the
[compatibility decision](MILESTONE_7_COMPATIBILITY_REVIEW.md). JEI
19.69.0.457 and Serene Seasons 10.1.0.9 received their own player checks;
Create/Ponder, Immersive Portals, TerraBlender/biome add-ons, Serene Seasons,
JEI, and Ruins remain optional. Ecliptic Seasons is deliberately not
integrated: its 1.21.1 public API does not support the required live Age
registration and per-Age calendar control. Missing optional mods must not
prevent the core mod from loading.
Known older writing/book, Age-plan, and workstation formats have explicit
migration or stable-default handling. An Age registry and its dimension
folders must be backed up together. Removed mods, missing custom registry
objects, and arbitrary prerelease saves are **not** guaranteed to load.
Retiring an Age through the creative Link Modifier archives its data and
invalidates its UUID; that intentional destructive operation is not a
migration. See the [old-save boundary](MILESTONE_7_REGRESSION.md#old-save-boundary-60).
## Release validation and limits
The 0.6.11.0 regression candidate passed `./gradlew --offline build` and
fresh-world GameTest runs: core **91/91**, generation **129/129**, and
environment **103/103**. The player reported an in-game pass for that
candidate. The 1.0.0.1 release candidate additionally allows Number Pages to
set Celestial Size. The 1.0.0.2 release makes Binder status diagnostics an
OP-only, default-off world setting. Its offline build and core GameTests
passed (93/93), and the player reported an in-game pass. The
preceding 1.0.0.0 candidate passed core and generation GameTests. Its
environment archive stalled in the first 50-test batch, repeatedly printing
its field without completing; it was stopped and is **not** counted as a
1.0.0.0–1.0.0.2 pass. The previous 0.6.11.0 run of that same suite passed 103/103.
The focused sky, season, and number-page in-game checks in the regression
matrix remain useful regression checks, not claimed full-matrix passes. The
Gitea release changelog records the tested JAR and verified SHA-256.
These results do not prove every two-player race, full restart, migration
from every development world, or optional-mod combination. The specific
manual matrix remains in [M7 regression](MILESTONE_7_REGRESSION.md); those
broader combinations are known validation limits, not claimed passes. Modern
chunk and tick budgets, safer portal validation, 1.21.1 world-height and
biome APIs, and the dynamic-dimension backend are deliberate deviations from
Legacy. A complete Legacy worldgen or link-property port is outside this
milestone.
+40
View File
@@ -0,0 +1,40 @@
# Milestone 7 advancements and discovery (#81)
Rivencraft's advancement tab follows the visible progression in Mystcraft
Legacy's `assets/mystcraft/advancements/`: Page, unwritten Linking Book,
Writing Desk writing, Age Book, and safe Age travel. Titles such as *The Ending
Has Not Yet Been Written*, *D'ni Ink*, and *The Art of Writing* reference Myst
without requiring any assets from that game. The Legacy hidden Quinn trigger
has no established Rivencraft action and is deliberately omitted.
`root`, `page`, and `linking_book` use vanilla server-side tick/inventory
criteria. `link_panel`, `copy_page`, `bind_age`, `open_portal`, and `enter_age`
use an impossible criterion awarded only after the server commits the
corresponding action. The Age-travel award requires a successful book or portal
link ending in a registered Rivencraft Age. Opening a book GUI, rendering a
destination preview, viewing a recipe, or merely loading an Age cannot award
it. Progress is stored by Minecraft per player and survives world restarts.
Vanilla recipe-book unlock advancements now cover the Writing Desk, Ink Mixer,
Book Binder, and Notebook, in addition to the existing Ink Vial, Crystal
Block, and Book Receptacle unlocks. The component-sensitive Linking Book
crafting recipe remains a special recipe: its Link Panel requirement and the
Writing Desk/Ink Mixer/Book Binder processes are explained by Rivencraft's
optional JEI integration. No recipe or advancement requires JEI, Create, or
Immersive Portals to be installed.
Manual Survival check: collect a Page and Linking Book; use the Ink Mixer to
take a Link Panel; copy a Page at the Writing Desk; bind a Descriptive Book;
enter its Age; activate a Crystal Portal. Confirm each advancement appears
only after the completed action, not from an output preview or GUI opening.
Repeat the actions with two players to confirm only the actor receives each
award. Restart an existing save and confirm completed progress remains, then
complete one previously unearned milestone. With JEI absent, the vanilla
recipe book should still reveal standard crafting recipes as their ingredients
are discovered; with JEI installed, the special writing guides should appear.
The automated Book Binder output-award scenario stalls in the GameTest storage
runner, so it is intentionally omitted under the project test policy. For its
manual check, open a ready Binder, observe that merely previewing the finished
book does not award *A Book of Ages*, then take the book and confirm the award.
Repeat by shift-clicking the result in a fresh Binder.
+53
View File
@@ -0,0 +1,53 @@
# Milestone 7 compatibility review (#82)
Reviewed 2026-10-19 for Minecraft 1.21.1. The project now compiles against
NeoForge 21.1.264 and advertises that as its minimum. The official
[NeoForge Maven metadata](https://maven.neoforged.net/releases/net/neoforged/neoforge/maven-metadata.xml)
lists 21.1.264 as the newest 21.1 release. Its
[changelog](https://maven.neoforged.net/releases/net/neoforged/neoforge/21.1.264/neoforge-21.1.264-changelog.txt)
includes received split-packet size checks (21.1.260), network setup payload
direction/decoding limits (21.1.261), ad-hoc channel identifier limits
(21.1.262), and an initial attachment-sync fix (21.1.264). Those are concrete
reasons to evaluate an upgrade, but do not by themselves prove Rivencraft and
its optional integrations work on that loader.
**Decision: adopt 21.1.264 beginning with 0.6.6.2.** An override build
succeeded, but its GameTest server repeated its storage-progress display
without producing test results. That run was stopped; it is neither a pass nor
evidence of a NeoForge defect. The player subsequently passed an in-game
singleplayer test on 21.1.264 with the optional stack, then passed a dedicated
server test including Immersive Portals travel to a Rivencraft Age. The
dedicated server also reached the ready state with only the required mods
before the full optional stack was installed. Both modes used Rivencraft
0.6.6.1. The earlier 21.1.251 baseline passed 70 required GameTests for
release V0.6.6.0.
| Dependency | Project baseline | Newest checked 1.21.1 release | Follow-up |
| --- | --- | --- | --- |
| Dynamic Dimensions AR Edition (required) | 0.9.1 | 0.9.1 | No newer release found on [CurseForge](https://www.curseforge.com/minecraft/mc-mods/dynamicdimension-ar-edition/files/all). |
| Bad Packets (required) | neo-0.8.2 | neo-0.8.2 | No newer matching [Modrinth](https://modrinth.com/mod/badpackets/versions) release found. |
| JEI (optional) | 19.57.0.449 at #82 review | 19.69.0.457 beta | Updated in #86 after client and dedicated GameTest passes; see [JEI review](MILESTONE_7_JEI_REVIEW.md). |
| Create (optional) | 6.0.10 | 6.0.10 | No newer matching [Modrinth](https://modrinth.com/mod/create/versions) release found. Its jar bundles Ponder 1.0.82. |
| Ponder (bundled with Create) | 1.0.82 | 1.0.87 library artifact | [Maven](https://maven.createmod.net/net/createmod/ponder/ponder-neoforge/maven-metadata.xml) has a newer artifact, but Create 6.0.10 still bundles 1.0.82. Do not treat this as a separately installed Create update. |
| Immersive Portals (optional) | 6.0.7 | 6.0.7 | No newer matching [Modrinth](https://modrinth.com/mod/immersive-portals-neoforge/versions) release found. |
| TerraBlender (optional) | 4.1.0.8 | 4.1.0.8 | No newer matching [Modrinth](https://modrinth.com/mod/terrablender/versions) release found. |
| Serene Seasons (optional) | 10.1.0.8 at #82 review | 10.1.0.9 | Updated in #88 after the player's full seasonal matrix passed; see [Serene review](MILESTONE_7_SERENE_REVIEW.md). |
| GlitchCore (Serene dependency) | 2.1.0.2 | 2.1.0.2 | No newer matching [Modrinth](https://modrinth.com/mod/glitchcore/versions) release found. |
| Biomes O' Plenty (TerraBlender test addon) | 21.1.0.14 in user's Prism instance | 21.1.0.14 | No newer matching [Modrinth](https://modrinth.com/mod/biomes-o-plenty/versions) release found. |
The Modrinth version comparisons above were filtered to **NeoForge and
Minecraft 1.21.1** on 2026-10-19. Create's bundled Ponder version was read
from `META-INF/jarjar/metadata.json` in `create-1.21.1-6.0.10.jar`; the
separate library-artifact comparison came from Create's Maven. Dynamic
Dimensions was checked on CurseForge. Versions for other Minecraft lines and
similarly named mods were excluded.
The full dedicated test stack contained Create/Ponder, Immersive Portals, JEI,
TerraBlender with Biomes O' Plenty, and Serene Seasons with GlitchCore. The
server loaded a new `rivencraft:age/test`, and its shutdown log confirms that
all Overworld, Nether, End, and Age chunks were saved. The player explicitly
approved 21.1.264 after that test. This does not independently certify every
optional combination, the LEGACY preview fallback on a client without Create
and Immersive Portals, or a full restart/rejoin cycle; keep those in the
regression checklist. Serene's GameTest mock-player network limitation still
requires real-client checks for seasonal behavior.
+41
View File
@@ -0,0 +1,41 @@
# JEI compatibility review (#86)
Reviewed 2026-10-20 for Minecraft 1.21.1 and NeoForge 21.1.264. Rivencraft
now targets JEI 19.69.0.457 after the client's in-game acceptance check. JEI
remains a `compileOnly` API and an opt-in
`localRuntime` dependency for development; the published mod has no required
JEI dependency.
The [official 1.21.1 NeoForge files](https://www.curseforge.com/minecraft/mc-mods/jei/files/all?page=1&pageSize=20&version=1.21.1)
list 19.69.0.457 (beta, 2026-10-20) after 19.64.0.455 (release, 2026-10-16).
The [19.69.0.457 Modrinth changelog](https://modrinth.com/mod/jei/versions?g=1.21.1&l=neoforge)
has a published-jar bytecode compatibility check. Its preceding 19.69.0.456
build changes ingredient search to Lucene and adds a runtime ingredient-search
refresh API. This makes page search a required client check, even though the
current Rivencraft plugin still compiles against the 457 API. The new Maven
runtime artifact is much larger (about 7 MB versus 2.3 MB for 455); a successful
compile alone is not evidence that its runtime plugin works.
Checks performed before changing the pinned dependency:
| Configuration | Result |
| --- | --- |
| `./gradlew -Pjei_version=19.69.0.457 -PwithJei=true build` | Passed; existing JEI API uses compile with four deprecation warnings and no errors. |
| `./gradlew -Pjei_version=19.69.0.457 -PwithJei=true runGameTestServer` | Passed; dedicated GameTest server loaded JEI 19.69.0.457 and all 74 required tests passed. |
| `./gradlew -Pjei_version=19.69.0.457 runGameTestServer` | Passed without JEI; all 74 required tests passed. |
| Prism client with JEI 19.69.0.457 and Rivencraft 0.6.6.6 | Client joined an integrated world; JEI registered Rivencraft extra ingredients and started without a JEI-plugin exception. The player reported an in-game pass for guide display, page search, and recipe visibility. |
On first 457 launch, JEI migrated its old `lowMemorySlowSearchEnabled` config
key and saved a backup of the original `jei-client.ini`; that warning was
handled by JEI and did not block startup. No Rivencraft config was changed.
The in-game acceptance report covers the visible JEI integration. A dedicated
GameTest server proves no server-side startup failure but does not exercise the
JEI GUI; keep page search, recipes, blank-Page hiding, and the Ink Mixer,
Writing Desk, and Book Binder guides in future upgrade checks. JEI is not
bundled into or required by the published Rivencraft jar.
The final pinned `0.6.6.7` build passed. A repeat GameTest run from the pinned
configuration stalled during test-world preparation before running any cases;
it was stopped. The two successful pre-pin runs above used the same JEI version
and code, with the dependency supplied by a Gradle property override.
+79
View File
@@ -0,0 +1,79 @@
# Milestone 7 regression and migration matrix (issue #83)
This is the dated regression record for the 0.6.11.0 candidate. The
[Milestone 7 acceptance](MILESTONE_7_ACCEPTANCE.md) owns the final sign-off. A passing
GameTest is server-side evidence; it is not proof of client rendering,
multiplayer timing, or every optional-mod combination.
## Automated evidence
| Area | Focused check | Candidate result |
| --- | --- | --- |
| Dedicated server, core linking, book/Age identity, old writing and workstation formats | `./gradlew --offline runGameTestServer`; includes `CoreGameTests`, `AgePersistenceGameTests`, `CrystalPortalGameTests`, M7 crafting/advancement checks | 91/91 required GameTests passed on NeoForge 21.1.264; clean shutdown and fresh-world removal. |
| Deterministic structures and terrain | `./gradlew --offline runGameTestServer -ParchivedGameTestSuites=generation`; includes library template/spacing/loot/stand checks, cave profiles, vanilla structures, crystal formations, fissures | 129/129 passed after correcting one village test to assert its own contribution rather than a seed-dependent total; fresh-world removal. |
| Sky, glyph numbers, seasons, creative/JEI page feed | `./gradlew --offline runGameTestServer -ParchivedGameTestSuites=environment` | 103/103 passed on the 0.6.11.0 candidate, including issue #94's number-page check; fresh-world removal. |
| Packaged models and data | `Milestone7ResourceGameTests.coreModelsResolveBundledTextures` in the core suite; parses critical block models, checks their Rivencraft texture references and the library NBT resource | Passed in the 91-test core run. This checks resource presence, not visual orientation or transparency. |
| Recipe behavior | `Milestone7CraftingGameTests` and `LinkingBookRecipeGameTests` through the loaded Recipe Manager | Passed in the core run; confirms crystal and receptacle quantities, ink bucket return, no Blank Page crafting, and Linking Book ingredients. |
| Portal state/save-load | `CrystalPortalGameTests` plus `AgePersistenceGameTests` in the core suite | Passed; covers activation/release, fallback orientation, horizontal/underside placement, uninterrupted surface, cooldown, retired Age and seed/plan identity. Full server restart remains manual. |
The generation archive initially failed
`AgeStructureGameTests.mixedEndAndTaigaVillagesChargeForEndPortion` because it
compared the total instability score (1200) with the village-only expectation
(200). A seed-completed sky legitimately supplied an extra sun (+1000). The
production scoring was unchanged; the check now isolates the
`forced_biome_villages` contribution. The rerun passed 129/129. This is a
repaired assertion, not a hidden feature failure.
Every default GameTest run creates a new world with Minecraft's fixed seed 0
and deletes it after pass or fail. See [GameTest guidance](GAMETESTS.md).
Do not retry a storage-stalled GameTest: stop it, remove that automated
scenario, and give its exact steps to the player. No run in this issue has
stalled so far. The older full-archive storage stall is historical and is not
counted as a current pass. On the subsequent **1.0.0.0 release candidate**,
the environment archive stalled during its first 50-test batch and was
stopped. The 103/103 result above applies to 0.6.11.0 only, not to 1.0.0.0
or the later 1.0.0.1–1.0.0.2 candidates. For the 1.0.0.2 manual handoff, create an Age
with Number Pages immediately before Celestial Angle, Phase, and Size pages;
confirm each affects the intended body rather than becoming a stray page. Also verify a
fixed-season Age remains fixed across a restart while the Overworld remains
independent. Do not rerun the stalled suite merely to obtain a green count.
## Old-save boundary (#60)
Issue #60 established a policy of preserving old saves where practical. Tests
cover bare-list `OrderedWriting`, page-free books, unknown symbol IDs, older
Age definitions with stable defaults, plan-v3/plan-v4 interpretation, and
workstation inventory migration. A bound book's UUID and its Age's registered
dimension remain stable through ordinary load. This does **not** imply every
pre-public-release world, removed biome mod, missing dimension provider, or
changed datapack can be opened. Back up the full world; the Age registry and
dimension folders are a unit. The creative Link Modifier can intentionally
retire an Age, archiving its data and marking the UUID dead. That is an explicit
administrative boundary, not a silent migration.
## Manual matrix for the player
Use a backup or disposable save. Record the exact mod list and jar version.
These checks are **pending for 0.6.11.0** unless a later note records an actual
pass. Historical passes on earlier slices should not be silently promoted to
this candidate.
| Scenario | What to verify |
| --- | --- |
| Full restart | Create a random and an authored Age, a library with a looted chest/page stand, an active portal, and a bound book. Stop and restart the server; UUID, terrain, loot removal, stand contents, portal activation, and return travel must persist. |
| Two players | Cross the same portal at nearly the same time, return independently, and use separate book previews. Cooldowns, destination positions, dropped-book ownership/retrieval, and preview chunk loaders must not interfere. |
| Cross-dimension travel | Compare the same Descriptive Book by hand, stand, and portal. Check footing/platform rules, arrival coordinates and facing, Disarm, Maintain Momentum, Intra Linking, and Return Link mode. |
| Client visuals/audio | Compare book spreads, glyphs, D'ni numbers, page/desk/binder/mixer models, 16×16 crystal buds and translucent elements, portal frame/surface order, skies/eclipses, page turns, and Legacy link sounds. A server test cannot observe pixels or audio. |
| Optional renderers | With neither Create nor Immersive Portals, confirm Legacy fallback. With Create alone, confirm Ponder snapshots and portal guide. With Immersive Portals, confirm live view, Explore exit, sky/sound isolation, portal travel, and fallback while chunks load. With both, `AUTO` should choose Immersive Portals. |
| Optional world/recipe mods | Test JEI guides/search, TerraBlender with a biome-producing addon (for example Biomes O' Plenty), Serene's six season modes plus Overworld independence/restart, and Ruins template selection/spawn weighting. Repeat startup without optional mods. |
| Migration | Copy a backed-up older development world. Verify books and Notebooks retain their Age/page IDs, a desk and stand keep contents, old Ages load or provide a clear error, and removing a custom symbol retains its unresolved ID. Do not test by modifying the only copy. |
| Binder diagnostics | As a non-OP, verify the Binder still creates books but shows no instability/seeded/status messages. As an OP, run `/rivencraft binder messages enable`, reopen the Binder, and verify those messages appear only for the OP. Disable them and restart the world; the setting should remain disabled. |
Historical evidence: the player approved NeoForge 21.1.264 on singleplayer
and a dedicated server with Immersive Portals; JEI 19.69.0.457 guides, Serene
Seasons 10.1.0.9's full per-Age matrix, Ruins generation, and issue #94's
numbered celestials each received an in-game pass on their respective earlier
release slices. See [compatibility review](MILESTONE_7_COMPATIBILITY_REVIEW.md),
[JEI review](MILESTONE_7_JEI_REVIEW.md), [Serene review](MILESTONE_7_SERENE_REVIEW.md),
and [Ruins notes](RUINS_COMPATIBILITY.md). The current candidate's broad
multiplayer/restart/optional-mod matrix remains unverified until tested.
+31
View File
@@ -0,0 +1,31 @@
# Serene Seasons 10.1.0.9 compatibility review (#88)
Reviewed 2026-10-20 for Minecraft 1.21.1 and NeoForge 21.1.264. Rivencraft
now compiles against [Serene Seasons 10.1.0.9](https://modrinth.com/mod/serene-seasons/version/pHEgQQUE)
with [GlitchCore 2.1.0.2](https://modrinth.com/mod/glitchcore/version/S2TfWrZR).
Both remain optional. The Serene update fixes a precipitation-mixin recursion;
it does not introduce a new dynamic-dimension API.
The 10.1.0.8 and 10.1.0.9 bytecode for Rivencraft's version-sensitive
`SeasonsConfig`, `SeasonHandler`, `SeasonSavedData`, and `SeasonTime` integration
classes is identical. In particular, the dimension whitelist field, per-level
saved season clock, and season update method have unchanged signatures and
implementations. The adapter still writes the whitelist through GlitchCore's
config API and sends Rivencraft's whitelist update to already connected clients.
Verification:
| Check | Result |
| --- | --- |
| Build against 10.1.0.9 and GlitchCore 2.1.0.2 | Passed. |
| Real Prism client with Serene 10.1.0.9, GlitchCore 2.1.0.2, and Rivencraft 0.6.6.7 | Both mods loaded and the player joined an Age. |
| No Seasons, normal Seasons, and all four Eternal modes in new and saved Ages | Player reported the full in-game matrix passed. |
| Reconnect, restart, and Overworld independence | Player reported the full in-game matrix passed. |
| Isolated dedicated-server startup without Serene/GlitchCore | Reached `Done` on port 25568 with only required runtime mods, then saved and stopped. |
| Isolated dedicated-server startup with Serene/GlitchCore | Reached `Done` on port 25569 with 10.1.0.9/2.1.0.2, then saved and stopped. |
Serene's sync packet is incompatible with GameTest mock players, so its
in-game behavior must be checked with a real client and server. The seasonal
test path in [SERENE_SEASONS_COMPATIBILITY.md](SERENE_SEASONS_COMPATIBILITY.md)
remains the regression checklist for future upgrades. Rivencraft does not
bundle or require Serene Seasons or GlitchCore.
+63
View File
@@ -0,0 +1,63 @@
# Milestone 7 visual and audio polish (#80)
The source is the local Mystcraft 0.13.7.06 extraction under
`/home/dnorberg/Documents/mystcraft-src/mystcraft-1.12.2-0.13.7.06/`.
Reused textures and OGG files are recorded in [asset provenance](ASSET_PROVENANCE.md).
The `dev images/book binder.png` and `dev images/ink mixer.png` screenshots
are the Legacy model references used for this slice.
## Legacy comparison and modern boundary
- The Crystal Block, Book Receptacle, and 16×512 portal animation already use
Legacy sprites. The Receptacle's 16×16×6 model already matches the Legacy
slab. The fallback portal now uses Legacy's four-pixel-deep, double-faced
`linkportal_ns.json` geometry, with the original animation; it declares a
translucent render layer and portal particle texture. The block remains
non-occluding. When Immersive Portals supplies a live view, the fallback
model is hidden, while the crystal frame is drawn over the view.
- The Age arrival platform now reuses the same Legacy crystal tile as Crystal
Block. It is an opaque, occluding full block, while retaining its empty loot
table and unobtainable pick-block behavior. It has glass-like 0.3 hardness.
The old cloud sprite is unused and removed.
- The Book Binder now includes the two inner braces and central press/book
piece omitted by the earlier model, using the existing byte-identical
Legacy textures. The Ink Mixer uses Legacy's `inkwell_model.json` geometry
and four original inkwell textures. A thin white paper surface replaces the
black paper appearance from the reference; the old simplified mixer tiles
are no longer used. The half-alpha glass atlas is intentionally rendered on
a cutout layer; its more opaque look passed the player's in-game check.
- Legacy's link listener selects Disarm before a custom portal sound, then
Following, Intra Linking, and ordinary Link. Rivencraft has no Following
modifier yet, so it selects Disarm, portal, Intra Linking, or ordinary Link
in that order. The Disarm and Intra OGGs are byte-identical Legacy copies.
- Legacy sends 50 small neutral link particles in roughly a one-by-two-block
region at both departure and arrival. Its fixed-function particle class is
not portable to 1.21.1. Rivencraft uses a one-shot burst of 50 vanilla Cloud
particles at both ends, emitted only after successful server-authoritative
travel. There is no continuous portal-particle loop in the inspected Legacy
`BlockLinkPortal` class, so the portal surface itself adds none.
- The Legacy `textures/entity/linkbook.png` and `linking/pop.ogg` are inspected
but not copied in this slice. The custom dropped Linkbook entity is part of
#85; adding its assets before the entity exists would leave unused resources.
Library walls, shelves, chest, and webs use vanilla blocks in the template,
so there are no separate library art files to port.
## Manual visual/audio check
Use the same bound book in a held use and a Crystal Portal. Confirm the link
particles and audio play at both ends, and the portal landing matches the book.
Repeat with Disarm and Intra Linking panels to check the distinct sounds.
Compare the fallback portal, crystal frame, and Receptacle with Immersive
Portals absent; verify the animated surface is visible from both sides and
does not expose caves or other geometry through solid blocks. With Immersive
Portals installed, confirm the live view replaces only the fallback surface,
the frame draws in front, and no fallback texture covers the live view.
Create/Ponder is optional and must not affect either rendering path.
Check a freshly generated arrival platform from above and below: the crystal
tile should be opaque, break about as quickly as glass, and drop no block item.
Compare the Book Binder press and Ink Mixer cup/glass against the `dev images`
references; the mixer paper should appear white, and neither block should
show missing-texture checkerboards or see-through-world artifacts.
The player reported that the in-game visual and audio checks pass on 2026-10-19,
including acceptance of the cutout glass appearance and current block sounds.
+15 -10
View File
@@ -1,5 +1,9 @@
# Porting roadmap
For a concise current status, start with [current implementation](CURRENT_IMPLEMENTATION.md)
and [milestone summaries](MILESTONES.md). This file retains the original
roadmap and architectural rationale.
Rivencraft ports Mystcraft Legacy from Minecraft 1.12.2 to NeoForge 1.21.1.
The world-generation, dimension, registry, networking, and rendering APIs have
changed substantially, so the work is divided into independently testable
@@ -25,13 +29,13 @@ must not silently change existing saved Ages.
Gitea is the source of truth for project status:
- [Issues](https://gitea.tail180fb1.ts.net/dnorberg/rivencraft/issues) contain
- [Issues](https://truenas-scale.tail180fb1.ts.net:8443/dnorberg/rivencraft/issues) contain
scoped implementation tasks, bugs, acceptance criteria, and technical
discussion.
- [Milestones](https://gitea.tail180fb1.ts.net/dnorberg/rivencraft/milestones)
- [Milestones](https://truenas-scale.tail180fb1.ts.net:8443/dnorberg/rivencraft/milestones)
group issues into the porting phases below and show their live completion
state.
- [Releases](https://gitea.tail180fb1.ts.net/dnorberg/rivencraft/releases)
- [Releases](https://truenas-scale.tail180fb1.ts.net:8443/dnorberg/rivencraft/releases)
contain user-facing changelogs for shipped versions.
New work should have an issue before implementation begins. Commits should
@@ -48,22 +52,23 @@ acceptance issue and all required implementation issues are complete.
3. **Ages** — persistent generated dimensions, deterministic traits,
lifecycle management, data-pack integration, and optional destination
renderer compatibility. **Complete.** See
[Milestone 3](https://gitea.tail180fb1.ts.net/dnorberg/rivencraft/milestone/8).
[Milestone 3](https://truenas-scale.tail180fb1.ts.net:8443/dnorberg/rivencraft/milestone/8).
4. **Writing system** — pages, notebooks, desks, book assembly, and the baseline
Ink Mixer for Link Panels. Symbol effects were deferred to Milestone 5.
**Complete.** See [Milestone 4](https://gitea.tail180fb1.ts.net/dnorberg/rivencraft/milestone/9)
**Complete.** See [Milestone 4](https://truenas-scale.tail180fb1.ts.net:8443/dnorberg/rivencraft/milestone/9)
and [writing-system data and migration](WRITING_DATA.md).
5. **Age grammar** — translate supported symbol combinations into modern biome,
noise, dimension-type, and world-generation configuration, with optional
TerraBlender and Serene Seasons integration. **Complete for the supported
subset.** See the [acceptance record](MILESTONE_5_ACCEPTANCE.md) and
[Legacy grammar audit](LEGACY_AGE_GRAMMAR_AUDIT.md).
6. **Instability** — deterministic validation and server-safe effects. **In
progress.** Start with the
[Legacy instability audit](LEGACY_INSTABILITY_AUDIT.md), which separates
source behavior from proposed 1.21.1 safety limits.
6. **Instability** — deterministic validation and server-safe effects.
**Complete.** See the [Legacy instability audit](LEGACY_INSTABILITY_AUDIT.md)
and [Milestone 6 acceptance](MILESTONE_6_ACCEPTANCE.md).
7. **Structures and polish** — libraries, crystals, portals, recipes, models,
sounds, advancements, compatibility, and migration tests.
sounds, advancements, compatibility, and migration tests. **In progress.**
See the [Milestone 7 regression matrix](MILESTONE_7_REGRESSION.md) and
[Legacy audit](LEGACY_M7_AUDIT.md).
## Architectural direction
+6 -3
View File
@@ -45,7 +45,7 @@ being captured in the preview.
## Supported combinations and upstream limits
The compatibility baseline is Minecraft 1.21.1, NeoForge 21.1.251, Create
The compatibility baseline is Minecraft 1.21.1, NeoForge 21.1.264, Create
6.0.10, and Immersive Portals 6.0.7. Core Age generation and the `LEGACY`
backend run without Create or Immersive Portals; the headless GameTest server
uses that dependency-free path.
@@ -66,8 +66,11 @@ unstable in a particular graphics or mod configuration.
For preview-related releases:
1. Run `./gradlew runGameTestServer -PwithArchivedGameTests=true` to verify the complete selection matrix,
core Age creation, persistence, and travel without optional renderers.
1. Run `./gradlew runGameTestServer` for the core selection matrix, Age
creation, persistence, and travel without optional renderers. Add the
relevant archives from [GameTest guidance](GAMETESTS.md); if a scenario
stalls, stop it and hand that exact check to a real client rather than
treating the interrupted run as a pass.
2. Open held Linking and Descriptive Books once with each available backend.
3. Open both book types from a Book Stand and confirm Explore is disabled.
4. With Immersive Portals, enter and leave Explore, travel between dimensions,
+21
View File
@@ -0,0 +1,21 @@
# Documentation map
Start with the player-facing [project README](../README.md). The two maintained
technical entry points are [current implementation](CURRENT_IMPLEMENTATION.md)
and [milestone summaries](MILESTONES.md). Use [GameTest guidance](GAMETESTS.md)
to run checks. The files below retain detailed design, provenance, and
version-specific test evidence; an older milestone record may describe a
former behavior or loader version.
| Milestone | Detailed records |
| --- | --- |
| M1–M3 | [Porting roadmap](PORTING.md), [Age administration](AGES.md), [Age profiles](AGE_PROFILES.md), [preview compatibility](PREVIEW_COMPATIBILITY.md), [random Age weights](RANDOM_AGE_WEIGHTS.md) |
| M4 | [Writing data](WRITING_DATA.md), [book presentation](DESCRIPTIVE_BOOK_PRESENTATION.md), [Ink Mixer audit](INK_MIXER_MODIFIER_AUDIT.md) |
| M5 | [Acceptance](MILESTONE_5_ACCEPTANCE.md), [Legacy grammar audit](LEGACY_AGE_GRAMMAR_AUDIT.md), [writing grammar](WRITING_GRAMMAR.md), [symbol semantics](SYMBOL_SEMANTICS.md), [TerraBlender](TERRABLENDER_COMPATIBILITY.md), [Serene Seasons](SERENE_SEASONS_COMPATIBILITY.md) |
| M6 | [Acceptance](MILESTONE_6_ACCEPTANCE.md), [regression](MILESTONE_6_REGRESSION.md), [Legacy audit](LEGACY_INSTABILITY_AUDIT.md), [score](INSTABILITY_SCORE.md), [live blocks](LIVE_BLOCK_INSTABILITY.md), [runtime](INSTABILITY_RUNTIME.md), [diagnostics](INSTABILITY_DIAGNOSTICS.md), [status effects](INSTABILITY_STATUS_EFFECTS.md), [decay](INSTABILITY_DECAY.md), [environmental hazards](INSTABILITY_ENVIRONMENTAL.md), [cloud platform](AGE_CLOUD_PLATFORM.md) |
| M7 | [Acceptance](MILESTONE_7_ACCEPTANCE.md), [regression and manual matrix](MILESTONE_7_REGRESSION.md), [Legacy audit](LEGACY_M7_AUDIT.md), [visual/audio](MILESTONE_7_VISUAL_AUDIT.md), [advancements](MILESTONE_7_ADVANCEMENTS.md), [JEI](MILESTONE_7_JEI_REVIEW.md), [Serene review](MILESTONE_7_SERENE_REVIEW.md), [compatibility](MILESTONE_7_COMPATIBILITY_REVIEW.md), [Ruins](RUINS_COMPATIBILITY.md) |
[Asset provenance](ASSET_PROVENANCE.md) applies across milestones. Detailed
audits are intentionally retained for source attribution and migration
history; these three entry points replace the former practice of treating
every dated task note as a current installation guide.
+66
View File
@@ -0,0 +1,66 @@
# Optional Ruins template pages (issue #91)
Rivencraft supports Ruins 1.21.1.2NF as an optional mod. When it is installed,
every `.tml` template in Ruins' active `config/ruins_config/<generic-or-biome>/`
folders receives a separate Ruins page in Rivencraft's creative and JEI page
feeds. New templates added to Ruins' config appear after a restart; removing a
template makes its page unavailable to new books. With Ruins absent, no Ruins
pages or structure integration are active.
An authored Age with Ruins pages is admitted through Ruins' dimension gate.
Rivencraft also admits the authored templates through their individual
`dimensionsToSpawnIn` gates, which usually list only `overworld` and would
otherwise prevent them from loading in an Age. Ruins still owns chunk
inspection, spawn chance, surface validation, biome pools, and spacing.
Rivencraft filters Ruins' weighted
template choice to the exact pages in that Age and vetoes an unauthorized
template in Ruins' pre-spawn event. A page therefore selects *which* template
may appear; it does not guarantee a structure in every chunk. Manual
`/testruin` placements are unaffected.
Repeating a template page multiplies that template's Ruins selection weight by
its page count and adds one spawn attempt per chunk for each duplicate page.
The extra attempts are capped at 32 per chunk (or Ruins' configured count if
higher). Distinct template pages do not add attempts, and Ruins' spacing and
surface checks still apply. As with Rivencraft's standard
structure pages, the first three copies of each template are instability-free;
each additional copy adds 100 instability. Ruins retains its own biome and
surface checks, so the standard structure forced-biome penalty does not apply.
Ruins' event identifies a template only by its filename. If two active folders
contain the same `.tml` basename, Rivencraft cannot distinguish them and
disables all Ruins pages for that configuration. Give each template a unique
filename to restore support. Ruins must also be able to parse the template and
find a suitable surface in the selected biome; a page cannot repair an invalid
or biome-incompatible template.
The adapter and dimension/selection mixin are version-sensitive to Ruins
1.21.1.2NF. The published Rivencraft jar does not include Ruins. To include it
in a development run, use `-PwithRuins=true`.
## Manual check
1. Start a client with Ruins 1.21.1.2NF and Rivencraft 0.6.9.3. Confirm the
Ruins Pages tab contains one page per configured `.tml` file, and search a
distinctive template name in JEI.
2. Bind a new Descriptive Book with a Link Panel, Standard Terrain, a suitable
surface biome, and one Ruins page (for example ZombieHut). Enter the Age and
explore *unvisited* chunks. Ruins marks inspected chunks and will not retry
chunks explored under the earlier broken build. Only the selected Ruins
template should appear. Ruins'
own chance and distance settings still determine how far exploration takes.
3. For duplicate weighting, bind an Age with one copy of one template page and
three copies of a second template page valid in the same biome. Across enough
new candidate chunks, the second should be selected more often relative to
the first, and there should be two additional spawn attempts per inspected
chunk. Four copies of one template should add 100 instability, visible
through the OP Age instability diagnostic, while three copies add none.
4. Make another Age without a Ruins page and confirm Ruins structures do not
appear there. Restart the game and confirm the authored Age keeps its page
selection. Then remove Ruins and confirm Rivencraft starts normally without
a Ruins tab.
The Ruins-enabled GameTest server passed all 90 required tests and loaded the
template-dimension and attempt mixins. Its test world was removed afterward.
Use the client check above to verify actual Ruins generation and the increased
attempt rate.
+5 -4
View File
@@ -20,7 +20,7 @@ Milestone 5 issue #29 adds typed meaning to the existing data-pack symbol catalo
`poem` is optional, client-safe artwork metadata: exactly four alphabetic words, ordered top, right, bottom, left. The client layers their glyphs from the shared Legacy component sheet at runtime. GUI thumbnails use the full transparent artwork over their page backgrounds; item icons use the same artwork reduced from 16 to 13 pixels across, over the page texture. Unregistered words use a stable generated component combination; when a symbol has no poem, the six original built-in IDs retain their Legacy poems and other IDs produce four stable fallback words. This affects appearance only, never Age generation. Generated images are cached up to 256 entries and discarded on resource reload.
The Writing Desk's 88 collection tabs use Legacy's number components, chiefly the bottom row of `symbolcomponents.png`, rather than word sigils. Legacy's `ModWords.constructNumber` combines four unit marks (1–4) with four five-step marks (5–20) to form 1–24 and uses a separate zero mark. Rivencraft extends these marks positionally in base 25 for tabs 25–88 (for example, 25 is 1 followed by 0). Hovering still reveals the decimal number for accessibility. The former arbitrary-word glyph generator remains useful for rendering text: on page-free Descriptive Books, the generated Age description now appears as a sequence of layered word glyphs instead of Minecraft's enchantment font. The Age name stays readable.
The Writing Desk retains 88 collection tabs, numbered from zero as in Legacy. Legacy's `ModWords.constructNumber` defines 0 as component 1 and 1–24 by overlaying a unit mark (1–4) and a five-step mark (5–20) from the bottom row of `symbolcomponents.png` in the *same square*. Legacy's Writing Desk has 25 tabs (0–24) and scrolls its four-tab window **one tab at a time**. Thus the supplied Legacy screenshots labeled 1–4, 5–8, and so on show overlapping windows, not 88 distinct numerals. Rivencraft retains its previously requested four-at-a-time navigation and 88 tabs. Its additional tab numbers use positional base 25: each place is an overlaid Legacy digit, with the places side by side (25 = 1,0). The two glyphs are sized and positioned to fit the tab. Hovering reveals the decimal tab index for accessibility. The generated-word mechanism renders page-free Descriptive Book text as layered glyphs instead of Minecraft's enchantment font. The Age name stays readable.
| Role | Value type and allowed values |
| --- | --- |
@@ -32,9 +32,10 @@ The Writing Desk's 88 collection tabs use Legacy's number components, chiefly th
| `weather` | `normal`, `fast`, `slow`, `off`, `always`, `cloudy`, `rain`, `snow`, or `storm`. |
| `season` | `no_seasons`, `seasons`, `eternal_winter`, `eternal_summer`, `eternal_fall`, or `eternal_spring`. Seasonal effects other than No Seasons require optional Serene Seasons. |
| `celestial` | `normal_time` (the first representable single-cycle behavior). |
| `period_modifier` | JSON number in `[0, 2]`; zero is stopped time. |
| `angle_modifier` | JSON number in `[0, 360)` degrees. |
| `phase_modifier` | JSON number in `[0, 360)` degrees; the compiler will convert to turns. |
| `period_modifier` | JSON number in `[0, 2]`; zero is stopped time. An immediately preceding D'ni number page overrides it with digit × 0.08. |
| `angle_modifier` | JSON number in `[0, 360)` degrees. An immediately preceding D'ni number page overrides it with digit × 15°, wrapping 360° to 0°. |
| `phase_modifier` | JSON number in `[0, 360)` degrees; the compiler converts it to turns. An immediately preceding D'ni number page overrides it with digit × 15°, wrapping 360° to 0°. |
| `size_modifier` | JSON scale in `[0.25, 3]`. An immediately preceding D'ni number page overrides it with a linear 0.25×–3× scale: digit 0 is 0.25× and digit 24 is 3×. Without a number, Small/Normal/Large remain 0.5×/1×/2×. |
| `block` | Canonical namespaced material ID for a compatible following feature; registered full-collision blocks and source fluids receive generated Pages. |
| `feature` | Canonical namespaced feature-effect ID; the compiler must recognize and validate it. This includes supported decorations and structures. |
+4 -4
View File
@@ -18,11 +18,11 @@ minecraft_version=1.21.1
# as they do not follow standard versioning conventions.
minecraft_version_range=[1.21.1]
# The Neo version must agree with the Minecraft version to get a valid artifact
neo_version=21.1.251
neo_version=21.1.264
ponder_version=1.0.82
dynamic_dimensions_file_id=7707789
badpackets_version=0.8.2
jei_version=19.57.0.449
jei_version=19.69.0.457
# The loader version range can only use the major version of FML as bounds
loader_version_range=[1,)
@@ -36,10 +36,10 @@ mod_name=Rivencraft
# The license of the mod. Review your options at https://choosealicense.com/. All Rights Reserved is the default.
mod_license=LGPL-3.0-or-later
# The mod version. Rivencraft uses the x.y.z.b policy documented in README.md.
mod_version=0.5.8.7
mod_version=1.0.1.1
immersive_portals_version=6.0.7
terrablender_version=4.1.0.8
serene_seasons_version_id=B6nTjh4b
serene_seasons_version_id=pHEgQQUE
glitchcore_version_id=S2TfWrZR
# The group ID for the mod. It is only important when publishing as an artifact to a Maven repository.
# This should match the base package used for the mod sources.
+106
View File
@@ -0,0 +1,106 @@
#!/usr/bin/env python3
"""Rebuild the bundled 1.21.1 structure template from Mystcraft Legacy's layout.
Run manually; world generation never downloads anything. The pinned Legacy source
is LGPL-3.0 and its original block placement order is preserved here.
"""
import gzip
import hashlib
import re
import struct
import urllib.request
from pathlib import Path
SOURCE = ("https://raw.githubusercontent.com/Mystcraft/Mystcraft-Legacy/"
"9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/"
"com/xcompwiz/mystcraft/world/gen/structure/ComponentScatteredFeatureSmallLibrary.java")
SHA256 = "487b3bef48dacfbea35ac2020dbb5543dab0c2a9d99bae4a11acb5cc6fc8bfac"
OUTPUT = Path(__file__).resolve().parents[1] / "src/main/resources/data/rivencraft/structure/mystcraft_library.nbt"
LECTERNS = {(6, 2), (8, 4), (8, 5), (8, 6), (6, 8)}
BLOCKS = {
"AIR": "air", "BOOKSHELF": "bookshelf", "COBBLESTONE": "cobblestone",
"COBBLESTONE_WALL": "cobblestone_wall", "PLANKS": "oak_planks",
"STONE_STAIRS": "stone_stairs", "STONE_SLAB": "cobblestone_slab", "WEB": "cobweb",
}
PATTERN = re.compile(r"setBlockState\(worldObj, Blocks\.(\w+)\.(.+?), "
r"(\d+), (\d+), (\d+), boundingbox\);")
def nbt_string(value):
encoded = value.encode("utf-8")
return struct.pack(">H", len(encoded)) + encoded
def tag(kind, name, payload):
return bytes([kind]) + nbt_string(name) + payload
def compound(entries):
return b"".join(entries) + b"\0"
def list_tag(name, element_kind, elements):
return tag(9, name, bytes([element_kind]) + struct.pack(">i", len(elements)) + b"".join(elements))
def int_list(name, values):
return list_tag(name, 3, [struct.pack(">i", value) for value in values])
def main():
source = urllib.request.urlopen(SOURCE, timeout=15).read()
if hashlib.sha256(source).hexdigest() != SHA256:
raise ValueError("Pinned Legacy source changed")
placements = {}
matches = PATTERN.findall(source.decode("utf-8"))
if len(matches) != 694:
raise ValueError(f"Expected 694 Legacy block placements, got {len(matches)}")
for legacy_block, state, x, y, z in matches:
x, y, z = int(x), int(y), int(z)
if legacy_block not in BLOCKS or not (0 <= x <= 10 and 0 <= y <= 10 and 0 <= z <= 10):
raise ValueError(f"Unsupported Legacy block/position: {legacy_block} {(x, y, z)}")
properties = {}
facing = re.search(r"BlockStairs.FACING, EnumFacing.(\w+)", state)
if facing:
properties["facing"] = facing.group(1).lower()
if "BlockStairs.EnumHalf.TOP" in state:
properties["half"] = "top"
if legacy_block == "STONE_SLAB":
meta = re.search(r"getStateFromMeta\((\d+)\)", state)
if not meta or int(meta.group(1)) not in (3, 11):
raise ValueError(f"Unknown Legacy slab metadata: {state}")
properties["type"] = "top" if int(meta.group(1)) == 11 else "bottom"
placements[x, y, z] = ("minecraft:" + BLOCKS[legacy_block], tuple(sorted(properties.items())))
# Legacy's lower lectern is a bookshelf at y=1. Remove that and its
# two-block upper half; runtime places a one-block Rivencraft stand at y=1.
for x, z in LECTERNS:
placements.pop((x, 1, z), None)
placements.pop((x, 2, z), None)
# Chest and its inventory are assigned at runtime, never frozen in NBT.
placements.pop((4, 1, 2), None)
placements = {pos: state for pos, state in placements.items() if state[0] != "minecraft:air"}
palette = sorted(set(placements.values()))
indexes = {state: index for index, state in enumerate(palette)}
palette_tags = []
for name, properties in palette:
entries = [tag(8, "Name", nbt_string(name))]
if properties:
entries.append(tag(10, "Properties", compound(
[tag(8, key, nbt_string(value)) for key, value in properties])))
palette_tags.append(compound(entries))
block_tags = [compound([int_list("pos", (x, y, z)),
tag(3, "state", struct.pack(">i", indexes[state]))])
for (x, y, z), state in sorted(placements.items())]
root = compound([int_list("size", (11, 11, 11)), list_tag("palette", 10, palette_tags),
list_tag("blocks", 10, block_tags), list_tag("entities", 10, []),
tag(3, "DataVersion", struct.pack(">i", 3955))])
OUTPUT.parent.mkdir(parents=True, exist_ok=True)
OUTPUT.write_bytes(gzip.compress(tag(10, "", root), mtime=0))
print(f"Wrote {OUTPUT}: {len(placements)} blocks, {len(palette)} palette states")
if __name__ == "__main__":
main()
@@ -15,10 +15,12 @@ import net.dnorberg.rivencraft.event.BookStandConversionHandler;
import net.dnorberg.rivencraft.event.AgeCelestialAngleSync;
import net.dnorberg.rivencraft.event.AgeLifecycleEvents;
import net.dnorberg.rivencraft.command.RivencraftCommands;
import net.dnorberg.rivencraft.command.LibraryLocateService;
import net.dnorberg.rivencraft.network.ModNetworking;
import net.dnorberg.rivencraft.config.RivencraftConfig;
import net.dnorberg.rivencraft.config.RivencraftClientConfig;
import net.dnorberg.rivencraft.compat.SereneSeasonsCompatibility;
import net.dnorberg.rivencraft.compat.RuinsCompatibility;
import net.dnorberg.rivencraft.book.AgeDimensionService;
import net.dnorberg.rivencraft.book.AgeWeatherService;
import net.dnorberg.rivencraft.book.AgeInstabilityRuntime;
@@ -42,6 +44,7 @@ public final class Rivencraft {
public Rivencraft(IEventBus modEventBus, ModContainer modContainer) {
AgeDimensionService.register();
RuinsCompatibility.register();
AgeStatusEffectProviders.register();
AgeDecayProviders.register();
AgeHazardProviders.register();
@@ -53,6 +56,7 @@ public final class Rivencraft {
ModBiomeSources.register(modEventBus);
ModChunkGenerators.register(modEventBus);
ModBlocks.register(modEventBus);
net.dnorberg.rivencraft.registry.ModEntities.register(modEventBus);
ModBlockEntities.register(modEventBus);
ModItems.register(modEventBus);
ModMenus.register(modEventBus);
@@ -62,6 +66,9 @@ public final class Rivencraft {
NeoForge.EVENT_BUS.addListener(BookStandConversionHandler::onRightClickBlock);
NeoForge.EVENT_BUS.addListener(AgeWeatherService::onLevelTickPost);
NeoForge.EVENT_BUS.addListener(AgeInstabilityRuntime::onLevelTickPost);
NeoForge.EVENT_BUS.addListener(net.dnorberg.rivencraft.book.AgeBlockInstability::onChunkLoad);
NeoForge.EVENT_BUS.addListener(net.dnorberg.rivencraft.book.AgeBlockInstability::onServerTickPost);
NeoForge.EVENT_BUS.addListener(net.dnorberg.rivencraft.book.AgeBlockInstability::onServerStopping);
NeoForge.EVENT_BUS.addListener(AgeEnvironmentalProviders::onLevelTickPost);
NeoForge.EVENT_BUS.addListener(AgeEnvironmentalProviders::onLevelUnload);
NeoForge.EVENT_BUS.addListener(AgeStatusEffectProviders::onServerTickPost);
@@ -72,11 +79,16 @@ public final class Rivencraft {
NeoForge.EVENT_BUS.addListener(AgeCelestialAngleSync::onPlayerLoggedIn);
NeoForge.EVENT_BUS.addListener(AgeCelestialAngleSync::onPlayerChangedDimension);
NeoForge.EVENT_BUS.addListener(AgeLifecycleEvents::onPlayerLoggedOut);
NeoForge.EVENT_BUS.addListener(AgeLifecycleEvents::onServerTickPost);
NeoForge.EVENT_BUS.addListener(AgeLifecycleEvents::onServerStopping);
NeoForge.EVENT_BUS.addListener(AgeInstabilityRuntime::onServerStopping);
NeoForge.EVENT_BUS.addListener(AgeEnvironmentalProviders::onServerStopping);
NeoForge.EVENT_BUS.addListener(AgeStatusEffectProviders::onServerStopping);
NeoForge.EVENT_BUS.addListener((net.neoforged.neoforge.event.server.ServerStoppingEvent event) ->
RuinsCompatibility.onServerStopping());
NeoForge.EVENT_BUS.addListener(RivencraftCommands::register);
NeoForge.EVENT_BUS.addListener(LibraryLocateService::onServerTickPost);
NeoForge.EVENT_BUS.addListener(LibraryLocateService::onServerStopping);
NeoForge.EVENT_BUS.addListener(AgeRuntimeProfiles::register);
NeoForge.EVENT_BUS.addListener(SymbolCatalog::register);
LOGGER.info("Initializing Rivencraft");
@@ -0,0 +1,30 @@
package net.dnorberg.rivencraft.advancement;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.book.AgeRegistrySavedData;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.server.level.ServerPlayer;
/** Awards action-only progression after the server has committed the action. */
public final class ProgressionAdvancements {
public static final String LINK_PANEL = "link_panel";
public static final String COPY_PAGE = "copy_page";
public static final String BIND_AGE = "bind_age";
public static final String OPEN_PORTAL = "open_portal";
public static final String ENTER_AGE = "enter_age";
private ProgressionAdvancements() {}
public static void award(ServerPlayer player, String path) {
var advancement = player.getServer().getAdvancements().get(
ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "progression/" + path));
if (advancement != null) player.getAdvancements().award(advancement, "completed");
}
public static void awardAgeTravel(ServerPlayer player) {
if (AgeRegistrySavedData.get(player.serverLevel()).findByDimension(
player.serverLevel().dimension().location()).isPresent()) {
award(player, ENTER_AGE);
}
}
}
@@ -0,0 +1,170 @@
package net.dnorberg.rivencraft.block;
import net.dnorberg.rivencraft.advancement.ProgressionAdvancements;
import com.mojang.serialization.MapCodec;
import net.dnorberg.rivencraft.block.entity.BookReceptacleBlockEntity;
import net.dnorberg.rivencraft.portal.CrystalPortalNetwork;
import net.dnorberg.rivencraft.book.AgeDimensionService;
import net.dnorberg.rivencraft.book.LinkTarget;
import net.dnorberg.rivencraft.registry.ModBlocks;
import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.registry.ModItems;
import net.minecraft.core.BlockPos;
import net.minecraft.core.Direction;
import net.minecraft.network.chat.Component;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.server.level.ServerPlayer;
import net.minecraft.sounds.SoundEvents;
import net.minecraft.sounds.SoundSource;
import net.minecraft.world.InteractionHand;
import net.minecraft.world.InteractionResult;
import net.minecraft.world.ItemInteractionResult;
import net.minecraft.world.entity.item.ItemEntity;
import net.minecraft.world.entity.player.Player;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.context.BlockPlaceContext;
import net.minecraft.world.level.Level;
import net.minecraft.world.level.BlockGetter;
import net.minecraft.world.level.block.BaseEntityBlock;
import net.minecraft.world.level.block.Block;
import net.minecraft.world.level.block.RenderShape;
import net.minecraft.world.level.block.entity.BlockEntity;
import net.minecraft.world.level.block.entity.BlockEntityTicker;
import net.minecraft.world.level.block.entity.BlockEntityType;
import net.dnorberg.rivencraft.registry.ModBlockEntities;
import net.minecraft.world.level.block.state.BlockState;
import net.minecraft.world.level.block.state.StateDefinition;
import net.minecraft.world.level.block.state.properties.BlockStateProperties;
import net.minecraft.world.level.block.state.properties.DirectionProperty;
import net.minecraft.world.level.block.state.properties.BooleanProperty;
import net.minecraft.world.phys.BlockHitResult;
import net.minecraft.world.phys.shapes.CollisionContext;
import net.minecraft.world.phys.shapes.VoxelShape;
/** A book-holding crystal attachment, with server-authoritative frame activation. */
public final class BookReceptacleBlock extends BaseEntityBlock {
public static final MapCodec<BookReceptacleBlock> CODEC = simpleCodec(BookReceptacleBlock::new);
public static final DirectionProperty FACING = BlockStateProperties.FACING;
public static final BooleanProperty HAS_BOOK = BlockStateProperties.HAS_BOOK;
public BookReceptacleBlock(Properties properties) {
super(properties);
registerDefaultState(stateDefinition.any().setValue(FACING, Direction.NORTH).setValue(HAS_BOOK, false));
}
@Override protected MapCodec<? extends BaseEntityBlock> codec() { return CODEC; }
@Override protected RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override protected VoxelShape getShape(BlockState state, BlockGetter level, BlockPos pos,
CollisionContext context) {
return switch (state.getValue(FACING)) {
case NORTH -> Block.box(0, 0, 10, 16, 16, 16);
case SOUTH -> Block.box(0, 0, 0, 16, 16, 6);
case EAST -> Block.box(0, 0, 0, 6, 16, 16);
case WEST -> Block.box(10, 0, 0, 16, 16, 16);
case UP -> Block.box(0, 0, 0, 16, 6, 16);
case DOWN -> Block.box(0, 10, 0, 16, 16, 16);
};
}
@Override protected void createBlockStateDefinition(StateDefinition.Builder<Block, BlockState> builder) {
builder.add(FACING, HAS_BOOK);
}
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) {
return new BookReceptacleBlockEntity(pos, state);
}
@Override public <T extends BlockEntity> BlockEntityTicker<T> getTicker(Level level, BlockState state,
BlockEntityType<T> type) {
return level instanceof ServerLevel
? createTickerHelper(type, ModBlockEntities.BOOK_RECEPTACLE.get(), BookReceptacleBlockEntity::serverTick)
: null;
}
@Override public BlockState getStateForPlacement(BlockPlaceContext context) {
Direction face = context.getClickedFace();
if (!context.getLevel().getBlockState(
context.getClickedPos().relative(face.getOpposite())).is(ModBlocks.CRYSTAL_BLOCK.get())) return null;
return defaultBlockState().setValue(FACING, face);
}
@Override protected ItemInteractionResult useItemOn(ItemStack stack, BlockState state, Level level, BlockPos pos,
Player player, InteractionHand hand, BlockHitResult hit) {
if (!isBoundBook(stack)) return ItemInteractionResult.PASS_TO_DEFAULT_BLOCK_INTERACTION;
if (level.isClientSide) return ItemInteractionResult.SUCCESS;
if (!(level instanceof ServerLevel server) ||
!(level.getBlockEntity(pos) instanceof BookReceptacleBlockEntity holder)) return ItemInteractionResult.FAIL;
if (!holder.getBook().isEmpty()) return ItemInteractionResult.FAIL;
CrystalPortalNetwork.Plan plan = CrystalPortalNetwork.plan(server, pos);
if (!plan.valid()) {
player.displayClientMessage(Component.translatable("message.rivencraft.portal.invalid_frame"), true);
return ItemInteractionResult.FAIL;
}
LinkTarget destination = stack.is(ModItems.LINKING_BOOK.get())
? stack.get(ModDataComponents.LINK_TARGET.get())
: player instanceof ServerPlayer serverPlayer
? AgeDimensionService.resolve(serverPlayer, stack.get(ModDataComponents.AGE_REFERENCE.get()),
net.dnorberg.rivencraft.writing.OrderedWriting.EMPTY,
!stack.getOrDefault(ModDataComponents.LINK_PROPERTIES.get(),
net.dnorberg.rivencraft.book.LinkProperties.NONE)
.has(net.dnorberg.rivencraft.book.LinkProperties.DISABLE_PLATFORM)).orElse(null)
: null;
if (destination == null || server.getServer().getLevel(destination.location().dimension()) == null) {
player.displayClientMessage(Component.translatable("message.rivencraft.descriptive_book.unavailable"), true);
return ItemInteractionResult.FAIL;
}
holder.setBook(stack.copyWithCount(1));
holder.setDestination(destination);
if (!CrystalPortalNetwork.activate(server, pos, plan, player)) {
holder.takeBook();
return ItemInteractionResult.FAIL;
}
if (!player.getAbilities().instabuild) stack.shrink(1);
if (net.neoforged.fml.ModList.get().isLoaded("immersive_portals_core")) {
net.dnorberg.rivencraft.compat.ImmersivePortalsCrystalView.activate(server, pos, plan, destination,
holder.getBook().is(ModItems.DESCRIPTIVE_BOOK.get()));
CrystalPortalNetwork.setLiveView(server, plan,
net.dnorberg.rivencraft.compat.ImmersivePortalsCrystalView.complete(
server, pos, plan, destination));
}
level.playSound(null, pos, SoundEvents.ENCHANTMENT_TABLE_USE, SoundSource.BLOCKS, 1, 1);
if (player instanceof ServerPlayer serverPlayer)
ProgressionAdvancements.award(serverPlayer, ProgressionAdvancements.OPEN_PORTAL);
return ItemInteractionResult.SUCCESS;
}
@Override protected InteractionResult useWithoutItem(BlockState state, Level level, BlockPos pos,
Player player, BlockHitResult hit) {
if (level.isClientSide) return InteractionResult.SUCCESS;
if (level instanceof ServerLevel server && level.getBlockEntity(pos) instanceof BookReceptacleBlockEntity holder
&& !holder.getBook().isEmpty()) {
CrystalPortalNetwork.shutdown(server, pos);
ItemStack book = holder.takeBook();
if (!player.getInventory().add(book)) player.drop(book, false);
level.playSound(null, pos, SoundEvents.BOOK_PAGE_TURN, SoundSource.BLOCKS, 1, 1);
return InteractionResult.SUCCESS;
}
return InteractionResult.PASS;
}
@Override protected void neighborChanged(BlockState state, Level level, BlockPos pos, Block neighbor,
BlockPos neighborPos, boolean moved) {
super.neighborChanged(state, level, pos, neighbor, neighborPos, moved);
BlockPos support = pos.relative(state.getValue(FACING).getOpposite());
if (!level.isClientSide && level.hasChunkAt(support) && !level.getBlockState(support)
.is(ModBlocks.CRYSTAL_BLOCK.get())) level.destroyBlock(pos, true);
}
@Override protected void onRemove(BlockState state, Level level, BlockPos pos, BlockState replacement, boolean moving) {
if (!state.is(replacement.getBlock()) && level instanceof ServerLevel server) {
CrystalPortalNetwork.shutdown(server, pos);
if (level.getBlockEntity(pos) instanceof BookReceptacleBlockEntity holder) {
ItemStack book = holder.takeBookOnBreak();
if (!book.isEmpty()) level.addFreshEntity(new ItemEntity(level, pos.getX()+0.5, pos.getY()+0.5,
pos.getZ()+0.5, book));
}
}
super.onRemove(state, level, pos, replacement, moving);
}
private static boolean isBoundBook(ItemStack stack) {
return stack.is(ModItems.LINKING_BOOK.get()) && stack.has(ModDataComponents.LINK_TARGET.get())
|| stack.is(ModItems.DESCRIPTIVE_BOOK.get()) && stack.has(ModDataComponents.AGE_REFERENCE.get());
}
}
@@ -1,14 +1,12 @@
package net.dnorberg.rivencraft.block;
import net.minecraft.core.BlockPos;
import net.minecraft.core.Direction;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.level.BlockGetter;
import net.minecraft.world.level.LevelReader;
import net.minecraft.world.level.block.Block;
import net.minecraft.world.level.block.state.BlockState;
/** Solid footing for Age arrivals, rendered as a translucent cloud. */
/** Solid crystal-textured footing for Age arrivals that cannot be collected. */
public final class CloudPlatformBlock extends Block {
public CloudPlatformBlock(Properties properties) {
super(properties);
@@ -18,19 +16,4 @@ public final class CloudPlatformBlock extends Block {
public ItemStack getCloneItemStack(LevelReader level, BlockPos pos, BlockState state) {
return ItemStack.EMPTY;
}
@Override
protected boolean skipRendering(BlockState state, BlockState adjacent, Direction side) {
return adjacent.is(this) || super.skipRendering(state, adjacent, side);
}
@Override
protected boolean propagatesSkylightDown(BlockState state, BlockGetter level, BlockPos pos) {
return true;
}
@Override
protected int getLightBlock(BlockState state, BlockGetter level, BlockPos pos) {
return 0;
}
}
@@ -0,0 +1,84 @@
package net.dnorberg.rivencraft.block;
import com.mojang.serialization.MapCodec;
import net.dnorberg.rivencraft.block.entity.BookReceptacleBlockEntity;
import net.dnorberg.rivencraft.block.entity.CrystalPortalBlockEntity;
import net.dnorberg.rivencraft.portal.CrystalPortalNetwork;
import net.dnorberg.rivencraft.portal.PortalTravelCooldown;
import net.dnorberg.rivencraft.portal.PortalTravelQueue;
import net.dnorberg.rivencraft.registry.ModBlocks;
import net.dnorberg.rivencraft.registry.ModItems;
import net.minecraft.core.BlockPos;
import net.minecraft.core.Direction;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.util.RandomSource;
import net.minecraft.world.entity.Entity;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.level.Level;
import net.minecraft.world.level.block.BaseEntityBlock;
import net.minecraft.world.level.block.Block;
import net.minecraft.world.level.block.RenderShape;
import net.minecraft.world.level.block.entity.BlockEntity;
import net.minecraft.world.level.block.state.BlockState;
import net.minecraft.world.level.block.state.StateDefinition;
import net.minecraft.world.level.block.state.properties.BooleanProperty;
import net.minecraft.world.level.block.state.properties.EnumProperty;
import net.minecraft.world.level.material.Fluid;
import net.neoforged.fml.ModList;
/** Non-solid linked surface; all travel is delegated to the held book's rules. */
public final class CrystalPortalBlock extends BaseEntityBlock {
public static final MapCodec<CrystalPortalBlock> CODEC = simpleCodec(CrystalPortalBlock::new);
// Retained so portal blocks already saved with this state still deserialize.
public static final BooleanProperty LIVE_VIEW = BooleanProperty.create("live_view");
public static final EnumProperty<Direction.Axis> AXIS = EnumProperty.create("axis", Direction.Axis.class);
public CrystalPortalBlock(Properties properties) {
super(properties);
registerDefaultState(stateDefinition.any().setValue(LIVE_VIEW, false).setValue(AXIS, Direction.Axis.Z));
}
@Override protected MapCodec<? extends BaseEntityBlock> codec() { return CODEC; }
@Override protected void createBlockStateDefinition(StateDefinition.Builder<Block, BlockState> builder) {
builder.add(LIVE_VIEW, AXIS);
}
@Override protected RenderShape getRenderShape(BlockState state) {
// Keep the animated fallback until the optional destination view has
// actually been established, including after a world restart.
return ModList.get().isLoaded("immersive_portals_core") && state.getValue(LIVE_VIEW)
? RenderShape.INVISIBLE : RenderShape.MODEL;
}
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) {
return new CrystalPortalBlockEntity(pos, state);
}
@Override protected boolean canBeReplaced(BlockState state, Fluid fluid) { return false; }
@Override protected void entityInside(BlockState state, Level level, BlockPos pos, Entity entity) {
if (!(level instanceof ServerLevel server)) return;
long now = server.getServer().getTickCount();
if (PortalTravelCooldown.blocked(entity, now)) return;
if (!(level.getBlockEntity(pos) instanceof CrystalPortalBlockEntity portal)
|| portal.receptacle() == null || !level.hasChunkAt(portal.receptacle())
|| !(level.getBlockEntity(portal.receptacle()) instanceof BookReceptacleBlockEntity holder)) return;
ItemStack book = holder.getBook();
if (book.isEmpty()) return;
PortalTravelCooldown.mark(entity, now);
PortalTravelQueue.enqueue(entity, server, pos, portal.receptacle(), book, now);
}
@Override protected void neighborChanged(BlockState state, Level level, BlockPos pos, Block neighbor,
BlockPos neighborPos, boolean moved) {
super.neighborChanged(state, level, pos, neighbor, neighborPos, moved);
if (!(level instanceof ServerLevel server)
|| !(level.getBlockEntity(pos) instanceof CrystalPortalBlockEntity portal)
|| portal.receptacle() == null) return;
// Like a vanilla portal, validate when the frame changes, not on a
// repeating timer that can race block entities loading after restart.
if (CrystalPortalNetwork.cellStatus(server, pos, portal.receptacle())
== CrystalPortalNetwork.CellStatus.INVALID) server.removeBlock(pos, false);
}
@Override protected void tick(BlockState state, ServerLevel level, BlockPos pos, RandomSource random) {
// Ignore validation ticks saved by older builds. Frame edits are
// handled by neighborChanged, and the receptacle maintains the view.
}
}
@@ -0,0 +1,63 @@
package net.dnorberg.rivencraft.block;
import com.mojang.serialization.MapCodec;
import net.dnorberg.rivencraft.block.entity.LinkModifierBlockEntity;
import net.dnorberg.rivencraft.menu.LinkModifierMenu;
import net.minecraft.core.BlockPos;
import net.minecraft.core.Direction;
import net.minecraft.network.chat.Component;
import net.minecraft.server.level.ServerPlayer;
import net.minecraft.world.Containers;
import net.minecraft.world.InteractionResult;
import net.minecraft.world.SimpleMenuProvider;
import net.minecraft.world.entity.player.Player;
import net.minecraft.world.item.context.BlockPlaceContext;
import net.minecraft.world.level.Level;
import net.minecraft.world.level.block.BaseEntityBlock;
import net.minecraft.world.level.block.RenderShape;
import net.minecraft.world.level.block.entity.BlockEntity;
import net.minecraft.world.level.block.state.BlockState;
import net.minecraft.world.level.block.state.StateDefinition;
import net.minecraft.world.level.block.state.properties.BlockStateProperties;
import net.minecraft.world.level.block.state.properties.DirectionProperty;
import net.minecraft.world.phys.BlockHitResult;
public final class LinkModifierBlock extends BaseEntityBlock {
public static final MapCodec<LinkModifierBlock> CODEC = simpleCodec(LinkModifierBlock::new);
public static final DirectionProperty FACING = BlockStateProperties.HORIZONTAL_FACING;
public LinkModifierBlock(Properties properties) {
super(properties);
registerDefaultState(stateDefinition.any().setValue(FACING, Direction.NORTH));
}
@Override protected MapCodec<? extends BaseEntityBlock> codec() { return CODEC; }
@Override protected void createBlockStateDefinition(StateDefinition.Builder<net.minecraft.world.level.block.Block,
BlockState> builder) { builder.add(FACING); }
@Override public BlockState getStateForPlacement(BlockPlaceContext context) {
return defaultBlockState().setValue(FACING, context.getHorizontalDirection().getOpposite());
}
@Override protected RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) {
return new LinkModifierBlockEntity(pos, state);
}
@Override protected InteractionResult useWithoutItem(BlockState state, Level level, BlockPos pos,
Player player, BlockHitResult hit) {
if (!level.isClientSide && player instanceof ServerPlayer serverPlayer
&& level.getBlockEntity(pos) instanceof LinkModifierBlockEntity modifier) {
serverPlayer.openMenu(new SimpleMenuProvider(
(id, inventory, ignored) -> new LinkModifierMenu(id, inventory, modifier),
Component.translatable("container.rivencraft.link_modifier")),
buffer -> buffer.writeBlockPos(pos));
}
return InteractionResult.sidedSuccess(level.isClientSide);
}
@Override protected void onRemove(BlockState state, Level level, BlockPos pos,
BlockState replacement, boolean moving) {
if (!state.is(replacement.getBlock()) && !level.isClientSide
&& level.getBlockEntity(pos) instanceof LinkModifierBlockEntity modifier) {
Containers.dropContents(level, pos, modifier);
}
super.onRemove(state, level, pos, replacement, moving);
}
}
@@ -12,6 +12,7 @@ import net.dnorberg.rivencraft.registry.ModBlockEntities;
import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.writing.NotebookContents;
import net.dnorberg.rivencraft.item.CollationFolderItem;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.WritingGrammar;
@@ -96,7 +97,7 @@ public final class BookBinderBlockEntity extends BlockEntity implements Containe
case COVER -> validCover(stack);
case LINK_PANEL -> stack.is(ModItems.PAGE.get())
&& PageItem.content(stack).kind() == PageContent.Kind.LINK_PANEL;
case NOTEBOOK -> stack.is(ModItems.NOTEBOOK.get());
case NOTEBOOK -> CollationFolderItem.isCollection(stack);
default -> slot >= FIRST_PAGE && slot < SIZE && validPage(stack);
};
}
@@ -296,7 +297,7 @@ public final class BookBinderBlockEntity extends BlockEntity implements Containe
/** Import a Notebook from either its stored slot or the player's cursor. */
public ItemStack importNotebookFromStack(ItemStack notebook, int index) {
if (!notebook.is(ModItems.NOTEBOOK.get()) || notebook.getCount() != 1) return ItemStack.EMPTY;
if (!CollationFolderItem.isCollection(notebook) || notebook.getCount() != 1) return ItemStack.EMPTY;
List<ItemStack> pages = notebook.getOrDefault(ModDataComponents.NOTEBOOK_CONTENTS.get(), NotebookContents.EMPTY).pages();
if (pages.isEmpty()) return ItemStack.EMPTY;
int end = nextPageIndex();
@@ -0,0 +1,159 @@
package net.dnorberg.rivencraft.block.entity;
import net.dnorberg.rivencraft.book.LinkTarget;
import net.dnorberg.rivencraft.book.AgeEnvironmentCompiler;
import net.dnorberg.rivencraft.block.BookReceptacleBlock;
import net.dnorberg.rivencraft.registry.ModBlockEntities;
import net.dnorberg.rivencraft.registry.ModBlocks;
import net.dnorberg.rivencraft.portal.CrystalPortalNetwork;
import net.minecraft.nbt.NbtOps;
import net.minecraft.core.BlockPos;
import net.minecraft.core.HolderLookup;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.network.protocol.Packet;
import net.minecraft.network.protocol.game.ClientGamePacketListener;
import net.minecraft.network.protocol.game.ClientboundBlockEntityDataPacket;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.level.block.entity.BlockEntity;
import net.minecraft.world.level.block.state.BlockState;
import net.minecraft.server.level.ServerLevel;
import net.neoforged.fml.ModList;
/** The book stays in this server-owned inventory while its crystal portal is active. */
public final class BookReceptacleBlockEntity extends BlockEntity {
private static final String BOOK_TAG = "Book";
private static final String DESTINATION_TAG = "Destination";
private static final String SKY_COLOR_TAG = "SkyColor";
private ItemStack book = ItemStack.EMPTY;
private LinkTarget destination;
private int skyColor = 0xFFFFFF;
private boolean restoreView = true;
public BookReceptacleBlockEntity(BlockPos pos, BlockState state) {
super(ModBlockEntities.BOOK_RECEPTACLE.get(), pos, state);
}
public ItemStack getBook() { return book; }
public LinkTarget destination() { return destination; }
public int skyColor() { return skyColor; }
public void setBook(ItemStack stack) {
book = stack.copyWithCount(1);
sync();
}
public void setDestination(LinkTarget target) {
destination = target;
skyColor = 0xFFFFFF;
if (target != null && level instanceof ServerLevel server) {
ServerLevel targetLevel = server.getServer().getLevel(target.location().dimension());
if (targetLevel != null) skyColor = AgeEnvironmentCompiler.previewSkyColor(
targetLevel, target.location().pos()) & 0xFFFFFF;
}
sync();
}
public ItemStack takeBook() {
return removeBook(true);
}
/** The block is already being replaced, so do not write its state back into the world. */
public ItemStack takeBookOnBreak() {
return removeBook(false);
}
private ItemStack removeBook(boolean notify) {
ItemStack result = book;
book = ItemStack.EMPTY;
destination = null;
skyColor = 0xFFFFFF;
if (notify) sync();
else setChanged();
return result;
}
private void sync() {
setChanged();
if (level instanceof ServerLevel server) {
BlockState state = server.getBlockState(worldPosition);
if (!state.is(ModBlocks.BOOK_RECEPTACLE.get())) return;
boolean hasBook = !book.isEmpty();
if (state.getValue(BookReceptacleBlock.HAS_BOOK) != hasBook) {
state = state.setValue(BookReceptacleBlock.HAS_BOOK, hasBook);
server.setBlock(worldPosition, state, 2);
}
server.sendBlockUpdated(worldPosition, state, state, 2);
}
}
@Override
protected void loadAdditional(CompoundTag tag, HolderLookup.Provider registries) {
super.loadAdditional(tag, registries);
book = tag.contains(BOOK_TAG, CompoundTag.TAG_COMPOUND)
? ItemStack.parse(registries, tag.getCompound(BOOK_TAG)).orElse(ItemStack.EMPTY)
: ItemStack.EMPTY;
destination = tag.contains(DESTINATION_TAG)
? LinkTarget.CODEC.parse(NbtOps.INSTANCE, tag.get(DESTINATION_TAG)).result().orElse(null) : null;
skyColor = tag.contains(SKY_COLOR_TAG) ? tag.getInt(SKY_COLOR_TAG) & 0xFFFFFF : 0xFFFFFF;
restoreView = true;
}
@Override
protected void saveAdditional(CompoundTag tag, HolderLookup.Provider registries) {
super.saveAdditional(tag, registries);
if (!book.isEmpty()) tag.put(BOOK_TAG, book.save(registries));
if (destination != null) LinkTarget.CODEC.encodeStart(NbtOps.INSTANCE, destination)
.result().ifPresent(encoded -> tag.put(DESTINATION_TAG, encoded));
if (destination != null) tag.putInt(SKY_COLOR_TAG, skyColor);
}
@Override public Packet<ClientGamePacketListener> getUpdatePacket() {
return ClientboundBlockEntityDataPacket.create(this);
}
@Override public CompoundTag getUpdateTag(HolderLookup.Provider registries) {
return saveWithoutMetadata(registries);
}
public static void serverTick(net.minecraft.world.level.Level world, BlockPos pos, BlockState state,
BookReceptacleBlockEntity holder) {
if (!(world instanceof ServerLevel level)) return;
// Reconcile receptacles saved before HAS_BOOK existed, including an
// occupied receptacle restored from an older pre-release world.
boolean hasBook = !holder.book.isEmpty();
if (state.getValue(BookReceptacleBlock.HAS_BOOK) != hasBook) holder.sync();
if (holder.book.isEmpty() || (!holder.restoreView && level.getGameTime() % 200 != 0)) return;
// Startup maintenance must never turn a saved portal off while its
// chunks and block entities are still arriving. Structural edits are
// validated by the portal blocks' neighbor updates instead.
if (holder.restoreView) CrystalPortalNetwork.recoverSavedOwners(level, pos);
CrystalPortalNetwork.Plan plan = CrystalPortalNetwork.plan(level, pos);
if (!plan.valid()) return;
if (!ModList.get().isLoaded("immersive_portals_core")) {
holder.restoreView = false;
return;
}
if (holder.restoreView) CrystalPortalNetwork.setLiveView(level, plan, false);
holder.restoreView = false;
if (holder.destination == null) {
net.dnorberg.rivencraft.compat.ImmersivePortalsCrystalView.remove(level, pos);
CrystalPortalNetwork.setLiveView(level, plan, false);
return;
}
if (level.getServer().getLevel(holder.destination.location().dimension()) == null) {
net.dnorberg.rivencraft.compat.ImmersivePortalsCrystalView.remove(level, pos);
CrystalPortalNetwork.setLiveView(level, plan, false);
return;
}
if (!net.dnorberg.rivencraft.compat.ImmersivePortalsCrystalView.complete(
level, pos, plan, holder.destination)) {
CrystalPortalNetwork.setLiveView(level, plan, false);
net.dnorberg.rivencraft.compat.ImmersivePortalsCrystalView.activate(
level, pos, plan, holder.destination,
holder.book.is(net.dnorberg.rivencraft.registry.ModItems.DESCRIPTIVE_BOOK.get()));
}
CrystalPortalNetwork.setLiveView(level, plan,
net.dnorberg.rivencraft.compat.ImmersivePortalsCrystalView.complete(
level, pos, plan, holder.destination));
}
}
@@ -0,0 +1,50 @@
package net.dnorberg.rivencraft.block.entity;
import net.dnorberg.rivencraft.registry.ModBlockEntities;
import net.minecraft.core.BlockPos;
import net.minecraft.core.HolderLookup;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.network.protocol.Packet;
import net.minecraft.network.protocol.game.ClientGamePacketListener;
import net.minecraft.network.protocol.game.ClientboundBlockEntityDataPacket;
import net.minecraft.world.level.block.entity.BlockEntity;
import net.minecraft.world.level.block.state.BlockState;
/** Persistent pointer to the local receptacle; no duplicate book or destination state. */
public final class CrystalPortalBlockEntity extends BlockEntity {
private static final String SOURCE_TAG = "Receptacle";
private BlockPos receptacle;
public CrystalPortalBlockEntity(BlockPos pos, BlockState state) {
super(ModBlockEntities.CRYSTAL_PORTAL.get(), pos, state);
}
public BlockPos receptacle() { return receptacle; }
public void setReceptacle(BlockPos pos) {
receptacle = pos.immutable();
setChanged();
if (level != null && !level.isClientSide)
level.sendBlockUpdated(worldPosition, getBlockState(), getBlockState(), 2);
}
@Override
protected void loadAdditional(CompoundTag tag, HolderLookup.Provider registries) {
super.loadAdditional(tag, registries);
receptacle = net.minecraft.nbt.NbtUtils.readBlockPos(tag, SOURCE_TAG).orElse(null);
}
@Override
protected void saveAdditional(CompoundTag tag, HolderLookup.Provider registries) {
super.saveAdditional(tag, registries);
if (receptacle != null) tag.put(SOURCE_TAG, net.minecraft.nbt.NbtUtils.writeBlockPos(receptacle));
}
@Override public Packet<ClientGamePacketListener> getUpdatePacket() {
return ClientboundBlockEntityDataPacket.create(this);
}
@Override public CompoundTag getUpdateTag(HolderLookup.Provider registries) {
return saveWithoutMetadata(registries);
}
}
@@ -0,0 +1,63 @@
package net.dnorberg.rivencraft.block.entity;
import net.dnorberg.rivencraft.registry.ModBlockEntities;
import net.dnorberg.rivencraft.registry.ModItems;
import net.minecraft.core.BlockPos;
import net.minecraft.core.HolderLookup;
import net.minecraft.core.NonNullList;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.world.Container;
import net.minecraft.world.ContainerHelper;
import net.minecraft.world.entity.player.Player;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.level.block.entity.BlockEntity;
import net.minecraft.world.level.block.state.BlockState;
/** One persisted book slot; edits are performed by the server menu. */
public final class LinkModifierBlockEntity extends BlockEntity implements Container {
private NonNullList<ItemStack> items = NonNullList.withSize(1, ItemStack.EMPTY);
public LinkModifierBlockEntity(BlockPos pos, BlockState state) {
super(ModBlockEntities.LINK_MODIFIER.get(), pos, state);
}
@Override public int getContainerSize() { return 1; }
@Override public boolean isEmpty() { return items.getFirst().isEmpty(); }
@Override public ItemStack getItem(int slot) { return items.get(slot); }
@Override public ItemStack removeItem(int slot, int amount) {
ItemStack removed = ContainerHelper.removeItem(items, slot, amount);
if (!removed.isEmpty()) setChanged();
return removed;
}
@Override public ItemStack removeItemNoUpdate(int slot) {
ItemStack removed = ContainerHelper.takeItem(items, slot);
if (!removed.isEmpty()) setChanged();
return removed;
}
@Override public void setItem(int slot, ItemStack stack) {
items.set(slot, stack.copyWithCount(Math.min(1, stack.getCount())));
setChanged();
}
@Override public boolean canPlaceItem(int slot, ItemStack stack) {
return slot == 0 && (stack.is(ModItems.LINKING_BOOK.get())
|| stack.is(ModItems.DESCRIPTIVE_BOOK.get()));
}
@Override public boolean stillValid(Player player) {
return level != null && level.isLoaded(worldPosition) && level.getBlockEntity(worldPosition) == this
&& player.distanceToSqr(worldPosition.getX() + 0.5, worldPosition.getY() + 0.5,
worldPosition.getZ() + 0.5) <= 64.0;
}
@Override public void clearContent() {
items = NonNullList.withSize(1, ItemStack.EMPTY);
setChanged();
}
@Override protected void loadAdditional(CompoundTag tag, HolderLookup.Provider registries) {
super.loadAdditional(tag, registries);
items = NonNullList.withSize(1, ItemStack.EMPTY);
ContainerHelper.loadAllItems(tag, items, registries);
}
@Override protected void saveAdditional(CompoundTag tag, HolderLookup.Provider registries) {
super.saveAdditional(tag, registries);
ContainerHelper.saveAllItems(tag, items, registries);
}
}
@@ -2,6 +2,7 @@ package net.dnorberg.rivencraft.block.entity;
import net.dnorberg.rivencraft.item.InkVialItem;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.item.CollationFolderItem;
import net.dnorberg.rivencraft.writing.InkVialExchange;
import net.dnorberg.rivencraft.writing.WritingInkService;
import net.dnorberg.rivencraft.writing.PageContent;
@@ -87,7 +88,7 @@ public final class WritingDeskBlockEntity extends BlockEntity implements Contain
worldPosition.getZ() + 0.5) <= 64.0;
}
@Override public boolean canPlaceItem(int slot, ItemStack stack) {
if (slot < COLLECTIONS) return stack.is(ModItems.NOTEBOOK.get())
if (slot < COLLECTIONS) return CollationFolderItem.isCollection(stack)
&& stack.getOrDefault(ModDataComponents.NOTEBOOK_CONTENTS.get(), NotebookContents.EMPTY)
.pages().stream().noneMatch(page -> PageItem.content(page).kind() == PageContent.Kind.LINK_PANEL)
|| stack.is(ModItems.PAGE.get())
@@ -0,0 +1,104 @@
package net.dnorberg.rivencraft.book;
import java.util.ArrayList;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import net.dnorberg.rivencraft.config.RivencraftConfig;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.minecraft.core.BlockPos;
import net.minecraft.core.SectionPos;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.world.level.ChunkPos;
import net.minecraft.world.level.block.state.BlockState;
import net.minecraft.world.level.chunk.LevelChunk;
import net.minecraft.world.level.chunk.LevelChunkSection;
import net.minecraft.util.RandomSource;
/** Extra random block ticks from authored Accelerated pages, bounded to loaded player chunks. */
final class AgeAcceleratedTicks {
private AgeAcceleratedTicks() {}
static void tick(ServerLevel level) {
int maximumAttempts = RivencraftConfig.acceleratedMaxAttempts();
if (maximumAttempts == 0) return;
AgeDefinition age = AgeRegistrySavedData.get(level)
.findByDimension(level.dimension().location()).orElse(null);
int pages = age == null || age.plan() == null ? 0 : acceleratedPages(age.plan());
if (pages == 0) return;
List<ChunkPos> chunks = loadedPlayerChunks(level);
if (chunks.isEmpty()) return;
int maximumChunks = Math.min(chunks.size(), RivencraftConfig.acceleratedMaxChunks());
int first = Math.floorMod(level.getServer().getTickCount(), chunks.size());
List<TickSection> eligible = new ArrayList<>();
for (int offset = 0; offset < maximumChunks; offset++) {
ChunkPos pos = chunks.get((first + offset) % chunks.size());
LevelChunk chunk = level.getChunkSource().getChunkNow(pos.x, pos.z);
if (chunk == null) continue;
LevelChunkSection[] sections = chunk.getSections();
for (int sectionIndex = 0; sectionIndex < sections.length; sectionIndex++) {
LevelChunkSection section = sections[sectionIndex];
if (!section.isRandomlyTickingBlocks()) continue;
int baseY = SectionPos.sectionToBlockCoord(chunk.getSectionYFromSectionIndex(sectionIndex));
eligible.add(new TickSection(pos, baseY, section));
}
}
if (eligible.isEmpty()) return;
// Legacy attempts three positions per random-ticking section per page. Divide
// the bounded total between sections before ticking any one of them, so a
// lower section cannot exhaust the entire budget ahead of surface crops.
int total = attemptBudget(pages, eligible.size(), maximumAttempts);
int perSection = total / eligible.size();
int remainder = total % eligible.size();
int firstSection = Math.floorMod(level.getServer().getTickCount(), eligible.size());
RandomSource random = level.getRandom();
for (int offset = 0; offset < eligible.size(); offset++) {
TickSection candidate = eligible.get((firstSection + offset) % eligible.size());
int samples = perSection + (offset < remainder ? 1 : 0);
for (int sample = 0; sample < samples; sample++) {
int x = random.nextInt(16);
int y = random.nextInt(16);
int z = random.nextInt(16);
BlockState state = candidate.section().getBlockState(x, y, z);
if (state.isRandomlyTicking()) {
state.randomTick(level, new BlockPos(candidate.chunk().getMinBlockX() + x,
candidate.baseY() + y, candidate.chunk().getMinBlockZ() + z), random);
}
}
}
}
static int attemptBudget(int pages, int sections, int maximumAttempts) {
if (pages < 0 || sections < 0 || maximumAttempts < 0)
throw new IllegalArgumentException("Negative accelerated tick budget input");
return (int) Math.min(maximumAttempts, Math.min(Integer.MAX_VALUE, 3L * pages * sections));
}
static int acceleratedPages(AgeGenerationPlan plan) {
return (int) plan.symbols().stream().filter(symbol ->
symbol.semantics().role() == SymbolSemantics.Role.ENVIRONMENT
&& symbol.semantics().value() instanceof SymbolSemantics.ChoiceValue choice
&& choice.id().equals("accelerated")).count();
}
private static List<ChunkPos> loadedPlayerChunks(ServerLevel level) {
Set<ChunkPos> chunks = new LinkedHashSet<>();
for (var player : level.players()) {
ChunkPos center = player.chunkPosition();
for (int x = -1; x <= 1; x++) {
for (int z = -1; z <= 1; z++) {
int chunkX = center.x + x;
int chunkZ = center.z + z;
if (level.getChunkSource().hasChunk(chunkX, chunkZ)) {
chunks.add(new ChunkPos(chunkX, chunkZ));
}
}
}
}
return new ArrayList<>(chunks);
}
private record TickSection(ChunkPos chunk, int baseY, LevelChunkSection section) {}
}
@@ -8,6 +8,7 @@ import java.util.Random;
import java.util.Set;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.compat.TerraBlenderBiomes;
import net.dnorberg.rivencraft.writing.BiomeSymbolPages;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.minecraft.core.Holder;
@@ -34,6 +35,12 @@ public record AgeBiomeSelection(AgeTraits.BiomeDistribution distribution, List<R
public static AgeBiomeSelection compile(WritingGrammar.Result writing, AgeTraits traits,
AgeRuntimeProfile profile, long seed, RegistryAccess registries) {
return compile(writing, traits, profile, seed, registries, RandomPagePolicy.UNRESTRICTED);
}
public static AgeBiomeSelection compile(WritingGrammar.Result writing, AgeTraits traits,
AgeRuntimeProfile profile, long seed, RegistryAccess registries,
RandomPagePolicy policy) {
List<ResourceLocation> authored = writing.symbols().stream()
.filter(symbol -> symbol.semantics().role() == SymbolSemantics.Role.BIOME)
.map(symbol -> ((SymbolSemantics.ResourceValue) symbol.semantics().value()).id()).toList();
@@ -67,10 +74,26 @@ public record AgeBiomeSelection(AgeTraits.BiomeDistribution distribution, List<R
+ " or a TerraBlender Nether region");
}
}
List<ResourceLocation> availableBiomes = eligible(registries, profile);
if (availableBiomes.isEmpty()) throw new IllegalArgumentException("No eligible biomes for terrain " + profile.noiseSettings());
List<ResourceLocation> terrainBiomes = eligible(registries, profile);
if (terrainBiomes.isEmpty()) throw new IllegalArgumentException("No eligible biomes for terrain " + profile.noiseSettings());
List<ResourceLocation> availableBiomes = distribution == AgeTraits.BiomeDistribution.NATIVE
? terrainBiomes : new ArrayList<>(policy.eligible(terrainBiomes, BiomeSymbolPages::symbolId));
if (distribution != AgeTraits.BiomeDistribution.NATIVE
&& new LinkedHashSet<>(availableBiomes).size() < minimum(distribution)) {
ResourceLocation preferred = profile.terrain() == AgeRuntimeProfile.Terrain.VOID
? ResourceLocation.withDefaultNamespace("the_void")
: cave ? ResourceLocation.withDefaultNamespace("deep_dark")
: ResourceLocation.withDefaultNamespace("plains");
if (terrainBiomes.contains(preferred) && !availableBiomes.contains(preferred))
availableBiomes.add(preferred);
for (ResourceLocation fallback : terrainBiomes) {
if (new LinkedHashSet<>(availableBiomes).size() >= minimum(distribution)) break;
if (!availableBiomes.contains(fallback)) availableBiomes.add(fallback);
}
}
if (distribution == AgeTraits.BiomeDistribution.NATIVE) {
if (!authored.isEmpty()) throw new IllegalArgumentException("Native biome distribution cannot use biome pages");
// Native noise biomes are supplied by Minecraft's preset, not chosen as Pages.
return new AgeBiomeSelection(distribution, profile.terrain() == AgeRuntimeProfile.Terrain.FLAT
? List.of(ResourceLocation.withDefaultNamespace("plains"))
: isCave(profile) ? availableBiomes : presetBiomes(registries, profile));
@@ -0,0 +1,328 @@
package net.dnorberg.rivencraft.book;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.config.RivencraftConfig;
import net.dnorberg.rivencraft.writing.BlockSymbolPages;
import net.minecraft.core.registries.BuiltInRegistries;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.server.MinecraftServer;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.world.level.ChunkPos;
import net.minecraft.world.level.chunk.LevelChunk;
import net.minecraft.world.level.chunk.status.ChunkStatus;
import net.neoforged.neoforge.common.Tags;
import net.neoforged.neoforge.event.level.ChunkEvent;
import net.neoforged.neoforge.event.server.ServerStoppingEvent;
import net.neoforged.neoforge.event.tick.ServerTickEvent;
/** Legacy-style excess-block profiling with gradual spawn-area generation. */
public final class AgeBlockInstability {
// Legacy's watched blocks and factor-1 values; modern ore variants share their parent weight.
// Storage blocks are deliberate extensions, including the requested diamond-block case.
private static final Map<ResourceLocation, Double> VANILLA_WEIGHTS = weights();
private static final Map<String, Double> COMMON_MINERAL_WEIGHTS = Map.ofEntries(
Map.entry("coal", 5.0), Map.entry("sulfur", 5.0), Map.entry("sulphur", 5.0),
Map.entry("salt", 5.0), Map.entry("tin", 60.0), Map.entry("lead", 60.0),
Map.entry("aluminum", 60.0), Map.entry("aluminium", 60.0),
Map.entry("zinc", 60.0), Map.entry("copper", 60.0),
Map.entry("iron", 60.0), Map.entry("nickel", 200.0),
Map.entry("osmium", 200.0), Map.entry("silver", 200.0),
Map.entry("emerald", 200.0), Map.entry("ruby", 200.0),
Map.entry("sapphire", 200.0), Map.entry("redstone", 250.0),
Map.entry("gold", 750.0), Map.entry("uranium", 750.0),
Map.entry("platinum", 750.0), Map.entry("diamond", 4000.0),
Map.entry("iridium", 4000.0), Map.entry("netherite", 8000.0));
private static final int MAX_PENDING = 2048;
private static final int SAMPLES_PER_TICK = 4;
private static final int GENERATION_INTERVAL_TICKS = 20;
private static final List<ChunkPos> SPAWN_OFFSETS = spawnOffsets();
private static final Map<MinecraftServer, ArrayDeque<Pending>> PENDING = new java.util.WeakHashMap<>();
private static final Map<MinecraftServer, Map<ResourceLocation, Integer>> NEXT_SPAWN_SAMPLE =
new java.util.WeakHashMap<>();
private static final Map<MinecraftServer, Integer> NEXT_TARGET = new java.util.WeakHashMap<>();
private static final Map<MinecraftServer, Boolean> GENERATION_IN_FLIGHT =
new java.util.WeakHashMap<>();
private AgeBlockInstability() {}
/** Track recognized materials from installed mods without requiring any mod-specific API. */
static boolean tracked(ResourceLocation id) {
if (VANILLA_WEIGHTS.containsKey(id)) return true;
if (id.getNamespace().equals("minecraft") || id.getNamespace().equals("rivencraft")) return false;
if (!BuiltInRegistries.BLOCK.containsKey(id)) return false;
var block = BuiltInRegistries.BLOCK.get(id);
return eligibleMaterial(block) && (configuredOverride(id) != null || inferredModdedWeight(id, block) > 0);
}
static double weight(ResourceLocation id) {
Double vanilla = VANILLA_WEIGHTS.get(id);
if (vanilla != null) return vanilla;
if (id.getNamespace().equals("minecraft") || id.getNamespace().equals("rivencraft")
|| !BuiltInRegistries.BLOCK.containsKey(id)) return 0;
var block = BuiltInRegistries.BLOCK.get(id);
if (!eligibleMaterial(block)) return 0;
return moddedWeight(id, inferredModdedWeight(id, block),
RivencraftConfig.moddedMaterialOverrides());
}
private static boolean eligibleMaterial(net.minecraft.world.level.block.Block block) {
return BlockSymbolPages.isRockMaterial(block) || BlockSymbolPages.isFluidMaterial(block);
}
private static Double configuredOverride(ResourceLocation id) {
return configuredOverride(id, RivencraftConfig.moddedMaterialOverrides());
}
private static Double configuredOverride(ResourceLocation id, List<? extends String> overrides) {
for (String entry : overrides) {
int separator = entry.lastIndexOf('=');
if (separator > 0 && entry.substring(0, separator).equals(id.toString()))
return (double) Integer.parseInt(entry.substring(separator + 1));
}
return null;
}
static double moddedWeight(ResourceLocation id, double inferred, List<? extends String> overrides) {
Double override = configuredOverride(id, overrides);
return override == null ? inferred : override;
}
private static double inferredModdedWeight(ResourceLocation id, net.minecraft.world.level.block.Block block) {
if (BlockSymbolPages.isFluidMaterial(block)) return 1.25;
var state = block.defaultBlockState();
String path = id.getPath();
boolean ore = state.is(Tags.Blocks.ORES) || path.endsWith("_ore") || path.contains("_ore_");
boolean storage = state.is(Tags.Blocks.STORAGE_BLOCKS)
|| (path.endsWith("_block") || path.startsWith("block_of_"))
&& namedMineralWeight(path) != null;
return inferredModdedWeight(id, ore, storage, false);
}
static double inferredModdedWeight(ResourceLocation id, boolean ore, boolean storage, boolean fluid) {
if (fluid) return 1.25;
Double named = namedMineralWeight(id.getPath());
if (ore) return named == null ? 60.0 : named;
if (storage) return named == null ? 120.0 : named;
return 0;
}
private static Double namedMineralWeight(String path) {
for (String part : path.split("[/_]")) {
Double value = COMMON_MINERAL_WEIGHTS.get(part);
if (value != null) return value;
}
return null;
}
public static void onChunkLoad(ChunkEvent.Load event) {
if (!(event.getLevel() instanceof ServerLevel level)
|| !(event.getChunk() instanceof LevelChunk chunk)) return;
boolean overworld = level.dimension() == net.minecraft.world.level.Level.OVERWORLD;
if (!overworld && !AgeInstabilityRuntime.isAgeDimension(level.dimension().location())) return;
// Chunk-load callbacks can occur while chunk storage is updating. Defer saved-data
// access to a bounded server-tick lane to avoid reentering that storage path.
synchronized (PENDING) {
var queue = PENDING.computeIfAbsent(level.getServer(), ignored -> new ArrayDeque<>());
if (queue.size() < MAX_PENDING) queue.addLast(new Pending(level, chunk));
}
}
public static void onServerTickPost(ServerTickEvent.Post event) {
for (int index = 0; index < SAMPLES_PER_TICK; index++) {
Pending pending;
synchronized (PENDING) {
var queue = PENDING.get(event.getServer());
pending = queue == null ? null : queue.pollFirst();
}
if (pending == null) break;
var pos = pending.chunk().getPos();
if (pending.level().getChunkSource().hasChunk(pos.x, pos.z))
AgeBlockProfileSavedData.get(pending.level()).sample(pending.chunk());
}
if (event.getServer().getTickCount() % GENERATION_INTERVAL_TICKS == 0) {
generateNextSpawnSample(event.getServer());
}
}
public static void onServerStopping(ServerStoppingEvent event) {
synchronized (PENDING) { PENDING.remove(event.getServer()); }
NEXT_SPAWN_SAMPLE.remove(event.getServer());
NEXT_TARGET.remove(event.getServer());
GENERATION_IN_FLIGHT.remove(event.getServer());
}
/** Generate at most one chunk per second across the active Age and its Overworld baseline. */
private static void generateNextSpawnSample(MinecraftServer server) {
if (GENERATION_IN_FLIGHT.containsKey(server)) return;
List<SampleTarget> targets = new ArrayList<>();
for (ServerLevel level : server.getAllLevels()) {
if (!AgeInstabilityRuntime.isAgeDimension(level.dimension().location())
|| level.players().isEmpty()) continue;
AgeDefinition age = AgeRegistrySavedData.get(level)
.findByDimension(level.dimension().location()).orElse(null);
if (age == null || age.instability().version() < 2) continue;
targets.add(new SampleTarget(level,
age.spawn() == null ? level.getSharedSpawnPos() : age.spawn(),
AgeBlockProfileSavedData.MIN_AGE_SAMPLES));
}
if (targets.isEmpty()) return;
ServerLevel overworld = server.overworld();
targets.add(0, new SampleTarget(overworld, overworld.getSharedSpawnPos(),
AgeBlockProfileSavedData.MIN_BASELINE_SAMPLES));
int first = Math.floorMod(NEXT_TARGET.getOrDefault(server, 0), targets.size());
for (int offset = 0; offset < targets.size(); offset++) {
int index = (first + offset) % targets.size();
SampleTarget target = targets.get(index);
if (generateNextSpawnSample(target.level(), target.origin(), target.minimum(), server)) {
NEXT_TARGET.put(server, index + 1);
return;
}
}
}
private static boolean generateNextSpawnSample(ServerLevel level, net.minecraft.core.BlockPos origin,
int minimum, MinecraftServer server) {
AgeBlockProfileSavedData profile = AgeBlockProfileSavedData.get(level);
if (profile.count() >= minimum) return false;
Map<ResourceLocation, Integer> cursors = NEXT_SPAWN_SAMPLE.computeIfAbsent(server,
ignored -> new HashMap<>());
ResourceLocation dimension = level.dimension().location();
int index = cursors.getOrDefault(dimension, 0);
ChunkPos center = new ChunkPos(origin);
while (index < SPAWN_OFFSETS.size()) {
ChunkPos offset = SPAWN_OFFSETS.get(index++);
ChunkPos target = new ChunkPos(center.x + offset.x, center.z + offset.z);
if (profile.contains(target)) continue;
cursors.put(dimension, index);
GENERATION_IN_FLIGHT.put(server, true);
// getChunkFuture blocks when called on the server thread. Its off-thread
// path schedules generation on Minecraft's chunk executor instead.
CompletableFuture.supplyAsync(() -> level.getChunkSource()
.getChunkFuture(target.x, target.z, ChunkStatus.FULL, true))
.thenCompose(future -> future)
.whenComplete((result, error) -> server.execute(() -> {
GENERATION_IN_FLIGHT.remove(server);
if (error != null) {
Rivencraft.LOGGER.warn("Could not profile chunk {} in {}", target, dimension, error);
} else if (result.orElse(null) instanceof LevelChunk chunk) {
profile.sample(chunk);
}
}));
return true;
}
return false;
}
private static List<ChunkPos> spawnOffsets() {
List<ChunkPos> offsets = new ArrayList<>(AgeBlockProfileSavedData.MAX_SAMPLES);
offsets.add(new ChunkPos(0, 0));
for (int radius = 1; offsets.size() < AgeBlockProfileSavedData.MAX_SAMPLES; radius++) {
for (int x = -radius; x <= radius; x++) {
offsets.add(new ChunkPos(x, -radius));
offsets.add(new ChunkPos(x, radius));
}
for (int z = -radius + 1; z < radius; z++) {
offsets.add(new ChunkPos(-radius, z));
offsets.add(new ChunkPos(radius, z));
}
}
return List.copyOf(offsets.subList(0, AgeBlockProfileSavedData.MAX_SAMPLES));
}
/** Zero until the Age exceeds 400 samples and the baseline reaches 500. */
static int score(AgeBlockProfileSavedData age, AgeBlockProfileSavedData baseline) {
return score(age.totals(), age.count(), baseline.totals(), baseline.count());
}
static int score(Map<ResourceLocation, Long> age, int ageChunks,
Map<ResourceLocation, Long> baseline, int baselineChunks) {
if (ageChunks < AgeBlockProfileSavedData.MIN_AGE_SAMPLES
|| baselineChunks < AgeBlockProfileSavedData.MIN_BASELINE_SAMPLES) return 0;
double result = 0;
Set<ResourceLocation> watched = new HashSet<>(age.keySet());
watched.addAll(baseline.keySet());
for (ResourceLocation id : watched) {
double weight = weight(id);
if (weight <= 0) continue;
double excess = age.getOrDefault(id, 0L) / (double) ageChunks
- 1.05 * baseline.getOrDefault(id, 0L) / (double) baselineChunks;
if (excess > 0) result += excess * weight;
}
return (int) Math.min(100_000, Math.round(result));
}
public static int score(ServerLevel level, AgeDefinition age) {
if (age.instability().version() < 2
|| !AgeInstabilityRuntime.isAgeDimension(level.dimension().location())
|| !age.dimensionId().equals(level.dimension().location())) return 0;
return score(AgeBlockProfileSavedData.get(level),
AgeBlockProfileSavedData.get(level.getServer().overworld()));
}
public static int sampledChunks(ServerLevel level) {
return AgeBlockProfileSavedData.get(level).count();
}
public static int effectiveScore(ServerLevel level, AgeDefinition age) {
return difficultyScore((long) age.instability().score() + score(level, age),
RivencraftConfig.instabilityDifficulty());
}
public static int difficultyScore(long rawScore, int difficulty) {
double multiplier = switch (difficulty) {
case 0 -> 0.25;
case 1 -> 0.5;
case 2 -> 1.0;
case 3 -> 1.75;
default -> throw new IllegalArgumentException("Unknown instability difficulty " + difficulty);
};
return (int) Math.min(Integer.MAX_VALUE, Math.max(0, rawScore * multiplier));
}
public static AgeInstabilityPlan effectivePlan(ServerLevel level, AgeDefinition age) {
int blockScore = score(level, age);
int difficulty = RivencraftConfig.instabilityDifficulty();
if (blockScore == 0 && difficulty == 2) return age.instabilityPlan();
int combined = difficultyScore((long) age.instability().score() + blockScore, difficulty);
AgeInstability effective = new AgeInstability(AgeInstability.CURRENT_VERSION, combined,
java.util.List.of(new AgeInstability.Contribution("effective_block_profile", -1, combined,
"Saved writing score plus sampled excess blocks")));
return AgeInstabilityPlan.select(effective, age.seed());
}
private static Map<ResourceLocation, Double> weights() {
Map<ResourceLocation, Double> values = new HashMap<>();
add(values, 5, "coal_ore", "deepslate_coal_ore", "lapis_ore", "deepslate_lapis_ore");
add(values, 60, "iron_ore", "deepslate_iron_ore");
add(values, 200, "emerald_ore", "deepslate_emerald_ore");
add(values, 250, "redstone_ore", "deepslate_redstone_ore");
add(values, 750, "gold_ore", "deepslate_gold_ore");
add(values, 4000, "diamond_ore", "deepslate_diamond_ore", "diamond_block");
add(values, 20, "nether_quartz_ore");
add(values, 50, "glowstone");
values.put(ResourceLocation.parse("rivencraft:crystal_block"), 20.0);
// Valuable blocks introduced after Legacy, and storage forms authorable in Rivencraft.
add(values, 200, "emerald_block");
add(values, 750, "gold_block", "raw_gold_block");
add(values, 4000, "ancient_debris");
add(values, 60, "iron_block", "raw_iron_block");
add(values, 8000, "netherite_block");
return Map.copyOf(values);
}
private static void add(Map<ResourceLocation, Double> values, int weight, String... paths) {
for (String path : paths) values.put(ResourceLocation.withDefaultNamespace(path), (double) weight);
}
private record Pending(ServerLevel level, LevelChunk chunk) {}
private record SampleTarget(ServerLevel level, net.minecraft.core.BlockPos origin, int minimum) {}
}
@@ -0,0 +1,96 @@
package net.dnorberg.rivencraft.book;
import java.util.HashMap;
import java.util.Map;
import net.minecraft.core.HolderLookup;
import net.minecraft.core.registries.BuiltInRegistries;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.nbt.ListTag;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.util.datafix.DataFixTypes;
import net.minecraft.world.level.ChunkPos;
import net.minecraft.world.level.chunk.LevelChunk;
import net.minecraft.world.level.saveddata.SavedData;
/** Persistent, bounded samples of generated block abundance for one dimension. */
public final class AgeBlockProfileSavedData extends SavedData {
private static final int PROFILE_VERSION = 2;
static final int MIN_AGE_SAMPLES = 401;
static final int MIN_BASELINE_SAMPLES = 500;
static final int MAX_SAMPLES = 1024;
private static final Factory<AgeBlockProfileSavedData> FACTORY = new Factory<>(
AgeBlockProfileSavedData::new, AgeBlockProfileSavedData::load, DataFixTypes.SAVED_DATA_MAP_DATA);
private final Map<Long, Map<ResourceLocation, Integer>> samples = new HashMap<>();
private final Map<ResourceLocation, Long> totals = new HashMap<>();
AgeBlockProfileSavedData() {}
static AgeBlockProfileSavedData get(ServerLevel level) {
return level.getDataStorage().computeIfAbsent(FACTORY, "rivencraft_block_profile");
}
int count() { return samples.size(); }
boolean contains(ChunkPos pos) { return samples.containsKey(pos.toLong()); }
Map<ResourceLocation, Long> totals() { return Map.copyOf(totals); }
boolean sample(LevelChunk chunk) {
if (samples.size() >= MAX_SAMPLES || samples.containsKey(chunk.getPos().toLong())) return false;
Map<ResourceLocation, Integer> counts = new HashMap<>();
for (var section : chunk.getSections()) {
if (section.hasOnlyAir()) continue;
section.getStates().count((state, amount) -> {
ResourceLocation id = BuiltInRegistries.BLOCK.getKey(state.getBlock());
if (AgeBlockInstability.tracked(id)) counts.merge(id, amount, Integer::sum);
});
}
add(chunk.getPos(), counts);
return true;
}
void add(ChunkPos pos, Map<ResourceLocation, Integer> counts) {
if (samples.size() >= MAX_SAMPLES || samples.containsKey(pos.toLong())) return;
samples.put(pos.toLong(), Map.copyOf(counts));
counts.forEach((id, amount) -> totals.merge(id, amount.longValue(), Long::sum));
setDirty();
}
@Override
public CompoundTag save(CompoundTag tag, HolderLookup.Provider registries) {
tag.putInt("Version", PROFILE_VERSION);
ListTag entries = new ListTag();
for (var sample : samples.entrySet()) {
CompoundTag entry = new CompoundTag();
entry.putLong("Chunk", sample.getKey());
CompoundTag blocks = new CompoundTag();
sample.getValue().forEach((id, amount) -> blocks.putInt(id.toString(), amount));
entry.put("Blocks", blocks);
entries.add(entry);
}
tag.put("Samples", entries);
return tag;
}
static AgeBlockProfileSavedData load(CompoundTag tag, HolderLookup.Provider registries) {
AgeBlockProfileSavedData data = new AgeBlockProfileSavedData();
// Earlier profiles omitted some modded candidates. Resample rather than
// mixing incompatible chunk averages after installing content mods.
if (tag.getInt("Version") != PROFILE_VERSION) return data;
ListTag entries = tag.getList("Samples", CompoundTag.TAG_COMPOUND);
for (int index = 0; index < Math.min(entries.size(), MAX_SAMPLES); index++) {
CompoundTag entry = entries.getCompound(index);
CompoundTag blocks = entry.getCompound("Blocks");
Map<ResourceLocation, Integer> counts = new HashMap<>();
for (String key : blocks.getAllKeys()) {
ResourceLocation id = ResourceLocation.tryParse(key);
if (id != null && blocks.getInt(key) > 0)
counts.put(id, blocks.getInt(key));
}
data.add(new ChunkPos(entry.getLong("Chunk")), counts);
}
return data;
}
}
@@ -51,6 +51,8 @@ public final class AgeDecayProviders {
AgeDefinition age = AgeRegistrySavedData.get(level).findByDimension(level.dimension().location()).orElse(null);
if (age == null) return -1;
ResourceLocation id = id("decay" + color.getSerializedName());
if (!RivencraftConfig.instabilityEnabled() || !AgeInstabilityControls.get(level).enabled(age.id())
|| !RivencraftConfig.instabilityProviderEnabled(id)) return -1;
int changed = 0;
for (int i = 0; i < Math.min(count, 32); i++) {
AgeInstabilityRuntime.Budget budget = new AgeInstabilityRuntime.Budget(1);
@@ -23,12 +23,14 @@ public record AgeDefinition(
@Nullable AgeSeasonMode seasonMode,
List<AgeFeatureSelection.Choice> randomFeatures,
AgeInstability instability,
AgeInstabilityPlan instabilityPlan
AgeInstabilityPlan instabilityPlan,
RandomPagePolicy randomPagePolicy
) {
public static final ResourceLocation RANDOM_VANILLA_PROFILE = ResourceLocation.fromNamespaceAndPath(
Rivencraft.MOD_ID, "random_vanilla"
);
public static final int CURRENT_GENERATION_VERSION = 16;
public static final int LEGACY_GENERATOR_CUTOFF = 16;
public static final int CURRENT_GENERATION_VERSION = AgeSkyProfile.RANDOM_SKY_GENERATION_VERSION;
public AgeDefinition {
Objects.requireNonNull(id, "id");
@@ -38,6 +40,7 @@ public record AgeDefinition(
Objects.requireNonNull(traits, "traits");
Objects.requireNonNull(instability, "instability");
Objects.requireNonNull(instabilityPlan, "instabilityPlan");
Objects.requireNonNull(randomPagePolicy, "randomPagePolicy");
randomFeatures = List.copyOf(randomFeatures);
if (plan != null && !randomFeatures.isEmpty()) {
throw new IllegalArgumentException("Authored Ages cannot also have random features");
@@ -87,6 +90,16 @@ public record AgeDefinition(
AgeInstabilityPlan.empty());
}
public AgeDefinition(UUID id, String name, long seed, ResourceLocation generationProfile,
int generationVersion, long createdGameTime, ResourceLocation dimensionId,
BlockPos spawn, AgeTraits traits, AgeGenerationPlan plan,
@Nullable AgeSeasonMode seasonMode, List<AgeFeatureSelection.Choice> randomFeatures,
AgeInstability instability, AgeInstabilityPlan instabilityPlan) {
this(id, name, seed, generationProfile, generationVersion, createdGameTime,
dimensionId, spawn, traits, plan, seasonMode, randomFeatures, instability,
instabilityPlan, RandomPagePolicy.UNRESTRICTED);
}
public static ResourceLocation dimensionId(UUID ageId) {
return ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "age/" + ageId);
}
@@ -116,6 +129,12 @@ public record AgeDefinition(
public AgeDefinition withSpawn(BlockPos spawn) {
return new AgeDefinition(id, name, seed, generationProfile, generationVersion,
createdGameTime, dimensionId, spawn.immutable(), traits, plan, seasonMode,
randomFeatures, instability, instabilityPlan);
randomFeatures, instability, instabilityPlan, randomPagePolicy);
}
/** A frozen authored profile takes precedence over the profile ID on old books. */
public boolean caveTerrain() {
return AgeBiomeSelection.isCave(plan == null
? AgeRuntimeProfiles.resolve(generationProfile) : plan.runtimeProfile());
}
}
@@ -0,0 +1,56 @@
package net.dnorberg.rivencraft.book;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.LinkOption;
import java.nio.file.Path;
import java.nio.file.StandardCopyOption;
import java.nio.file.AtomicMoveNotSupportedException;
import net.dnorberg.rivencraft.Rivencraft;
import net.minecraft.server.MinecraftServer;
import net.minecraft.world.level.storage.LevelResource;
/** Retires an exact Age and moves its unloaded region data out of the live world. */
public final class AgeDeletionService {
public enum Result { RETIRED, ALREADY_DEAD, OCCUPIED, UNLOAD_FAILED, STORAGE_FAILED }
private AgeDeletionService() { }
public static Result retire(MinecraftServer server, AgeDefinition age) {
AgeRegistrySavedData registry = AgeRegistrySavedData.get(server.overworld());
if (registry.isDead(age.id())) return Result.ALREADY_DEAD;
var level = server.getLevel(AgeDimensionService.dimensionKey(age));
if (level != null && !level.players().isEmpty()) return Result.OCCUPIED;
if (AgeDimensionService.unload(server, age) == AgeDimensionService.UnloadResult.FAILED)
return Result.UNLOAD_FAILED;
Path world = server.getWorldPath(LevelResource.ROOT).toAbsolutePath().normalize();
Path ageRoot = world.resolve("dimensions/rivencraft/age").normalize();
Path data = world.resolve("dimensions")
.resolve(age.dimensionId().getNamespace())
.resolve(age.dimensionId().getPath()).normalize();
// Exact Rivencraft Age only; never move the shared age/ directory.
if (!data.startsWith(ageRoot) || data.equals(ageRoot)
|| !"rivencraft".equals(age.dimensionId().getNamespace())
|| !age.dimensionId().getPath().startsWith("age/")) return Result.STORAGE_FAILED;
try {
if (Files.isSymbolicLink(world.resolve("dimensions"))
|| Files.isSymbolicLink(world.resolve("dimensions/rivencraft"))
|| Files.isSymbolicLink(ageRoot) || Files.isSymbolicLink(data)) return Result.STORAGE_FAILED;
if (Files.exists(data, LinkOption.NOFOLLOW_LINKS)) {
Path archive = world.getParent().resolve(world.getFileName() + "-retired-ages")
.resolve(age.id().toString());
if (Files.exists(archive, LinkOption.NOFOLLOW_LINKS)) return Result.STORAGE_FAILED;
Files.createDirectories(archive.getParent());
try { Files.move(data, archive, StandardCopyOption.ATOMIC_MOVE); }
catch (AtomicMoveNotSupportedException exception) { Files.move(data, archive); }
Rivencraft.LOGGER.warn("Retired Age {} data moved from {} to {}", age.id(), data, archive);
}
} catch (IOException exception) {
Rivencraft.LOGGER.error("Cannot archive data for Age {}", age.id(), exception);
return Result.STORAGE_FAILED;
}
registry.markDead(age.id());
return Result.RETIRED;
}
}
@@ -16,7 +16,12 @@ import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.registry.ModBlocks;
import net.dnorberg.rivencraft.compat.ImmersivePortalsChunkLoaders;
import net.dnorberg.rivencraft.compat.SereneSeasonsCompatibility;
import net.dnorberg.rivencraft.compat.RuinsCompatibility;
import net.dnorberg.rivencraft.compat.TerraBlenderBiomes;
import net.dnorberg.rivencraft.writing.BiomeSymbolPages;
import net.dnorberg.rivencraft.writing.BlockSymbolPages;
import net.dnorberg.rivencraft.writing.SymbolCatalog;
import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.minecraft.core.BlockPos;
import net.minecraft.core.GlobalPos;
@@ -70,6 +75,7 @@ public final class AgeDimensionService {
DynamicDimensionLoadCallback.register((server, loader) -> {
ServerLevel overworld = server.overworld();
for (AgeDefinition age : AgeRegistrySavedData.get(overworld).definitions()) {
if (AgeRegistrySavedData.get(overworld).isDead(age.id())) continue;
if (!canLoadProfile(server, age)) continue;
ServerLevel level = loader.loadDynamicDimension(
age.dimensionId(),
@@ -79,6 +85,7 @@ public final class AgeDimensionService {
if (level != null) {
applyCelestialClock(level, age);
SereneSeasonsCompatibility.registerAge(server, age);
RuinsCompatibility.registerAge(age);
}
}
synchronizeImmersivePortals(server);
@@ -91,8 +98,19 @@ public final class AgeDimensionService {
public static Optional<LinkTarget> resolve(ServerPlayer player, AgeReference reference,
OrderedWriting writing) {
AgeDefinition definition = AgeRegistrySavedData.resolveOrCreate(player.serverLevel(), reference, writing);
ServerLevel level = ensureLoaded(player.getServer(), definition);
return resolve(player, reference, writing, true);
}
public static Optional<LinkTarget> resolve(ServerPlayer player, AgeReference reference,
OrderedWriting writing, boolean generatePlatform) {
return resolve(player.serverLevel(), reference, writing, generatePlatform);
}
public static Optional<LinkTarget> resolve(ServerLevel source, AgeReference reference,
OrderedWriting writing, boolean generatePlatform) {
AgeDefinition definition = AgeRegistrySavedData.resolveOrCreate(source, reference, writing);
if (AgeRegistrySavedData.get(source).isDead(definition.id())) return Optional.empty();
ServerLevel level = ensureLoaded(source.getServer(), definition);
if (level == null) {
return Optional.empty();
}
@@ -100,7 +118,8 @@ public final class AgeDimensionService {
BlockPos spawn = definition.spawn();
if (spawn == null) {
applyInitialCelestialPhase(level, definition);
spawn = createSafeSpawn(level, definition);
spawn = createSafeSpawn(level, definition, generatePlatform);
if (spawn == null) return Optional.empty();
if (AgeFeatureSelection.resolved(definition.plan()).stream()
.anyMatch(choice -> choice.id().equals(AgeFeatureSelection.STAR_FISSURES))
|| definition.randomFeatures().stream()
@@ -118,11 +137,13 @@ public final class AgeDimensionService {
}
public static ServerLevel ensureLoaded(MinecraftServer server, AgeDefinition definition) {
if (AgeRegistrySavedData.get(server.overworld()).isDead(definition.id())) return null;
ResourceKey<Level> key = dimensionKey(definition);
ServerLevel existing = server.getLevel(key);
if (existing != null) {
applyCelestialClock(existing, definition);
SereneSeasonsCompatibility.registerAge(server, definition);
RuinsCompatibility.registerAge(definition);
return existing;
}
@@ -139,6 +160,7 @@ public final class AgeDimensionService {
} else {
applyCelestialClock(loaded, definition);
SereneSeasonsCompatibility.registerAge(server, definition);
RuinsCompatibility.registerAge(definition);
synchronizeImmersivePortals(server);
}
return loaded;
@@ -166,6 +188,10 @@ public final class AgeDimensionService {
}
private static void applyCelestialClock(ServerLevel level, AgeDefinition age) {
if (age.caveTerrain()) {
level.setDayTimePerTick(1.0F);
return;
}
if (age.traits().hasStoppedCelestialCycle()) {
// NeoForge rejects an exact zero rate. The smallest positive float
// never advances the integer clock during a practical world
@@ -194,6 +220,7 @@ public final class AgeDimensionService {
}
private static void applyInitialCelestialPhase(ServerLevel level, AgeDefinition age) {
if (age.caveTerrain()) return;
long phaseTime = (long)(age.traits().celestialPhase() * Level.TICKS_PER_DAY);
if (AgeEnvironmentCompiler.hasWrittenPhase(age.plan())) {
// Legacy's Nadir is midnight, while vanilla day time zero is sunrise.
@@ -212,21 +239,24 @@ public final class AgeDimensionService {
return ResourceKey.create(net.minecraft.core.registries.Registries.DIMENSION, definition.dimensionId());
}
private static BlockPos createSafeSpawn(ServerLevel level, AgeDefinition age) {
private static BlockPos createSafeSpawn(ServerLevel level, AgeDefinition age, boolean generatePlatform) {
BlockPos floorCenter;
if (age.generationProfile().equals(AgeGenerationProfiles.CAVE)) {
if (age.caveTerrain()) {
// Cave Ages are enclosed. Searching from the world ceiling would
// select or expose their roof, so begin with the floor beneath a
// player standing at Y=64 and search downward from there.
floorCenter = highestFootedSurface(level, CAVE_SPAWN_SEARCH_Y - 1)
.orElseGet(() -> fallbackSpawnFloor(level));
.orElseGet(() -> generatePlatform ? fallbackSpawnFloor(level) : null);
} else if (isNetherStyle(level)) {
floorCenter = netherSpawnFloor(level);
floorCenter = generatePlatform ? netherSpawnFloor(level)
: highestFootedSurface(level, CAVE_SPAWN_SEARCH_Y - 1).orElse(null);
} else {
floorCenter = highestFootedSurface(level).orElseGet(() -> fallbackSpawnFloor(level));
floorCenter = highestFootedSurface(level).orElseGet(() -> generatePlatform ? fallbackSpawnFloor(level) : null);
}
for (int x = -PLATFORM_RADIUS; x <= PLATFORM_RADIUS; x++) {
if (floorCenter == null) return null;
if (generatePlatform) for (int x = -PLATFORM_RADIUS; x <= PLATFORM_RADIUS; x++) {
for (int z = -PLATFORM_RADIUS; z <= PLATFORM_RADIUS; z++) {
BlockPos floor = floorCenter.offset(x, 0, z);
level.setBlock(floor, ModBlocks.CLOUD_PLATFORM.get().defaultBlockState(), 2);
@@ -237,6 +267,11 @@ public final class AgeDimensionService {
}
BlockPos spawn = floorCenter.above();
if (!generatePlatform) {
var safe = LinkingService.resolveDestination(level, spawn, true);
if (safe.isEmpty()) return null;
spawn = BlockPos.containing(safe.get());
}
level.setDefaultSpawnPos(spawn, 0.0F);
return spawn;
}
@@ -312,6 +347,7 @@ public final class AgeDimensionService {
private static ChunkGenerator createGenerator(MinecraftServer server, AgeDefinition age) {
AgeRuntimeProfile profile = runtimeProfile(age);
BiomeSource biomeSource = createBiomeSource(server, age, profile);
List<ResourceLocation> libraryAgeSymbols = libraryAgeSymbols(age, profile, biomeSource);
List<AgeFeatureSelection.Choice> features = age.plan() == null
? age.randomFeatures() : AgeFeatureSelection.resolved(age.plan());
if (profile.terrain() == AgeRuntimeProfile.Terrain.FLAT) {
@@ -320,8 +356,8 @@ public final class AgeDimensionService {
server.registryAccess().lookupOrThrow(Registries.STRUCTURE_SET),
server.registryAccess().lookupOrThrow(Registries.PLACED_FEATURE)
);
return age.generationVersion() < AgeDefinition.CURRENT_GENERATION_VERSION
? new FlatLevelSource(settings) : new AgeFlatChunkGenerator(biomeSource, settings, features, age.seed());
return age.generationVersion() < AgeDefinition.LEGACY_GENERATOR_CUTOFF
? new FlatLevelSource(settings) : new AgeFlatChunkGenerator(biomeSource, settings, features, age.seed(), libraryAgeSymbols);
}
if (profile.terrain() == AgeRuntimeProfile.Terrain.VOID) {
FlatLevelGeneratorSettings settings = new FlatLevelGeneratorSettings(
@@ -330,8 +366,8 @@ public final class AgeDimensionService {
List.of()
);
settings.updateLayers();
return age.generationVersion() < AgeDefinition.CURRENT_GENERATION_VERSION
? new FlatLevelSource(settings) : new AgeFlatChunkGenerator(biomeSource, settings, features, age.seed());
return age.generationVersion() < AgeDefinition.LEGACY_GENERATOR_CUTOFF
? new FlatLevelSource(settings) : new AgeFlatChunkGenerator(biomeSource, settings, features, age.seed(), libraryAgeSymbols);
}
var noiseSettings = server.registryAccess().lookupOrThrow(Registries.NOISE_SETTINGS);
@@ -340,10 +376,43 @@ public final class AgeDimensionService {
NoiseGeneratorSettings baseSettings = noiseSettings.getOrThrow(settingsKey).value();
Holder<NoiseGeneratorSettings> settings = Holder.direct(withBiomeMaterialRules(baseSettings));
boolean caveTerrain = AgeBiomeSelection.isCave(profile);
return age.generationVersion() < AgeDefinition.CURRENT_GENERATION_VERSION
return age.generationVersion() < AgeDefinition.LEGACY_GENERATOR_CUTOFF
? new NoiseBasedChunkGenerator(biomeSource, settings)
: new AgeFeatureChunkGenerator(biomeSource, settings, features, age.seed(),
caveTerrain, caveTerrain ? TerraBlenderBiomes.nether(server.registryAccess()) : List.of());
caveTerrain, caveTerrain ? TerraBlenderBiomes.nether(server.registryAccess()) : List.of(),
libraryAgeSymbols);
}
/** Freeze the Age's authoring/result pages into the generator; worldgen never reads SavedData. */
public static List<ResourceLocation> libraryAgeSymbols(AgeDefinition age, AgeRuntimeProfile profile,
BiomeSource biomes) {
LinkedHashSet<ResourceLocation> ids = new LinkedHashSet<>();
ResourceLocation effectiveTerrain = AgeRuntimeProfiles.profiles().entrySet().stream()
.filter(entry -> entry.getValue().equals(profile))
.map(java.util.Map.Entry::getKey).sorted().findFirst()
.orElse(AgeGenerationProfiles.migrationFallback(age.generationProfile()));
ids.add(ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID,
"terrain/" + effectiveTerrain.getPath()));
if (age.plan() != null) {
age.plan().activeSymbols().forEach(symbol -> ids.add(symbol.reference().id()));
} else {
ids.add(ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID,
"biome/" + age.traits().biomeDistribution().name().toLowerCase(java.util.Locale.ROOT)));
ids.add(ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID,
"lighting/" + age.traits().lighting().name().toLowerCase(java.util.Locale.ROOT)));
ids.add(ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID,
"weather/" + age.traits().weather().name().toLowerCase(java.util.Locale.ROOT)));
age.randomFeatures().forEach(choice -> {
ids.add(ResourceLocation.fromNamespaceAndPath(
Rivencraft.MOD_ID, "feature/" + choice.id().getPath()));
choice.material().ifPresent(material -> ids.add(BlockSymbolPages.symbolId(material)));
});
biomes.possibleBiomes().forEach(holder -> holder.unwrapKey().ifPresent(key -> {
if (BiomeSymbolPages.isPublicPageBiome(key.location()))
ids.add(BiomeSymbolPages.symbolId(key.location()));
}));
}
return ids.stream().filter(id -> SymbolCatalog.isKnown(new SymbolReference(id))).toList();
}
private static NoiseGeneratorSettings withBiomeMaterialRules(NoiseGeneratorSettings base) {
@@ -390,13 +459,13 @@ public final class AgeDimensionService {
AgeDefinition age,
AgeRuntimeProfile profile
) {
if (age.generationVersion() < AgeDefinition.CURRENT_GENERATION_VERSION) {
if (age.generationVersion() < AgeDefinition.LEGACY_GENERATOR_CUTOFF) {
return legacyBiomeSource(server, age, profile);
}
AgeBiomeSelection selection = age.plan() != null && age.plan().biomeSelection() != null
? age.plan().biomeSelection()
: AgeBiomeSelection.compile(net.dnorberg.rivencraft.writing.WritingGrammar.parse(OrderedWriting.EMPTY),
age.traits(), profile, age.seed(), server.registryAccess());
age.traits(), profile, age.seed(), server.registryAccess(), age.randomPagePolicy());
var registry = server.registryAccess().lookupOrThrow(Registries.BIOME);
List<Holder<Biome>> biomes = new ArrayList<>();
List<ResourceLocation> fallbacks = AgeBiomeSelection.eligible(server.registryAccess(), profile);
@@ -493,7 +562,9 @@ public final class AgeDimensionService {
DimensionType base = server.registryAccess().lookupOrThrow(Registries.DIMENSION_TYPE)
.getOrThrow(ResourceKey.create(Registries.DIMENSION_TYPE, profile.dimensionType())).value();
AgeTraits.Lighting lighting = age.traits().lighting();
boolean hasSkyLight = base.hasSkyLight() && lighting != AgeTraits.Lighting.DARK;
AgeSkyProfile sky = AgeSkyProfile.forAge(age);
boolean hasSkyLight = (base.hasSkyLight() || !sky.bodies().isEmpty())
&& lighting != AgeTraits.Lighting.DARK && !age.caveTerrain();
float ambientLight = lighting == AgeTraits.Lighting.BRIGHT ? 0.25F : 0.0F;
return new DimensionType(
base.fixedTime(),
@@ -508,7 +579,9 @@ public final class AgeDimensionService {
base.height(),
base.logicalHeight(),
base.infiniburn(),
AgeEnvironmentCompiler.skyEffects(age.plan(), base.effectsLocation()),
age.plan() == null && sky.custom()
? AgeEnvironmentCompiler.CUSTOM_SKY_EFFECTS
: AgeEnvironmentCompiler.skyEffects(age.plan(), base.effectsLocation()),
ambientLight,
base.monsterSettings()
);
@@ -2,15 +2,42 @@ package net.dnorberg.rivencraft.book;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.core.BlockPos;
import net.minecraft.core.registries.Registries;
import net.minecraft.resources.ResourceKey;
import net.minecraft.world.level.dimension.BuiltinDimensionTypes;
/** Resolves written environment pages without changing the seeded page-free Age path. */
public final class AgeEnvironmentCompiler {
public static final ResourceLocation CUSTOM_SKY_EFFECTS = ResourceLocation.fromNamespaceAndPath(
"rivencraft", "custom_sky");
private AgeEnvironmentCompiler() {}
public static AgeTraits apply(AgeGenerationPlan plan, AgeTraits seeded) {
if (plan == null) return seeded;
AgeTraits applied;
if (plan.version() >= 4) {
AgeTraits base = applyLegacy(plan, seeded);
CelestialWriting ordered = orderedCelestial(plan, seeded);
applied = new AgeTraits(base.biomeDistribution(), base.lighting(), base.weather(),
ordered.period(), base.celestialAngle(), ordered.phase());
} else {
applied = applyLegacy(plan, seeded);
}
AgeSkyProfile.compile(plan, applied);
return forTerrain(applied, plan.runtimeProfile());
}
/** Cave terrain has no exposed weather or meaningful sky clock, even with authored pages. */
public static AgeTraits forTerrain(AgeTraits traits, AgeRuntimeProfile profile) {
if (!AgeBiomeSelection.isCave(profile)) return traits;
return new AgeTraits(traits.biomeDistribution(), traits.lighting(), AgeTraits.Weather.OFF,
1.0D, 0.0F, 0.0F);
}
/** Version-3 plans keep their frozen, stage-sorted environment interpretation. */
private static AgeTraits applyLegacy(AgeGenerationPlan plan, AgeTraits seeded) {
AgeTraits.Lighting lighting = seeded.lighting();
AgeTraits.Weather weather = seeded.weather();
double period = seeded.celestialPeriod();
@@ -47,8 +74,7 @@ public final class AgeEnvironmentCompiler {
phaseDegrees = writtenPhase ? circularMidpoint(phaseDegrees, next) : next;
writtenPhase = true;
}
case ANGLE_MODIFIER -> throw new IllegalArgumentException(
"Sun angle pages require a custom sky renderer and are not supported yet");
case ANGLE_MODIFIER -> { } // Consumed by the next independently rendered celestial.
default -> { }
}
}
@@ -61,6 +87,8 @@ public final class AgeEnvironmentCompiler {
/** Vanilla effects are the sky styles the current renderer can honor exactly. */
public static ResourceLocation skyEffects(AgeGenerationPlan plan, ResourceLocation fallback) {
if (plan == null) return fallback;
if (skyColor(plan) != -1 || staticSky(plan) || AgeSkyProfile.hasCustomCelestials(plan))
return CUSTOM_SKY_EFFECTS;
return plan.activeSymbols().stream()
.filter(symbol -> symbol.semantics().role() == SymbolSemantics.Role.SKY)
.map(symbol -> ((SymbolSemantics.ChoiceValue) symbol.semantics().value()).id())
@@ -72,11 +100,92 @@ public final class AgeEnvironmentCompiler {
}).findFirst().orElse(fallback);
}
public static boolean staticSky(AgeGenerationPlan plan) {
return plan != null && plan.activeSymbols().stream().anyMatch(symbol ->
symbol.semantics().role() == SymbolSemantics.Role.SKY
&& ((SymbolSemantics.ChoiceValue) symbol.semantics().value()).id().equals("static"));
}
/** An authored color is fixed; -1 means the biome or selected vanilla sky supplies it. */
public static int skyColor(AgeGenerationPlan plan) {
return AgeSkyProfile.authoredSkyColor(plan);
}
public static int selectedSkyColor(AgeGenerationPlan plan, ResourceLocation fallback, int biomeSkyColor) {
int authored = skyColor(plan);
if (authored != -1) return authored;
if (staticSky(plan)) return 0xFF929292;
ResourceLocation effects = skyEffects(plan, fallback);
return previewSkyColor(effects, biomeSkyColor);
}
/** Shared server answer for book previews and the fallback crystal portal surface. */
public static int previewSkyColor(ServerLevel level, BlockPos origin) {
int biomeColor = level.getBiome(origin).value().getSkyColor();
var age = AgeRegistrySavedData.get(level).definitions().stream()
.filter(candidate -> AgeDimensionService.dimensionKey(candidate).equals(level.dimension()))
.findFirst();
if (age.isEmpty()) return previewSkyColor(level.dimensionType().effectsLocation(), biomeColor);
var definition = age.orElseThrow();
AgeSkyProfile sky = AgeSkyProfile.forAge(definition);
if (definition.plan() == null && definition.generationVersion() >= AgeSkyProfile.RANDOM_SKY_GENERATION_VERSION) {
if (sky.color() != -1) return sky.color();
if (sky.style() == AgeSkyProfile.Style.STATIC) return 0xFF929292;
}
var profile = definition.plan() == null
? AgeRuntimeProfiles.resolve(definition.generationProfile())
: definition.plan().runtimeProfile();
ResourceLocation baseEffects = level.getServer().registryAccess()
.lookupOrThrow(Registries.DIMENSION_TYPE)
.getOrThrow(ResourceKey.create(Registries.DIMENSION_TYPE, profile.dimensionType()))
.value().effectsLocation();
return selectedSkyColor(definition.plan(), baseEffects, biomeColor);
}
public static boolean hasWrittenPhase(AgeGenerationPlan plan) {
return plan != null && plan.activeSymbols().stream()
if (plan == null) return false;
if (plan.version() >= 4) return orderedCelestial(plan, null).writtenPhase();
return plan.activeSymbols().stream()
.anyMatch(symbol -> symbol.semantics().role() == SymbolSemantics.Role.PHASE_MODIFIER);
}
private static CelestialWriting orderedCelestial(AgeGenerationPlan plan, AgeTraits seeded) {
double period = seeded == null ? 1.0D : seeded.celestialPeriod();
float phase = seeded == null ? 0.0F : seeded.celestialPhase();
Double pendingPeriod = null;
Float pendingPhase = null;
boolean writtenPhase = false;
Double pendingNumber = null;
for (AgeGenerationPlan.ResolvedSymbol symbol : plan.symbols()) {
SymbolSemantics semantics = symbol.semantics();
Double number = pendingNumber;
if (semantics.role() != SymbolSemantics.Role.COLOR_NUMBER) pendingNumber = null;
switch (semantics.role()) {
case COLOR_NUMBER -> pendingNumber = ((SymbolSemantics.NumberValue) semantics.value()).amount();
case PERIOD_MODIFIER -> {
double next = CelestialPageValues.value(semantics, number);
pendingPeriod = pendingPeriod == null ? next : (pendingPeriod + next) / 2.0D;
}
case PHASE_MODIFIER -> {
float next = (float) CelestialPageValues.value(semantics, number);
pendingPhase = pendingPhase == null ? next : circularMidpoint(pendingPhase, next);
}
case CELESTIAL -> {
period = pendingPeriod == null ? 1.0D : pendingPeriod;
phase = pendingPhase == null ? (seeded == null ? 0.0F : seeded.celestialPhase())
: pendingPhase / 360.0F;
writtenPhase = pendingPhase != null;
pendingPeriod = null;
pendingPhase = null;
}
default -> { }
}
}
return new CelestialWriting(period, phase, writtenPhase);
}
private record CelestialWriting(double period, float phase, boolean writtenPhase) { }
public static int previewSkyColor(ResourceLocation effects, int biomeSkyColor) {
if (effects.equals(BuiltinDimensionTypes.NETHER_EFFECTS)) return 0xFF6B2725;
if (effects.equals(BuiltinDimensionTypes.END_EFFECTS)) return 0xFF211835;
@@ -60,6 +60,9 @@ public final class AgeEnvironmentalProviders {
if (!AgeInstabilityRuntime.isAgeDimension(level.dimension().location())) return -1;
AgeDefinition age = AgeRegistrySavedData.get(level).findByDimension(level.dimension().location()).orElse(null);
if (age == null) return -1;
if (!RivencraftConfig.instabilityEnabled() || !AgeInstabilityControls.get(level).enabled(age.id())
|| !RivencraftConfig.instabilityProviderEnabled(ResourceLocation.fromNamespaceAndPath(
Rivencraft.MOD_ID, effect.equals("meteor") ? "meteors" : effect))) return 0;
List<ChunkPos> chunks = AgeHazardProviders.loadedChunksNearPlayers(level, 16);
if (chunks.isEmpty()) return 0;
var context = new AgeInstabilityRuntime.Context(level, age, chunks,
@@ -77,7 +80,7 @@ public final class AgeEnvironmentalProviders {
}
case "erosion" -> {
if (!RivencraftConfig.erosionEnabled() || !AgeHazardProviders.canMutate(level)
|| age.instability().score() < InstabilityProviderCatalog.Deck.DESTRUCTIVE.entryCost()
|| AgeBlockInstability.effectiveScore(level, age) < InstabilityProviderCatalog.Deck.DESTRUCTIVE.entryCost()
|| !(player.pick(6.0, 0.0F, false) instanceof BlockHitResult hit)) yield 0;
BlockPos pos = hit.getBlockPos();
yield erodeAt(context, pos) ? 1 : 0;
@@ -90,11 +93,12 @@ public final class AgeEnvironmentalProviders {
return METEORS.equals(id) || BURNING.equals(id) || EROSION.equals(id);
}
static void tickPlanned(ServerLevel level, AgeDefinition age, long tick) {
List<AgeInstabilityPlan.ProviderLevel> cards = age.instabilityPlan().providers().stream()
static void tickPlanned(ServerLevel level, AgeDefinition age, long tick,
List<AgeInstabilityPlan.ProviderLevel> providers) {
List<AgeInstabilityPlan.ProviderLevel> cards = providers.stream()
.filter(card -> isEnvironmental(card.id())).toList();
boolean optInErosion = RivencraftConfig.erosionEnabled()
&& age.instability().score() >= InstabilityProviderCatalog.Deck.DESTRUCTIVE.entryCost();
&& AgeBlockInstability.effectiveScore(level, age) >= InstabilityProviderCatalog.Deck.DESTRUCTIVE.entryCost();
if (cards.isEmpty() && !optInErosion) return;
List<ChunkPos> chunks = AgeHazardProviders.loadedChunksNearPlayers(level,
RivencraftConfig.hazardsMaxChunks());
@@ -165,7 +169,8 @@ public final class AgeEnvironmentalProviders {
return;
}
AgeDefinition age = AgeRegistrySavedData.get(level).findByDimension(level.dimension().location()).orElse(null);
if (age == null) {
if (age == null || !AgeInstabilityControls.get(level).enabled(age.id())
|| !RivencraftConfig.instabilityProviderEnabled(METEORS)) {
ACTIVE.remove(level);
return;
}
@@ -10,6 +10,7 @@ import java.util.Map;
import java.util.Optional;
import java.util.Random;
import net.dnorberg.rivencraft.writing.BlockSymbolPages;
import net.dnorberg.rivencraft.compat.RuinsTemplatePages;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.dnorberg.rivencraft.writing.WritingGrammar;
@@ -157,12 +158,19 @@ public final class AgeFeatureSelection {
/** Page-free Ages roll up to two material features, plus rare Skylands, once at creation. */
public static List<Choice> randomChoices(long ageSeed, AgeRuntimeProfile profile, RegistryAccess registries) {
return randomChoices(ageSeed, profile, registries, RandomPagePolicy.UNRESTRICTED);
}
public static List<Choice> randomChoices(long ageSeed, AgeRuntimeProfile profile, RegistryAccess registries,
RandomPagePolicy policy) {
Random random = new Random(ageSeed ^ 0x4D4154455249414CL);
int count = random.nextInt(3);
List<LegacyRankChoice.Option<ResourceLocation>> features = new ArrayList<>();
for (ResourceLocation id : BLOCK_FEATURES) if (error(id, profile, registries) == null)
for (ResourceLocation id : BLOCK_FEATURES) if (error(id, profile, registries) == null
&& policy.allows(featurePage(id)))
features.add(new LegacyRankChoice.Option<>(id, randomMaterialRank(id)));
for (ResourceLocation id : FLUID_FEATURES) if (error(id, profile, registries) == null)
for (ResourceLocation id : FLUID_FEATURES) if (error(id, profile, registries) == null
&& policy.allows(featurePage(id)))
features.add(new LegacyRankChoice.Option<>(id, randomMaterialRank(id)));
List<Choice> choices = new ArrayList<>();
while (choices.size() < count && !features.isEmpty()) {
@@ -171,23 +179,30 @@ public final class AgeFeatureSelection {
var category = solidFeature(feature)
? BlockSymbolPages.CATEGORY : BlockSymbolPages.FLUID_CATEGORY;
List<ResourceLocation> materials = BlockSymbolPages.availableBlocks(category).stream()
.filter(id -> policy.allows(BlockSymbolPages.symbolId(id)))
.filter(id -> materialError(new Choice(feature, Optional.of(id))) == null).toList();
if (!materials.isEmpty()) choices.add(new Choice(feature,
Optional.of(materials.get(random.nextInt(materials.size())))));
}
if (profile.terrain() == AgeRuntimeProfile.Terrain.NOISE
&& policy.allows(featurePage(id("skylands")))
&& Math.floorMod(mix(ageSeed ^ RANDOM_SKYLANDS_SALT), 8) == 0)
choices.add(new Choice(id("skylands"), Optional.empty()));
if (error(CRYSTAL_FORMATIONS, profile, registries) == null && random.nextInt(10) == 0)
if (error(CRYSTAL_FORMATIONS, profile, registries) == null
&& policy.allows(featurePage(CRYSTAL_FORMATIONS)) && random.nextInt(10) == 0)
choices.add(new Choice(CRYSTAL_FORMATIONS, Optional.empty()));
if (randomStarFissure(ageSeed))
if (policy.allows(featurePage(STAR_FISSURES)) && randomStarFissure(ageSeed))
choices.add(new Choice(STAR_FISSURES, Optional.empty()));
AgeBiomeSelection biomes = AgeBiomeSelection.compile(WritingGrammar.parse(OrderedWriting.EMPTY),
AgeTraits.select(ageSeed), profile, ageSeed, registries);
choices.addAll(AgeStructureSelection.randomChoices(ageSeed, profile, biomes, registries));
AgeTraits.select(ageSeed, policy), profile, ageSeed, registries, policy);
choices.addAll(AgeStructureSelection.randomChoices(ageSeed, profile, biomes, registries, policy));
return List.copyOf(choices);
}
private static ResourceLocation featurePage(ResourceLocation id) {
return ResourceLocation.fromNamespaceAndPath("rivencraft", "feature/" + id.getPath());
}
static int randomMaterialRank(ResourceLocation feature) {
if (feature.equals(id("surface_lakes")) || feature.equals(id("deep_lakes"))) return 1;
if (feature.equals(id("lava_lakes"))) return 2; // New separate fluid choice.
@@ -235,6 +250,9 @@ public final class AgeFeatureSelection {
}
public static String error(ResourceLocation choice, AgeRuntimeProfile profile, RegistryAccess registries) {
if (RuinsTemplatePages.isSymbol(choice))
return RuinsTemplatePages.contains(choice) ? null : "Ruins template " + choice
+ " is unavailable; restore Ruins and its template before loading this Age";
if (AgeStructureSelection.feature(choice))
return AgeStructureSelection.error(choice, profile, null, registries);
if (choice.equals(AgeDenseOres.ID))
@@ -1,8 +1,12 @@
package net.dnorberg.rivencraft.book;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
@@ -18,7 +22,7 @@ import net.minecraft.resources.ResourceLocation;
public record AgeGenerationPlan(int version, long ageSeed, OrderedWriting writing, List<ResolvedSymbol> symbols,
AgeRuntimeProfile runtimeProfile, AgeBiomeSelection biomeSelection,
List<Integer> activeSymbolIndices, int writingInstability) {
public static final int CURRENT_VERSION = 3;
public static final int CURRENT_VERSION = 4;
public AgeGenerationPlan {
if (version < 1 || version > CURRENT_VERSION) {
@@ -44,11 +48,14 @@ public record AgeGenerationPlan(int version, long ageSeed, OrderedWriting writin
if (version >= 3 && !symbols.isEmpty() && activeSymbolIndices.isEmpty()) {
throw new IllegalArgumentException("Version 3 Age plan has no active symbols");
}
if (activeSymbolIndices.stream().distinct().count() != activeSymbolIndices.size()) {
throw new IllegalArgumentException("Age plan repeats an active symbol index");
}
Set<Integer> resolvedIndices = new HashSet<>();
for (ResolvedSymbol symbol : symbols) resolvedIndices.add(symbol.index());
Set<Integer> seenActive = new HashSet<>();
for (int index : activeSymbolIndices) {
if (symbols.stream().noneMatch(symbol -> symbol.index() == index)) {
if (!seenActive.add(index)) {
throw new IllegalArgumentException("Age plan repeats an active symbol index");
}
if (!resolvedIndices.contains(index)) {
throw new IllegalArgumentException("Active symbol is not in the saved writing: " + index);
}
}
@@ -107,8 +114,13 @@ public record AgeGenerationPlan(int version, long ageSeed, OrderedWriting writin
}
public List<ResolvedSymbol> activeSymbols() {
return activeSymbolIndices.stream().map(index -> symbols.stream()
.filter(symbol -> symbol.index() == index).findFirst().orElseThrow()).toList();
Map<Integer, ResolvedSymbol> byIndex = new HashMap<>(symbols.size());
for (ResolvedSymbol symbol : symbols) byIndex.putIfAbsent(symbol.index(), symbol);
return activeSymbolIndices.stream().map(index -> {
ResolvedSymbol symbol = byIndex.get(index);
if (symbol == null) throw new IllegalStateException("Missing active symbol " + index);
return symbol;
}).toList();
}
public CompoundTag save() {
@@ -176,7 +188,7 @@ public record AgeGenerationPlan(int version, long ageSeed, OrderedWriting writin
String raw = item.getString("Value");
SymbolSemantics.Value value = switch (role) {
case TERRAIN, BIOME, BLOCK, FEATURE -> new SymbolSemantics.ResourceValue(ResourceLocation.parse(raw));
case PERIOD_MODIFIER, ANGLE_MODIFIER, PHASE_MODIFIER ->
case PERIOD_MODIFIER, ANGLE_MODIFIER, PHASE_MODIFIER, SIZE_MODIFIER, COLOR_NUMBER ->
new SymbolSemantics.NumberValue(Double.parseDouble(raw));
default -> new SymbolSemantics.ChoiceValue(raw);
};
@@ -8,6 +8,7 @@ import java.util.Optional;
import java.util.Random;
import java.util.Set;
import java.util.UUID;
import java.util.function.Predicate;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.config.RivencraftConfig;
import net.minecraft.core.BlockPos;
@@ -54,9 +55,10 @@ public final class AgeHazardProviders {
}
/** Roll every selected hazard card each scheduler pass, independently of other providers. */
static void tickPlanned(ServerLevel level, AgeDefinition age, long tick) {
static void tickPlanned(ServerLevel level, AgeDefinition age, long tick,
List<AgeInstabilityPlan.ProviderLevel> providers) {
if (!RivencraftConfig.hazardsEnabled()) return;
List<AgeInstabilityPlan.ProviderLevel> hazards = age.instabilityPlan().providers().stream()
List<AgeInstabilityPlan.ProviderLevel> hazards = providers.stream()
.filter(provider -> isHazard(provider.id())).toList();
if (hazards.isEmpty()) return;
List<ChunkPos> chunks = loadedChunksNearPlayers(level, RivencraftConfig.hazardsMaxChunks());
@@ -69,18 +71,27 @@ public final class AgeHazardProviders {
}
static List<ChunkPos> loadedChunksNearPlayers(ServerLevel level, int maximum) {
List<ChunkPos> players = level.players().stream()
.sorted(Comparator.comparing(Entity::getUUID))
.map(ServerPlayer::chunkPosition).toList();
return candidateChunks(players, maximum,
chunk -> level.getChunkSource().hasChunk(chunk.x, chunk.z));
}
/** Pure candidate selection; the caller's predicate must only report already-loaded chunks. */
static List<ChunkPos> candidateChunks(List<ChunkPos> players, int maximum,
Predicate<ChunkPos> loaded) {
if (maximum <= 0) return List.of();
Set<ChunkPos> chunks = new LinkedHashSet<>();
List<ServerPlayer> players = level.players().stream()
.sorted(Comparator.comparing(Entity::getUUID)).toList();
for (int radius = 0; radius <= 4; radius++) {
for (int dx = -radius; dx <= radius; dx++) {
for (int dz = -radius; dz <= radius; dz++) {
if (Math.max(Math.abs(dx), Math.abs(dz)) != radius) continue;
for (ServerPlayer player : players) {
ChunkPos center = player.chunkPosition();
for (ChunkPos center : players) {
int x = center.x + dx;
int z = center.z + dz;
if (level.getChunkSource().hasChunk(x, z)) chunks.add(new ChunkPos(x, z));
ChunkPos candidate = new ChunkPos(x, z);
if (loaded.test(candidate)) chunks.add(candidate);
if (chunks.size() >= maximum) return List.copyOf(chunks);
}
}
@@ -96,6 +107,8 @@ public final class AgeHazardProviders {
|| !AgeInstabilityRuntime.isAgeDimension(level.dimension().location())) return -1;
AgeDefinition age = AgeRegistrySavedData.get(level).findByDimension(level.dimension().location()).orElse(null);
if (age == null) return -1;
if (!RivencraftConfig.instabilityEnabled() || !AgeInstabilityControls.get(level).enabled(age.id())
|| !RivencraftConfig.instabilityProviderEnabled(lightning ? LIGHTNING : EXPLOSIONS)) return -1;
AgeHazardSavedData data = AgeHazardSavedData.get(level);
if (!data.ready(lightning, level.getGameTime(), RivencraftConfig.hazardsMinInterval())) return 0;
ChunkPos center = player.chunkPosition();
@@ -198,7 +211,8 @@ public final class AgeHazardProviders {
static void explodeBounded(ServerLevel level, AgeDefinition age, ChunkPos chunk, BlockPos pos,
boolean blockDamage, boolean playerDamage, boolean ignite, int maxBlocks, int maxEntities,
int maxDamage, int radius) {
boolean grief = canMutate(level) && blockDamage && maxBlocks > 0;
boolean grief = destructiveBlocksAllowed(RivencraftConfig.instabilityWorldMutation(),
level.getGameRules().getBoolean(GameRules.RULE_MOBGRIEFING), blockDamage, maxBlocks);
boolean fire = grief && ignite
&& level.getGameRules().getBoolean(GameRules.RULE_DOFIRETICK);
Explosion explosion = level.explode(null, null, new BoundedExplosion(level, age, chunk, grief,
@@ -237,6 +251,19 @@ public final class AgeHazardProviders {
&& level.getGameRules().getBoolean(GameRules.RULE_MOBGRIEFING);
}
static boolean destructiveBlocksAllowed(boolean worldMutation, boolean mobGriefing,
boolean blockDamage, int maxBlocks) {
return worldMutation && mobGriefing && blockDamage && maxBlocks > 0;
}
static boolean protectedBlock(ServerLevel level, AgeDefinition age, BlockPos pos, BlockState state) {
return state.isAir() || state.hasBlockEntity() || state.is(Blocks.TNT)
|| state.is(AgeDecayProviders.PROTECTED) || state.is(BlockTags.PORTALS)
|| AgeDecayProviders.isSpawnProtected(age, pos)
|| state.getDestroySpeed(level, pos) < 0
|| BuiltInRegistries.BLOCK.getKey(state.getBlock()).getNamespace().equals(Rivencraft.MOD_ID);
}
private static boolean eligibleEntity(Entity entity) {
return eligibleEntity(entity, RivencraftConfig.hazardsPlayerDamage());
}
@@ -285,12 +312,7 @@ public final class AgeHazardProviders {
@Override
public boolean shouldBlockExplode(Explosion explosion, BlockGetter reader, BlockPos pos,
BlockState state, float power) {
if (!grief || !inLoadedChunk(pos) || state.isAir() || state.hasBlockEntity()
|| state.is(Blocks.TNT)
|| state.is(AgeDecayProviders.PROTECTED) || state.is(BlockTags.PORTALS)
|| AgeDecayProviders.isSpawnProtected(age, pos)
|| state.getDestroySpeed(level, pos) < 0
|| BuiltInRegistries.BLOCK.getKey(state.getBlock()).getNamespace().equals(Rivencraft.MOD_ID)) return false;
if (!grief || !inLoadedChunk(pos) || protectedBlock(level, age, pos, state)) return false;
if (approved.contains(pos)) return true;
if (approved.size() >= maxBlocks) return false;
var actor = FakePlayerFactory.getMinecraft(level);
@@ -6,6 +6,7 @@ import java.util.List;
import java.util.Map;
import java.util.Objects;
import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.dnorberg.rivencraft.compat.RuinsTemplatePages;
import net.minecraft.core.RegistryAccess;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.nbt.ListTag;
@@ -13,8 +14,9 @@ import net.minecraft.resources.ResourceLocation;
/** Frozen, server-owned score. Only new Age creation consults the current symbol catalog. */
public record AgeInstability(int version, int score, List<Contribution> breakdown) {
public static final int CURRENT_VERSION = 1;
public static final int CURRENT_VERSION = 2;
private static final int BRIGHT_LIGHTING_COST = 500;
private static final int INEFFECTIVE_CAVE_PAGE_COST = 100;
private static final int EXCESS_LEGACY_STRUCTURE_COST = 100;
private static final int FORCED_STRUCTURE_BIOME_COST = 100;
private static final Map<ResourceLocation, String> COUNTED_STRUCTURES = Map.ofEntries(
@@ -35,7 +37,8 @@ public record AgeInstability(int version, int score, List<Contribution> breakdow
);
public AgeInstability {
if (version != CURRENT_VERSION) throw new IllegalArgumentException("Unsupported instability version " + version);
if (version < 1 || version > CURRENT_VERSION)
throw new IllegalArgumentException("Unsupported instability version " + version);
breakdown = List.copyOf(breakdown);
if (score < 0 || score != breakdown.stream().mapToInt(Contribution::points).sum()) {
throw new IllegalArgumentException("Instability score does not match breakdown");
@@ -44,24 +47,40 @@ public record AgeInstability(int version, int score, List<Contribution> breakdow
/** Pre-scoring saves are explicitly neutral, never rescored from current data packs. */
public static AgeInstability legacyNeutral() {
return new AgeInstability(CURRENT_VERSION, 0,
return new AgeInstability(1, 0,
List.of(new Contribution("legacy_neutral", -1, 0, "Age predates frozen instability scoring")));
}
static AgeInstability compute(AgeGenerationPlan plan, AgeTraits traits, RegistryAccess registries) {
return compute(plan, traits, registries, Long.MIN_VALUE);
}
static AgeInstability compute(AgeGenerationPlan plan, AgeTraits traits, RegistryAccess registries, long ageSeed) {
return compute(plan, traits, registries, ageSeed, RandomPagePolicy.UNRESTRICTED);
}
static AgeInstability compute(AgeGenerationPlan plan, AgeTraits traits, RegistryAccess registries,
long ageSeed, RandomPagePolicy policy) {
Objects.requireNonNull(traits, "traits");
List<Contribution> contributions = new ArrayList<>();
if (plan == null) {
contributions.add(new Contribution("random_baseline", -1, 0, "Page-free or Link-Panel-only Age"));
} else {
contributions.add(new Contribution("authored_baseline", -1, 0, "Authored Age"));
WritingGrammar.Result parsed = WritingGrammar.parse(plan.writing());
if (!parsed.canCreate() || parsed.writingInstability() != plan.writingInstability()) {
throw new IllegalArgumentException("Writing changed between Age compilation and scoring");
}
for (WritingGrammar.Diagnostic diagnostic : parsed.diagnostics()) {
contributions.add(new Contribution(diagnostic.code().name().toLowerCase(java.util.Locale.ROOT),
diagnostic.index(), diagnostic.instability(), diagnostic.message()));
if (plan.version() < 4) {
// An old plan's writing cost was frozen under the previous grammar.
// Never validate it against the new ordered-modifier interpretation.
contributions.add(new Contribution("legacy_writing", -1, plan.writingInstability(),
"Writing cost frozen by the original Age plan"));
} else {
WritingGrammar.Result parsed = WritingGrammar.parse(plan.writing());
if (!parsed.canCreate() || parsed.writingInstability() != plan.writingInstability()) {
throw new IllegalArgumentException("Writing changed between Age compilation and scoring");
}
for (WritingGrammar.Diagnostic diagnostic : parsed.diagnostics()) {
contributions.add(new Contribution(diagnostic.code().name().toLowerCase(java.util.Locale.ROOT),
diagnostic.index(), diagnostic.instability(), diagnostic.message()));
}
}
addAuditedSymbolCosts(plan, registries, contributions);
}
@@ -73,6 +92,17 @@ public record AgeInstability(int version, int score, List<Contribution> breakdow
contributions.add(new Contribution("bright_lighting", -1, BRIGHT_LIGHTING_COST,
"Seeded bright lighting"));
}
AgeSkyProfile sky = plan == null && ageSeed != Long.MIN_VALUE ? AgeSkyProfile.random(ageSeed, traits, policy)
: plan == null ? new AgeSkyProfile(AgeSkyProfile.Style.INHERITED, -1, List.of())
: AgeSkyProfile.compile(plan, traits);
int seenSuns = 0;
for (AgeSkyProfile.Body body : sky.bodies()) {
if (body.kind() != AgeSkyProfile.Kind.SUN) continue;
if (++seenSuns <= 2) continue;
int points = 1000 * (seenSuns - 2);
contributions.add(new Contribution("extra_sun", -1, points,
"Sun " + seenSuns + " adds growing instability"));
}
return new AgeInstability(CURRENT_VERSION,
contributions.stream().mapToInt(Contribution::points).sum(), contributions);
}
@@ -80,7 +110,38 @@ public record AgeInstability(int version, int score, List<Contribution> breakdow
private static void addAuditedSymbolCosts(AgeGenerationPlan plan, RegistryAccess registries,
List<Contribution> contributions) {
Map<ResourceLocation, Integer> structureCounts = new HashMap<>();
boolean cave = AgeBiomeSelection.isCave(plan.runtimeProfile());
for (AgeGenerationPlan.ResolvedSymbol symbol : plan.symbols()) {
if (cave) {
var role = symbol.semantics().role();
if (switch (role) {
case WEATHER, SEASON, CELESTIAL, PERIOD_MODIFIER, PHASE_MODIFIER,
ANGLE_MODIFIER, DIRECTION_MODIFIER -> true;
default -> false;
}) {
contributions.add(new Contribution("cave_ignored_" + role.id(), symbol.index(),
INEFFECTIVE_CAVE_PAGE_COST,
"Sky or weather page has no effect in Cave terrain"));
}
}
if (symbol.semantics().role()
== net.dnorberg.rivencraft.writing.SymbolSemantics.Role.ENVIRONMENT
&& symbol.semantics().value()
instanceof net.dnorberg.rivencraft.writing.SymbolSemantics.ChoiceValue choice
&& choice.id().equals("accelerated")) {
contributions.add(new Contribution("accelerated", symbol.index(), 1000,
"Authored accelerated random ticks"));
continue;
}
if (symbol.semantics().role()
== net.dnorberg.rivencraft.writing.SymbolSemantics.Role.CORRUPTED) {
String size = ((net.dnorberg.rivencraft.writing.SymbolSemantics.ChoiceValue)
symbol.semantics().value()).id();
int cost = corruptedCost(size);
contributions.add(new Contribution("corrupted_" + size, symbol.index(), cost,
"Legacy corrupted " + size + " feature page"));
continue;
}
if (symbol.semantics().role()
== net.dnorberg.rivencraft.writing.SymbolSemantics.Role.LIGHTING
&& symbol.semantics().value()
@@ -95,9 +156,12 @@ public record AgeInstability(int version, int score, List<Contribution> breakdow
|| !(symbol.semantics().value()
instanceof net.dnorberg.rivencraft.writing.SymbolSemantics.ResourceValue resource)) continue;
String name = COUNTED_STRUCTURES.get(resource.id());
if (name == null && RuinsTemplatePages.isSymbol(resource.id()))
name = RuinsTemplatePages.fallbackName(resource.id());
if (name == null) continue;
int count = structureCounts.merge(resource.id(), 1, Integer::sum);
if (AgeStructureSelection.requiresBiomeOverride(resource.id(), plan.biomeSelection(), registries)) {
if (COUNTED_STRUCTURES.containsKey(resource.id())
&& AgeStructureSelection.requiresBiomeOverride(resource.id(), plan.biomeSelection(), registries)) {
contributions.add(new Contribution("forced_biome_" + resource.id().getPath(), symbol.index(),
FORCED_STRUCTURE_BIOME_COST,
name + " occurrence " + count + " is forced into an unsupported biome"));
@@ -113,10 +177,19 @@ public record AgeInstability(int version, int score, List<Contribution> breakdow
static int featureCost(ResourceLocation feature, int occurrence) {
if (occurrence < 1) throw new IllegalArgumentException("Feature occurrence must be positive");
return COUNTED_STRUCTURES.containsKey(feature) && occurrence > 3
return (COUNTED_STRUCTURES.containsKey(feature) || RuinsTemplatePages.isSymbol(feature)) && occurrence > 3
? EXCESS_LEGACY_STRUCTURE_COST : 0;
}
static int corruptedCost(String size) {
return switch (size) {
case "large" -> 0;
case "medium" -> 1000;
case "small" -> 2000;
default -> throw new IllegalArgumentException("Unknown corrupted page size " + size);
};
}
/** Current totals exposed to diagnostics. Player-driven mutable bonuses are deliberately disabled. */
public Totals totals() {
return new Totals(score, 0, 0, score);
@@ -0,0 +1,55 @@
package net.dnorberg.rivencraft.book;
import java.util.HashSet;
import java.util.Set;
import java.util.UUID;
import net.minecraft.core.HolderLookup;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.nbt.ListTag;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.util.datafix.DataFixTypes;
import net.minecraft.world.level.saveddata.SavedData;
/** Per-world operator overrides. Absence means enabled; scores and plans stay immutable. */
public final class AgeInstabilityControls extends SavedData {
private static final String DATA_NAME = "rivencraft_instability_controls";
private static final Factory<AgeInstabilityControls> FACTORY = new Factory<>(
AgeInstabilityControls::new, AgeInstabilityControls::load, DataFixTypes.SAVED_DATA_MAP_DATA);
private final Set<UUID> disabled = new HashSet<>();
public static AgeInstabilityControls get(ServerLevel level) {
return level.getServer().overworld().getDataStorage().computeIfAbsent(FACTORY, DATA_NAME);
}
public boolean enabled(UUID ageId) {
return !disabled.contains(ageId);
}
public boolean setEnabled(UUID ageId, boolean enabled) {
boolean changed = enabled ? disabled.remove(ageId) : disabled.add(ageId);
if (changed) setDirty();
return changed;
}
static AgeInstabilityControls load(CompoundTag tag, HolderLookup.Provider registries) {
AgeInstabilityControls controls = new AgeInstabilityControls();
ListTag entries = tag.getList("DisabledAges", CompoundTag.TAG_COMPOUND);
for (int index = 0; index < entries.size(); index++) {
CompoundTag entry = entries.getCompound(index);
if (entry.hasUUID("Id")) controls.disabled.add(entry.getUUID("Id"));
}
return controls;
}
@Override
public CompoundTag save(CompoundTag tag, HolderLookup.Provider registries) {
ListTag entries = new ListTag();
disabled.stream().sorted().forEach(id -> {
CompoundTag entry = new CompoundTag();
entry.putUUID("Id", id);
entries.add(entry);
});
tag.put("DisabledAges", entries);
return tag;
}
}
@@ -38,8 +38,11 @@ public final class AgeInstabilityRuntime {
}
public static void onLevelTickPost(LevelTickEvent.Post event) {
if (!(event.getLevel() instanceof ServerLevel level) || !RivencraftConfig.instabilityEnabled()
if (!(event.getLevel() instanceof ServerLevel level)
|| !isAgeDimension(level.dimension().location()) || level.players().isEmpty()) return;
// Authored environmental pages are active Age rules, not selected instability cards.
AgeAcceleratedTicks.tick(level);
if (!RivencraftConfig.instabilityEnabled()) return;
MinecraftServer server = level.getServer();
long tick = server.getTickCount();
int cooldown = RivencraftConfig.instabilityCooldown();
@@ -52,15 +55,16 @@ public final class AgeInstabilityRuntime {
if (!admitted(state.eligible, level.dimension().location(), tick / cooldown,
RivencraftConfig.instabilityMaxAges())) return;
AgeDefinition age = AgeRegistrySavedData.get(level).findByDimension(level.dimension().location()).orElse(null);
if (age == null || age.instabilityPlan().providers().isEmpty()) return;
if (age == null || !AgeInstabilityControls.get(level).enabled(age.id())) return;
List<AgeInstabilityPlan.ProviderLevel> providers = AgeBlockInstability.effectivePlan(level, age).providers();
if (providers.isEmpty()) return;
// Legacy's per-chunk hazards must not wait for the rotating two-provider sample.
AgeHazardProviders.tickPlanned(level, age, tick);
AgeEnvironmentalProviders.tickPlanned(level, age, tick);
AgeHazardProviders.tickPlanned(level, age, tick, providers);
AgeEnvironmentalProviders.tickPlanned(level, age, tick, providers);
List<ChunkPos> chunks = loadedChunksNearPlayers(level, RivencraftConfig.instabilityMaxChunks());
if (chunks.isEmpty()) return;
Budget budget = new Budget(RivencraftConfig.instabilityMaxActions());
Context context = new Context(level, age, chunks, tick, budget);
List<AgeInstabilityPlan.ProviderLevel> providers = age.instabilityPlan().providers();
int first = (int) Math.floorMod(tick / cooldown + age.seed(), providers.size());
int ran = 0;
for (int offset = 0; offset < providers.size() && ran < RivencraftConfig.instabilityMaxProviders()
@@ -74,6 +78,8 @@ public final class AgeInstabilityRuntime {
/** Shared handler guard, including quarantine, for rotating and per-chunk provider lanes. */
static boolean invoke(Context context, ResourceLocation id, int level) {
if (!RivencraftConfig.instabilityEnabled()
|| !AgeInstabilityControls.get(context.level()).enabled(context.age().id())) return false;
Handler handler = HANDLERS.get(id);
if (handler == null) {
if (!InstabilityProviderCatalog.contains(id) && UNKNOWN_LOGGED.add(id)) {
@@ -81,7 +87,8 @@ public final class AgeInstabilityRuntime {
}
return false;
}
if (handler.worldMutating() && !RivencraftConfig.instabilityWorldMutation()) return false;
if (!policyAllowsProvider(RivencraftConfig.instabilityProviderEnabled(id),
RivencraftConfig.instabilityWorldMutation(), handler.worldMutating())) return false;
long retryAfter = FAILURES.computeIfAbsent(context.level(), ignored -> new HashMap<>())
.getOrDefault(id, 0L);
if (context.serverTick() < retryAfter) return false;
@@ -107,6 +114,45 @@ public final class AgeInstabilityRuntime {
return id.getNamespace().equals(Rivencraft.MOD_ID) && id.getPath().startsWith("age/");
}
static boolean policyAllowsProvider(boolean providerEnabled, boolean worldMutation,
boolean mutatingHandler) {
return providerEnabled && (!mutatingHandler || worldMutation);
}
/** Current runtime state, distinct from the Age's immutable score and provider selection. */
public static String providerStatus(ServerLevel level, AgeDefinition age, ResourceLocation id) {
if (!RivencraftConfig.instabilityEnabled()) return "global config off";
if (!AgeInstabilityControls.get(level).enabled(age.id())) return "Age disabled";
Handler handler = HANDLERS.get(id);
if (handler == null) return "handler unavailable";
if (!RivencraftConfig.instabilityProviderEnabled(id)) return "provider config off";
if (handler.worldMutating() && !RivencraftConfig.instabilityWorldMutation()) return "world mutation off";
String path = id.getPath();
if (path.startsWith("decay") && !RivencraftConfig.decayEnabled()) return "decay config off";
if ((path.equals("lightning") || path.equals("explosions")) && !RivencraftConfig.hazardsEnabled())
return "hazards config off";
if (path.equals("meteors") && !RivencraftConfig.meteorEnabled()) return "meteor config off";
if (path.equals("burning") && !RivencraftConfig.scorchEnabled()) return "burning config off";
if (path.equals("erosion") && !RivencraftConfig.erosionEnabled()) return "erosion config off";
if (!path.startsWith("decay") && !path.equals("lightning") && !path.equals("explosions")
&& !path.equals("meteors") && !path.equals("burning") && !path.equals("erosion")
&& !path.equals("crumble") && !RivencraftConfig.statusEffectsEnabled())
return "status effects config off";
if (path.startsWith("enemy") && !RivencraftConfig.statusEffectsHostiles())
return "hostile status effects config off";
if (!path.startsWith("enemy") && !path.startsWith("decay") && !path.equals("lightning")
&& !path.equals("explosions") && !path.equals("meteors") && !path.equals("burning")
&& !path.equals("erosion") && !RivencraftConfig.statusEffectsPlayers()
&& !RivencraftConfig.statusEffectsNonplayers())
return "status effect targets disabled";
ServerLevel ageLevel = level.getServer().getLevel(AgeDimensionService.dimensionKey(age));
if (ageLevel == null) return "Age unloaded";
if (ageLevel.players().isEmpty()) return "no players in Age";
long retryAfter = FAILURES.getOrDefault(ageLevel, Map.of()).getOrDefault(id, 0L);
if (ageLevel.getServer().getTickCount() < retryAfter) return "quarantined until tick " + retryAfter;
return "eligible; chance, cooldown, and protection still apply";
}
static boolean admitted(List<ResourceLocation> eligible, ResourceLocation id, long run,
int maximum) {
int index = eligible.indexOf(id);
@@ -121,7 +167,8 @@ public final class AgeInstabilityRuntime {
for (ServerLevel level : server.getAllLevels()) {
ResourceLocation id = level.dimension().location();
if (isAgeDimension(id) && !level.players().isEmpty()
&& registry.findByDimension(id).filter(age -> !age.instabilityPlan().providers().isEmpty())
&& registry.findByDimension(id).filter(age -> !AgeBlockInstability.effectivePlan(level, age).providers().isEmpty())
.filter(age -> AgeInstabilityControls.get(level).enabled(age.id()))
.isPresent()) eligible.add(id);
}
eligible.sort(Comparator.comparing(ResourceLocation::toString));
@@ -59,6 +59,53 @@ public final class AgeInstabilityRuntimeGameTests {
helper.succeed();
}
@GameTest(template = "empty")
public static void perAgeControlsPersistWithoutChangingScoresOrOtherAges(GameTestHelper helper) {
UUID first = UUID.randomUUID();
UUID second = UUID.randomUUID();
AgeInstabilityControls controls = new AgeInstabilityControls();
helper.assertTrue(controls.enabled(first) && controls.enabled(second),
"Ages must be enabled by default");
helper.assertTrue(controls.setEnabled(first, false) && !controls.enabled(first)
&& controls.enabled(second), "Disabling one Age must not change another");
AgeInstabilityControls restored = AgeInstabilityControls.load(
controls.save(new CompoundTag(), helper.getLevel().registryAccess()),
helper.getLevel().registryAccess());
helper.assertTrue(!restored.enabled(first) && restored.enabled(second),
"The per-Age override must survive a save round trip");
helper.assertTrue(restored.setEnabled(first, true) && restored.enabled(first),
"Re-enabling must remove the override");
var oldAge = new AgeDefinition(first, "Old Age", 1L, AgeGenerationProfiles.STANDARD,
AgeDefinition.CURRENT_GENERATION_VERSION, 0L, AgeDefinition.dimensionId(first), null,
AgeTraits.LEGACY_DEFAULTS);
helper.assertValueEqual(oldAge.instability().score(), 0,
"A pre-scoring Age must remain neutral regardless of runtime controls");
helper.assertTrue(oldAge.instabilityPlan().providers().isEmpty(),
"Runtime controls must not generate providers for old Ages");
AgeInstabilityControls live = AgeInstabilityControls.get(helper.getLevel());
live.setEnabled(first, false);
helper.assertValueEqual(AgeInstabilityRuntime.providerStatus(helper.getLevel(), oldAge,
ResourceLocation.parse("rivencraft:poison")), "Age disabled",
"Diagnostics must distinguish an Age override from the saved plan");
live.setEnabled(first, true);
helper.assertValueEqual(AgeInstabilityRuntime.providerStatus(helper.getLevel(), oldAge,
ResourceLocation.parse("example:missing_handler")), "handler unavailable",
"Unknown saved providers must not be reported as active");
helper.succeed();
}
@GameTest(template = "empty")
public static void instabilityControlCommandsRequireOperatorPermission(GameTestHelper helper) {
var server = helper.getLevel().getServer();
var command = server.getCommands().getDispatcher().getRoot().getChild("rivencraft");
helper.assertTrue(command != null, "Rivencraft commands must be registered on a dedicated server");
helper.assertTrue(!command.canUse(server.createCommandSourceStack().withPermission(0))
&& command.canUse(server.createCommandSourceStack().withPermission(2)),
"Non-operators cannot reach Age instability enable/disable commands");
helper.succeed();
}
@GameTest(template = "empty")
public static void ageScopeRotationAndActionBudgetAreBounded(GameTestHelper helper) {
ResourceLocation first = ResourceLocation.parse("rivencraft:age/first");
@@ -23,6 +23,49 @@ public final class AgePersistenceGameTests {
private AgePersistenceGameTests() {
}
@GameTest(template = "empty")
public static void modifierSeedChangePersistsWithoutChangingAgeIdentity(GameTestHelper helper) {
UUID id = UUID.randomUUID();
AgeDefinition original = AgeRegistrySavedData.resolveOrCreate(helper.getLevel(),
new AgeReference(id, "Reseed " + id));
AgeRegistrySavedData registry = AgeRegistrySavedData.get(helper.getLevel());
long newSeed = original.seed() == 987654321L ? 987654322L : 987654321L;
helper.assertTrue(registry.reseed(helper.getLevel().getServer(), id, newSeed),
"An unoccupied Age must accept a new seed");
AgeDefinition changed = registry.find(id).orElseThrow();
helper.assertValueEqual(changed.id(), original.id(), "Reseeding must preserve the Age identity");
helper.assertValueEqual(changed.dimensionId(), original.dimensionId(),
"Reseeding must preserve its dimension and existing chunk location");
helper.assertValueEqual(changed.seed(), newSeed, "The new generator seed must be saved");
AgeDefinition restored = AgeRegistrySavedData.load(
registry.save(new CompoundTag(), helper.getLevel().registryAccess()),
helper.getLevel().registryAccess()).find(id).orElseThrow();
helper.assertValueEqual(restored.seed(), newSeed, "The new seed must survive reload");
var ageLevel = AgeDimensionService.ensureLoaded(helper.getLevel().getServer(), changed);
helper.assertTrue(ageLevel != null, "The reseeded Age must reload");
helper.assertValueEqual(ageLevel.getSeed(), newSeed,
"The runtime level must use the saved seed for new chunks");
helper.succeed();
}
@GameTest(template = "empty")
public static void retiredAgeIdentitySurvivesSaveAndCannotLoad(GameTestHelper helper) {
UUID id = UUID.randomUUID();
AgeReference reference = new AgeReference(id, "Retired " + id);
AgeDefinition age = AgeRegistrySavedData.resolveOrCreate(helper.getLevel(), reference);
AgeRegistrySavedData registry = AgeRegistrySavedData.get(helper.getLevel());
helper.assertTrue(registry.markDead(id), "The first retirement must set the tombstone");
helper.assertTrue(!registry.markDead(id), "Retirement must be idempotent");
helper.assertTrue(AgeDimensionService.ensureLoaded(helper.getLevel().getServer(), age) == null,
"A retired Age must never load from an old book");
AgeRegistrySavedData restored = AgeRegistrySavedData.load(
registry.save(new CompoundTag(), helper.getLevel().registryAccess()),
helper.getLevel().registryAccess());
helper.assertTrue(restored.isDead(id) && restored.find(id).isPresent(),
"Both the retired flag and reserved Age identity must survive reload");
helper.succeed();
}
@GameTest(template = "empty")
public static void authoredPlanRetainsResolvedMeaningAndAgeIdentity(GameTestHelper helper) {
OrderedWriting writing = new OrderedWriting(List.of(
@@ -82,9 +125,9 @@ public final class AgePersistenceGameTests {
new AgeReference(UUID.randomUUID(), "Stable Writing"), stable);
AgeDefinition defectiveAge = AgeRegistrySavedData.resolveOrCreate(helper.getLevel(),
new AgeReference(UUID.randomUUID(), "Defective Writing"), defective);
helper.assertValueEqual(stableAge.instability().score(), 0,
helper.assertValueEqual(nonCelestialInstability(stableAge), 0,
"Missing seeded branches do not add instability");
helper.assertValueEqual(defectiveAge.instability().score(), 600,
helper.assertValueEqual(nonCelestialInstability(defectiveAge), 600,
"Out-of-order and repeated terrain pages each add their saved penalty");
helper.assertTrue(defectiveAge.instability().breakdown().stream()
.anyMatch(part -> part.reason().equals("duplicate") && part.pageIndex() == 3),
@@ -141,9 +184,9 @@ public final class AgePersistenceGameTests {
new AgeReference(UUID.randomUUID(), "Three " + structure), structureWriting(structure, 3));
AgeDefinition four = AgeRegistrySavedData.resolveOrCreate(helper.getLevel(),
new AgeReference(UUID.randomUUID(), "Four " + structure), structureWriting(structure, 4));
helper.assertValueEqual(three.instability().score(), 0,
helper.assertValueEqual(nonCelestialInstability(three), 0,
"The first three " + structure + " pages retain Legacy's zero cost");
helper.assertValueEqual(four.instability().score(), 100,
helper.assertValueEqual(nonCelestialInstability(four), 100,
"The fourth " + structure + " page must add Legacy's 100-point cost");
helper.assertTrue(four.instability().breakdown().stream().anyMatch(part ->
part.reason().equals("excess_" + structure) && part.pageIndex() == 8),
@@ -164,6 +207,13 @@ public final class AgePersistenceGameTests {
"Modern repeated structures must use the same deterministic scoring path");
helper.assertValueEqual(AgeInstability.featureCost(ResourceLocation.parse("rivencraft:dungeons"), 4), 0,
"A Legacy-neutral feature must remain neutral when repeated");
ResourceLocation ruin = net.dnorberg.rivencraft.compat.RuinsTemplatePages.symbolId("ZombieHut.tml");
helper.assertValueEqual(AgeInstability.featureCost(ruin, 1), 0,
"The first Ruins template page is free like a standard structure");
helper.assertValueEqual(AgeInstability.featureCost(ruin, 3), 0,
"The first three copies of a Ruins page are free");
helper.assertValueEqual(AgeInstability.featureCost(ruin, 4), 100,
"Each Ruins page beyond the third adds 100 instability");
OrderedWriting duplicateBright = new OrderedWriting(List.of(
WritingEntry.linkPanel(),
@@ -173,7 +223,7 @@ public final class AgePersistenceGameTests {
));
AgeDefinition bright = AgeRegistrySavedData.resolveOrCreate(helper.getLevel(),
new AgeReference(UUID.randomUUID(), "Double Bright"), duplicateBright);
helper.assertValueEqual(bright.instability().score(), 1500,
helper.assertValueEqual(nonCelestialInstability(bright), 1500,
"Each Bright Lighting page costs 500 and the extra controller costs another 500");
helper.assertValueEqual(bright.instability().breakdown().stream()
.filter(part -> part.reason().equals("bright_lighting")).count(), 2L,
@@ -377,6 +427,13 @@ public final class AgePersistenceGameTests {
helper.succeed();
}
/** Isolate the writing-cost assertion from seed-completed extra-sun instability. */
private static int nonCelestialInstability(AgeDefinition age) {
return age.instability().breakdown().stream()
.filter(part -> !part.reason().equals("extra_sun"))
.mapToInt(AgeInstability.Contribution::points).sum();
}
private static CompoundTag entry(
UUID id,
String name,
@@ -5,6 +5,9 @@ import java.util.Map;
import java.util.Optional;
import java.util.UUID;
import java.util.List;
import java.util.HashSet;
import java.util.Set;
import net.minecraft.nbt.StringTag;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.minecraft.core.BlockPos;
import net.minecraft.core.HolderLookup;
@@ -13,6 +16,7 @@ import net.minecraft.nbt.CompoundTag;
import net.minecraft.nbt.ListTag;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.server.MinecraftServer;
import net.minecraft.util.datafix.DataFixTypes;
import net.minecraft.world.level.saveddata.SavedData;
import net.neoforged.fml.ModList;
@@ -21,6 +25,7 @@ import net.neoforged.fml.ModList;
public final class AgeRegistrySavedData extends SavedData {
private static final String DATA_NAME = "rivencraft_ages";
private static final String AGES_TAG = "Ages";
private static final String DEAD_AGES_TAG = "DeadAges";
private static final String ID_TAG = "Id";
private static final String NAME_TAG = "Name";
private static final String SEED_TAG = "Seed";
@@ -34,6 +39,7 @@ public final class AgeRegistrySavedData extends SavedData {
private static final String TRAITS_TAG = "Traits";
private static final String PLAN_TAG = "GenerationPlan";
private static final String RANDOM_FEATURES_TAG = "RandomFeatures";
private static final String RANDOM_PAGE_POLICY_TAG = "RandomPagePolicy";
private static final String SEASON_MODE_TAG = "SeasonMode";
private static final String INSTABILITY_TAG = "Instability";
private static final String INSTABILITY_PLAN_TAG = "InstabilityPlan";
@@ -50,6 +56,7 @@ public final class AgeRegistrySavedData extends SavedData {
);
private final Map<UUID, AgeDefinition> ages = new HashMap<>();
private final Set<UUID> deadAges = new HashSet<>();
public static AgeRegistrySavedData get(ServerLevel level) {
return level.getServer().overworld().getDataStorage().computeIfAbsent(FACTORY, DATA_NAME);
@@ -71,9 +78,19 @@ public final class AgeRegistrySavedData extends SavedData {
ServerLevel overworld = level.getServer().overworld();
AgeRegistrySavedData data = get(overworld);
long seed = ageSeed(overworld.getSeed(), data.availableDimensionId(normalizedName(name)));
AgeGenerationPlan.compile(writing, seed,
AgeGenerationPlan plan = AgeGenerationPlan.compile(writing, seed,
AgeRuntimeProfiles.selectForWriting(seed, writing, overworld.registryAccess()), AgeTraits.select(seed),
overworld.registryAccess());
if (plan == null) {
RandomPagePolicy policy = RandomPagePolicy.configured();
ResourceLocation profileId = AgeRuntimeProfiles.select(seed, policy);
AgeRuntimeProfile profile = AgeRuntimeProfiles.resolve(profileId);
AgeTraits traits = AgeTraits.select(seed, policy);
AgeBiomeSelection.compile(net.dnorberg.rivencraft.writing.WritingGrammar.parse(OrderedWriting.EMPTY),
traits, profile, seed, overworld.registryAccess(), policy);
AgeSkyProfile.random(seed, traits, policy);
AgeSeasonMode.select(null, seed, ModList.get().isLoaded("sereneseasons"), profile, policy);
}
}
public static ResourceLocation previewGenerationProfile(ServerLevel level, String name) {
@@ -110,6 +127,16 @@ public final class AgeRegistrySavedData extends SavedData {
return List.copyOf(ages.values());
}
public boolean isDead(UUID ageId) { return deadAges.contains(ageId); }
/** Keep the ID and definition reserved so an old book cannot regenerate a retired Age. */
public boolean markDead(UUID ageId) {
if (!ages.containsKey(ageId)) return false;
boolean changed = deadAges.add(ageId);
if (changed) setDirty();
return changed;
}
public AgeDefinition setSpawn(UUID ageId, BlockPos spawn) {
AgeDefinition existing = ages.get(ageId);
if (existing == null) {
@@ -121,6 +148,33 @@ public final class AgeRegistrySavedData extends SavedData {
return updated;
}
/** Changes the generator for future chunks; existing chunk data is deliberately preserved. */
public boolean reseed(MinecraftServer server, UUID ageId, long seed) {
AgeDefinition previous = ages.get(ageId);
if (previous == null || isDead(ageId)) return false;
if (previous.seed() == seed) return true;
ServerLevel loaded = server.getLevel(AgeDimensionService.dimensionKey(previous));
if (loaded != null && !loaded.players().isEmpty()) return false;
// Legacy changes the Age's seed, not its already-written pages or selected traits.
// Keeping the frozen plan and feature list prevents a visited Age from changing
// its identity while newly generated chunks use the revised terrain noise.
AgeGenerationPlan oldPlan = previous.plan();
AgeGenerationPlan plan = oldPlan == null ? null : new AgeGenerationPlan(oldPlan.version(), seed,
oldPlan.writing(), oldPlan.symbols(), oldPlan.runtimeProfile(), oldPlan.biomeSelection(),
oldPlan.activeSymbolIndices(), oldPlan.writingInstability());
AgeDefinition changed = new AgeDefinition(previous.id(), previous.name(), seed,
previous.generationProfile(), previous.generationVersion(), previous.createdGameTime(),
previous.dimensionId(), previous.spawn(), previous.traits(), plan, previous.seasonMode(),
previous.randomFeatures(), previous.instability(), previous.instabilityPlan(),
previous.randomPagePolicy());
if (AgeDimensionService.unload(server, previous) == AgeDimensionService.UnloadResult.FAILED)
return false;
ages.put(ageId, changed);
setDirty();
return true;
}
private AgeDefinition getOrCreate(AgeReference reference, OrderedWriting writing,
long worldSeed, long createdGameTime, RegistryAccess registries) {
AgeDefinition existing = ages.get(reference.id());
@@ -131,11 +185,19 @@ public final class AgeRegistrySavedData extends SavedData {
String name = normalizedName(reference.name());
ResourceLocation dimensionId = availableDimensionId(name);
long seed = ageSeed(worldSeed, dimensionId);
RandomPagePolicy policy = RandomPagePolicy.configured();
ResourceLocation seedProfile = AgeRuntimeProfiles.selectForWriting(seed, writing, registries);
AgeTraits traits = AgeTraits.select(seed);
AgeGenerationPlan plan = AgeGenerationPlan.compile(writing, seed, seedProfile, traits, registries);
AgeTraits effectiveTraits = AgeEnvironmentCompiler.apply(plan, traits);
AgeInstability instability = AgeInstability.compute(plan, effectiveTraits, registries);
if (plan == null) {
seedProfile = AgeRuntimeProfiles.select(seed, policy);
traits = AgeTraits.select(seed, policy);
}
AgeTraits effectiveTraits = plan == null
? AgeEnvironmentCompiler.forTerrain(traits, AgeRuntimeProfiles.resolve(seedProfile))
: AgeEnvironmentCompiler.apply(plan, traits);
AgeInstability instability = AgeInstability.compute(plan, effectiveTraits, registries, seed,
plan == null ? policy : RandomPagePolicy.UNRESTRICTED);
AgeInstabilityPlan instabilityPlan = AgeInstabilityPlan.select(instability, seed);
AgeDefinition created = new AgeDefinition(
reference.id(),
@@ -148,11 +210,14 @@ public final class AgeRegistrySavedData extends SavedData {
null,
effectiveTraits,
plan,
AgeSeasonMode.select(plan, seed, ModList.get().isLoaded("sereneseasons")),
AgeSeasonMode.select(plan, seed, ModList.get().isLoaded("sereneseasons"),
plan == null ? AgeRuntimeProfiles.resolve(seedProfile) : plan.runtimeProfile(),
plan == null ? policy : RandomPagePolicy.UNRESTRICTED),
plan == null ? AgeFeatureSelection.randomChoices(seed,
AgeRuntimeProfiles.resolve(seedProfile), registries) : List.of(),
AgeRuntimeProfiles.resolve(seedProfile), registries, policy) : List.of(),
instability,
instabilityPlan
instabilityPlan,
plan == null ? policy : RandomPagePolicy.UNRESTRICTED
);
ages.put(created.id(), created);
setDirty();
@@ -161,6 +226,11 @@ public final class AgeRegistrySavedData extends SavedData {
static AgeRegistrySavedData load(CompoundTag tag, HolderLookup.Provider registries) {
AgeRegistrySavedData data = new AgeRegistrySavedData();
ListTag deadTags = tag.getList(DEAD_AGES_TAG, StringTag.TAG_STRING);
for (int index = 0; index < deadTags.size(); index++) {
try { data.deadAges.add(UUID.fromString(deadTags.getString(index))); }
catch (IllegalArgumentException ignored) { }
}
ListTag serializedAges = tag.getList(AGES_TAG, CompoundTag.TAG_COMPOUND);
for (int index = 0; index < serializedAges.size(); index++) {
CompoundTag entry = serializedAges.getCompound(index);
@@ -214,7 +284,10 @@ public final class AgeRegistrySavedData extends SavedData {
? AgeSeasonMode.parseOrNull(entry.getString(SEASON_MODE_TAG)) : null,
readRandomFeatures(entry),
instability,
instabilityPlan
instabilityPlan,
entry.contains(RANDOM_PAGE_POLICY_TAG, CompoundTag.TAG_COMPOUND)
? RandomPagePolicy.load(entry.getCompound(RANDOM_PAGE_POLICY_TAG))
: RandomPagePolicy.UNRESTRICTED
));
}
return data;
@@ -259,11 +332,15 @@ public final class AgeRegistrySavedData extends SavedData {
entry.put(RANDOM_FEATURES_TAG, featureTags);
}
if (age.seasonMode() != null) entry.putString(SEASON_MODE_TAG, age.seasonMode().name());
if (age.plan() == null) entry.put(RANDOM_PAGE_POLICY_TAG, age.randomPagePolicy().save());
entry.put(INSTABILITY_TAG, age.instability().save());
entry.put(INSTABILITY_PLAN_TAG, age.instabilityPlan().save());
serializedAges.add(entry);
});
tag.put(AGES_TAG, serializedAges);
ListTag deadTags = new ListTag();
deadAges.stream().sorted().forEach(id -> deadTags.add(StringTag.valueOf(id.toString())));
tag.put(DEAD_AGES_TAG, deadTags);
return tag;
}
@@ -57,20 +57,39 @@ public final class AgeRuntimeProfiles {
/** Selects from all valid loaded profiles in stable resource-ID order. */
public static ResourceLocation select(long seed) {
return select(seed, RandomPagePolicy.UNRESTRICTED);
}
public static ResourceLocation select(long seed, RandomPagePolicy policy) {
if (PROFILES.isEmpty()) {
return AgeGenerationProfiles.select(seed);
List<LegacyRankChoice.Option<ResourceLocation>> profiles = policy.required(
AgeGenerationProfiles.all().stream().sorted()
.map(id -> new LegacyRankChoice.Option<>(id, AgeGenerationProfiles.randomRank(id)))
.toList(), option -> terrainPage(option.value()),
new LegacyRankChoice.Option<>(AgeGenerationProfiles.STANDARD, 1));
return LegacyRankChoice.choose(new Random(seed ^ 0x5445525241494E4CL), profiles);
}
List<LegacyRankChoice.Option<ResourceLocation>> profiles = PROFILES.keySet().stream().sorted()
List<LegacyRankChoice.Option<ResourceLocation>> available = PROFILES.keySet().stream().sorted()
.map(id -> new LegacyRankChoice.Option<>(id, AgeGenerationProfiles.randomRank(id))).toList();
LegacyRankChoice.Option<ResourceLocation> fallback = available.stream()
.filter(option -> option.value().equals(AgeGenerationProfiles.STANDARD))
.findFirst().orElse(available.getFirst());
List<LegacyRankChoice.Option<ResourceLocation>> profiles = policy.required(available,
option -> terrainPage(option.value()), fallback);
return LegacyRankChoice.choose(new Random(seed ^ 0x5445525241494E4CL), profiles);
}
private static ResourceLocation terrainPage(ResourceLocation profile) {
return ResourceLocation.fromNamespaceAndPath("rivencraft", "terrain/" + profile.getPath());
}
/** Keep seed-selected terrain random, but only among profiles able to host authored features. */
public static ResourceLocation selectForWriting(long seed, OrderedWriting writing, RegistryAccess registries) {
ResourceLocation selected = select(seed);
WritingGrammar.Result parsed = WritingGrammar.parse(writing);
if (parsed.activeSymbols().stream().anyMatch(symbol ->
symbol.semantics().role() == SymbolSemantics.Role.TERRAIN)) return selected;
boolean authoredTerrain = parsed.activeSymbols().stream().anyMatch(symbol ->
symbol.semantics().role() == SymbolSemantics.Role.TERRAIN);
ResourceLocation selected = select(seed);
if (authoredTerrain) return selected;
List<ResourceLocation> features = parsed.activeSymbols().stream()
.filter(symbol -> symbol.semantics().role() == SymbolSemantics.Role.FEATURE)
.map(symbol -> ((SymbolSemantics.ResourceValue) symbol.semantics().value()).id()).toList();
@@ -19,18 +19,33 @@ public enum AgeSeasonMode {
/** An omitted page is selected once when an Age is created with Serene installed. */
public static AgeSeasonMode select(AgeGenerationPlan plan, long ageSeed, boolean sereneInstalled) {
return select(plan, ageSeed, sereneInstalled, plan == null ? null : plan.runtimeProfile());
}
public static AgeSeasonMode select(AgeGenerationPlan plan, long ageSeed, boolean sereneInstalled,
AgeRuntimeProfile profile) {
return select(plan, ageSeed, sereneInstalled, profile, RandomPagePolicy.UNRESTRICTED);
}
public static AgeSeasonMode select(AgeGenerationPlan plan, long ageSeed, boolean sereneInstalled,
AgeRuntimeProfile profile, RandomPagePolicy policy) {
if (profile != null && AgeBiomeSelection.isCave(profile)) return NO_SEASONS;
if (hasAuthoredPage(plan)) return from(plan);
return sereneInstalled ? LegacyRankChoice.choose(new Random(ageSeed ^ RANDOM_SALT), List.of(
return sereneInstalled ? LegacyRankChoice.choose(new Random(ageSeed ^ RANDOM_SALT), policy.required(List.of(
new LegacyRankChoice.Option<>(SEASONS, 1),
new LegacyRankChoice.Option<>(NO_SEASONS, 2),
new LegacyRankChoice.Option<>(ETERNAL_WINTER, 3),
new LegacyRankChoice.Option<>(ETERNAL_SUMMER, 3),
new LegacyRankChoice.Option<>(ETERNAL_FALL, 3),
new LegacyRankChoice.Option<>(ETERNAL_SPRING, 3))) : null;
new LegacyRankChoice.Option<>(ETERNAL_SPRING, 3)),
option -> net.minecraft.resources.ResourceLocation.fromNamespaceAndPath("rivencraft",
"season/" + option.value().name().toLowerCase(Locale.ROOT)),
new LegacyRankChoice.Option<>(NO_SEASONS, 2))) : null;
}
/** Existing Ages without a stored choice retain their old cycling behavior. */
public static AgeSeasonMode from(AgeDefinition age) {
if (age.caveTerrain()) return NO_SEASONS;
return age.seasonMode() == null ? from(age.plan()) : age.seasonMode();
}
@@ -49,6 +64,7 @@ public enum AgeSeasonMode {
public static AgeSeasonMode from(AgeGenerationPlan plan) {
if (plan == null) return SEASONS;
if (AgeBiomeSelection.isCave(plan.runtimeProfile())) return NO_SEASONS;
return plan.activeSymbols().stream()
.filter(symbol -> symbol.semantics().role() == SymbolSemantics.Role.SEASON)
.map(symbol -> valueOf(((SymbolSemantics.ChoiceValue) symbol.semantics().value())
@@ -58,6 +74,7 @@ public enum AgeSeasonMode {
public static void validate(AgeGenerationPlan plan) {
if (plan == null) return;
if (AgeBiomeSelection.isCave(plan.runtimeProfile())) return;
if (hasAuthoredPage(plan) && from(plan) != NO_SEASONS
&& !ModList.get().isLoaded("sereneseasons")) {
throw new IllegalArgumentException("This seasonal page requires Serene Seasons to create the Age");
@@ -0,0 +1,339 @@
package net.dnorberg.rivencraft.book;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Random;
import java.util.Set;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.minecraft.resources.ResourceLocation;
/** The ordered, deterministic sky specification for an Age. No client data is trusted here. */
public record AgeSkyProfile(Style style, int color, List<Body> bodies) {
public static final int RANDOM_SKY_GENERATION_VERSION = 17;
private static final int[] COLORS = {0xB74A50, 0xD9834B, 0xDBC574, 0x5AAB80,
0x6FA8DF, 0x9870B9, 0xD5DBE1, 0x252531};
public AgeSkyProfile {
bodies = List.copyOf(bodies);
long suns = bodies.stream().filter(body -> body.kind() == Kind.SUN).count();
long moons = bodies.size() - suns;
if (suns > 10 || moons > 10) throw new IllegalArgumentException("An Age may have at most ten suns and ten moons");
}
public static AgeSkyProfile forAge(AgeDefinition age) {
if (age.plan() != null) return compile(age.plan(), age.traits());
if (age.generationVersion() >= RANDOM_SKY_GENERATION_VERSION)
return random(age.seed(), age.traits(), age.randomPagePolicy());
return new AgeSkyProfile(Style.INHERITED, -1, List.of());
}
public static AgeSkyProfile random(long seed, AgeTraits traits) {
return random(seed, traits, RandomPagePolicy.UNRESTRICTED);
}
public static AgeSkyProfile random(long seed, AgeTraits traits, RandomPagePolicy policy) {
Random random = new Random(seed ^ 0x534B5950524F464CL);
List<Style> styles = policy.required(java.util.Arrays.stream(Style.values())
.filter(style -> style != Style.INHERITED || !policy.restricts("sky")).toList(),
AgeSkyProfile::skyPage, Style.INHERITED);
Style style = styles.get(random.nextInt(styles.size()));
int color = randomColor(random);
int suns = policy.allows(ResourceLocation.fromNamespaceAndPath("rivencraft", "celestial/sun"))
? random.nextInt(4) : 0;
int moons = policy.allows(ResourceLocation.fromNamespaceAndPath("rivencraft", "celestial/moon"))
? random.nextInt(4) : 0;
List<Body> bodies = new ArrayList<>();
for (int i = 0; i < suns; i++)
bodies.add(new Body(Kind.SUN, randomColor(random),
0.75F + random.nextFloat(), random.nextFloat() * 360.0F,
traits.celestialPeriod(), random.nextFloat(), random.nextBoolean()));
for (int i = 0; i < moons; i++)
bodies.add(new Body(Kind.MOON, randomColor(random),
0.75F + random.nextFloat(), random.nextFloat() * 360.0F,
traits.celestialPeriod(), random.nextFloat(), random.nextBoolean()));
return new AgeSkyProfile(style, color, bodies);
}
private static ResourceLocation skyPage(Style style) {
return ResourceLocation.fromNamespaceAndPath("rivencraft",
"sky/" + (style == Style.INHERITED ? "inherited" : style.name().toLowerCase(java.util.Locale.ROOT)));
}
public static AgeSkyProfile compile(AgeGenerationPlan plan, AgeTraits traits) {
if (plan == null) return new AgeSkyProfile(Style.INHERITED, -1, List.of());
Style style = Style.INHERITED;
int color = authoredSkyColor(plan);
boolean customBodies = hasCustomCelestials(plan);
List<Body> bodies = new ArrayList<>();
Set<Integer> active = new HashSet<>(plan.activeSymbolIndices());
AgeTraits seeded = AgeTraits.select(plan.ageSeed());
double period = 1.0D;
float angle = seeded.celestialAngle();
float phase = seeded.celestialPhase();
float size = 1.0F;
List<Integer> bodyColors = new ArrayList<>();
ColorAccumulator pendingColors = new ColorAccumulator();
Double pendingNumber = null;
boolean clockwise = true;
for (AgeGenerationPlan.ResolvedSymbol symbol : plan.symbols()) {
if (!active.contains(symbol.index())) continue;
SymbolSemantics semantics = symbol.semantics();
Double number = pendingNumber;
if (semantics.role() != SymbolSemantics.Role.COLOR_NUMBER) pendingNumber = null;
switch (semantics.role()) {
case SKY -> {
pendingColors.clear();
style = switch (((SymbolSemantics.ChoiceValue) semantics.value()).id()) {
case "overworld" -> Style.OVERWORLD;
case "nether" -> Style.NETHER;
case "end" -> Style.END;
case "static" -> Style.STATIC;
default -> throw new IllegalArgumentException("Unknown sky style");
};
}
case COLOR_NUMBER -> pendingNumber = ((SymbolSemantics.NumberValue)
semantics.value()).amount();
case COLOR -> {
pendingColors.add(((SymbolSemantics.ChoiceValue) semantics.value()).id(),
number == null ? randomColorNumber(plan.ageSeed(), symbol.index()) : number.intValue());
}
case PERIOD_MODIFIER -> period = CelestialPageValues.value(semantics, number);
case ANGLE_MODIFIER -> angle = (float) CelestialPageValues.value(semantics, number);
case PHASE_MODIFIER -> phase = (float) (CelestialPageValues.value(semantics, number) / 360.0D);
case SIZE_MODIFIER -> size = (float) CelestialPageValues.value(semantics, number);
case CELESTIAL_COLOR -> bodyColors.add(color(
((SymbolSemantics.ChoiceValue) semantics.value()).id()));
case DIRECTION_MODIFIER -> clockwise = ((SymbolSemantics.ChoiceValue) semantics.value())
.id().equals("clockwise");
case CELESTIAL -> {
String choice = ((SymbolSemantics.ChoiceValue) semantics.value()).id();
int bodyColor = pendingColors.written() ? pendingColors.rgb()
: bodyColors.isEmpty() ? 0xFFFFFF : mixColors(bodyColors);
if (choice.equals("normal_time")) {
if (customBodies) {
bodies.add(new Body(Kind.SUN, bodyColor, size, angle, period, phase, clockwise));
bodies.add(new Body(Kind.MOON, bodyColor, 1.0F, angle, period,
(phase + 0.5F) % 1.0F, clockwise));
}
} else {
bodies.add(new Body(choice.equals("sun") ? Kind.SUN : Kind.MOON,
bodyColor, size, angle, period, phase, clockwise));
}
period = 1.0D;
angle = seeded.celestialAngle();
phase = seeded.celestialPhase();
size = 1.0F;
bodyColors.clear();
pendingColors.clear();
clockwise = true;
}
default -> { }
}
}
// Missing branches are seed-completed, including the celestial branch.
// An explicit sky or sky-color page does not suppress that completion.
if (plan.activeSymbols().stream().noneMatch(symbol ->
symbol.semantics().role() == SymbolSemantics.Role.CELESTIAL)) {
bodies.addAll(random(plan.ageSeed(), seeded).bodies());
}
return new AgeSkyProfile(style, color, bodies);
}
public static int mixColors(List<Integer> colors) {
if (colors.isEmpty()) return -1;
long red = 0, green = 0, blue = 0;
for (int color : colors) {
red += color >> 16 & 255;
green += color >> 8 & 255;
blue += color & 255;
}
int count = colors.size();
return (int) ((red + count / 2) / count) << 16
| (int) ((green + count / 2) / count) << 8
| (int) ((blue + count / 2) / count);
}
/** Shared color pages affect the next Sky or celestial page; trailing colors tint the sky. */
public static int authoredSkyColor(AgeGenerationPlan plan) {
if (plan == null) return -1;
ColorAccumulator pending = new ColorAccumulator();
Integer multiplier = null;
int skyColor = -1;
List<Integer> legacyColors = new ArrayList<>();
Set<Integer> active = new HashSet<>(plan.activeSymbolIndices());
for (AgeGenerationPlan.ResolvedSymbol symbol : plan.symbols()) {
if (!active.contains(symbol.index())) continue;
SymbolSemantics semantics = symbol.semantics();
if (semantics.role() != SymbolSemantics.Role.COLOR
&& semantics.role() != SymbolSemantics.Role.COLOR_NUMBER) multiplier = null;
switch (semantics.role()) {
case COLOR_NUMBER -> multiplier = (int) ((SymbolSemantics.NumberValue) semantics.value()).amount();
case COLOR -> {
pending.add(((SymbolSemantics.ChoiceValue) semantics.value()).id(),
multiplier == null ? randomColorNumber(plan.ageSeed(), symbol.index()) : multiplier);
multiplier = null;
}
case SKY -> {
if (pending.written()) skyColor = pending.rgb();
pending.clear();
}
case CELESTIAL -> pending.clear();
case SKY_COLOR -> legacyColors.add(color(
((SymbolSemantics.ChoiceValue) semantics.value()).id()));
default -> { }
}
}
if (pending.written()) skyColor = pending.rgb();
return skyColor != -1 ? skyColor : mixColors(legacyColors);
}
private static int randomColorNumber(long ageSeed, int pageIndex) {
return new Random(ageSeed ^ (0x9E3779B97F4A7C15L * (pageIndex + 1L))).nextInt(25);
}
private static final class ColorAccumulator {
private int red;
private int green;
private int blue;
private boolean written;
void add(String color, int multiplier) {
int amount = multiplier * 10;
written = true;
switch (color) {
case "red" -> red += amount;
case "green" -> green += amount;
case "blue" -> blue += amount;
case "white" -> { red += amount; green += amount; blue += amount; }
case "black" -> { red -= amount; green -= amount; blue -= amount; }
default -> throw new IllegalArgumentException("Unknown shared color " + color);
}
}
boolean written() { return written; }
int rgb() {
return clamp(red) << 16 | clamp(green) << 8 | clamp(blue);
}
void clear() { red = green = blue = 0; written = false; }
private static int clamp(int channel) { return Math.max(0, Math.min(255, channel)); }
}
private static int randomColor(Random random) {
int count = 1 + random.nextInt(3);
List<Integer> colors = new ArrayList<>(count);
for (int i = 0; i < count; i++) colors.add(COLORS[random.nextInt(COLORS.length)]);
return mixColors(colors);
}
public static boolean hasCustomCelestials(AgeGenerationPlan plan) {
return plan != null && (hasColorForCelestial(plan) || plan.activeSymbols().stream().anyMatch(symbol ->
symbol.semantics().role() == SymbolSemantics.Role.CELESTIAL
&& !((SymbolSemantics.ChoiceValue) symbol.semantics().value()).id().equals("normal_time")
|| symbol.semantics().role() == SymbolSemantics.Role.CELESTIAL_COLOR
|| symbol.semantics().role() == SymbolSemantics.Role.SIZE_MODIFIER
|| symbol.semantics().role() == SymbolSemantics.Role.ANGLE_MODIFIER
|| symbol.semantics().role() == SymbolSemantics.Role.DIRECTION_MODIFIER));
}
private static boolean hasColorForCelestial(AgeGenerationPlan plan) {
Set<Integer> active = new HashSet<>(plan.activeSymbolIndices());
boolean pending = false;
for (AgeGenerationPlan.ResolvedSymbol symbol : plan.symbols()) {
if (!active.contains(symbol.index())) continue;
switch (symbol.semantics().role()) {
case COLOR -> pending = true;
case SKY -> pending = false;
case CELESTIAL -> {
if (pending) return true;
pending = false;
}
default -> { }
}
}
return false;
}
public boolean custom() {
return style == Style.STATIC || color != -1 || !bodies.isEmpty();
}
/** Vanilla has one skylight channel; combine visible bodies into that channel. */
public float lightAt(double dayTime) {
float sunlight = 0.0F;
float moonlight = 0.0F;
for (Body body : bodies) {
double orbit = body.period() == 0.0D ? body.phase()
: (body.clockwise() ? 1.0D : -1.0D) * dayTime
/ (24000.0D * body.period()) + body.phase();
float altitude = (float) Math.cos(orbit * Math.PI * 2.0D);
if (altitude <= 0.0F) continue;
if (body.kind() == Kind.SUN) sunlight += altitude * (1.0F - 0.85F * eclipseFor(body, dayTime));
else moonlight += altitude * 0.18F;
}
return Math.min(1.0F, sunlight > 0.0F ? sunlight : moonlight);
}
/** Disc overlap in the rendered sky, from first contact (0) to centered alignment (1). */
public float eclipseFor(Body body, double dayTime) {
float strongest = 0.0F;
net.minecraft.world.phys.Vec3 bodyDirection = direction(body, dayTime);
for (Body other : bodies) {
if (other.kind() == body.kind()) continue;
double dot = Math.max(-1.0D, Math.min(1.0D,
bodyDirection.dot(direction(other, dayTime))));
double separation = Math.acos(dot);
// The outer 32x32 quad is only glow. The opaque body occupies its
// central 8x8 pixels, so contact must use one quarter of its size.
double radius = Math.atan((body.kind() == Kind.SUN ? 30.0D : 20.0D)
* body.size() * 0.25D / 100.0D)
+ Math.atan((other.kind() == Kind.SUN ? 30.0D : 20.0D)
* other.size() * 0.25D / 100.0D);
if (radius > 0.0D) strongest = Math.max(strongest,
(float) Math.max(0.0D, 1.0D - separation / radius));
}
return strongest;
}
public float eclipseAt(double dayTime) {
float strongest = 0.0F;
for (Body body : bodies) {
if (body.kind() == Kind.SUN && direction(body, dayTime).y > 0.0D)
strongest = Math.max(strongest, eclipseFor(body, dayTime));
}
return strongest;
}
private static net.minecraft.world.phys.Vec3 direction(Body body, double dayTime) {
double orbit = body.period() == 0.0D ? body.phase()
: (body.clockwise() ? 1.0D : -1.0D) * dayTime
/ (24000.0D * body.period()) + body.phase();
double tilt = orbit * Math.PI * 2.0D;
double bearing = Math.toRadians(body.angle());
double lateral = Math.sin(tilt);
return new net.minecraft.world.phys.Vec3(
Math.sin(bearing) * lateral, Math.cos(tilt), Math.cos(bearing) * lateral);
}
public static int color(String name) {
return switch (name) {
case "red" -> COLORS[0];
case "orange" -> COLORS[1];
case "yellow" -> COLORS[2];
case "green" -> COLORS[3];
case "blue" -> COLORS[4];
case "purple" -> COLORS[5];
case "white" -> COLORS[6];
case "black" -> COLORS[7];
default -> throw new IllegalArgumentException("Unknown sky color " + name);
};
}
public enum Style { INHERITED, OVERWORLD, NETHER, END, STATIC }
public enum Kind { SUN, MOON }
public record Body(Kind kind, int color, float size, float angle,
double period, float phase, boolean clockwise) { }
}
@@ -75,7 +75,7 @@ public final class AgeStatusEffectProviders {
candidates.sort(Comparator.comparing(Entity::getUUID));
LivingEntity target = candidates.get(random.nextInt(candidates.size()));
if (!context.budget().claim() || !target.addEffect(instance)) return;
leases.add(new Lease(new WeakReference<>(target), instance,
leases.add(new Lease(id, new WeakReference<>(target), instance,
context.serverTick() + duration, spec.target()));
}
@@ -100,7 +100,12 @@ public final class AgeStatusEffectProviders {
if (event.getServer().getTickCount() % 20 != 0) return;
boolean disabled = !RivencraftConfig.instabilityEnabled() || !RivencraftConfig.statusEffectsEnabled();
long tick = event.getServer().getTickCount();
for (var entry : LEASES.entrySet()) prune(entry.getKey(), entry.getValue(), tick, disabled);
for (var entry : LEASES.entrySet()) {
AgeDefinition age = AgeRegistrySavedData.get(entry.getKey())
.findByDimension(entry.getKey().dimension().location()).orElse(null);
prune(entry.getKey(), entry.getValue(), tick, disabled || age == null
|| !AgeInstabilityControls.get(entry.getKey()).enabled(age.id()));
}
LEASES.values().removeIf(List::isEmpty);
}
@@ -146,7 +151,8 @@ public final class AgeStatusEffectProviders {
iterator.remove();
continue;
}
boolean revoke = removeAll || entity.level() != level
boolean revoke = removeAll || !RivencraftConfig.instabilityProviderEnabled(lease.provider())
|| entity.level() != level
|| !allowedByPolicy(lease.target(), entity);
if (revoke || tick >= lease.expiresAt()) {
removeOwnedEffect(entity, lease);
@@ -208,11 +214,11 @@ public final class AgeStatusEffectProviders {
private enum Target { GENERAL, HOSTILE }
private record Spec(Holder<MobEffect> effect, int legacyDuration, boolean global, Target target) {}
private record Lease(WeakReference<LivingEntity> entity, MobEffectInstance instance, long expiresAt,
private record Lease(ResourceLocation provider, WeakReference<LivingEntity> entity, MobEffectInstance instance, long expiresAt,
Target target, int amplifier, int originalDuration) {
private Lease(WeakReference<LivingEntity> entity, MobEffectInstance instance, long expiresAt,
private Lease(ResourceLocation provider, WeakReference<LivingEntity> entity, MobEffectInstance instance, long expiresAt,
Target target) {
this(entity, instance, expiresAt, target, instance.getAmplifier(), instance.getDuration());
this(provider, entity, instance, expiresAt, target, instance.getAmplifier(), instance.getDuration());
}
}
}
@@ -178,8 +178,11 @@ public final class AgeStructureGameTests {
var age = AgeRegistrySavedData.resolveOrCreate(helper.getLevel(),
new AgeReference(java.util.UUID.randomUUID(), "Mixed " + firstBiome), writing);
int expected = firstBiome.equals("the_end") ? 200 : 0;
helper.assertValueEqual(age.instability().score(), expected,
"Each Village page must charge 100 if any selected biome needs the override");
helper.assertValueEqual(age.instability().breakdown().stream()
.filter(part -> part.reason().equals("forced_biome_villages"))
.mapToInt(AgeInstability.Contribution::points).sum(), expected,
"Each Village page must charge 100 if any selected biome needs the override; "
+ "seed-completed celestial instability is independent");
helper.assertValueEqual(age.instability().breakdown().stream()
.filter(part -> part.reason().equals("forced_biome_villages")).count(),
firstBiome.equals("the_end") ? 2L : 0L,
@@ -157,7 +157,14 @@ public final class AgeStructureSelection {
public static List<AgeFeatureSelection.Choice> randomChoices(long ageSeed, AgeRuntimeProfile profile,
AgeBiomeSelection biomes, RegistryAccess registries) {
return randomChoices(ageSeed, profile, biomes, registries, RandomPagePolicy.UNRESTRICTED);
}
public static List<AgeFeatureSelection.Choice> randomChoices(long ageSeed, AgeRuntimeProfile profile,
AgeBiomeSelection biomes, RegistryAccess registries,
RandomPagePolicy policy) {
List<LegacyRankChoice.Option<ResourceLocation>> eligible = new ArrayList<>(FEATURES.stream()
.filter(id -> policy.allows(ResourceLocation.fromNamespaceAndPath("rivencraft", "feature/" + id.getPath())))
.filter(id -> error(id, profile, biomes, registries) == null)
.filter(id -> dungeons(id) || biomeCompatible(id, biomes, registries))
.map(id -> new LegacyRankChoice.Option<>(id, randomRank(id))).toList());
@@ -2,6 +2,8 @@ package net.dnorberg.rivencraft.book;
import java.util.Random;
import java.util.List;
import java.util.Locale;
import net.minecraft.resources.ResourceLocation;
/** Immutable random-Age traits selected once from the Age seed. */
public record AgeTraits(
@@ -29,8 +31,8 @@ public record AgeTraits(
if (biomeDistribution == null || lighting == null || weather == null) {
throw new IllegalArgumentException("Age trait choices cannot be null");
}
if (celestialPeriod != STOPPED_CELESTIAL_PERIOD
&& (celestialPeriod < MIN_CELESTIAL_PERIOD || celestialPeriod > MAX_CELESTIAL_PERIOD)) {
if (!Double.isFinite(celestialPeriod)
|| celestialPeriod < STOPPED_CELESTIAL_PERIOD || celestialPeriod > MAX_CELESTIAL_PERIOD) {
throw new IllegalArgumentException("Celestial period is outside the legacy range");
}
if (celestialAngle < MIN_CELESTIAL_ANGLE || celestialAngle >= MAX_CELESTIAL_ANGLE) {
@@ -42,8 +44,12 @@ public record AgeTraits(
}
public static AgeTraits select(long seed) {
return select(seed, RandomPagePolicy.UNRESTRICTED);
}
public static AgeTraits select(long seed, RandomPagePolicy policy) {
Random random = new Random(seed ^ 0x524956454E435241L);
BiomeDistribution biomeDistribution = LegacyRankChoice.choose(random, List.of(
BiomeDistribution biomeDistribution = LegacyRankChoice.choose(random, policy.required(List.of(
new LegacyRankChoice.Option<>(BiomeDistribution.NATIVE, 1),
new LegacyRankChoice.Option<>(BiomeDistribution.SINGLE, 1),
new LegacyRankChoice.Option<>(BiomeDistribution.MEDIUM, 1),
@@ -52,12 +58,16 @@ public record AgeTraits(
new LegacyRankChoice.Option<>(BiomeDistribution.TINY, 2),
new LegacyRankChoice.Option<>(BiomeDistribution.SMALL, 2),
new LegacyRankChoice.Option<>(BiomeDistribution.LARGE, 2),
new LegacyRankChoice.Option<>(BiomeDistribution.HUGE, 2)));
Lighting lighting = LegacyRankChoice.choose(random, List.of(
new LegacyRankChoice.Option<>(BiomeDistribution.HUGE, 2)),
option -> page("biome", option.value()),
new LegacyRankChoice.Option<>(BiomeDistribution.NATIVE, 1)));
Lighting lighting = LegacyRankChoice.choose(random, policy.required(List.of(
new LegacyRankChoice.Option<>(Lighting.NORMAL, 1),
new LegacyRankChoice.Option<>(Lighting.DARK, 2),
new LegacyRankChoice.Option<>(Lighting.BRIGHT, 2)));
Weather weather = LegacyRankChoice.choose(random, List.of(
new LegacyRankChoice.Option<>(Lighting.BRIGHT, 2)),
option -> page("lighting", option.value()),
new LegacyRankChoice.Option<>(Lighting.NORMAL, 1)));
Weather weather = LegacyRankChoice.choose(random, policy.required(List.of(
new LegacyRankChoice.Option<>(Weather.NORMAL, 1),
new LegacyRankChoice.Option<>(Weather.FAST, 2),
new LegacyRankChoice.Option<>(Weather.SLOW, 2),
@@ -66,7 +76,9 @@ public record AgeTraits(
new LegacyRankChoice.Option<>(Weather.CLOUDY, 2),
new LegacyRankChoice.Option<>(Weather.RAIN, 2),
new LegacyRankChoice.Option<>(Weather.SNOW, 2),
new LegacyRankChoice.Option<>(Weather.STORM, 2)));
new LegacyRankChoice.Option<>(Weather.STORM, 2)),
option -> page("weather", option.value()),
new LegacyRankChoice.Option<>(Weather.NORMAL, 1)));
// Legacy's PERIOD_BASIC grammar gives ModZero rank 2 and its other
// three length modifiers rank 1, producing an effective 1-in-7 weight.
boolean stopped = random.nextInt(7) == 0;
@@ -81,6 +93,11 @@ public record AgeTraits(
);
}
private static ResourceLocation page(String category, Enum<?> value) {
return ResourceLocation.fromNamespaceAndPath("rivencraft",
category + "/" + value.name().toLowerCase(Locale.ROOT));
}
public boolean hasStoppedCelestialCycle() {
return celestialPeriod == STOPPED_CELESTIAL_PERIOD;
}
@@ -26,7 +26,7 @@ public final class AgeWeatherService {
return;
}
AgeTraits.Weather weather = age.traits().weather();
AgeTraits.Weather weather = age.caveTerrain() ? AgeTraits.Weather.OFF : age.traits().weather();
if (weather == AgeTraits.Weather.NORMAL) {
STATES.remove(level);
return;
@@ -0,0 +1,90 @@
package net.dnorberg.rivencraft.book;
import java.util.List;
import java.util.UUID;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.writing.WritingEntry;
import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.level.biome.Biomes;
import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
/** Focused Cave terrain writing and persisted-generation coverage for issue #14. */
@GameTestHolder(Rivencraft.MOD_ID)
@PrefixGameTestTemplate(false)
public final class CaveTerrainGameTests {
private CaveTerrainGameTests() {}
@GameTest(template = "empty")
public static void caveSkyAndWeatherPagesCostInstabilityButDoNotApply(GameTestHelper helper) {
OrderedWriting cave = writing("terrain/cave", "biome/lush_caves", "biome/nether_wastes",
"biome/tiled", "weather/storm", "season/eternal_winter", "period/zero",
"celestial/normal_time");
AgeTraits seeded = new AgeTraits(AgeTraits.BiomeDistribution.SINGLE, AgeTraits.Lighting.NORMAL,
AgeTraits.Weather.ALWAYS, 0.5D, 0.0F, 0.25F);
var registries = helper.getLevel().registryAccess();
AgeGenerationPlan plan = AgeGenerationPlan.compile(cave, 42L, AgeGenerationProfiles.CAVE,
seeded, registries);
AgeTraits applied = AgeEnvironmentCompiler.apply(plan, seeded);
helper.assertValueEqual(applied.weather(), AgeTraits.Weather.OFF, "Cave weather must be off");
helper.assertValueEqual(applied.celestialPeriod(), 1.0D, "Cave time pages must not alter the clock");
helper.assertValueEqual(applied.celestialPhase(), 0.0F, "Cave time pages must not set a phase");
helper.assertValueEqual(AgeSeasonMode.select(plan, 42L, true), AgeSeasonMode.NO_SEASONS,
"Cave seasons must be disabled even when Serene Seasons is present");
helper.assertValueEqual(plan.biomeSelection().biomes(),
List.of(Biomes.LUSH_CAVES.location(), Biomes.NETHER_WASTES.location()),
"Cave writing must retain exactly its cave and Nether biomes");
AgeInstability instability = AgeInstability.compute(plan, applied, registries);
helper.assertValueEqual(instability.breakdown().stream()
.filter(part -> part.reason().startsWith("cave_ignored_")).count(), 4L,
"Each ineffective weather, season, period, and celestial page must add instability");
helper.assertValueEqual(AgeInstability.compute(AgeGenerationPlan.load(plan.save()), applied, registries),
instability, "Cave page penalties must survive plan reload");
AgeGenerationPlan surfaceCaves = AgeGenerationPlan.compile(writing("terrain/standard", "feature/caves"),
42L, AgeGenerationProfiles.STANDARD, seeded, registries);
helper.assertTrue(!AgeBiomeSelection.isCave(surfaceCaves.runtimeProfile())
&& AgeFeatureSelection.resolved(surfaceCaves).stream()
.anyMatch(choice -> AgeFeatureSelection.caves(choice.id())),
"The separate Caves feature page must still add caves to surface terrain");
helper.succeed();
}
@GameTest(template = "empty", timeoutTicks = 600)
public static void authoredCaveBiomeAndSpawnSurviveSavedDataReload(GameTestHelper helper) {
var player = helper.makeMockServerPlayerInLevel();
AgeReference reference = new AgeReference(UUID.randomUUID(), "Cave issue 14 " + UUID.randomUUID());
AgeDimensionService.resolve(player, reference,
writing("terrain/cave", "biome/nether_wastes", "biome/single")).orElseThrow();
var registry = AgeRegistrySavedData.get(helper.getLevel());
AgeDefinition age = registry.find(reference.id()).orElseThrow();
helper.assertTrue(age.caveTerrain(), "The Age must retain Cave terrain");
helper.assertTrue(age.spawn() != null && age.spawn().getY() <= 64,
"Cave spawn search must start at Y=64, not atop the roof");
helper.assertValueEqual(age.traits().weather(), AgeTraits.Weather.OFF,
"A new Cave Age must persist disabled weather");
helper.assertValueEqual(age.seasonMode(), AgeSeasonMode.NO_SEASONS,
"A new Cave Age must persist disabled seasons");
AgeDefinition reloaded = AgeRegistrySavedData.load(
registry.save(new CompoundTag(), helper.getLevel().registryAccess()),
helper.getLevel().registryAccess()).find(reference.id()).orElseThrow();
helper.assertValueEqual(reloaded, age, "Saved Cave biome, spawn, and environment must survive reload");
helper.assertValueEqual(reloaded.plan().biomeSelection().biomes(),
List.of(Biomes.NETHER_WASTES.location()),
"The generated Cave Age must preserve its authored-only Nether pool");
helper.succeed();
}
private static OrderedWriting writing(String... pages) {
var entries = new java.util.ArrayList<WritingEntry>();
entries.add(WritingEntry.linkPanel());
for (String page : pages) entries.add(WritingEntry.symbol(new SymbolReference(
ResourceLocation.parse("rivencraft:" + page))));
return new OrderedWriting(entries);
}
}
@@ -0,0 +1,18 @@
package net.dnorberg.rivencraft.book;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
/** A preceding D'ni number overrides the next celestial modifier's fixed page value. */
final class CelestialPageValues {
private CelestialPageValues() {}
static double value(SymbolSemantics semantics, Double number) {
if (number == null) return ((SymbolSemantics.NumberValue) semantics.value()).amount();
return switch (semantics.role()) {
case PERIOD_MODIFIER -> number * 0.08D;
case ANGLE_MODIFIER, PHASE_MODIFIER -> (number * 15.0D) % 360.0D;
case SIZE_MODIFIER -> 0.25D + number * (2.75D / 24.0D);
default -> throw new IllegalArgumentException("Not a celestial numeric modifier");
};
}
}
@@ -0,0 +1,64 @@
package net.dnorberg.rivencraft.book;
import java.util.List;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.writing.WritingEntry;
import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper;
import net.minecraft.resources.ResourceLocation;
import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
/** Focused core coverage without launching the storage-heavy environment archive. */
@GameTestHolder(Rivencraft.MOD_ID)
@PrefixGameTestTemplate(false)
public final class CelestialSizeGameTests {
private CelestialSizeGameTests() {}
@GameTest(template = "empty")
public static void adjacentNumberSetsNextCelestialSize(GameTestHelper helper) {
OrderedWriting writing = new OrderedWriting(List.of(WritingEntry.linkPanel(),
page("number/0"), page("size/small"), page("celestial/sun"),
page("number/24"), page("size/large"), page("celestial/moon"),
page("number/12"), page("size/normal"), page("celestial/sun")));
helper.assertValueEqual(WritingGrammar.parse(writing).writingInstability(), 0,
"Adjacent number and size pages must be valid writing");
AgeTraits seeded = AgeTraits.select(94L);
AgeGenerationPlan plan = AgeGenerationPlan.compile(writing, 94L,
AgeGenerationProfiles.STANDARD, seeded, helper.getLevel().registryAccess());
AgeSkyProfile sky = AgeSkyProfile.compile(plan, AgeEnvironmentCompiler.apply(plan, seeded));
helper.assertValueEqual(sky.bodies().size(), 3, "Three authored bodies must remain distinct");
helper.assertValueEqual(sky.bodies().get(0).size(), 0.25F, "Digit zero selects minimum size");
helper.assertValueEqual(sky.bodies().get(1).size(), 3.0F, "Digit 24 selects maximum size");
helper.assertValueEqual(sky.bodies().get(2).size(), 1.625F, "Digit 12 selects midpoint size");
helper.assertValueEqual(AgeSkyProfile.compile(AgeGenerationPlan.load(plan.save()),
AgeEnvironmentCompiler.apply(plan, seeded)), sky,
"Numbered sizes must survive an Age-plan save/load round trip");
OrderedWriting plain = new OrderedWriting(List.of(WritingEntry.linkPanel(),
page("size/small"), page("celestial/sun"),
page("size/normal"), page("celestial/moon"),
page("size/large"), page("celestial/sun")));
AgeGenerationPlan plainPlan = AgeGenerationPlan.compile(plain, 95L,
AgeGenerationProfiles.STANDARD, AgeTraits.select(95L), helper.getLevel().registryAccess());
AgeSkyProfile plainSky = AgeSkyProfile.compile(plainPlan,
AgeEnvironmentCompiler.apply(plainPlan, AgeTraits.select(95L)));
helper.assertValueEqual(plainSky.bodies().get(0).size(), 0.5F, "Small retains its fixed value");
helper.assertValueEqual(plainSky.bodies().get(1).size(), 1.0F, "Normal retains its fixed value");
helper.assertValueEqual(plainSky.bodies().get(2).size(), 2.0F, "Large retains its fixed value");
OrderedWriting separated = new OrderedWriting(List.of(WritingEntry.linkPanel(),
page("number/24"), page("direction/clockwise"),
page("size/large"), page("celestial/sun")));
helper.assertValueEqual(WritingGrammar.parse(separated).writingInstability(), 100,
"An intervening page must not allow a number to modify size");
helper.succeed();
}
private static WritingEntry page(String path) {
return WritingEntry.symbol(new SymbolReference(ResourceLocation.fromNamespaceAndPath("rivencraft", path)));
}
}
@@ -20,6 +20,9 @@ public final class CloudPlatformGameTests {
helper.getLevel().setBlock(pos, state, 2);
helper.assertTrue(!state.getCollisionShape(helper.getLevel(), pos).isEmpty(),
"Cloud platform must support a standing player");
helper.assertTrue(state.canOcclude(), "Arrival platform must be opaque");
helper.assertValueEqual(state.getDestroySpeed(helper.getLevel(), pos), 0.3F,
"Arrival platform should break as easily as glass");
helper.assertTrue(ModBlocks.CLOUD_PLATFORM.get().getCloneItemStack(helper.getLevel(), pos, state).isEmpty(),
"Cloud platform must not provide a pick-block item");
helper.succeed();
@@ -52,9 +52,12 @@ public final class EnvironmentWritingGameTests {
public static void environmentPagesEnterCreativeAndJeiFeed(GameTestHelper helper) {
Set<String> expected = Set.of(
"lighting/normal", "lighting/dark", "lighting/bright",
"sky/overworld", "sky/nether", "sky/end",
"sky/overworld", "sky/nether", "sky/end", "sky/static", "color/red", "color/green",
"color/blue", "color/black", "color/white", "number/0", "number/24",
"weather/normal", "weather/fast", "weather/slow", "weather/off",
"weather/always", "weather/storm", "celestial/normal_time",
"weather/always", "weather/storm", "celestial/normal_time", "celestial/sun",
"celestial/moon", "size/large", "angle/east",
"direction/clockwise", "direction/counterclockwise",
"season/no_seasons", "season/seasons", "season/eternal_winter",
"season/eternal_summer", "season/eternal_fall", "season/eternal_spring",
"period/zero", "period/half", "period/full", "period/double",
@@ -67,6 +70,9 @@ public final class EnvironmentWritingGameTests {
helper.assertTrue(PageItem.bundledCreativeSymbols().containsAll(expected)
&& creative.containsAll(expected),
"Every supported environment page must enter the creative index JEI also consumes");
helper.assertValueEqual(PageItem.bundledCreativeSymbols().stream()
.filter(path -> path.startsWith("number/")).count(), 25L,
"Creative and JEI must expose all 25 D'ni number pages");
for (String path : expected) {
var id = ResourceLocation.fromNamespaceAndPath("rivencraft", path);
helper.assertTrue(SymbolCatalog.isKnown(new SymbolReference(id))
@@ -135,6 +141,207 @@ public final class EnvironmentWritingGameTests {
helper.succeed();
}
@GameTest(template = "empty")
public static void authoredStaticSkyColorSurvivesWritingAndFeedsPreview(GameTestHelper helper) {
OrderedWriting writing = new OrderedWriting(List.of(
WritingEntry.linkPanel(), page("terrain/standard"), page("number/20"),
page("color/blue"), page("sky/static"), page("celestial/normal_time")));
AgeTraits seeded = AgeTraits.select(44L);
AgeGenerationPlan plan = AgeGenerationPlan.compile(writing, 44L, AgeGenerationProfiles.STANDARD,
seeded, helper.getLevel().registryAccess());
helper.assertTrue(AgeEnvironmentCompiler.staticSky(plan),
"The authored Static Sky page must survive Age compilation");
helper.assertValueEqual(AgeEnvironmentCompiler.skyEffects(plan, BuiltinDimensionTypes.OVERWORLD_EFFECTS),
AgeEnvironmentCompiler.CUSTOM_SKY_EFFECTS,
"The static sky must select Rivencraft's custom renderer");
helper.assertValueEqual(AgeEnvironmentCompiler.selectedSkyColor(plan,
BuiltinDimensionTypes.OVERWORLD_EFFECTS, 0xFF77AAFF),
0x0000C8, "The authored color must tint the sky and preview consistently");
AgeGenerationPlan restored = AgeGenerationPlan.load(plan.save());
helper.assertTrue(AgeEnvironmentCompiler.staticSky(restored),
"A saved Age must retain its static sky choice");
helper.assertValueEqual(AgeEnvironmentCompiler.skyColor(restored), 0x0000C8,
"A saved Age must retain its sky color choice");
AgeGenerationPlan coloredEnd = AgeGenerationPlan.compile(new OrderedWriting(List.of(
WritingEntry.linkPanel(), page("terrain/standard"), page("number/15"),
page("color/red"), page("sky/end"), page("celestial/normal_time"))),
45L, AgeGenerationProfiles.STANDARD, AgeTraits.select(45L),
helper.getLevel().registryAccess());
helper.assertValueEqual(AgeEnvironmentCompiler.skyEffects(coloredEnd,
BuiltinDimensionTypes.OVERWORLD_EFFECTS),
AgeEnvironmentCompiler.CUSTOM_SKY_EFFECTS,
"A color page must make non-Overworld skies renderable by the custom sky effect");
helper.assertValueEqual(AgeEnvironmentCompiler.selectedSkyColor(coloredEnd,
BuiltinDimensionTypes.OVERWORLD_EFFECTS, 0xFF77AAFF),
0x960000, "A color page must override the selected sky type's default tint");
helper.assertTrue(PageItem.bundledCreativeSymbols().contains("sky/static")
&& PageItem.bundledCreativeSymbols().contains("color/blue")
&& PageItem.bundledCreativeSymbols().contains("number/24"),
"New sky pages must be available through the Creative and JEI page catalog");
helper.succeed();
}
@GameTest(template = "empty")
public static void skyAndCelestialColorsBlendWithoutRequiringBodies(GameTestHelper helper) {
OrderedWriting writing = new OrderedWriting(List.of(
WritingEntry.linkPanel(), page("terrain/standard"),
page("number/10"), page("color/red"), page("number/5"), page("color/blue"),
page("sky/overworld"), page("number/12"), page("color/green"),
page("number/7"), page("color/blue"), page("celestial/sun")));
helper.assertTrue(WritingGrammar.parse(writing).canCreate(),
"Two sky colors and two colors for one sun must be valid writing");
AgeTraits traits = AgeTraits.select(46L);
AgeGenerationPlan plan = AgeGenerationPlan.compile(writing, 46L,
AgeGenerationProfiles.STANDARD, traits, helper.getLevel().registryAccess());
int skyColor = 0x640032;
int sunColor = 0x007846;
helper.assertValueEqual(AgeEnvironmentCompiler.skyColor(plan), skyColor,
"Sky color pages must blend without discarding either page");
AgeSkyProfile profile = AgeSkyProfile.compile(plan, traits);
helper.assertValueEqual(profile.bodies().size(), 1, "The written Age has exactly one sun");
helper.assertValueEqual(profile.bodies().getFirst().color(), sunColor,
"Celestial colors must blend for the following body");
helper.assertValueEqual(AgeSkyProfile.compile(AgeGenerationPlan.load(plan.save()), traits), profile,
"Blended colors must survive the saved writing plan");
AgeSkyProfile bodyless = new AgeSkyProfile(AgeSkyProfile.Style.OVERWORLD, skyColor, List.of());
helper.assertTrue(bodyless.custom() && bodyless.bodies().isEmpty(),
"An Age can have an authored sky without any celestial bodies");
helper.succeed();
}
@GameTest(template = "empty")
public static void colorNumbersUseDniDigitsAndMissingChannelsRemainZero(GameTestHelper helper) {
OrderedWriting writing = new OrderedWriting(List.of(
WritingEntry.linkPanel(), page("number/12"), page("color/red"),
page("number/5"), page("color/white"), page("number/3"), page("color/black"),
page("sky/overworld")));
AgeGenerationPlan plan = AgeGenerationPlan.compile(writing, 49L,
AgeGenerationProfiles.STANDARD, AgeTraits.select(49L), helper.getLevel().registryAccess());
helper.assertValueEqual(AgeEnvironmentCompiler.skyColor(plan), 0x8C1414,
"White adds and Black subtracts from every channel; missing green and blue start at zero");
helper.assertValueEqual(AgeEnvironmentCompiler.skyColor(AgeGenerationPlan.load(plan.save())), 0x8C1414,
"D'ni color multipliers must remain frozen in a saved Age plan");
OrderedWriting unnumbered = new OrderedWriting(List.of(
WritingEntry.linkPanel(), page("color/green"), page("sky/overworld")));
AgeGenerationPlan randomPlan = AgeGenerationPlan.compile(unnumbered, 50L,
AgeGenerationProfiles.STANDARD, AgeTraits.select(50L), helper.getLevel().registryAccess());
int color = AgeEnvironmentCompiler.skyColor(randomPlan);
helper.assertTrue((color & 0xFF00FF) == 0 && ((color >> 8) & 255) <= 240
&& ((color >> 8) & 255) % 10 == 0,
"An unnumbered color gets one seeded base-25 digit and leaves omitted channels at zero");
helper.assertValueEqual(AgeEnvironmentCompiler.skyColor(AgeGenerationPlan.load(randomPlan.save())), color,
"A random color digit must not change when an Age is reloaded");
helper.succeed();
}
@GameTest(template = "empty")
public static void numberPagesSetAdjacentCelestialModifiers(GameTestHelper helper) {
OrderedWriting writing = new OrderedWriting(List.of(
WritingEntry.linkPanel(), page("terrain/standard"), page("sky/overworld"),
page("number/1"), page("period/double"),
page("number/7"), page("angle/east"),
page("number/12"), page("phase/rising"), page("celestial/sun"),
page("number/24"), page("angle/west"),
page("number/0"), page("phase/setting"),
page("number/0"), page("period/full"), page("celestial/moon")));
helper.assertValueEqual(WritingGrammar.parse(writing).writingInstability(), 0,
"Adjacent number and celestial modifier pages must not count as misplaced writing");
AgeTraits seeded = AgeTraits.select(94L);
AgeGenerationPlan plan = AgeGenerationPlan.compile(writing, 94L,
AgeGenerationProfiles.STANDARD, seeded, helper.getLevel().registryAccess());
AgeTraits effective = AgeEnvironmentCompiler.apply(plan, seeded);
AgeSkyProfile sky = AgeSkyProfile.compile(plan, effective);
helper.assertValueEqual(sky.bodies().getFirst().period(), 0.08D,
"A number overrides a fixed Length page at 0.08 per digit, even below the random minimum");
helper.assertValueEqual(sky.bodies().getFirst().angle(), 105.0F,
"A number overrides a fixed Angle page at 15 degrees per digit");
helper.assertValueEqual(sky.bodies().getFirst().phase(), 0.5F,
"A number overrides a fixed Phase page at 15 degrees per digit");
helper.assertValueEqual(sky.bodies().getLast().angle(), 0.0F,
"Digit 24 wraps a full 360-degree rotation to zero");
helper.assertValueEqual(sky.bodies().getLast().phase(), 0.0F,
"Digit zero is a valid phase override");
helper.assertValueEqual(effective.celestialPeriod(), 0.0D,
"The final authored celestial controls the world clock");
helper.assertValueEqual(AgeSkyProfile.compile(AgeGenerationPlan.load(plan.save()), effective), sky,
"Numbered celestial values must survive a plan save/load round trip");
AgeGenerationPlan normalTime = AgeGenerationPlan.compile(new OrderedWriting(List.of(
WritingEntry.linkPanel(), page("number/6"), page("angle/north"),
page("celestial/normal_time"))), 95L, AgeGenerationProfiles.STANDARD,
AgeTraits.select(95L), helper.getLevel().registryAccess());
helper.assertValueEqual(AgeEnvironmentCompiler.skyEffects(normalTime,
BuiltinDimensionTypes.OVERWORLD_EFFECTS), AgeEnvironmentCompiler.CUSTOM_SKY_EFFECTS,
"An authored angle on Normal Time must select the custom celestial renderer");
AgeSkyProfile normalSky = AgeSkyProfile.compile(normalTime,
AgeEnvironmentCompiler.apply(normalTime, AgeTraits.select(95L)));
helper.assertValueEqual(normalSky.bodies().getFirst().angle(), 90.0F,
"The custom Normal Time sun must honor its numbered angle");
helper.assertValueEqual(normalSky.bodies().getFirst().color(), 0xFFFFFF,
"Uncolored custom celestial bodies must remain visible");
OrderedWriting separated = new OrderedWriting(List.of(WritingEntry.linkPanel(),
page("number/7"), page("direction/clockwise"), page("angle/east"), page("celestial/sun")));
helper.assertValueEqual(WritingGrammar.parse(separated).writingInstability(), 100,
"A number does not reach past an intervening page");
helper.succeed();
}
@GameTest(template = "empty")
public static void alignedMoonEclipsesSunAndDimsLight(GameTestHelper helper) {
AgeSkyProfile.Body sun = new AgeSkyProfile.Body(AgeSkyProfile.Kind.SUN,
0xCC8844, 1.0F, 0.0F, 1.0D, 0.0F, true);
AgeSkyProfile.Body moon = new AgeSkyProfile.Body(AgeSkyProfile.Kind.MOON,
0xFFFFFF, 1.0F, 0.0F, 1.0D, 0.0F, true);
AgeSkyProfile clear = new AgeSkyProfile(AgeSkyProfile.Style.OVERWORLD, 0x6688AA, List.of(sun));
AgeSkyProfile eclipse = new AgeSkyProfile(AgeSkyProfile.Style.OVERWORLD, 0x6688AA,
List.of(sun, moon));
helper.assertValueEqual(eclipse.eclipseAt(0.0D), 1.0F,
"Centered sun and moon must produce a full eclipse");
helper.assertTrue(eclipse.lightAt(0.0D) < clear.lightAt(0.0D),
"An eclipse must dim world skylight, not just the rendered sprites");
AgeSkyProfile separated = new AgeSkyProfile(AgeSkyProfile.Style.OVERWORLD, 0x6688AA,
List.of(sun, new AgeSkyProfile.Body(AgeSkyProfile.Kind.MOON,
0xFFFFFF, 1.0F, 0.0F, 1.0D, 0.5F, true)));
helper.assertValueEqual(separated.eclipseAt(0.0D), 0.0F,
"A moon on the far side of the sky must not eclipse the sun");
AgeSkyProfile glowOnlyOverlap = new AgeSkyProfile(AgeSkyProfile.Style.OVERWORLD, 0x6688AA,
List.of(sun, new AgeSkyProfile.Body(AgeSkyProfile.Kind.MOON,
0xFFFFFF, 1.0F, 0.0F, 1.0D, 0.04F, true)));
helper.assertValueEqual(glowOnlyOverlap.eclipseAt(0.0D), 0.0F,
"Overlapping glows must not count as an eclipse before the opaque discs touch");
helper.succeed();
}
@GameTest(template = "empty")
public static void randomAndAuthoredCelestialsKeepIndependentOrbits(GameTestHelper helper) {
AgeTraits traits = AgeTraits.select(12345L);
AgeSkyProfile first = AgeSkyProfile.random(12345L, traits);
helper.assertValueEqual(first, AgeSkyProfile.random(12345L, traits),
"A random Age must recreate the same sky from its saved seed");
helper.assertTrue(first.bodies().stream().filter(body -> body.kind() == AgeSkyProfile.Kind.SUN).count() <= 10
&& first.bodies().stream().filter(body -> body.kind() == AgeSkyProfile.Kind.MOON).count() <= 10,
"Random Ages must obey the same celestial limits as authored Ages");
OrderedWriting writing = new OrderedWriting(List.of(
WritingEntry.linkPanel(), page("terrain/standard"), page("sky/end"),
page("angle/east"), page("direction/counterclockwise"), page("number/24"), page("color/red"),
page("size/large"), page("period/half"), page("celestial/sun"),
page("direction/clockwise"), page("celestial/moon")));
AgeGenerationPlan plan = AgeGenerationPlan.compile(writing, 12345L, AgeGenerationProfiles.STANDARD,
traits, helper.getLevel().registryAccess());
AgeSkyProfile sky = AgeSkyProfile.compile(plan, AgeEnvironmentCompiler.apply(plan, traits));
helper.assertValueEqual(sky.bodies().size(), 2, "Both written celestial bodies must be retained");
helper.assertValueEqual(sky.bodies().getFirst().angle(), 90.0F,
"The first body's compass angle must be independent");
helper.assertFalse(sky.bodies().getFirst().clockwise(),
"The first body should move counterclockwise");
helper.assertTrue(sky.bodies().getLast().clockwise(),
"The second body should move clockwise");
helper.assertValueEqual(AgeSkyProfile.compile(AgeGenerationPlan.load(plan.save()), traits), sky,
"Body angle and direction must survive Age-plan serialization");
helper.succeed();
}
@GameTest(template = "empty")
public static void writtenEnvironmentPersistsAndPageFreeAgesStaySeeded(GameTestHelper helper) {
OrderedWriting writing = new OrderedWriting(List.of(
@@ -193,6 +400,48 @@ public final class EnvironmentWritingGameTests {
});
}
@GameTest(template = "empty")
public static void celestialModifiersFollowWrittenOrder(GameTestHelper helper) {
AgeTraits seeded = AgeTraits.select(42L);
OrderedWriting consumed = new OrderedWriting(List.of(WritingEntry.linkPanel(),
page("period/half"), page("period/double"), page("phase/rising"),
page("celestial/normal_time")));
AgeGenerationPlan consumedPlan = AgeGenerationPlan.compile(consumed, 42L,
AgeGenerationProfiles.STANDARD, seeded, helper.getLevel().registryAccess());
AgeTraits consumedTraits = AgeEnvironmentCompiler.apply(consumedPlan, seeded);
helper.assertValueEqual(consumedTraits.celestialPeriod(), 1.25D,
"Repeated period pages must combine before Normal Time consumes them");
helper.assertValueEqual(consumedTraits.celestialPhase(), 0.25F,
"A preceding phase page must be consumed by Normal Time");
helper.assertValueEqual(consumedPlan.writingInstability(), 0,
"Consumed modifiers must not be charged as dangling");
OrderedWriting dangling = new OrderedWriting(List.of(WritingEntry.linkPanel(),
page("celestial/normal_time"), page("period/zero"), page("phase/rising")));
AgeGenerationPlan danglingPlan = AgeGenerationPlan.compile(dangling, 42L,
AgeGenerationProfiles.STANDARD, seeded, helper.getLevel().registryAccess());
AgeTraits danglingTraits = AgeEnvironmentCompiler.apply(danglingPlan, seeded);
helper.assertValueEqual(danglingTraits.celestialPeriod(), 1.0D,
"A period after Normal Time must not change the already-written sun");
helper.assertValueEqual(danglingTraits.celestialPhase(), seeded.celestialPhase(),
"A phase after Normal Time must not change the already-written sun");
helper.assertFalse(AgeEnvironmentCompiler.hasWrittenPhase(danglingPlan),
"An unconsumed phase page must not set the Age's start time");
helper.assertValueEqual(danglingPlan.writingInstability(), 200,
"Each unconsumed modifier kind must contribute Legacy's +100");
helper.assertValueEqual(AgeEnvironmentCompiler.apply(AgeGenerationPlan.load(danglingPlan.save()), seeded),
danglingTraits, "Ordered modifier behavior must survive reload");
AgeGenerationPlan previousVersion = new AgeGenerationPlan(3, danglingPlan.ageSeed(),
danglingPlan.writing(), danglingPlan.symbols(), danglingPlan.runtimeProfile(),
danglingPlan.biomeSelection(), danglingPlan.activeSymbolIndices(), danglingPlan.writingInstability());
helper.assertTrue(AgeEnvironmentCompiler.apply(previousVersion, seeded).hasStoppedCelestialCycle(),
"An existing version-3 Age must retain its earlier stage-sorted time behavior");
helper.assertTrue(AgeInstability.compute(previousVersion, seeded, helper.getLevel().registryAccess())
.breakdown().stream().anyMatch(entry -> entry.reason().equals("legacy_writing")),
"Version-3 writing cost must not be revalidated under version-4 grammar");
helper.succeed();
}
private static WritingEntry page(String path) {
return WritingEntry.symbol(new SymbolReference(ResourceLocation.fromNamespaceAndPath("rivencraft", path)));
}
@@ -0,0 +1,128 @@
package net.dnorberg.rivencraft.book;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.entity.DroppedBookEntity;
import net.dnorberg.rivencraft.registry.ModEntities;
import net.dnorberg.rivencraft.registry.ModItems;
import net.minecraft.core.BlockPos;
import net.minecraft.core.GlobalPos;
import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.world.InteractionHand;
import net.minecraft.world.entity.item.ItemEntity;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items;
import net.minecraft.world.level.block.Blocks;
import net.minecraft.world.phys.AABB;
import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
@GameTestHolder(Rivencraft.MOD_ID)
@PrefixGameTestTemplate(false)
public final class HandheldBookTravelGameTests {
private HandheldBookTravelGameTests() {
}
@GameTest(template = "empty")
public static void successfulHandheldTravelLeavesOnlyActiveBookAtOrigin(GameTestHelper helper) {
var player = helper.makeMockServerPlayerInLevel();
ItemStack book = new ItemStack(ModItems.LINKING_BOOK.get());
player.setItemInHand(InteractionHand.MAIN_HAND, book);
player.getInventory().setItem(1, new ItemStack(Items.DIAMOND));
var source = player.position();
BlockPos destination = helper.absolutePos(new BlockPos(2, 1, 2));
helper.getLevel().setBlock(destination, Blocks.AIR.defaultBlockState(), 2);
helper.getLevel().setBlock(destination.above(), Blocks.AIR.defaultBlockState(), 2);
LinkTarget target = new LinkTarget(GlobalPos.of(helper.getLevel().dimension(), destination), 0, 0);
helper.assertValueEqual(LinkingService.travelHandheld(player, InteractionHand.MAIN_HAND, book, target,
new LinkProperties(LinkProperties.INTRA_LINKING), false), LinkingService.LinkResult.SUCCESS,
"A valid intra-dimensional handheld link must succeed");
helper.assertTrue(player.getMainHandItem().isEmpty(), "Only the active book must leave the hand");
helper.assertTrue(player.getInventory().getItem(1).is(Items.DIAMOND),
"An unrelated inventory item must remain with the player");
var drops = helper.getLevel().getEntitiesOfClass(DroppedBookEntity.class, new AABB(source, source).inflate(2.0),
entity -> entity.getItem() == book);
helper.assertValueEqual(drops.size(), 1,
"Exactly one entity for this active book must remain at the departure point");
helper.assertTrue(drops.getFirst().getItem() == book,
"The model-rendered entity must retain the exact active book stack");
helper.assertTrue(drops.getFirst().copy() instanceof DroppedBookEntity,
"The pickup-animation copy must keep the custom renderer's entity type");
helper.succeed();
}
@GameTest(template = "empty")
public static void rejectedHandheldTravelKeepsBook(GameTestHelper helper) {
var player = helper.makeMockServerPlayerInLevel();
ItemStack book = new ItemStack(ModItems.LINKING_BOOK.get());
player.setItemInHand(InteractionHand.OFF_HAND, book);
LinkTarget target = new LinkTarget(GlobalPos.of(helper.getLevel().dimension(), player.blockPosition()), 0, 0);
helper.assertValueEqual(LinkingService.travelHandheld(player, InteractionHand.OFF_HAND, book, target,
LinkProperties.NONE, false), LinkingService.LinkResult.INTRA_LINKING_REQUIRED,
"A same-dimension link without Intra Linking must be rejected");
helper.assertTrue(player.getOffhandItem() == book, "The exact rejected book must be restored to its hand");
helper.assertTrue(helper.getLevel().getEntitiesOfClass(ItemEntity.class,
new AABB(player.position(), player.position()).inflate(2.0),
entity -> entity.getItem().is(ModItems.LINKING_BOOK.get())).isEmpty(),
"A rejected link must not leave a second copy at the origin");
helper.succeed();
}
@GameTest(template = "empty")
public static void disarmDropsOtherInventoryWithoutDuplicatingActiveBook(GameTestHelper helper) {
var player = helper.makeMockServerPlayerInLevel();
ItemStack book = new ItemStack(ModItems.LINKING_BOOK.get());
player.setItemInHand(InteractionHand.MAIN_HAND, book);
player.getInventory().setItem(1, new ItemStack(Items.DIAMOND));
var source = player.position();
BlockPos destination = helper.absolutePos(new BlockPos(2, 1, 2));
helper.getLevel().setBlock(destination, Blocks.AIR.defaultBlockState(), 2);
helper.getLevel().setBlock(destination.above(), Blocks.AIR.defaultBlockState(), 2);
LinkTarget target = new LinkTarget(GlobalPos.of(helper.getLevel().dimension(), destination), 0, 0);
helper.assertValueEqual(LinkingService.travelHandheld(player, InteractionHand.MAIN_HAND, book, target,
new LinkProperties(LinkProperties.INTRA_LINKING | LinkProperties.DISARM), false),
LinkingService.LinkResult.SUCCESS, "Disarm must not block handheld travel");
var drops = helper.getLevel().getEntitiesOfClass(ItemEntity.class, new AABB(source, source).inflate(2.0));
helper.assertValueEqual(drops.stream().filter(entity -> entity instanceof DroppedBookEntity).count(),
1L, "Disarm must not create a second copy of the active book");
helper.assertValueEqual(drops.stream().filter(entity -> entity.getItem().is(Items.DIAMOND)).count(),
1L, "Disarm must still drop unrelated inventory items");
helper.succeed();
}
@GameTest(template = "empty")
public static void originBookUsesSlowDecayWithoutVanillaDespawn(GameTestHelper helper) {
DroppedBookEntity book = new DroppedBookEntity(helper.getLevel(),
net.minecraft.world.phys.Vec3.ZERO, new ItemStack(ModItems.LINKING_BOOK.get()));
CompoundTag seeded = new CompoundTag();
book.saveWithoutId(seeded);
seeded.putInt("BookDecayTicks", 9_999);
book.readAdditionalSaveData(seeded);
book.tick();
CompoundTag saved = new CompoundTag();
book.saveWithoutId(saved);
helper.assertValueEqual(saved.getShort("Age"), (short)-32_768,
"The dropped book must not expire after vanilla's five minutes");
helper.assertValueEqual(saved.getShort("Health"), (short)4,
"A dropped book must lose one item-health point after 10,000 loaded ticks");
helper.assertValueEqual(saved.getInt("BookDecayTicks"), 0,
"Slow decay must reset its interval and persist across a restart");
DroppedBookEntity restored = new DroppedBookEntity(ModEntities.DROPPED_BOOK.get(), helper.getLevel());
restored.readAdditionalSaveData(saved);
CompoundTag resaved = new CompoundTag();
restored.saveWithoutId(resaved);
helper.assertTrue(restored.getItem().is(ModItems.LINKING_BOOK.get()),
"The custom book entity must retain its book on reload");
helper.assertValueEqual(resaved.getShort("Age"), (short)-32_768,
"The custom book must remain non-despawning after reload");
helper.assertValueEqual(resaved.getShort("Health"), (short)4,
"Decay damage must persist after reload");
helper.assertTrue(restored.copy().getItem().is(ModItems.LINKING_BOOK.get()),
"A pickup-animation copy must retain the book data after reload");
helper.succeed();
}
}
@@ -0,0 +1,58 @@
package net.dnorberg.rivencraft.book;
import net.dnorberg.rivencraft.mixin.MobDropChanceAccessor;
import net.minecraft.world.Container;
import net.minecraft.world.entity.Entity;
import net.minecraft.world.entity.EquipmentSlot;
import net.minecraft.world.entity.Mob;
import net.minecraft.world.entity.animal.horse.AbstractHorse;
import net.minecraft.world.entity.item.ItemEntity;
import net.minecraft.server.level.ServerPlayer;
import net.minecraft.world.item.ItemStack;
/** Legacy-style Disarm: leave carried items and eligible equipment at the departure point. */
public final class LinkDisarmService {
private LinkDisarmService() {}
public static boolean mayTravel(Entity entity) {
// Legacy refuses loose items and dropped Link Books on Disarm links.
return !(entity instanceof ItemEntity);
}
public static void disarm(Entity entity) {
if (entity instanceof ServerPlayer player) {
eject(player, player.getInventory());
player.containerMenu.broadcastChanges();
}
if (entity instanceof Container container) eject(entity, container);
if (entity instanceof AbstractHorse horse) eject(entity, horse.getInventory());
if (entity instanceof Mob mob) dropEquipment(mob);
}
private static void eject(Entity carrier, Container inventory) {
for (int slot = 0; slot < inventory.getContainerSize(); slot++) {
ItemStack stack = inventory.getItem(slot);
if (stack.isEmpty()) continue;
inventory.setItem(slot, ItemStack.EMPTY);
carrier.spawnAtLocation(stack);
}
inventory.setChanged();
}
private static void dropEquipment(Mob mob) {
for (EquipmentSlot slot : EquipmentSlot.values()) {
ItemStack stack = mob.getItemBySlot(slot);
if (stack.isEmpty()) continue;
float chance = ((MobDropChanceAccessor) mob).rivencraft$getEquipmentDropChance(slot);
mob.setItemSlot(slot, ItemStack.EMPTY);
if (chance <= 0 || mob.getRandom().nextFloat() >= chance) continue;
if (chance <= 1 && stack.isDamageableItem()) {
int minimum = Math.max(stack.getMaxDamage() - 25, 1);
int damage = stack.getMaxDamage() - mob.getRandom().nextInt(
1 + mob.getRandom().nextInt(minimum));
stack.setDamageValue(Math.clamp(damage, 1, minimum));
}
mob.spawnAtLocation(stack);
}
}
}
@@ -0,0 +1,125 @@
package net.dnorberg.rivencraft.book;
import net.dnorberg.rivencraft.Rivencraft;
import net.minecraft.core.BlockPos;
import net.minecraft.core.GlobalPos;
import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper;
import net.minecraft.world.entity.EquipmentSlot;
import net.minecraft.world.entity.EntityType;
import net.minecraft.world.entity.animal.horse.Donkey;
import net.minecraft.world.entity.item.ItemEntity;
import net.minecraft.world.entity.monster.Zombie;
import net.minecraft.world.entity.vehicle.MinecartChest;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items;
import net.minecraft.world.level.block.Blocks;
import net.minecraft.world.phys.AABB;
import net.minecraft.world.phys.Vec3;
import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
@GameTestHolder(Rivencraft.MOD_ID)
@PrefixGameTestTemplate(false)
public final class LinkModifierBehaviorGameTests {
private LinkModifierBehaviorGameTests() {}
@GameTest(template = "empty")
public static void maintainMomentumRotatesToDestinationYaw(GameTestHelper helper) {
Vec3 result = LinkingService.rotatedMomentum(new Vec3(3, -0.5, 4), 90);
helper.assertTrue(Math.abs(result.x) < 0.0001 && Math.abs(result.y + 0.3) < 0.0001
&& Math.abs(result.z - 5) < 0.0001,
"Legacy momentum preserves horizontal speed, rotates to destination yaw, and adds a small lift");
helper.succeed();
}
@GameTest(template = "empty")
public static void disarmRefusesLooseItems(GameTestHelper helper) {
var level = helper.getLevel();
ItemEntity item = new ItemEntity(level, 1, 1, 1, new ItemStack(Items.DIAMOND));
level.addFreshEntity(item);
LinkTarget target = new LinkTarget(GlobalPos.of(level.dimension(), helper.absolutePos(new BlockPos(2, 1, 2))),
0, 0);
helper.assertValueEqual(LinkingService.travelEntityPortal(item, target,
new LinkProperties(LinkProperties.DISARM | LinkProperties.INTRA_LINKING), false),
LinkingService.LinkResult.DISARM_REJECTED,
"Legacy Disarm must refuse a loose item before teleportation");
helper.assertTrue(item.isAlive() && item.getItem().is(Items.DIAMOND),
"Rejected item must remain at the source");
helper.succeed();
}
@GameTest(template = "empty")
public static void ordinaryLinkMovesLooseItemWithoutMakingPlatform(GameTestHelper helper) {
var level = helper.getLevel();
BlockPos landing = helper.absolutePos(new BlockPos(2, 2, 2));
level.setBlock(landing.below(), Blocks.AIR.defaultBlockState(), 2);
level.setBlock(landing, Blocks.AIR.defaultBlockState(), 2);
level.setBlock(landing.above(), Blocks.AIR.defaultBlockState(), 2);
ItemEntity item = new ItemEntity(level, 1, 1, 1, new ItemStack(Items.DIAMOND));
level.addFreshEntity(item);
LinkTarget target = new LinkTarget(GlobalPos.of(level.dimension(), landing), 0, 0);
helper.assertValueEqual(LinkingService.travelEntityPortal(item, target,
new LinkProperties(LinkProperties.INTRA_LINKING), false),
LinkingService.LinkResult.SUCCESS, "Ordinary portal links may carry loose items");
helper.assertTrue(item.blockPosition().distManhattan(landing) <= 1,
"Item must arrive at the linked location");
helper.assertTrue(level.getBlockState(landing.below()).isAir(),
"A Linking Book must not generate a landing platform by default");
helper.succeed();
}
@GameTest(template = "empty")
public static void explicitGeneratePlatformAddsOnlyArrivalFloor(GameTestHelper helper) {
var level = helper.getLevel();
BlockPos landing = helper.absolutePos(new BlockPos(2, 2, 2));
level.setBlock(landing.below(), Blocks.AIR.defaultBlockState(), 2);
level.setBlock(landing, Blocks.AIR.defaultBlockState(), 2);
level.setBlock(landing.above(), Blocks.AIR.defaultBlockState(), 2);
level.setBlock(landing.above(2), Blocks.AIR.defaultBlockState(), 2);
ItemEntity item = new ItemEntity(level, 1, 1, 1, new ItemStack(Items.DIAMOND));
level.addFreshEntity(item);
LinkTarget target = new LinkTarget(GlobalPos.of(level.dimension(), landing), 0, 0);
helper.assertValueEqual(LinkingService.travelEntityPortal(item, target,
new LinkProperties(LinkProperties.INTRA_LINKING | LinkProperties.GENERATE_PLATFORM), false),
LinkingService.LinkResult.SUCCESS, "An explicit platform link must travel");
helper.assertTrue(level.getBlockState(landing.below()).is(
net.dnorberg.rivencraft.registry.ModBlocks.CLOUD_PLATFORM.get()),
"An enabled Linking Book platform must add one cloud block below the arrival");
helper.succeed();
}
@GameTest(template = "empty")
public static void disarmEmptiesCarrierAndMobEquipment(GameTestHelper helper) {
var level = helper.getLevel();
Vec3 source = Vec3.atCenterOf(helper.absolutePos(new BlockPos(1, 1, 1)));
MinecartChest cart = EntityType.CHEST_MINECART.create(level);
Donkey donkey = EntityType.DONKEY.create(level);
Zombie zombie = EntityType.ZOMBIE.create(level);
helper.assertTrue(cart != null && donkey != null && zombie != null, "Carriers must instantiate");
cart.setPos(source);
donkey.setPos(source);
zombie.setPos(source);
level.addFreshEntity(cart);
level.addFreshEntity(donkey);
level.addFreshEntity(zombie);
cart.setItem(0, new ItemStack(Items.EMERALD));
donkey.getInventory().setItem(0, new ItemStack(Items.SADDLE));
zombie.setItemSlot(EquipmentSlot.MAINHAND, new ItemStack(Items.IRON_SWORD));
zombie.setDropChance(EquipmentSlot.MAINHAND, 2.0F);
LinkDisarmService.disarm(cart);
LinkDisarmService.disarm(donkey);
LinkDisarmService.disarm(zombie);
helper.assertTrue(cart.getItem(0).isEmpty() && donkey.getInventory().getItem(0).isEmpty()
&& zombie.getItemBySlot(EquipmentSlot.MAINHAND).isEmpty(),
"Disarm must remove inventory contents and worn equipment");
var drops = level.getEntitiesOfClass(ItemEntity.class, new AABB(source, source).inflate(3));
helper.assertTrue(drops.stream().anyMatch(item -> item.getItem().is(Items.EMERALD))
&& drops.stream().anyMatch(item -> item.getItem().is(Items.SADDLE))
&& drops.stream().anyMatch(item -> item.getItem().is(Items.IRON_SWORD)),
"Carrier items and guaranteed-drop mob equipment must remain at departure");
helper.succeed();
}
}
@@ -11,11 +11,15 @@ import net.minecraft.network.chat.Component;
/** Flags written into a Link Panel and carried by books assembled from it. */
public record LinkProperties(int flags) {
public static final int DISARM = 1;
/** Retained only to read pre-0.4.7.1 test books; no longer generated or applied. */
/** Linking Books do not create a platform unless this Legacy flag is enabled. */
public static final int GENERATE_PLATFORM = 2;
public static final int MAINTAIN_MOMENTUM = 4;
public static final int INTRA_LINKING = 8;
private static final int ALL_FLAGS = DISARM | GENERATE_PLATFORM | MAINTAIN_MOMENTUM | INTRA_LINKING;
public static final int INTRA_LINKING_ONLY = 16;
public static final int RELATIVE_LINK = 32;
public static final int DISABLE_PLATFORM = 64;
private static final int ALL_FLAGS = DISARM | GENERATE_PLATFORM | MAINTAIN_MOMENTUM | INTRA_LINKING
| INTRA_LINKING_ONLY | RELATIVE_LINK | DISABLE_PLATFORM;
public static final LinkProperties NONE = new LinkProperties(0);
public static final Codec<LinkProperties> CODEC = Codec.intRange(0, ALL_FLAGS).xmap(
LinkProperties::new, LinkProperties::flags);
@@ -35,13 +39,17 @@ public record LinkProperties(int flags) {
/** Intra Linking only governs Linking Books; a Descriptive Book treats that panel as ordinary. */
public LinkProperties forDescriptiveBook() {
return new LinkProperties(flags & ~INTRA_LINKING);
return new LinkProperties(flags & ~(INTRA_LINKING | INTRA_LINKING_ONLY));
}
public void appendTooltip(List<Component> lines) {
if (has(DISARM)) lines.add(propertyName("disarm"));
if (has(MAINTAIN_MOMENTUM)) lines.add(propertyName("maintain_momentum"));
if (has(INTRA_LINKING)) lines.add(propertyName("intra_linking"));
if (has(INTRA_LINKING_ONLY)) lines.add(propertyName("intra_linking_only"));
if (has(RELATIVE_LINK)) lines.add(propertyName("relative_link"));
if (has(GENERATE_PLATFORM)) lines.add(propertyName("generate_platform"));
if (has(DISABLE_PLATFORM)) lines.add(propertyName("disable_platform"));
}
private static Component propertyName(String name) {
@@ -54,6 +62,10 @@ public record LinkProperties(int flags) {
case DISARM -> propertyName("disarm");
case MAINTAIN_MOMENTUM -> propertyName("maintain_momentum");
case INTRA_LINKING -> propertyName("intra_linking");
case INTRA_LINKING_ONLY -> propertyName("intra_linking_only");
case RELATIVE_LINK -> propertyName("relative_link");
case GENERATE_PLATFORM -> propertyName("generate_platform");
case DISABLE_PLATFORM -> propertyName("disable_platform");
default -> throw new IllegalArgumentException("Unknown link property flag: " + flag);
};
}
@@ -0,0 +1,41 @@
package net.dnorberg.rivencraft.book;
import net.dnorberg.rivencraft.registry.ModSounds;
import net.minecraft.core.particles.ParticleTypes;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.server.level.ServerPlayer;
import net.minecraft.sounds.SoundEvent;
import net.minecraft.sounds.SoundSource;
import net.minecraft.world.phys.Vec3;
/** Legacy-style sound and particle bursts at both ends of a successful link. */
public final class LinkVisualEffects {
private static final int PARTICLE_COUNT = 50;
private LinkVisualEffects() {}
public static SoundEvent sound(LinkProperties properties, boolean portal) {
// Legacy's Disarm flag takes precedence over a portal's sound override.
if (properties.has(LinkProperties.DISARM)) return ModSounds.LINK_DISARM.get();
if (portal) return ModSounds.LINK_PORTAL.get();
if (properties.has(LinkProperties.INTRA_LINKING)) return ModSounds.LINK_INTRA.get();
return ModSounds.LINK.get();
}
public static void play(ServerLevel source, Vec3 departure, ServerPlayer player,
LinkProperties properties, boolean portal) {
SoundEvent event = sound(properties, portal);
burst(source, departure, event);
burst(player.serverLevel(), player.position(), event);
}
private static void burst(ServerLevel level, Vec3 position, SoundEvent event) {
level.playSound(null, position.x, position.y, position.z, event,
SoundSource.PLAYERS, 0.8F, level.random.nextFloat() * 0.2F + 0.9F);
// Legacy emitted 50 small neutral particles in a roughly one-by-two-
// block space. Cloud particles are a vanilla gray-white stand-in for
// its removed fixed-function particle class.
level.sendParticles(ParticleTypes.CLOUD, position.x, position.y, position.z,
PARTICLE_COUNT, 0.5, 1.0, 0.5, 0.005);
}
}
@@ -5,14 +5,21 @@ import java.util.Optional;
import java.util.stream.IntStream;
import java.util.stream.Stream;
import net.dnorberg.rivencraft.compat.ImmersivePortalsChunkLoaders;
import net.dnorberg.rivencraft.entity.DroppedBookEntity;
import net.dnorberg.rivencraft.portal.PortalTravelCooldown;
import net.dnorberg.rivencraft.registry.ModBlocks;
import net.minecraft.core.BlockPos;
import net.minecraft.core.Direction;
import net.minecraft.server.level.ServerLevel;
import net.minecraft.server.level.ServerPlayer;
import net.minecraft.world.InteractionHand;
import net.minecraft.world.entity.Entity;
import net.minecraft.world.item.ItemStack;
import net.minecraft.tags.BlockTags;
import net.minecraft.world.level.border.WorldBorder;
import net.minecraft.world.level.levelgen.Heightmap;
import net.minecraft.world.phys.Vec3;
import net.minecraft.world.level.portal.DimensionTransition;
import net.neoforged.fml.ModList;
/** Server-side validation and execution for book travel. */
@@ -29,7 +36,42 @@ public final class LinkingService {
}
public static LinkResult travel(ServerPlayer player, LinkTarget target, LinkProperties properties) {
return travel(player, target, false, properties);
return travel(player, target, false, properties, false);
}
/** Removes only the active handheld book after a successful link, leaving it at the departure point. */
public static LinkResult travelHandheld(ServerPlayer player, InteractionHand hand, ItemStack activeBook,
LinkTarget target, LinkProperties properties, boolean requiresFooting) {
if (player.getItemInHand(hand) != activeBook || activeBook.isEmpty()) {
return LinkResult.NO_SAFE_DESTINATION;
}
ServerLevel sourceLevel = player.serverLevel();
Vec3 sourcePosition = player.position();
player.setItemInHand(hand, ItemStack.EMPTY);
boolean dropped = false;
try {
LinkResult result = requiresFooting
? travelWithFooting(player, target, properties)
: travel(player, target, properties);
if (result != LinkResult.SUCCESS) return result;
DroppedBookEntity book = new DroppedBookEntity(sourceLevel, sourcePosition, activeBook);
dropped = sourceLevel.addFreshEntity(book);
return result;
} finally {
// Failed validation or a rejected entity spawn must never eat the book.
if (!dropped) {
if (player.getItemInHand(hand).isEmpty()) player.setItemInHand(hand, activeBook);
else if (!player.getInventory().add(activeBook)) player.drop(activeBook, false);
}
player.containerMenu.broadcastChanges();
}
}
/** Portal travel uses the vanilla transfer if its destination is not yet loaded. */
public static LinkResult travelPortal(ServerPlayer player, LinkTarget target, LinkProperties properties) {
return travel(player, target, false, properties, true);
}
public static Optional<Vec3> resolveDestination(ServerLevel level, BlockPos origin, boolean ageArrival) {
@@ -48,75 +90,170 @@ public final class LinkingService {
if (destinationLevel == null) {
return LinkResult.MISSING_DIMENSION;
}
Optional<Vec3> destination = resolveDestination(destinationLevel, target.location().pos(), true);
if (properties.has(LinkProperties.INTRA_LINKING_ONLY) && destinationLevel != player.serverLevel())
return LinkResult.INTRA_ONLY;
BlockPos origin = landingOrigin(player, destinationLevel, target, properties);
Optional<Vec3> destination = resolveDestination(destinationLevel, origin, true);
if (destination.isEmpty()) {
return LinkResult.NO_SAFE_DESTINATION;
}
Vec3 position = destination.get();
Vec3 momentum = player.getDeltaMovement();
if (properties.has(LinkProperties.DISARM)) dropInventoryAtSource(player);
teleport(player, destinationLevel, position, target);
if (properties.has(LinkProperties.MAINTAIN_MOMENTUM)) player.setDeltaMovement(momentum);
if (properties.has(LinkProperties.DISARM)) LinkDisarmService.disarm(player);
teleport(player, destinationLevel, position, target, true);
applyMomentum(player, momentum, target, properties);
player.resetFallDistance();
return LinkResult.SUCCESS;
}
/** A descriptive portal requires existing footing, but never generates a landing platform. */
public static LinkResult travelDescriptivePortal(ServerPlayer player, LinkTarget target, LinkProperties properties) {
ServerLevel destinationLevel = player.getServer().getLevel(target.location().dimension());
if (destinationLevel == null) return LinkResult.MISSING_DIMENSION;
boolean instant = destinationChunksLoaded(destinationLevel, target.location().pos());
if (properties.has(LinkProperties.INTRA_LINKING_ONLY) && destinationLevel != player.serverLevel())
return LinkResult.INTRA_ONLY;
Optional<Vec3> destination = resolveDestination(destinationLevel,
landingOrigin(player, destinationLevel, target, properties), true);
if (destination.isEmpty()) return LinkResult.NO_SAFE_DESTINATION;
Vec3 momentum = player.getDeltaMovement();
if (properties.has(LinkProperties.DISARM)) LinkDisarmService.disarm(player);
teleport(player, destinationLevel, destination.get(), target, instant);
applyMomentum(player, momentum, target, properties);
player.resetFallDistance();
return LinkResult.SUCCESS;
}
private static LinkResult travel(ServerPlayer player, LinkTarget target, boolean requiresFooting,
LinkProperties properties) {
LinkProperties properties, boolean portal) {
ServerLevel destinationLevel = player.getServer().getLevel(target.location().dimension());
if (destinationLevel == null) {
return LinkResult.MISSING_DIMENSION;
}
if (destinationLevel == player.level() && !properties.has(LinkProperties.INTRA_LINKING))
if (properties.has(LinkProperties.INTRA_LINKING_ONLY) && destinationLevel != player.serverLevel())
return LinkResult.INTRA_ONLY;
if (destinationLevel == player.level() && !properties.has(LinkProperties.INTRA_LINKING)
&& !properties.has(LinkProperties.INTRA_LINKING_ONLY))
return LinkResult.INTRA_LINKING_REQUIRED;
Optional<Vec3> destination = resolveDestination(destinationLevel, target.location().pos(), requiresFooting);
boolean instant = !portal || destinationChunksLoaded(destinationLevel, target.location().pos());
Optional<Vec3> destination = resolveDestination(destinationLevel,
landingOrigin(player, destinationLevel, target, properties), requiresFooting);
if (destination.isEmpty()) {
return LinkResult.NO_SAFE_DESTINATION;
}
Vec3 position = destination.get();
Vec3 momentum = player.getDeltaMovement();
if (properties.has(LinkProperties.DISARM)) dropInventoryAtSource(player);
teleport(player, destinationLevel, position, target);
if (properties.has(LinkProperties.MAINTAIN_MOMENTUM)) player.setDeltaMovement(momentum);
if (properties.has(LinkProperties.DISARM)) LinkDisarmService.disarm(player);
teleport(player, destinationLevel, position, target, instant);
if (properties.has(LinkProperties.GENERATE_PLATFORM))
generateArrivalPlatform(destinationLevel, position);
applyMomentum(player, momentum, target, properties);
player.resetFallDistance();
return LinkResult.SUCCESS;
}
/** Drop each inventory stack as an item entity at the departure point. */
private static void dropInventoryAtSource(ServerPlayer player) {
var inventory = player.getInventory();
for (int slot = 0; slot < inventory.getContainerSize(); slot++) {
var stack = inventory.getItem(slot);
if (stack.isEmpty()) continue;
inventory.setItem(slot, net.minecraft.world.item.ItemStack.EMPTY);
player.drop(stack, false);
}
player.containerMenu.broadcastChanges();
/** Non-player portal travel follows the same link rules; Disarm may remove carried cargo. */
public static LinkResult travelEntityPortal(Entity entity, LinkTarget target,
LinkProperties properties, boolean requiresFooting) {
if (!(entity.level() instanceof ServerLevel source)) return LinkResult.MISSING_DIMENSION;
ServerLevel destinationLevel = source.getServer().getLevel(target.location().dimension());
if (destinationLevel == null) return LinkResult.MISSING_DIMENSION;
if (properties.has(LinkProperties.INTRA_LINKING_ONLY) && destinationLevel != source)
return LinkResult.INTRA_ONLY;
if (destinationLevel == source && !properties.has(LinkProperties.INTRA_LINKING)
&& !properties.has(LinkProperties.INTRA_LINKING_ONLY)) return LinkResult.INTRA_LINKING_REQUIRED;
if (properties.has(LinkProperties.DISARM) && !LinkDisarmService.mayTravel(entity))
return LinkResult.DISARM_REJECTED;
if (!entity.canChangeDimensions(source, destinationLevel)) return LinkResult.NO_SAFE_DESTINATION;
BlockPos origin = landingOrigin(entity, destinationLevel, target, properties);
Optional<Vec3> destination = resolveDestination(destinationLevel, origin, requiresFooting);
if (destination.isEmpty()) return LinkResult.NO_SAFE_DESTINATION;
Vec3 momentum = entity.getDeltaMovement();
if (properties.has(LinkProperties.DISARM)) LinkDisarmService.disarm(entity);
Entity arrived = entity.changeDimension(new DimensionTransition(destinationLevel, destination.get(),
properties.has(LinkProperties.MAINTAIN_MOMENTUM)
? rotatedMomentum(momentum, target.yaw()) : Vec3.ZERO,
target.yaw(), target.pitch(), DimensionTransition.DO_NOTHING));
if (arrived == null) return LinkResult.NO_SAFE_DESTINATION;
if (!requiresFooting && properties.has(LinkProperties.GENERATE_PLATFORM))
generateArrivalPlatform(destinationLevel, destination.get());
arrived.setXRot(target.pitch());
arrived.resetFallDistance();
PortalTravelCooldown.mark(arrived, source.getServer().getTickCount());
return LinkResult.SUCCESS;
}
static Vec3 rotatedMomentum(Vec3 incoming, float destinationYaw) {
// Legacy rotates the horizontal speed to the destination yaw and adds a small upward lift.
double horizontalSpeed = Math.hypot(incoming.x, incoming.z);
double radians = Math.toRadians(destinationYaw);
return new Vec3(horizontalSpeed * Math.cos(radians), incoming.y + 0.2,
horizontalSpeed * Math.sin(radians));
}
private static void applyMomentum(ServerPlayer player, Vec3 incoming, LinkTarget target,
LinkProperties properties) {
player.setDeltaMovement(properties.has(LinkProperties.MAINTAIN_MOMENTUM)
? rotatedMomentum(incoming, target.yaw()) : Vec3.ZERO);
}
private static void generateArrivalPlatform(ServerLevel level, Vec3 arrival) {
BlockPos feet = BlockPos.containing(arrival);
BlockPos floor = feet.below();
// Legacy only fills a missing floor when there is clear space above the arrival.
if (level.isEmptyBlock(floor) && level.isEmptyBlock(feet.above(2)))
level.setBlock(floor, ModBlocks.CLOUD_PLATFORM.get().defaultBlockState(), 3);
}
/** Legacy relative links retain the traveller's offset from the source spawn. */
private static BlockPos landingOrigin(Entity player, ServerLevel destinationLevel,
LinkTarget target, LinkProperties properties) {
if (!properties.has(LinkProperties.RELATIVE_LINK)) return target.location().pos();
BlockPos sourceSpawn = ((ServerLevel) player.level()).getSharedSpawnPos();
BlockPos destinationSpawn = destinationLevel.getSharedSpawnPos();
BlockPos departure = player.blockPosition();
return destinationSpawn.offset(departure.getX() - sourceSpawn.getX(),
departure.getY() - sourceSpawn.getY(), departure.getZ() - sourceSpawn.getZ());
}
private static void teleport(
ServerPlayer player,
ServerLevel destinationLevel,
Vec3 position,
LinkTarget target
LinkTarget target,
boolean instant
) {
if (ModList.get().isLoaded("immersive_portals_core")) {
ImmersivePortalsChunkLoaders.close(player);
ImmersivePortalsChunkLoaders.teleport(
player, destinationLevel, position, target.yaw(), target.pitch());
} else {
player.teleportTo(
destinationLevel,
position.x,
position.y,
position.z,
target.yaw(),
target.pitch()
);
if (instant) {
ImmersivePortalsChunkLoaders.teleport(
player, destinationLevel, position, target.yaw(), target.pitch());
return;
}
}
player.teleportTo(
destinationLevel,
position.x,
position.y,
position.z,
target.yaw(),
target.pitch()
);
}
private static boolean destinationChunksLoaded(ServerLevel level, BlockPos center) {
int chunkX = center.getX() >> 4;
int chunkZ = center.getZ() >> 4;
for (int x = chunkX - 1; x <= chunkX + 1; x++) {
for (int z = chunkZ - 1; z <= chunkZ + 1; z++) {
if (!level.getChunkSource().hasChunk(x, z)) return false;
}
}
return true;
}
static Optional<Vec3> findSafeDestination(ServerLevel level, BlockPos origin) {
@@ -195,6 +332,8 @@ public final class LinkingService {
SUCCESS,
MISSING_DIMENSION,
INTRA_LINKING_REQUIRED,
INTRA_ONLY,
DISARM_REJECTED,
NO_SAFE_DESTINATION
}
}
@@ -0,0 +1,158 @@
package net.dnorberg.rivencraft.book;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import net.dnorberg.rivencraft.registry.ModBlocks;
import net.minecraft.core.BlockPos;
import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper;
import net.minecraft.world.level.ChunkPos;
import net.minecraft.world.level.block.Blocks;
import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
/** Focused safety gaps; score and migration cases remain in the default suite. */
@GameTestHolder("rivencraft_archive_instability")
@PrefixGameTestTemplate(false)
public final class Milestone6RegressionGameTests {
private Milestone6RegressionGameTests() {}
@GameTest(template = "empty")
public static void multiplayerCandidatesStayLoadedDeduplicatedAndCapped(GameTestHelper helper) {
ChunkPos first = new ChunkPos(0, 0);
ChunkPos second = new ChunkPos(8, 0);
ChunkPos unloaded = new ChunkPos(0, 1);
Set<ChunkPos> loaded = Set.of(first, second, new ChunkPos(1, 0));
var selected = AgeHazardProviders.candidateChunks(List.of(first, second, first), 2, loaded::contains);
helper.assertValueEqual(selected, List.of(first, second),
"Two players in different loaded areas must each contribute one candidate before expansion");
helper.assertTrue(!selected.contains(unloaded) && selected.stream().distinct().count() == 2,
"Unloaded and duplicate chunks must never enter the effect context");
helper.assertValueEqual(AgeHazardProviders.candidateChunks(List.of(first, second), 1, loaded::contains),
List.of(first), "The per-attempt chunk cap must be obeyed with multiple players");
helper.assertTrue(AgeHazardProviders.candidateChunks(List.of(first), 0, loaded::contains).isEmpty(),
"A zero work budget must not inspect chunks");
helper.succeed();
}
@GameTest(template = "empty")
public static void disablingEffectsCannotRerollFrozenPlan(GameTestHelper helper) {
AgeInstability score = new AgeInstability(AgeInstability.CURRENT_VERSION, 20_000,
List.of(new AgeInstability.Contribution("fixture", -1, 20_000, "regression score")));
AgeInstabilityPlan plan = AgeInstabilityPlan.select(score, 741L);
UUID id = UUID.randomUUID();
AgeDefinition age = new AgeDefinition(id, "Policy fixture", 741L, AgeGenerationProfiles.STANDARD,
AgeDefinition.CURRENT_GENERATION_VERSION, 0L, AgeDefinition.dimensionId(id), null,
AgeTraits.LEGACY_DEFAULTS, null, null, List.of(), score, plan);
AgeInstabilityControls controls = new AgeInstabilityControls();
controls.setEnabled(id, false);
helper.assertTrue(!controls.enabled(id) && controls.enabled(UUID.randomUUID()),
"An Age override must not spill into another Age");
helper.assertTrue(!AgeInstabilityRuntime.policyAllowsProvider(false, true, false)
&& !AgeInstabilityRuntime.policyAllowsProvider(true, false, true)
&& AgeInstabilityRuntime.policyAllowsProvider(true, false, false),
"Per-provider disable and world-mutation disable must block only their intended effects");
controls.setEnabled(id, true);
helper.assertValueEqual(age.instability(), score, "Controls must not change the frozen score");
helper.assertValueEqual(age.instabilityPlan(), plan, "Controls must not reroll the frozen provider plan");
helper.succeed();
}
@GameTest(template = "empty")
public static void disabledGriefAndProtectedBlocksStayUntouched(GameTestHelper helper) {
helper.assertTrue(!AgeHazardProviders.destructiveBlocksAllowed(false, true, true, 16)
&& !AgeHazardProviders.destructiveBlocksAllowed(true, false, true, 16)
&& !AgeHazardProviders.destructiveBlocksAllowed(true, true, false, 16)
&& !AgeHazardProviders.destructiveBlocksAllowed(true, true, true, 0),
"Every disabled destructive policy must prevent block damage");
helper.assertTrue(AgeHazardProviders.destructiveBlocksAllowed(true, true, true, 1),
"The enabled path must still have a bounded block budget");
BlockPos spawn = helper.absolutePos(new BlockPos(1, 1, 1));
BlockPos far = spawn.offset(12, 0, 12);
UUID id = UUID.randomUUID();
AgeDefinition age = new AgeDefinition(id, "Protected fixture", 1L, AgeGenerationProfiles.STANDARD,
AgeDefinition.CURRENT_GENERATION_VERSION, 0L, AgeDefinition.dimensionId(id), spawn,
AgeTraits.LEGACY_DEFAULTS);
var level = helper.getLevel();
helper.assertTrue(AgeHazardProviders.protectedBlock(level, age, spawn, Blocks.STONE.defaultBlockState()),
"Arrival blocks must be protected from an explosion");
for (var state : List.of(Blocks.CHEST.defaultBlockState(), Blocks.NETHER_PORTAL.defaultBlockState(),
Blocks.BEDROCK.defaultBlockState(), ModBlocks.CLOUD_PLATFORM.get().defaultBlockState())) {
helper.assertTrue(AgeHazardProviders.protectedBlock(level, age, far, state),
"Block entities, portals, unbreakable blocks, and Rivencraft blocks must be protected");
}
helper.assertTrue(!AgeHazardProviders.protectedBlock(level, age, far, Blocks.STONE.defaultBlockState()),
"Ordinary stone outside the protected arrival area remains eligible");
helper.succeed();
}
@GameTest(template = "empty")
public static void generatedDiamondBlocksIncreaseLiveInstability(GameTestHelper helper) {
var diamond = net.minecraft.resources.ResourceLocation.parse("minecraft:diamond_block");
var ore = net.minecraft.resources.ResourceLocation.parse("minecraft:diamond_ore");
helper.assertValueEqual(AgeBlockInstability.score(Map.of(diamond, 4000L), 400,
Map.of(ore, 2000L), 500), 0,
"Legacy's 400-chunk threshold must gate the live block component");
int score = AgeBlockInstability.score(Map.of(diamond, 4010L, ore, 1604L), 401,
Map.of(ore, 2000L), 500);
helper.assertValueEqual(score, 40_000,
"Ten generated diamond blocks per sampled chunk add substantial instability");
helper.assertValueEqual(AgeBlockInstability.score(Map.of(ore, 1604L), 401,
Map.of(ore, 2000L), 500), 0,
"Natural ore abundance equal to the baseline must remain free");
var effective = new AgeInstability(AgeInstability.CURRENT_VERSION, score,
List.of(new AgeInstability.Contribution("block_profile", -1, score, "sampled excess")));
helper.assertTrue(!AgeInstabilityPlan.select(effective, 64L).providers().isEmpty(),
"A new effective score must unlock providers without replacing the authored base plan");
helper.succeed();
}
@GameTest(template = "empty")
public static void commonModdedMaterialWeightsStayBounded(GameTestHelper helper) {
var tin = net.minecraft.resources.ResourceLocation.parse("examplemod:deepslate_tin_ore");
var uranium = net.minecraft.resources.ResourceLocation.parse("examplemod:raw_uranium_block");
var oil = net.minecraft.resources.ResourceLocation.parse("examplemod:oil");
var unknown = net.minecraft.resources.ResourceLocation.parse("examplemod:unknown_ore");
helper.assertValueEqual(AgeBlockInstability.inferredModdedWeight(tin, true, false, false), 60.0,
"Common tin ore should use the low mineral tier");
helper.assertValueEqual(AgeBlockInstability.inferredModdedWeight(uranium, false, true, false), 750.0,
"A common radioactive mineral block should use its material tier");
helper.assertValueEqual(AgeBlockInstability.inferredModdedWeight(oil, false, false, true), 1.25,
"Modded source fluids should use the Legacy fluid factor");
helper.assertValueEqual(AgeBlockInstability.inferredModdedWeight(unknown, true, false, false), 60.0,
"Unknown but tagged ores should use a conservative fallback");
helper.assertValueEqual(AgeBlockInstability.inferredModdedWeight(unknown, false, false, false), 0.0,
"Uncategorized modded blocks must not be watched automatically");
helper.assertValueEqual(AgeBlockInstability.moddedWeight(tin, 60.0, List.of()), 60.0,
"Recognized ore from an installed mod should be scored automatically");
helper.assertValueEqual(AgeBlockInstability.moddedWeight(tin, 60.0,
List.of("examplemod:deepslate_tin_ore=750")), 750.0,
"A block override should replace the discovered weight");
helper.assertValueEqual(AgeBlockInstability.moddedWeight(tin, 60.0,
List.of("examplemod:deepslate_tin_ore=0")), 0.0,
"A zero-weight override should exclude a discovered block");
helper.succeed();
}
@GameTest(template = "empty")
public static void blockProfileSamplesPersistWithoutDoubleCounting(GameTestHelper helper) {
var data = new AgeBlockProfileSavedData();
var diamond = net.minecraft.resources.ResourceLocation.parse("minecraft:diamond_block");
data.add(new ChunkPos(3, 4), Map.of(diamond, 12));
data.add(new ChunkPos(3, 4), Map.of(diamond, 100));
helper.assertValueEqual(data.count(), 1, "A reloaded chunk must not be sampled twice");
helper.assertValueEqual(data.totals().get(diamond), 12L, "Duplicate loads cannot inflate abundance");
var restored = AgeBlockProfileSavedData.load(data.save(new net.minecraft.nbt.CompoundTag(),
helper.getLevel().registryAccess()), helper.getLevel().registryAccess());
helper.assertValueEqual(restored.count(), 1, "The profiled chunk set must survive restart");
helper.assertValueEqual(restored.totals(), data.totals(), "Block counts must survive restart");
var oldProfile = data.save(new net.minecraft.nbt.CompoundTag(), helper.getLevel().registryAccess());
oldProfile.remove("Version");
helper.assertValueEqual(AgeBlockProfileSavedData.load(oldProfile,
helper.getLevel().registryAccess()).count(), 0,
"Profiles lacking modded candidate counts must resample after migration");
helper.succeed();
}
}
@@ -0,0 +1,91 @@
package net.dnorberg.rivencraft.book;
import java.util.List;
import java.util.Set;
import java.util.stream.Collectors;
import net.dnorberg.rivencraft.config.RivencraftConfig;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.nbt.ListTag;
import net.minecraft.nbt.StringTag;
import net.minecraft.resources.ResourceLocation;
/** A snapshot of Page eligibility, frozen with each random Age at binding time. */
public record RandomPagePolicy(Set<ResourceLocation> allowlist, Set<ResourceLocation> blocklist) {
public static final RandomPagePolicy UNRESTRICTED = new RandomPagePolicy(Set.of(), Set.of());
public RandomPagePolicy {
allowlist = Set.copyOf(allowlist);
blocklist = Set.copyOf(blocklist);
}
public static RandomPagePolicy configured() {
return new RandomPagePolicy(parse(RivencraftConfig.randomPageAllowlist()),
parse(RivencraftConfig.randomPageBlocklist()));
}
private static Set<ResourceLocation> parse(List<? extends String> ids) {
return ids.stream().map(RandomPagePolicy::parsePageId).collect(Collectors.toUnmodifiableSet());
}
/** Server config IDs may omit the built-in Rivencraft namespace. */
public static ResourceLocation parsePageId(String value) {
ResourceLocation id = ResourceLocation.tryParse(value.contains(":") ? value : "rivencraft:" + value);
if (id == null) throw new IllegalArgumentException("Invalid Page ID " + value);
return id;
}
public boolean allows(ResourceLocation id) {
if (blocklist.contains(id)) return false;
String category = category(id);
return !restricts(category) || allowlist.contains(id);
}
public boolean restricts(String category) {
return allowlist.stream().anyMatch(entry -> category(entry).equals(category));
}
public <T> List<T> eligible(List<T> candidates, java.util.function.Function<T, ResourceLocation> pageId) {
return candidates.stream().filter(candidate -> allows(pageId.apply(candidate))).toList();
}
public <T> List<T> required(List<T> candidates, java.util.function.Function<T, ResourceLocation> pageId,
T fallback) {
List<T> eligible = eligible(candidates, pageId);
return eligible.isEmpty() ? List.of(fallback) : eligible;
}
private static String category(ResourceLocation id) {
String path = id.getPath();
if (path.startsWith("biome/") && java.util.Set.of("native", "single", "tiled", "grid",
"tiny", "small", "medium", "large", "huge").contains(path.substring("biome/".length())))
return "biome_distribution";
return path.substring(0, path.indexOf('/') < 0 ? path.length() : path.indexOf('/'));
}
public CompoundTag save() {
CompoundTag tag = new CompoundTag();
tag.put("Allowlist", strings(allowlist));
tag.put("Blocklist", strings(blocklist));
return tag;
}
public static RandomPagePolicy load(CompoundTag tag) {
return new RandomPagePolicy(read(tag.getList("Allowlist", StringTag.TAG_STRING)),
read(tag.getList("Blocklist", StringTag.TAG_STRING)));
}
private static ListTag strings(Set<ResourceLocation> ids) {
ListTag tags = new ListTag();
ids.stream().sorted().forEach(id -> tags.add(StringTag.valueOf(id.toString())));
return tags;
}
private static Set<ResourceLocation> read(ListTag tags) {
java.util.Set<ResourceLocation> ids = new java.util.HashSet<>();
for (int index = 0; index < tags.size(); index++) {
ResourceLocation id = ResourceLocation.tryParse(tags.getString(index));
if (id != null) ids.add(id);
}
return Set.copyOf(ids);
}
}
Loaded 100 of 291 files, more files were not shown because too many files have changed in this diff. Show more