Compare commits

...
10 Commits
Author SHA1 Message Date
dnorberg 4541cbbba5 Add optional TerraBlender biome integration and cave biome pages (#37)
Build / build (push) Canceled after 0s
2026-10-04 01:10:24 -04:00
dnorberg 68db795216 Cover panel-only book modifiers with regression test
Build / build (push) Canceled after 0s
2026-10-03 07:46:49 -04:00
dnorberg b86e855907 Add Link Panel modifiers and legacy Ink Mixer presentation (#36)
Build / build (push) Canceled after 0s
2026-10-03 07:36:46 -04:00
dnorberg 6c3b4f1885 Apply authored feature and decoration pages to ages
Build / build (push) Canceled after 0s
2026-10-02 21:28:11 -04:00
dnorberg 84a1f32732 Organize creative pages and stabilize GameTests
Build / build (push) Canceled after 0s
2026-10-02 14:49:41 -04:00
dnorberg a7b2c24915 Apply authored Age environment symbols (#34)
Build / build (push) Canceled after 0s
2026-10-01 17:28:20 -04:00
dnorberg 050a9537e9 Apply authored biome distributions and expose biome pages (#33)
Build / build (push) Canceled after 0s
2026-10-01 16:29:01 -04:00
dnorberg e28079566b Implement terrain symbol generation profiles
Build / build (push) Canceled after 0s
2026-09-30 16:44:22 -04:00
dnorberg 28c2ca0db3 Persist authored Age generation plans (#31)
Build / build (push) Canceled after 0s
2026-09-30 16:17:25 -04:00
dnorberg 27abebe3aa Validate ordered Age writing and highlight Binder errors (#30)
Build / build (push) Canceled after 0s
2026-09-30 15:39:53 -04:00
117 changed files with 4527 additions and 343 deletions

No files matched your search

+5 -3
View File
@@ -74,9 +74,11 @@ Or, with mise:
All required GameTests should pass before distributing a build.
GameTests use `build/gametest-run/world`, separate from the normal development
world. Before each run, Gradle removes that test world if it exceeds 512 MiB.
Override the limit with `-PgameTestMaxWorldMiB=NUMBER`. A caller-supplied
`-PgameTestRunDir` is never removed automatically.
world. Gradle starts each default run with a fresh world and removes it after
every run, whether tests pass or fail. The GameTest server always uses seed `0`,
so retries regenerate a clean world with that seed. Logs and configuration are kept.
A caller-supplied `-PgameTestRunDir`
is never removed automatically.
To run the suite in a fresh temporary directory instead, use:
+25 -7
View File
@@ -21,9 +21,17 @@ 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; no server tick is
needed. The earlier paper-in-one-hand method remains available. Ink modifier
ingredients and link properties are planned for Milestone 5.
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.
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
@@ -77,6 +85,11 @@ larger ordered collection of Pages between desks and the binder.
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`.
@@ -92,10 +105,15 @@ outputs a Descriptive Book once the title, cover, and Link Panel are present.
Inputs are consumed only when the result is taken.
The completed book receives its Age identity when assembled. With only a Link
Panel, it describes a randomly generated Age. Its writing is stored on the
book; the Descriptive Book screen's turned pages show ordered symbols and
unresolved IDs. Until Milestone 5, symbols do not affect generation and written
books use the same random Age fallback. The Descriptive Book screen follows
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.
Further symbol effects are scheduled for later Milestone 5 slices. 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; their pictograms await
+81 -32
View File
@@ -17,7 +17,7 @@ tasks.named('wrapper', Wrapper).configure {
version = mod_version
group = mod_group_id
List<String> archivedGameTestSuites = ['linking', 'writing', 'desk', 'binder', 'mixer', 'recipe']
List<String> archivedGameTestSuites = ['linking', 'environment', 'writing', 'grammar', 'desk', 'binder', 'mixer', 'recipe']
List<String> selectedArchivedGameTestSuites = providers.gradleProperty('withArchivedGameTests')
.map { it.toBoolean() }.orElse(false).get() ? archivedGameTestSuites
: providers.gradleProperty('archivedGameTestSuites').orElse('').get()
@@ -38,6 +38,35 @@ sourceSets.main.resources {
exclude("src/generated/**/.cache") // datagen cache files
}
// Generate the client-safe creative-page index from bundled symbol definitions.
// New built-in symbols then appear in the Pages tab without another Java list.
abstract class GenerateCreativeSymbolIndex extends DefaultTask {
@InputDirectory abstract DirectoryProperty getSymbolsDir()
@OutputDirectory abstract DirectoryProperty getIndexDir()
@TaskAction void generate() {
File root = symbolsDir.get().asFile
def definitions = new LinkedHashMap<String, Object>()
java.nio.file.Files.walk(root.toPath()).withCloseable { paths ->
paths.filter { java.nio.file.Files.isRegularFile(it) && it.toString().endsWith('.json') }
.sorted().forEach { source ->
String path = root.toPath().relativize(source).toString()
.replace('\\', '/').replaceAll(/\.json$/, '')
definitions["rivencraft:${path}"] = new groovy.json.JsonSlurper().parse(source.toFile())
}
}
File index = new File(indexDir.get().asFile, 'assets/rivencraft/creative_symbol_pages.json')
index.parentFile.mkdirs()
index.text = groovy.json.JsonOutput.prettyPrint(groovy.json.JsonOutput.toJson(definitions)) + '\n'
}
}
def generateCreativeSymbolIndex = tasks.register('generateCreativeSymbolIndex', GenerateCreativeSymbolIndex) {
symbolsDir.set(layout.projectDirectory.dir('src/main/resources/data/rivencraft/rivencraft/symbols'))
indexDir.set(layout.buildDirectory.dir('generated/resources/creativeSymbols'))
}
sourceSets.main.resources.srcDir generateCreativeSymbolIndex
// Archived suites use separate namespaces but share the same empty structure.
tasks.named('processResources', ProcessResources).configure {
archivedGameTestSuites.each { suite ->
@@ -62,6 +91,11 @@ repositories {
content { includeGroup 'curse.maven' }
}
maven { url = 'https://maven.bai.lol' }
maven {
name = 'TerraBlenderMaven'
url = 'https://maven.minecraftforge.net/releases/'
content { includeGroup 'com.github.glitchfiend' }
}
maven {
url = 'https://api.modrinth.com/maven'
content { includeGroup 'maven.modrinth' }
@@ -148,42 +182,52 @@ neoForge {
}
}
// GameTests generate Ages, so their dedicated world can grow quickly across runs.
// Never auto-delete a caller-supplied gameTestRunDir or a normal dev world.
long gameTestWorldLimitMiB = providers.gradleProperty('gameTestMaxWorldMiB').orElse('512').get().toLong()
if (gameTestWorldLimitMiB <= 0) {
throw new GradleException('gameTestMaxWorldMiB must be a positive number')
}
// Vanilla's GameTestServer uses a fixed world seed of 0. Every default run
// regenerates its world; custom run directories are never managed here.
boolean customGameTestRunDir = providers.gradleProperty('gameTestRunDir').isPresent()
File dedicatedGameTestDir = layout.buildDirectory.dir('gametest-run').get().asFile.canonicalFile
File dedicatedGameTestWorld = new File(dedicatedGameTestDir, 'world')
def cleanOversizedGameTestWorld = tasks.register('cleanOversizedGameTestWorld') {
File dedicatedGameTestBuildDir = layout.buildDirectory.get().asFile
File dedicatedGameTestDir = layout.buildDirectory.dir('gametest-run').get().asFile
def prepareGameTestWorld = tasks.register('prepareGameTestWorld') {
onlyIf { !customGameTestRunDir }
doLast {
if (customGameTestRunDir) {
getLogger().lifecycle('Skipping automatic GameTest world cleanup for custom gameTestRunDir')
return
}
def worldDir = dedicatedGameTestWorld
if (!worldDir.isDirectory() || java.nio.file.Files.isSymbolicLink(worldDir.toPath())) {
return
}
def paths = java.nio.file.Files.walk(worldDir.toPath()).withCloseable { it.toList() }
long bytes = paths.sum(0L) { path ->
java.nio.file.Files.isRegularFile(path, java.nio.file.LinkOption.NOFOLLOW_LINKS)
? java.nio.file.Files.size(path) : 0L
}
long limit = gameTestWorldLimitMiB * 1024L * 1024L
if (bytes > limit) {
getLogger().lifecycle('Removing oversized GameTest world {} ({} MiB; limit {} MiB)',
worldDir, Math.ceil(bytes / 1048576d) as long, gameTestWorldLimitMiB)
paths.toSorted(java.util.Comparator.reverseOrder()).each { java.nio.file.Files.delete(it) }
}
GameTestWorlds.clean(dedicatedGameTestBuildDir, dedicatedGameTestDir)
}
}
def finishGameTestWorld = tasks.register('finishGameTestWorld') {
onlyIf { !customGameTestRunDir }
doLast {
GameTestWorlds.clean(dedicatedGameTestBuildDir, dedicatedGameTestDir)
}
}
tasks.named('runGameTestServer').configure {
dependsOn(cleanOversizedGameTestWorld)
dependsOn(prepareGameTestWorld)
finalizedBy(finishGameTestWorld)
}
class GameTestWorlds {
static void check(File buildDir, File runDir) {
[buildDir, runDir, new File(runDir, 'world'), new File(runDir, 'failed-worlds'),
new File(runDir, 'failed-seed.txt'), new File(runDir, '.last-gametest-succeeded')].each { path ->
if (java.nio.file.Files.isSymbolicLink(path.toPath())) {
throw new GradleException("Refusing to manage a symlinked GameTest path: ${path}")
}
}
}
static void clean(File buildDir, File runDir) {
check(buildDir, runDir)
[new File(runDir, 'world'), new File(runDir, 'failed-worlds')].each { root ->
if (root.exists()) {
java.nio.file.Files.walk(root.toPath()).withCloseable { paths ->
paths.sorted(java.util.Comparator.reverseOrder()).forEach { path ->
java.nio.file.Files.delete(path)
}
}
}
}
java.nio.file.Files.deleteIfExists(new File(runDir, 'failed-seed.txt').toPath())
java.nio.file.Files.deleteIfExists(new File(runDir, '.last-gametest-succeeded').toPath())
}
}
// Sets up a dependency configuration called 'localRuntime'.
@@ -199,6 +243,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}"
// 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()) {
localRuntime "com.github.glitchfiend:TerraBlender-neoforge:${minecraft_version}-${terrablender_version}"
}
implementation "curse.maven:dynamicdimension-ar-edition-1469680:${dynamic_dimensions_file_id}"
implementation "lol.bai:badpackets:neo-${badpackets_version}"
// JEI integration is isolated in its plugin and absent from the published runtime dependencies.
+88 -5
View File
@@ -30,15 +30,98 @@ resources and can be overridden by a higher-priority pack. The example under
directory. Valid custom profiles join the stable, sorted pool used when a new
Age rolls its base terrain; the selected ID is then persisted with that Age.
Each built-in profile now has a matching `terrain/<name>` Symbol Page. Put one
of those pages after the Link Panel in a Book Binder to select that terrain
instead of the seed-selected random profile. Standard, Amplified, and Cave use
their corresponding registered noise settings; Island uses Minecraft's
floating-islands noise settings; Flat and Void use flat-source generators.
The Cave and Island pages are Rivencraft terrain choices based on existing
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.
## Written biome selection (generation version 16)
Biome pages follow the terrain page and precede the distribution-control page
in the Binder. Bundled controls are Native, Single, Tiled, Grid, and Tiny through
Huge regions. Single needs one distinct biome; Tiled/Grid and Tiny–Huge need
two. An authored book receives seeded filler only when it falls below that
minimum, while extra authored pages are retained as weighted entries. A book
with no biome pages selects a seeded count from two up to the number of
eligible biomes for Tiled/Grid and Tiny–Huge. The eligible pool comes from the
terrain's biome preset, or `#rivencraft:cave_biomes` for Cave terrain, so future
biome integrations can expand it without changing the count rule. Single uses
one; Native uses its preset biome pool. This random-age maximum does not truncate
authored pages: the Binder's 27 symbol-page positions bound an authored book.
Native cannot be paired with explicit biome pages. Legacy filled Tiny–Huge to
three; Rivencraft deliberately uses two so a pair of written biome pages stays
exactly as written.
The Biome Pages creative tab offers pages for every registered vanilla biome.
Hand-authored symbol definitions take precedence; the remaining vanilla pages
are generated from the biome registry, so they do not each need a JSON file.
Custom/modded biomes still require a data-pack symbol definition.
Standard, Amplified, and Sky Island terrain fill from the vanilla Overworld
biome preset, including its underground Lush Caves, Dripstone Caves, and Deep
Dark biomes. Standard terrain therefore keeps Overworld-style cave generation,
and cave biome pages can also be written explicitly. Sky islands can use an
explicitly authored End biome page.
Cave terrain fills only from `#rivencraft:cave_biomes` (Lush Caves, Dripstone
Caves, and Deep Dark by default); explicitly authored Nether biome pages are
also accepted. Other cave/biome pairings are diagnosed and blocked for now.
Milestone 6 instability should allow such illegal combinations as unstable
Ages, without silently treating them as ordinary cave generation. Flat terrain
uses Overworld choices when a distribution is authored; its Native default
remains Plains. Void terrain defaults to The Void and needs additional authored
biomes for a multi-biome distribution.
The resolved list of biome IDs, their order/repetitions, and distribution are
frozen into the Age plan. A removed biome ID emits a warning and uses an
eligible fallback for that load; restoring the biome recovers the original
selection. Generation-version-15 Ages keep their prior registry-wide biome
selection algorithm instead of being silently regenerated.
## Written environment
Lighting pages select Normal, Dark, or Bright lighting for the new Age. A Sky
page selects Minecraft's Overworld, Nether, or End sky effects; the chosen
effects also determine the destination preview backdrop. Overworld sky tint
continues to come from the destination biome. A written sky changes only that
Age's dimension type, not the source world or other Ages.
Normal, Fast, Slow, Off, Always, and Storm weather pages use the existing Age
weather controller. Zero, Half, Full, and Double Length pages set the day-cycle
period, and Nadir, Rising, Zenith, and Setting pages set its initial phase.
Repeated numeric modifiers combine in written order. A Zero Length Age keeps
the nonzero minimum clock rate that avoids client skybox bounce. Pages for
Cloudy, forced Rain, and Snow are not offered: vanilla precipitation rendering
cannot reproduce those Legacy distinctions yet, and Snow remains planned for
the optional season integrations. A data pack that supplies these unsupported
weather choices receives a binding error rather than a false success.
The category creative tabs and optional JEI page ingredients use the same generated
index of bundled environment symbols. Existing Age definitions and page-free
random Ages retain their saved or seeded environment unchanged.
## Persistence and reload behavior
An Age permanently stores its selected profile ID, generation version, seed,
and rolled traits. `/reload` replaces the profile definitions but does not
reroll those immutable values. An unloaded Age resolves its stored profile
again when it loads, so intentional profile overrides affect its runtime
resources and newly generated chunks.
and rolled traits. For an **authored** Age, the generation plan also stores a
copy of the resolved runtime profile: terrain shape, noise settings, biome
preset, and dimension type. `/reload` cannot reinterpret that plan; an unloaded
authored Age uses the saved profile snapshot when it loads, even if the defining
symbol or profile JSON has since changed. An older, page-free Age has no plan
and continues to resolve its saved profile ID at load time.
A profile removed after an Age was created resolves to `rivencraft:standard`.
Registered noise, biome-preset, and dimension-type IDs are validated when
profiles load. Before loading an authored Age, the saved references are checked
again. If a data pack supplying one has been removed, the dimension stays
unloaded and the log identifies the missing resource; the Age's plan is not
silently replaced. Restore the pack to load that Age. A custom dimension type
retains its own skylight capability: normal lighting cannot make a Nether-style
type skylit.
A profile removed after a page-free Age was created resolves to `rivencraft:standard`.
The legacy `rivencraft:random_vanilla` alias also resolves to `standard`.
Rivencraft logs this fallback. Invalid built-in overrides do not replace the
required built-in definitions; a reload fails if a required built-in profile
+110 -12
View File
@@ -1,15 +1,14 @@
# GameTest suites
The default dedicated-server run is a small smoke suite: 17 Rivencraft tests
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.
NeoForge currently adds two of its own tests, so the runner reports 19.
```shell
./gradlew runGameTestServer
```
The remaining 47 Rivencraft tests are archived, not deleted. They cover
The remaining Rivencraft tests are archived, not deleted. They cover
completed milestone details such as every Age terrain profile, Notebook and
Desk surface interactions, refill edge cases, book assembly controls, and
workstation break/drop behavior. Run only the relevant archive alongside the
@@ -17,11 +16,11 @@ core tests when investigating an issue:
```shell
./gradlew runGameTestServer -ParchivedGameTestSuites=desk
./gradlew runGameTestServer -ParchivedGameTestSuites=linking,binder
./gradlew runGameTestServer -ParchivedGameTestSuites=grammar,binder
```
Available suite names are `linking`, `writing`, `desk`, `binder`, `mixer`, and
`recipe`. Run all 64 Rivencraft tests (66 including NeoForge's two) before a
Available suite names are `linking`, `environment`, `writing`, `grammar`, `desk`,
`binder`, `mixer`, and `recipe`. Run all Rivencraft tests before a
release or after broad cross-system changes:
```shell
@@ -34,9 +33,108 @@ Immersive Portals. The core suite delegates to the original regression methods
for its selected cases, so the two suites do not maintain duplicate test logic.
GameTest Ages are created in `build/gametest-run/world`, not in a development
client save. The Gradle task removes that **dedicated** world automatically if
it exceeds 512 MiB; override the threshold with `-PgameTestMaxWorldMiB=128`,
for example. Cleanup never targets a custom `-PgameTestRunDir` or a player
world. A fresh test world can also help diagnose a slow or stalled worldgen
run. The full suite should still be run before shipping changes in the
archived systems.
client save. Every default GameTest invocation starts with a fresh world.
Minecraft 1.21.1's GameTest server uses the fixed seed `0`. Gradle deletes the
world after every run, whether tests pass or fail. A forcibly killed run may
leave `world` behind; the next run deletes it before starting.
Logs and configuration remain available. Cleanup never targets a custom
`-PgameTestRunDir` or a player world; callers using a custom directory manage
it themselves. The full suite should still be run
before shipping changes in the archived systems.
If a new GameTest stalls the server, stop that run, remove the offending
automated check, and hand its exact scenario to the player for in-game
verification. Do not keep retrying a stalled test or leave its process running.
Keep the narrower non-stalling plan, persistence, and runtime checks automated.
## Manual Ink Mixer modifier check (Milestone 5, issue #36)
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
start and the mixer should work normally.
Put paper and an Ink Vial in the mixer. Hold Gunpowder on the cursor and
right-click the ink basin once; one Gunpowder should be consumed, and hovering
the basin should show a 20% Disarm chance. Black Dye, Clay Balls, and an
unrelated item such as Stone should remain untouched.
Closing and reopening the mixer should retain the chance. Taking a Link Panel
should consume one paper and one full Ink Vial, clear the current
mixture, and possibly give a panel with Disarm on its tooltip. Repeat until
a property-bearing panel appears, craft it with leather, and confirm the
unwritten Linking Book preserves the property tooltip. After binding it,
link to another dimension; inventory items should drop at the departure point.
With twenty Ender Pearls added to a fresh mixture, both Disarm and Intra
Linking should show about 96.1%, and the basin should animate both property
colors. Taking a panel should reset all three percentages and clear the color
effect; a near-certain modifier should show the brighter outer animation.
Also bind a Descriptive Book with a Disarm panel and check the same drop behavior.
Bind a Descriptive Book with both Intra Linking and Maintain Momentum on its
panel: the assembled book should retain Maintain Momentum but omit Intra
Linking. For Linking Books, try an unmodified book whose destination is the
current dimension: it should refuse travel. A Linking Book with Intra Linking
should work in the same dimension. A Descriptive Book does not require or use
Intra Linking, even if an older book retained that flag.
Automatic Return Links should still appear according to the existing setting
and work from an Age back to the Overworld. A full player inventory or blocked glass-bottle slot
must not duplicate or consume materials for an output that cannot be taken.
Link Panels should not enter Notebooks (folders) or Writing Desk tabs, whether
clicked, shift-clicked, or dragged onto the page surface. An old Notebook or
Desk already holding a Link Panel should still let the player take it out,
but the Desk must not offer a copy of it. The Desk should continue to copy
ordinary symbol Pages; JEI should show that example instead of Link Panel copying.
## Manual Age unload/reload check
The automated suite does not unload a freshly generated Age. Minecraft can
queue point-of-interest block updates after generation; closing that Age's
region storage while a queued update is still pending can leave the dedicated
GameTest server waiting forever in `SectionStorage.readColumn`. Plan save/load,
terrain generation, and safe spawn remain automated; runtime unload/reload is
checked in a normal game session:
1. Back up the test world. Bind one Link-Panel-only Descriptive Book and one
Descriptive Book with a terrain page (for example, Island), using distinct
names. Bring a working way back to the Overworld.
2. Travel through each book, confirm the named Age and expected terrain, then
return to the Overworld. Close book screens and wait a few seconds.
3. With cheats enabled, run `/rivencraft age list` and record each Age's
`rivencraft:age/...` dimension ID. Run `/rivencraft age unload <dimension>`
for one Age at a time, then list again to confirm it is unloaded.
4. Reopen the same Descriptive Books and travel back. Confirm each book reaches
its original Age, the terrain and safe arrival remain intact, and no extra
Age entry was created. Save, restart the world, and repeat the book check.
## Manual feature-generation check (Milestone 5, issue #35)
The automated suite verifies feature pages, compiled and saved feature IDs,
vanilla registry mappings, unsupported combinations, and the runtime generator.
An automated scan across many newly generated chunks stalled the GameTest
server, so physical placement is handed to the player for in-game verification:
1. In a fresh world, bind a Descriptive Book with Link Panel, Standard Terrain,
Plains Biome, Single Biome, Caves, and Rocks pages in that order.
Missing weather/lighting/celestial branches may be seed-filled. Travel to
the Age and explore several fresh surface chunks: boulders made from one
seed-selected full-collision block should appear among the plains terrain.
Then explore underground in fresh
chunks; the Caves page should add a second cave-carving pass to Standard
terrain, not switch the Age to Cave terrain.
2. Make a second book with Flat Terrain and Caves. The Binder should mark the
Caves page unsupported and prevent assembly. Cave Terrain plus Caves should
be accepted; Cave Terrain plus Rocks should be rejected.
3. Return, save, and restart the world. Re-enter the first Age and explore
*new* chunks. The authored decorations should continue without rebinding.
Previously generated chunks are intentionally unchanged.
4. Title-derived terrain regression (with Create installed): with no Terrain Page, assemble Link Panel,
Glowstone, Rocks, Chocolate, Small Lakes in that order and name the Age
`glow`. The Binder should accept it and generate compatible surface terrain;
Glowstone should be the rock material and Chocolate should appear in authored
Small Lakes across fresh chunks. Ordinary vanilla lava lakes may still occur.
Repeat
with `gl` or `glo` to confirm names do not change page validity. An explicit
Flat or Cave Terrain Page with Rocks should still be rejected.
+30
View File
@@ -0,0 +1,30 @@
# Ink Mixer and Link Panel modifiers (Milestone 5, issue #36)
Legacy source: [`InkEffects`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/data/InkEffects.java), [`TileEntityInkMixer`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/tileentity/TileEntityInkMixer.java), and [`LinkPropertyAPI`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/api/java/com/xcompwiz/mystcraft/api/hook/LinkPropertyAPI.java).
Legacy does **not** use a conventional ingredient slot: the player clicks the ink basin with a carried item. Each accepted item is consumed immediately, changing the basin's property probabilities. A Link Panel is a virtual result; taking it consumes paper and ink, rolls each property independently using a saved next-seed, writes the selected flags to the Page, then resets that basin's mixture. The Link Panel passes those flags to a Linking Book made with leather. The preview must not roll or consume anything.
| Ingredient | Property | Chance per item |
| --- | --- | ---: |
| Gunpowder | Disarm | 20% |
| Mushroom Stew | Disarm | 5% |
| Clay Ball | Generate Platform | 25% |
| Experience Bottle | Intra Linking | 15% |
| Ender Pearl | Intra Linking + Disarm | 15% each |
| Feather | Maintain Momentum | 15% |
| Fire Charge | Disarm | 25% |
| Black dye | Empty effect key; ignored by Legacy's mixer | None in practice |
Legacy also has optional ore-dictionary dusts: brass, bronze, tin, iron, lead, silver, diamond, and gold. Their effect combinations are in `InkEffects.init()`. Forge's ore dictionary does not exist in NeoForge 1.21.1, so these should be mapped through item tags only when a suitable tag and item exist; none should become a hard dependency. The `Relative` and `Intra Linking Only` properties are registered but have no built-in ingredient. `Natural`, `External`, `Offensive`, `Op-TP`, and `Following` are internal link flags, not mixer ingredients.
For each additive, Legacy scales each existing probability by `1 - sum(additive chances)` and then adds the additive's probabilities. Properties are rolled independently on the final Page. The Legacy link effects are: Disarm drops carried inventory before travel; Generate Platform places a single arrival block if a drop exists; Maintain Momentum retains velocity; Intra Linking permits a same-dimension link.
Rivencraft deliberately diverges from Legacy's shared-probability dilution here: each supported modifier accumulates independently as `new = 1 - (1 - old) × (1 - item chance)^item count`. Twenty Ender Pearls therefore produce about 96.1% each for Disarm and Intra Linking, and a panel can receive both. Taking the panel resets every probability to zero. The GUI uses Legacy's empty-basin atlas sprite, fills the basin dark when ink is present, and projects its colored rotating D'ni effect over the ink (red Disarm, blue Momentum, green Intra); the effect intensifies as a modifier approaches certainty and disappears after output is taken.
Implementation requirements: keep the mixer server-authoritative; persist mixture probabilities and next-seed; show a deterministic virtual result; consume exact inputs once; prevent duplicate output on shift-click; preserve inputs when output cannot be taken; copy the Page's link properties into a Linking Book; apply supported properties only after destination validation; retain unmodified books' current safe-link behavior; and expose both base and modifier sequences to optional JEI. Tests should cover persistence, multiple additives, invalid items, full inventory/bottle output, and panel-to-book transfer.
## Rivencraft 0.4.7.x implementation scope
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.
+1 -1
View File
@@ -39,6 +39,6 @@ These are schema bounds, not claims that Legacy shipped numeric config ranges. S
The server rejects a v2 definition with an unknown top-level or semantics field, missing/incorrectly typed field, unknown role or choice, malformed/non-canonical resource ID, or out-of-range/non-finite number. An invalid definition is logged with its file ID and excluded from the active catalog. Saved pages and books still retain that ID, allowing the player to recover them if the data pack is corrected. A reload atomically replaces the catalog rather than mutating saved writing.
Schema v1 definitions remain readable as **display-only** symbols; existing packs need not be rewritten merely to show or copy pages. A v1 definition cannot add a `semantics` field. To make one eligible for future Age compilation, publish a v2 definition with the **same file path and ID**, adding a valid role and value. Do not rename the page ID or reorder a book's `OrderedWriting`. The client receives only `SymbolDisplayMetadata` (ID, translation keys, category, resolved flag); semantic definitions are not serialized to it. This slice defines and validates meaning but does **not yet apply** written symbols to Age generation; issues #30 and #31 implement parsing and compilation.
Schema v1 definitions remain readable as **display-only** symbols; existing packs need not be rewritten merely to show or copy pages. A v1 definition cannot add a `semantics` field. To make one eligible for Age grammar parsing, publish a v2 definition with the **same file path and ID**, adding a valid role and value. Do not rename the page ID or reorder a book's `OrderedWriting`. The client receives only `SymbolDisplayMetadata` (ID, translation keys, category, resolved flag); semantic definitions are not serialized to it. The [ordered-writing parser](WRITING_GRAMMAR.md) validates new books, but does **not yet apply** written symbols to Age generation; issue #31 adds compilation.
The six built-in definitions demonstrate terrain, biome-controller, lighting, weather, celestial, and feature roles. A third-party pack may add its own definitions under its namespace. Use an explicit semantic role even when the display category has the same name; the two fields serve different purposes.
+63
View File
@@ -0,0 +1,63 @@
# Optional TerraBlender biome compatibility (Milestone 5, issue #37)
Rivencraft targets TerraBlender NeoForge **1.21.1-4.1.0.8**. The official
[1.21.1 release](https://modrinth.com/mod/terrablender/version/4.1.0.8) and
[region API](https://github.com/Glitchfiend/TerraBlender/blob/1.21.1/Common/src/main/java/terrablender/api/Regions.java)
are available for this Minecraft version. TerraBlender is `compileOnly` and
is **not** required by the published Rivencraft jar. For a local development
run with TerraBlender, use `-PwithTerraBlender=true`.
TerraBlender's API registers Overworld and Nether biome *regions*; it does not
register arbitrary Rivencraft Age dimensions. Rivencraft therefore keeps its
own deterministic Age biome sources and uses a guarded adapter to read the
registered region biome IDs. Only biomes still present in Minecraft's biome
registry are accepted. TerraBlender Overworld region biomes extend the pool
for standard, flat, and sky-island Ages; Nether region biomes extend Cave Age
pools and are valid authored Cave biome pages. Vanilla Nether-tagged biomes
are also valid Cave biomes. This is generic: no Biomes O' Plenty IDs are
hard-coded.
Every registered biome receives a generated page in Rivencraft's Biome or Cave
Biome creative tab, and in JEI when JEI is installed. Cave-tagged, Nether-tagged,
and TerraBlender Nether-region biomes go in the Cave Biome tab. Existing vanilla page IDs such as
`rivencraft:biome/desert` are unchanged; modded biome IDs include their
namespace, for example `rivencraft:biome/example/orchard` for a biome named
`example:orchard`.
Authoring still validates the exact biome registry key. New Age plans freeze
the selected biome IDs, distribution, and seed, so a reload with the same mods
retains the result. If a modded biome later disappears, the Age loader warns
and uses an eligible fallback for that load without rewriting its frozen plan.
Restore the mod to recover the authored biome. Do not remove biome mods from
an existing play world without a backup.
## Compatibility matrix
| Setup | Expected result | Validation |
| --- | --- | --- |
| Rivencraft without TerraBlender | Vanilla biome pages and Age generation remain functional; no TerraBlender classes load on the core path. | Default GameTest server and build. |
| Rivencraft with TerraBlender 4.1.0.8, no biome addon | Same baseline pool; default TerraBlender regions add no modded biome IDs. | GameTest server with `-PwithTerraBlender=true`. |
| Rivencraft + TerraBlender + Biomes O' Plenty 1.21.1 | BOP registry biomes appear as distinct Biome pages, with Nether-region pages in the Cave Biome tab. Its Overworld regions can enter composed standard/sky-island Age pools; its Nether regions can enter Cave Age pools. | In-game check below; this combination is not bundled in automated tests. |
| TerraBlender present but its region API cannot be read | Log one warning and use Rivencraft's normal biome pool. | Guarded adapter fallback; intentionally not forced by GameTest. |
## In-game check requested for Biomes O' Plenty
Use a **new test world** with compatible NeoForge 1.21.1 builds of
TerraBlender and Biomes O' Plenty installed on both sides.
1. In the Rivencraft Biome and Cave Biome Pages creative tabs (and JEI, if installed), find
at least one BOP Overworld biome and one BOP Nether biome, respectively. The page tooltip
should identify the biome and not show an unresolved symbol.
2. Bind a Descriptive Book with a Link Panel, Standard Terrain, a two-biome
distribution page, and two different BOP Overworld biome pages. Travel to
the Age and confirm both named biomes can occur. Reopen the same world and
confirm the Age still uses the same authored biome pool.
3. Bind a second book using Cave Terrain and a BOP Nether biome page. The
Binder must accept the page, and the resulting Cave Age must use the
selected Nether biome rather than rejecting it as non-cave.
4. Separately, run Rivencraft without TerraBlender and confirm a Link-Panel-
only random Age can still be created and entered. Do not reuse the BOP test
world for this absence check.
The previous broad registry-enumeration GameTest stalled in the test server,
so the BOP-specific and client-side checks are deliberately handed off for
manual testing instead of retaining that stalled test.
+6 -8
View File
@@ -34,10 +34,9 @@ Invalid definitions are logged and excluded by the server. Menus and future
page synchronization must obtain resolved display metadata from the server;
clients never make a symbol valid by naming it.
Rivencraft ships a small catalog covering terrain, biomes, lighting, weather,
celestial behavior, and features. Its v2 semantics prepare for the full
Legacy-inspired grammar; writing still uses random Age fallback until the
parser and compiler are implemented.
Rivencraft ships a catalog covering terrain, biomes, lighting, weather,
sky, celestial behavior, and features. The parser and compiler apply supported
schema-v2 pages to newly created Ages; omitted branches retain seeded defaults.
## Persistent writing
@@ -54,9 +53,7 @@ book copies its writing and Age reference; merely copying it never creates a
new Age. The Book Binder creates the Age when its finished output is taken.
The Descriptive Book screen can inspect the ordered pages by turning them from
the bottom corners and identifies unresolved IDs using server-provided symbol
metadata. Until Milestone 5, the
saved symbols are informational only: Age creation uses the existing random
fallback and does not apply them to generation.
metadata. Page-free books continue to use random Age generation.
Removing a data pack never removes its IDs from saved writing. A missing ID is
resolved as client-safe **Unresolved Symbol** display metadata while retaining
@@ -108,7 +105,8 @@ imported at a chosen strip position; the empty Notebook remains recoverable.
The preview result is virtual. Taking the completed Descriptive Book commits the
inputs once, creates its Age identity, and saves schema-versioned
`OrderedWriting` plus the Age reference on the book. Link-Panel-only books
create random Ages. A written symbol does **not** yet change that generation.
create random Ages. Supported written pages change the corresponding Age
generation branch; missing branches use seeded defaults.
Inputs, title, and pending Age identity survive Binder save/load; breaking the
Binder returns stored inputs. The completed book retains both its writing and
Age identity through item save/load and copying.
+21
View File
@@ -0,0 +1,21 @@
# Ordered Descriptive Book grammar (Milestone 5, issue #30)
`WritingGrammar` interprets the saved `OrderedWriting` on the server using only `SymbolCatalog`'s schema-v2 semantics. Client display metadata, page names, and supplied translations never determine an Age's meaning. The parser is pure: it returns immutable parsed entries and indexed diagnostics without changing a book or its pages.
New Binder writing has at most one Link Panel plus 27 symbol pages. The Link Panel must be first. A Link-Panel-only book, or an older book with no writing component, keeps the existing random Age path. Any authored supported symbol makes the book a partial or complete grammar. From 0.4.3.0, the server compiles it into a persistent Age plan before consuming Binder inputs or generating chunks.
The supported order follows the representable subset of the [Legacy grammar audit](LEGACY_AGE_GRAMMAR_AUDIT.md): terrain; zero or more biome pages; biome controller; weather; lighting; sky effects; zero or more period or phase modifiers; one celestial page; then zero or more distinct features, each optionally preceded by a compatible block-material page. Biome pages precede the controller that consumes them, and celestial modifiers precede the celestial page. Terrain, controller, weather, lighting, sky, and celestial are single-choice categories; identical repeats are duplicates and differing values conflict. Repeated modifiers are intentional. Biome pages may repeat, preserving author order and any future weighting; feature IDs may not repeat. Angle modifiers remain recognized in the schema but are rejected at binding until a sky renderer can apply sun tilt.
Missing terrain, controller, weather, lighting, celestial, or the controller's minimum biome count is an **incomplete** warning, not an error: the compiler retains seed-selected traits for missing branches. An omitted terrain page uses a seed-selected profile compatible with authored feature pages, so changing the Age name cannot accidentally select Flat, Void, or Cave terrain for Rocks or Lakes. If no profile can support the writing, binding still rejects it. The minimum biome count is zero for Native, one for Single, and two for Tiled/Grid and Tiny–Huge. Native cannot consume authored biome pages; Single accepts only one. Unknown IDs, schema-v1 display-only symbols, wrong ordering, misplaced modifiers, duplicates, conflicts, missing/extra Link Panels, and oversized writing are errors. The Binder disables output and exposes the first error on the result-slot tooltip. When that error belongs to a page, its thumbnail is tinted and outlined red, the strip scrolls to it, and hovering it shows the diagnostic. This maps the parser's compact entry position back through any empty page positions. Rejected inputs remain removable. Binding an unwritten Descriptive Book rechecks its server-owned writing and reports the first error without creating an Age. A terrain symbol whose profile is unavailable is also rejected before Binder inputs are consumed.
The plan stores the original writing order, the authoritative semantic value of each resolved symbol, the Age seed, and a copy of the selected runtime profile. An explicit terrain page overrides random terrain selection; an omitted terrain uses a seed-selected compatible profile. The built-in Standard, Amplified, Cave, Island, Flat, and Void terrain pages select their matching generation resources. Age loading uses the frozen runtime profile and does not need the original symbol definition or runtime-profile JSON, though its referenced noise, biome-preset, and dimension-type registry entries must remain available. Existing bound books without plans are not reinterpreted. Page-free and Link-Panel-only books keep the pre-existing random path. Biome and environment pages affect new Ages, and the supported feature subset below is compiled into the same frozen plan; instability remains Milestone 6 work.
## Supported feature pages (issue #35)
Feature pages come after the celestial section. Their order is retained in the plan and in decoration placement. The Caves page adds a second, Age-seeded vanilla cave-carving pass to Noise terrain, including Standard, Amplified, Island, and Cave terrain. It chooses the vanilla Overworld or Nether cave carver from the source biome. This is separate from the Milestone 7 issue about Cave **terrain** generation. Flat and Void terrain have no suitable solid noise body and reject Caves with a binder diagnostic.
Flowers, Trees, Huge Trees, Rocks, Surface Lakes, Deep Lakes, and Small Lakes add vanilla placed features after normal biome decoration. Huge Trees currently use vanilla old-growth spruce placement as a modern approximation of Legacy's huge-tree page; it is not the custom Legacy tree generator. Without a preceding material page, Rocks select a valid solid block and each lake page selects a valid source-fluid block from the registered pool. The selection is deterministic for an Age seed and feature ID, so all chunks in that Age use the same material across restarts with the same block registry. The page-specific feature preserves vanilla placement rules other than the biome-list filter, since an authored page deliberately adds it to the Age. Surface and Small Lakes use a more visible one-in-twelve-chunks attempt rate instead of vanilla lava lakes' one-in-two-hundred; Deep Lakes retain their underground placement. Vanilla biome lava lakes are separate and can still appear alongside authored fluid lakes. These decorations require surface Noise terrain; Cave, Flat, and Void reject them. Flowers and both tree pages require at least one surface Overworld biome and only run in compatible chunks; Nether, End, and tagged cave biomes do not receive surface vegetation. Ravines add a separate Age-seeded vanilla canyon-carving pass to Noise terrain. Unsupported feature IDs and missing vanilla registry entries produce diagnostics instead of becoming no-ops.
Material pages are generated for registered full-collision, non-fluid blocks and genuine source-fluid blocks, including eligible blocks supplied by other mods. Blocks with block entities are excluded. Waterlogged plants and coral are not fluid blocks and receive no pages. Valid source-fluid blocks appear only in the Fluid Pages creative tab; valid full-collision solids appear only in Block Pages. Both categories use the same saved material-page semantics. Put a Block Page immediately before Rocks to choose a rock material, or a Fluid Page immediately before Surface Lakes, Deep Lakes, or Small Lakes to choose a lake fluid. A material page left alone, placed before a different category, or attached to an incompatible feature is rejected. Both the feature and material ID are frozen in the saved plan, so future chunks retain their choice after restart. Existing chunks are not retroactively decorated. Custom structures, crystals, portals, and the Cave-terrain bug are outside this slice.
The Rivencraft symbol-page creative tabs read a generated index of bundled symbol definitions and group Pages by each definition's category, except biome-controller roles, which appear in a separate Biome Generation tab rather than the Biome tab. Adding another valid JSON symbol under `src/main/resources/data/rivencraft/rivencraft/symbols/` includes its page in the matching category tab on the next build; a new bundled category receives its own tab. Registry-derived Block and Fluid Pages have separate tabs and both appear in optional JEI. Link Pages have a separate tab. Blank Pages appear in neither the creative tabs nor JEI's ingredient list. The server catalog still decides whether a page is valid for writing. External server data-pack symbols are not included in this bundled index.
+2 -1
View File
@@ -36,8 +36,9 @@ 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.4.1.5
mod_version=0.4.8.1
immersive_portals_version=6.0.7
terrablender_version=4.1.0.8
# 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.
# See https://maven.apache.org/guides/mini/guide-naming-conventions.html
@@ -10,6 +10,7 @@ import net.dnorberg.rivencraft.registry.ModSounds;
import net.dnorberg.rivencraft.registry.ModBlocks;
import net.dnorberg.rivencraft.registry.ModBlockEntities;
import net.dnorberg.rivencraft.registry.ModBiomeSources;
import net.dnorberg.rivencraft.registry.ModChunkGenerators;
import net.dnorberg.rivencraft.event.BookStandConversionHandler;
import net.dnorberg.rivencraft.event.AgeCelestialAngleSync;
import net.dnorberg.rivencraft.event.AgeLifecycleEvents;
@@ -40,6 +41,7 @@ public final class Rivencraft {
modEventBus.addListener(ModNetworking::register);
ModDataComponents.register(modEventBus);
ModBiomeSources.register(modEventBus);
ModChunkGenerators.register(modEventBus);
ModBlocks.register(modEventBus);
ModBlockEntities.register(modEventBus);
ModItems.register(modEventBus);
@@ -5,6 +5,9 @@ import java.util.List;
import java.util.UUID;
import net.dnorberg.rivencraft.book.AgeReference;
import net.dnorberg.rivencraft.book.AgeRegistrySavedData;
import net.dnorberg.rivencraft.book.AgeGenerationPlan;
import net.dnorberg.rivencraft.book.AgeGenerationProfiles;
import net.dnorberg.rivencraft.book.AgeRuntimeProfiles;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.registry.ModBlockEntities;
import net.dnorberg.rivencraft.registry.ModDataComponents;
@@ -12,10 +15,16 @@ import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.writing.NotebookContents;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.dnorberg.rivencraft.writing.WritingEntry;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.minecraft.core.BlockPos;
import net.minecraft.core.HolderLookup;
import net.minecraft.core.NonNullList;
import net.minecraft.core.registries.Registries;
import net.minecraft.resources.ResourceKey;
import net.dnorberg.rivencraft.book.AgeBiomeSelection;
import net.dnorberg.rivencraft.book.AgeFeatureSelection;
import net.minecraft.core.component.DataComponents;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.network.chat.Component;
@@ -108,7 +117,115 @@ public final class BookBinderBlockEntity extends BlockEntity implements Containe
if (!page.isEmpty() && (!validPage(page) || !PageItem.isUsableWriting(page) || page.getCount() != 1
|| PageItem.content(page).kind() == PageContent.Kind.BLANK)) return false;
}
return true;
OrderedWriting writing = currentWriting();
if (!writingGrammar().canCreate()) return false;
try {
if (level instanceof ServerLevel serverLevel) {
AgeRegistrySavedData.validateNewWriting(serverLevel, title, writing);
} else {
AgeGenerationPlan.compile(writing, 0L, AgeGenerationProfiles.STANDARD,
net.dnorberg.rivencraft.book.AgeTraits.select(0L), level.registryAccess());
}
return true;
} catch (IllegalArgumentException exception) {
return false;
}
}
public WritingGrammar.Result writingGrammar() {
WritingGrammar.Result parsed = WritingGrammar.parse(currentWriting());
if (!parsed.canCreate()) return parsed;
List<WritingGrammar.Diagnostic> diagnostics = new ArrayList<>(parsed.diagnostics());
var terrain = parsed.symbols().stream()
.filter(symbol -> symbol.semantics().role() == SymbolSemantics.Role.TERRAIN)
.findFirst();
if (terrain.isPresent()) {
var profileId = ((SymbolSemantics.ResourceValue) terrain.orElseThrow().semantics().value()).id();
if (!AgeRuntimeProfiles.profiles().containsKey(profileId)) {
diagnostics.add(new WritingGrammar.Diagnostic(WritingGrammar.Code.UNSUPPORTED_PROFILE,
terrain.orElseThrow().index(), "Restore the Age profile " + profileId + " or remove this page"));
}
}
if (level != null) {
var biomes = level.registryAccess().lookupOrThrow(Registries.BIOME);
var selectedProfile = terrain.isPresent()
? ((SymbolSemantics.ResourceValue) terrain.orElseThrow().semantics().value()).id()
: level instanceof ServerLevel serverLevel
? AgeRegistrySavedData.previewGenerationProfile(serverLevel, title, currentWriting())
: AgeGenerationProfiles.STANDARD;
var runtimeProfile = AgeRuntimeProfiles.profiles().get(selectedProfile);
boolean cave = runtimeProfile != null && AgeBiomeSelection.isCave(runtimeProfile);
parsed.symbols().stream().filter(symbol -> symbol.semantics().role() == SymbolSemantics.Role.BIOME)
.forEach(symbol -> {
var id = ((SymbolSemantics.ResourceValue) symbol.semantics().value()).id();
var holder = biomes.get(ResourceKey.create(Registries.BIOME, id));
if (holder.isEmpty()) {
diagnostics.add(new WritingGrammar.Diagnostic(WritingGrammar.Code.UNKNOWN_BIOME,
symbol.index(), "Restore biome " + id + " or remove this page"));
} else if (cave && !AgeBiomeSelection.isCaveBiome(level.registryAccess(),
holder.orElseThrow())) {
diagnostics.add(new WritingGrammar.Diagnostic(WritingGrammar.Code.UNSUPPORTED_BIOME,
symbol.index(), "Cave Ages require cave or Nether biomes; remove " + id));
}
});
if (runtimeProfile != null) {
parsed.symbols().stream().filter(symbol -> symbol.semantics().role() == SymbolSemantics.Role.FEATURE)
.forEach(symbol -> {
var id = ((SymbolSemantics.ResourceValue) symbol.semantics().value()).id();
String error = AgeFeatureSelection.error(id, runtimeProfile, level.registryAccess());
if (error != null) diagnostics.add(new WritingGrammar.Diagnostic(
WritingGrammar.Code.UNSUPPORTED_FEATURE, symbol.index(), error));
});
}
// Compile against the actual title-derived Age seed as a final compatibility
// check. This also pinpoints biome-pool conflicts that cannot be inferred from
// an individual feature page alone (for example Trees with only Nether biomes).
if (level instanceof ServerLevel serverLevel && diagnostics.stream().noneMatch(
diagnostic -> diagnostic.code() == WritingGrammar.Code.UNSUPPORTED_FEATURE)) {
try {
AgeRegistrySavedData.validateNewWriting(serverLevel, title, currentWriting());
} catch (IllegalArgumentException exception) {
if (exception.getMessage() != null && (exception.getMessage().startsWith("Feature ")
|| exception.getMessage().startsWith("Caves "))) {
parsed.symbols().stream().filter(symbol -> symbol.semantics().role()
== SymbolSemantics.Role.FEATURE).findFirst().ifPresent(symbol ->
diagnostics.add(new WritingGrammar.Diagnostic(
WritingGrammar.Code.UNSUPPORTED_FEATURE, symbol.index(),
exception.getMessage())));
}
}
}
}
return new WritingGrammar.Result(parsed.symbols(), diagnostics);
}
/** Map the parser's compact entry index back to the visible strip, including empty page positions. */
public int writingStripIndex(int grammarIndex) {
if (grammarIndex < 0) return -1;
int entryIndex = 0;
if (canPlaceItem(LINK_PANEL, items.get(LINK_PANEL))) {
if (grammarIndex == 0) return 0;
entryIndex++;
}
for (int slot = FIRST_PAGE; slot < SIZE; slot++) {
ItemStack page = items.get(slot);
if (!page.isEmpty() && PageItem.content(page).symbol().isPresent()) {
if (entryIndex == grammarIndex) return slot - FIRST_PAGE + 1;
entryIndex++;
}
}
return -1;
}
private OrderedWriting currentWriting() {
List<WritingEntry> entries = new ArrayList<>();
if (canPlaceItem(LINK_PANEL, items.get(LINK_PANEL))) entries.add(WritingEntry.linkPanel());
for (int slot = FIRST_PAGE; slot < SIZE; slot++) {
ItemStack page = items.get(slot);
if (!page.isEmpty()) PageItem.content(page).symbol().ifPresent(reference ->
entries.add(WritingEntry.symbol(reference)));
}
return new OrderedWriting(entries);
}
public ItemStack previewBook() {
@@ -117,15 +234,14 @@ public final class BookBinderBlockEntity extends BlockEntity implements Containe
pendingAgeId = UUID.randomUUID();
setChanged();
}
List<WritingEntry> entries = new ArrayList<>();
entries.add(WritingEntry.linkPanel());
for (int slot = FIRST_PAGE; slot < SIZE; slot++) {
ItemStack page = items.get(slot);
if (!page.isEmpty()) entries.add(WritingEntry.symbol(PageItem.content(page).symbol().orElseThrow()));
}
ItemStack book = new ItemStack(ModItems.DESCRIPTIVE_BOOK.get());
book.set(ModDataComponents.AGE_REFERENCE.get(), new AgeReference(pendingAgeId, title));
book.set(ModDataComponents.BOOK_WRITING.get(), new OrderedWriting(entries));
book.set(ModDataComponents.BOOK_WRITING.get(), currentWriting());
if (items.get(LINK_PANEL).has(ModDataComponents.LINK_PROPERTIES.get())) {
var properties = items.get(LINK_PANEL).get(ModDataComponents.LINK_PROPERTIES.get())
.forDescriptiveBook();
if (properties.flags() != 0) book.set(ModDataComponents.LINK_PROPERTIES.get(), properties);
}
book.set(DataComponents.CUSTOM_NAME, Component.literal(title));
return book;
}
@@ -135,7 +251,7 @@ public final class BookBinderBlockEntity extends BlockEntity implements Containe
if (!canAssemble()) return false;
if (pendingAgeId == null) pendingAgeId = UUID.randomUUID();
if (level instanceof ServerLevel serverLevel)
AgeRegistrySavedData.resolveOrCreate(serverLevel, new AgeReference(pendingAgeId, title));
AgeRegistrySavedData.resolveOrCreate(serverLevel, new AgeReference(pendingAgeId, title), currentWriting());
items.get(COVER).shrink(1);
if (items.get(COVER).isEmpty()) items.set(COVER, ItemStack.EMPTY);
items.get(LINK_PANEL).shrink(1);
@@ -1,10 +1,14 @@
package net.dnorberg.rivencraft.block.entity;
import java.util.Random;
import net.dnorberg.rivencraft.book.LinkProperties;
import net.dnorberg.rivencraft.item.InkVialItem;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.writing.InkVialExchange;
import net.dnorberg.rivencraft.writing.InkModifierIngredients;
import net.dnorberg.rivencraft.registry.ModBlockEntities;
import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.writing.WritingInkService;
import net.minecraft.core.BlockPos;
import net.minecraft.core.HolderLookup;
import net.minecraft.core.NonNullList;
@@ -18,7 +22,7 @@ import net.minecraft.world.level.Level;
import net.minecraft.world.level.block.entity.BlockEntity;
import net.minecraft.world.level.block.state.BlockState;
/** Baseline Link Panel mixer. Modifier ingredients belong to the symbol/ink-effects milestone. */
/** Server-owned Link Panel mixer with a persistent, Legacy-style additive mixture. */
public final class InkMixerBlockEntity extends BlockEntity implements Container {
public static final int INK = 0;
public static final int PAPER = 1;
@@ -27,6 +31,12 @@ public final class InkMixerBlockEntity extends BlockEntity implements Container
private NonNullList<ItemStack> items = NonNullList.withSize(SIZE, ItemStack.EMPTY);
private int inkRemaining;
private long nextModifierSeed = new Random().nextLong();
private final double[] modifierChances = new double[3];
private static final int[] FLAGS = {LinkProperties.DISARM,
LinkProperties.MAINTAIN_MOMENTUM, LinkProperties.INTRA_LINKING};
private static final String[] CHANCE_KEYS = {"DisarmChance", "MomentumChance", "IntraLinkingChance"};
private static final int[] OLD_CHANCE_INDEX = {0, 2, 3};
public InkMixerBlockEntity(BlockPos pos, BlockState state) {
super(ModBlockEntities.INK_MIXER.get(), pos, state);
@@ -34,6 +44,44 @@ public final class InkMixerBlockEntity extends BlockEntity implements Container
public int inkRemaining() { return inkRemaining; }
public int modifierChancePermille(int index) {
return Math.clamp((int) Math.round(modifierChances[index] * 1000), 0, 1000);
}
/** Infuses a carried ingredient into the current ink pool; only the server calls this. */
public boolean addModifier(ItemStack carried, int amount) {
InkModifierIngredients.Ingredient ingredient = InkModifierIngredients.find(carried);
if (ingredient == null || inkRemaining == 0 || amount <= 0 || carried.getCount() < amount)
return false;
for (InkModifierIngredients.Effect effect : ingredient.effects())
for (int index = 0; index < FLAGS.length; index++)
if (FLAGS[index] == effect.flag())
modifierChances[index] = 1.0 - (1.0 - modifierChances[index])
* Math.pow(1.0 - effect.chance(), amount);
carried.shrink(amount);
setChanged();
return true;
}
public ItemStack previewLinkPanel() {
if (!canCreateLinkPanel()) return ItemStack.EMPTY;
ItemStack panel = PageItem.createLinkPanelPage();
LinkProperties properties = rollProperties(nextModifierSeed).properties();
if (properties.flags() != 0) panel.set(ModDataComponents.LINK_PROPERTIES.get(), properties);
return panel;
}
private record Roll(LinkProperties properties, long nextSeed) {}
private Roll rollProperties(long seed) {
Random random = new Random(seed);
int selected = 0;
for (int index = 0; index < FLAGS.length; index++)
if (modifierChances[index] > 0 && random.nextDouble() < modifierChances[index])
selected |= FLAGS[index];
return new Roll(new LinkProperties(selected), random.nextLong());
}
@Override public int getContainerSize() { return SIZE; }
@Override public boolean isEmpty() { return items.stream().allMatch(ItemStack::isEmpty); }
@Override public ItemStack getItem(int slot) { return items.get(slot); }
@@ -78,20 +126,21 @@ public final class InkMixerBlockEntity extends BlockEntity implements Container
public boolean canCreateLinkPanel() {
if (!items.get(PAPER).is(Items.PAPER)) return false;
int cost = WritingInkService.linkPanelCost();
return InkVialExchange.canPay(items, INK, BOTTLES, inkRemaining, cost);
return InkVialExchange.canPay(items, INK, BOTTLES, inkRemaining, InkVialItem.CAPACITY);
}
/** Commit inputs only when a virtual output is actually taken. */
public boolean consumeLinkPanelMaterials() {
if (!canCreateLinkPanel()) return false;
int cost = WritingInkService.linkPanelCost();
int cost = InkVialItem.CAPACITY;
if (inkRemaining < cost) {
inkRemaining += InkVialExchange.exchange(items, INK, BOTTLES);
}
inkRemaining -= cost;
items.get(PAPER).shrink(1);
if (items.get(PAPER).isEmpty()) items.set(PAPER, ItemStack.EMPTY);
nextModifierSeed = rollProperties(nextModifierSeed).nextSeed();
java.util.Arrays.fill(modifierChances, 0);
setChanged();
if (inkRemaining == 0) refillEmptyBasin();
return true;
@@ -104,6 +153,7 @@ public final class InkMixerBlockEntity extends BlockEntity implements Container
@Override public void clearContent() {
items = NonNullList.withSize(SIZE, ItemStack.EMPTY);
inkRemaining = 0;
java.util.Arrays.fill(modifierChances, 0);
setChanged();
}
@Override protected void loadAdditional(CompoundTag tag, HolderLookup.Provider registries) {
@@ -111,11 +161,20 @@ public final class InkMixerBlockEntity extends BlockEntity implements Container
items = NonNullList.withSize(SIZE, ItemStack.EMPTY);
ContainerHelper.loadAllItems(tag, items, registries);
inkRemaining = Math.clamp(tag.getInt("InkRemaining"), 0, InkVialItem.CAPACITY);
if (tag.contains("NextModifierSeed")) nextModifierSeed = tag.getLong("NextModifierSeed");
for (int index = 0; index < modifierChances.length; index++) {
double chance = tag.contains(CHANCE_KEYS[index]) ? tag.getDouble(CHANCE_KEYS[index])
: tag.getDouble("ModifierChance" + OLD_CHANCE_INDEX[index]);
modifierChances[index] = Math.clamp(chance, 0.0, 1.0);
}
refillEmptyBasin();
}
@Override protected void saveAdditional(CompoundTag tag, HolderLookup.Provider registries) {
super.saveAdditional(tag, registries);
ContainerHelper.saveAllItems(tag, items, registries);
tag.putInt("InkRemaining", inkRemaining);
tag.putLong("NextModifierSeed", nextModifierSeed);
for (int index = 0; index < modifierChances.length; index++)
tag.putDouble(CHANCE_KEYS[index], modifierChances[index]);
}
}
@@ -1,8 +1,12 @@
package net.dnorberg.rivencraft.block.entity;
import net.dnorberg.rivencraft.item.InkVialItem;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.writing.InkVialExchange;
import net.dnorberg.rivencraft.writing.WritingInkService;
import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.NotebookContents;
import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.registry.ModBlockEntities;
import net.dnorberg.rivencraft.registry.ModItems;
import net.minecraft.core.BlockPos;
@@ -83,7 +87,11 @@ 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()) || stack.is(ModItems.PAGE.get());
if (slot < COLLECTIONS) return stack.is(ModItems.NOTEBOOK.get())
&& 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())
&& PageItem.content(stack).kind() != PageContent.Kind.LINK_PANEL;
return switch (slot) {
case INK -> stack.is(ModItems.INK_VIAL.get());
case RETURN -> false;
@@ -0,0 +1,158 @@
package net.dnorberg.rivencraft.book;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Random;
import java.util.Set;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.compat.TerraBlenderBiomes;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.minecraft.core.Holder;
import net.minecraft.core.RegistryAccess;
import net.minecraft.core.registries.Registries;
import net.minecraft.resources.ResourceKey;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.tags.TagKey;
import net.minecraft.tags.BiomeTags;
import net.minecraft.world.level.biome.Biome;
import net.minecraft.world.level.biome.MultiNoiseBiomeSource;
import net.minecraft.world.level.biome.MultiNoiseBiomeSourceParameterList;
/** Frozen biome pool and controller for an authored Age. Repeated IDs are intentional weights. */
public record AgeBiomeSelection(AgeTraits.BiomeDistribution distribution, List<ResourceLocation> biomes) {
public static final TagKey<Biome> CAVE_BIOMES = TagKey.create(Registries.BIOME,
ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "cave_biomes"));
public AgeBiomeSelection {
if (distribution == null) throw new IllegalArgumentException("Missing biome distribution");
biomes = List.copyOf(biomes);
if (biomes.isEmpty()) throw new IllegalArgumentException("An Age biome pool cannot be empty");
}
public static AgeBiomeSelection compile(WritingGrammar.Result writing, AgeTraits traits,
AgeRuntimeProfile profile, long seed, RegistryAccess registries) {
List<ResourceLocation> authored = writing.symbols().stream()
.filter(symbol -> symbol.semantics().role() == SymbolSemantics.Role.BIOME)
.map(symbol -> ((SymbolSemantics.ResourceValue) symbol.semantics().value()).id()).toList();
var controller = writing.symbols().stream()
.filter(symbol -> symbol.semantics().role() == SymbolSemantics.Role.BIOME_CONTROLLER)
.map(symbol -> ((SymbolSemantics.ChoiceValue) symbol.semantics().value()).id())
.findFirst();
AgeTraits.BiomeDistribution distribution = controller
.map(value -> AgeTraits.BiomeDistribution.valueOf(value.toUpperCase(java.util.Locale.ROOT)))
.orElse(traits.biomeDistribution());
if (profile.terrain() == AgeRuntimeProfile.Terrain.VOID && controller.isEmpty() && authored.isEmpty()) {
distribution = AgeTraits.BiomeDistribution.SINGLE;
}
if (controller.isEmpty() && !authored.isEmpty()) {
if (distribution == AgeTraits.BiomeDistribution.NATIVE
|| (distribution == AgeTraits.BiomeDistribution.SINGLE && authored.size() > 1)) {
distribution = authored.size() == 1 ? AgeTraits.BiomeDistribution.SINGLE
: authored.size() == 2 ? AgeTraits.BiomeDistribution.TILED
: AgeTraits.BiomeDistribution.MEDIUM;
}
}
var registry = registries.lookupOrThrow(Registries.BIOME);
boolean cave = isCave(profile);
for (ResourceLocation id : authored) {
Holder.Reference<Biome> holder = registry.get(ResourceKey.create(Registries.BIOME, id))
.orElseThrow(() -> new IllegalArgumentException("Unknown biome " + id + "; restore its data pack or remove its page"));
if (cave && !isCaveBiome(registries, holder)) {
throw new IllegalArgumentException("Biome " + id
+ " is not a cave or Nether biome; use #rivencraft:cave_biomes, #minecraft:is_nether,"
+ " or a TerraBlender Nether region");
}
}
List<ResourceLocation> availableBiomes = eligible(registries, profile);
if (availableBiomes.isEmpty()) throw new IllegalArgumentException("No eligible biomes for terrain " + profile.noiseSettings());
if (distribution == AgeTraits.BiomeDistribution.NATIVE) {
if (!authored.isEmpty()) throw new IllegalArgumentException("Native biome distribution cannot use biome pages");
return new AgeBiomeSelection(distribution, profile.terrain() == AgeRuntimeProfile.Terrain.FLAT
? List.of(ResourceLocation.withDefaultNamespace("plains"))
: isCave(profile) ? availableBiomes : presetBiomes(registries, profile));
}
List<ResourceLocation> selected = new ArrayList<>(authored);
Set<ResourceLocation> distinct = new LinkedHashSet<>(selected);
int minimum = minimum(distribution);
int target = minimum;
if (authored.isEmpty()) {
// The terrain's available pool is the upper bound, including any
// compatible TerraBlender region biomes present at creation time.
int availableBiomeCount = new LinkedHashSet<>(availableBiomes).size();
int maximum = distribution == AgeTraits.BiomeDistribution.SINGLE ? 1 : availableBiomeCount;
if (maximum >= minimum) {
target += new Random(seed ^ 0x42494F4D45434F55L).nextInt(maximum - minimum + 1);
}
}
List<ResourceLocation> filler = new ArrayList<>(availableBiomes);
java.util.Collections.shuffle(filler, new Random(seed ^ 0x42494F4D45504F4FL));
for (ResourceLocation id : filler) {
if (distinct.size() >= target) break;
if (distinct.add(id)) selected.add(id);
}
if (distinct.size() < minimum) {
throw new IllegalArgumentException(distribution + " requires " + minimum
+ " distinct biomes; supply more biome pages for this terrain");
}
return new AgeBiomeSelection(distribution, selected);
}
public static List<ResourceLocation> eligible(RegistryAccess registries, AgeRuntimeProfile profile) {
var registry = registries.lookupOrThrow(Registries.BIOME);
if (isCave(profile)) {
List<ResourceLocation> tagged = registry.listElements().filter(holder -> holder.is(CAVE_BIOMES))
.map(holder -> holder.key().location()).sorted().toList();
List<ResourceLocation> vanilla = !tagged.isEmpty() ? tagged : List.of("minecraft:deep_dark", "minecraft:dripstone_caves", "minecraft:lush_caves")
.stream().map(ResourceLocation::parse)
.filter(id -> registry.get(ResourceKey.create(Registries.BIOME, id)).isPresent()).toList();
List<ResourceLocation> nether = registry.listElements().filter(holder -> holder.is(BiomeTags.IS_NETHER))
.map(holder -> holder.key().location()).toList();
return merge(merge(vanilla, nether), TerraBlenderBiomes.nether(registries));
}
if (profile.terrain() == AgeRuntimeProfile.Terrain.VOID) {
return List.of(ResourceLocation.withDefaultNamespace("the_void"));
}
ResourceLocation preset = profile.terrain() == AgeRuntimeProfile.Terrain.FLAT
? ResourceLocation.withDefaultNamespace("overworld") : profile.biomePreset();
List<ResourceLocation> nativeBiomes = presetBiomes(registries, profile);
return merge(nativeBiomes, preset.equals(ResourceLocation.withDefaultNamespace("nether"))
? TerraBlenderBiomes.nether(registries) : TerraBlenderBiomes.overworld(registries));
}
private static List<ResourceLocation> presetBiomes(RegistryAccess registries, AgeRuntimeProfile profile) {
if (profile.terrain() == AgeRuntimeProfile.Terrain.VOID)
return List.of(ResourceLocation.withDefaultNamespace("the_void"));
ResourceLocation preset = profile.terrain() == AgeRuntimeProfile.Terrain.FLAT
? ResourceLocation.withDefaultNamespace("overworld") : profile.biomePreset();
var parameters = registries.lookupOrThrow(Registries.MULTI_NOISE_BIOME_SOURCE_PARAMETER_LIST)
.getOrThrow(ResourceKey.create(Registries.MULTI_NOISE_BIOME_SOURCE_PARAMETER_LIST, preset));
return MultiNoiseBiomeSource.createFromPreset(parameters).possibleBiomes().stream()
.map(holder -> holder.unwrapKey().orElseThrow().location())
.sorted(Comparator.naturalOrder()).toList();
}
public static boolean isCaveBiome(RegistryAccess registries, Holder.Reference<Biome> holder) {
return holder.is(CAVE_BIOMES) || holder.is(BiomeTags.IS_NETHER)
|| TerraBlenderBiomes.nether(registries).contains(holder.key().location());
}
private static List<ResourceLocation> merge(List<ResourceLocation> vanilla, List<ResourceLocation> additions) {
return java.util.stream.Stream.concat(vanilla.stream(), additions.stream()).distinct().sorted().toList();
}
public static boolean isCave(AgeRuntimeProfile profile) {
return profile.terrain() == AgeRuntimeProfile.Terrain.NOISE
&& profile.noiseSettings().equals(ResourceLocation.withDefaultNamespace("caves"));
}
public static int minimum(AgeTraits.BiomeDistribution distribution) {
return switch (distribution) {
case NATIVE, SINGLE -> 1;
case TILED, GRID, TINY, SMALL, MEDIUM, LARGE, HUGE -> 2;
};
}
}
@@ -16,12 +16,13 @@ public record AgeDefinition(
long createdGameTime,
ResourceLocation dimensionId,
BlockPos spawn,
AgeTraits traits
AgeTraits traits,
AgeGenerationPlan plan
) {
public static final ResourceLocation RANDOM_VANILLA_PROFILE = ResourceLocation.fromNamespaceAndPath(
Rivencraft.MOD_ID, "random_vanilla"
);
public static final int CURRENT_GENERATION_VERSION = 13;
public static final int CURRENT_GENERATION_VERSION = 16;
public AgeDefinition {
Objects.requireNonNull(id, "id");
@@ -29,6 +30,16 @@ public record AgeDefinition(
Objects.requireNonNull(generationProfile, "generationProfile");
Objects.requireNonNull(dimensionId, "dimensionId");
Objects.requireNonNull(traits, "traits");
if (plan != null && plan.ageSeed() != seed) {
throw new IllegalArgumentException("Age plan seed does not match its Age definition");
}
}
public AgeDefinition(UUID id, String name, long seed, ResourceLocation generationProfile,
int generationVersion, long createdGameTime, ResourceLocation dimensionId,
BlockPos spawn, AgeTraits traits) {
this(id, name, seed, generationProfile, generationVersion, createdGameTime,
dimensionId, spawn, traits, null);
}
public static ResourceLocation dimensionId(UUID ageId) {
@@ -59,6 +70,6 @@ public record AgeDefinition(
public AgeDefinition withSpawn(BlockPos spawn) {
return new AgeDefinition(id, name, seed, generationProfile, generationVersion,
createdGameTime, dimensionId, spawn.immutable(), traits);
createdGameTime, dimensionId, spawn.immutable(), traits, plan);
}
}
@@ -6,10 +6,15 @@ import dev.galacticraft.dynamicdimensions.api.event.DimensionRemovedCallback;
import dev.galacticraft.dynamicdimensions.api.event.DynamicDimensionLoadCallback;
import java.util.Optional;
import java.util.List;
import java.util.Comparator;
import java.util.ArrayList;
import java.util.LinkedHashSet;
import java.util.Set;
import java.util.Collections;
import java.util.Comparator;
import java.util.Random;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.compat.ImmersivePortalsChunkLoaders;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.minecraft.core.BlockPos;
import net.minecraft.core.GlobalPos;
import net.minecraft.core.Holder;
@@ -31,12 +36,14 @@ import net.minecraft.world.level.biome.CheckerboardColumnBiomeSource;
import net.minecraft.world.level.biome.FixedBiomeSource;
import net.minecraft.world.level.biome.MultiNoiseBiomeSource;
import net.dnorberg.rivencraft.world.ScaledBiomeSource;
import net.dnorberg.rivencraft.world.AgeFlatChunkGenerator;
import net.dnorberg.rivencraft.world.AgeFeatureChunkGenerator;
import net.minecraft.world.level.chunk.ChunkGenerator;
import net.minecraft.world.level.dimension.BuiltinDimensionTypes;
import net.minecraft.world.level.dimension.DimensionType;
import net.minecraft.world.level.levelgen.FlatLevelSource;
import net.minecraft.world.level.levelgen.Heightmap;
import net.minecraft.world.level.levelgen.NoiseBasedChunkGenerator;
import net.minecraft.world.level.levelgen.FlatLevelSource;
import net.minecraft.world.level.levelgen.NoiseGeneratorSettings;
import net.minecraft.world.level.levelgen.SurfaceRules;
import net.minecraft.world.level.levelgen.flat.FlatLevelGeneratorSettings;
@@ -59,6 +66,7 @@ public final class AgeDimensionService {
DynamicDimensionLoadCallback.register((server, loader) -> {
ServerLevel overworld = server.overworld();
for (AgeDefinition age : AgeRegistrySavedData.get(overworld).definitions()) {
if (!canLoadProfile(server, age)) continue;
ServerLevel level = loader.loadDynamicDimension(
age.dimensionId(),
createGenerator(server, age),
@@ -73,7 +81,12 @@ public final class AgeDimensionService {
}
public static Optional<LinkTarget> resolve(ServerPlayer player, AgeReference reference) {
AgeDefinition definition = AgeRegistrySavedData.resolveOrCreate(player.serverLevel(), reference);
return resolve(player, reference, OrderedWriting.EMPTY);
}
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);
if (level == null) {
return Optional.empty();
@@ -100,6 +113,8 @@ public final class AgeDimensionService {
return existing;
}
if (!canLoadProfile(server, definition)) return null;
ServerLevel overworld = server.overworld();
ServerLevel loaded = DynamicDimensionRegistry.from(server).loadDynamicDimension(
definition.dimensionId(),
@@ -148,8 +163,28 @@ public final class AgeDimensionService {
}
}
private static boolean canLoadProfile(MinecraftServer server, AgeDefinition age) {
try {
AgeRuntimeProfiles.validateReferences(server.registryAccess(), age.generationProfile(), runtimeProfile(age));
return true;
} catch (IllegalArgumentException exception) {
Rivencraft.LOGGER.error("Cannot load Age {} ({}): {}. Restore its data pack; saved Age data is unchanged.",
age.id(), age.dimensionId(), exception.getMessage());
return false;
}
}
private static AgeRuntimeProfile runtimeProfile(AgeDefinition age) {
return age.plan() == null ? AgeRuntimeProfiles.resolve(age.generationProfile())
: age.plan().runtimeProfile();
}
private static void applyInitialCelestialPhase(ServerLevel level, AgeDefinition age) {
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.
phaseTime = (phaseTime + 18_000L) % Level.TICKS_PER_DAY;
}
level.setDayTime(phaseTime);
}
@@ -261,13 +296,16 @@ public final class AgeDimensionService {
}
private static ChunkGenerator createGenerator(MinecraftServer server, AgeDefinition age) {
AgeRuntimeProfile profile = AgeRuntimeProfiles.resolve(age.generationProfile());
AgeRuntimeProfile profile = runtimeProfile(age);
BiomeSource biomeSource = createBiomeSource(server, age, profile);
if (profile.terrain() == AgeRuntimeProfile.Terrain.FLAT) {
return new FlatLevelSource(FlatLevelGeneratorSettings.getDefault(
var settings = FlatLevelGeneratorSettings.getDefault(
server.registryAccess().lookupOrThrow(Registries.BIOME),
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);
}
if (profile.terrain() == AgeRuntimeProfile.Terrain.VOID) {
FlatLevelGeneratorSettings settings = new FlatLevelGeneratorSettings(
@@ -276,19 +314,18 @@ public final class AgeDimensionService {
List.of()
);
settings.updateLayers();
return new FlatLevelSource(settings);
return age.generationVersion() < AgeDefinition.CURRENT_GENERATION_VERSION
? new FlatLevelSource(settings) : new AgeFlatChunkGenerator(biomeSource, settings);
}
var biomeParameters = server.registryAccess()
.lookupOrThrow(Registries.MULTI_NOISE_BIOME_SOURCE_PARAMETER_LIST);
var noiseSettings = server.registryAccess().lookupOrThrow(Registries.NOISE_SETTINGS);
ResourceKey<NoiseGeneratorSettings> settingsKey = ResourceKey.create(
Registries.NOISE_SETTINGS, profile.noiseSettings());
ResourceKey<net.minecraft.world.level.biome.MultiNoiseBiomeSourceParameterList> biomePreset =
ResourceKey.create(Registries.MULTI_NOISE_BIOME_SOURCE_PARAMETER_LIST, profile.biomePreset());
BiomeSource biomeSource = createBiomeSource(server, age, biomeParameters, biomePreset);
NoiseGeneratorSettings baseSettings = noiseSettings.getOrThrow(settingsKey).value();
return new NoiseBasedChunkGenerator(biomeSource, Holder.direct(withBiomeMaterialRules(baseSettings)));
Holder<NoiseGeneratorSettings> settings = Holder.direct(withBiomeMaterialRules(baseSettings));
List<AgeFeatureSelection.Choice> features = AgeFeatureSelection.resolved(age.plan());
return features.isEmpty() ? new NoiseBasedChunkGenerator(biomeSource, settings)
: new AgeFeatureChunkGenerator(biomeSource, settings, features, age.seed());
}
private static NoiseGeneratorSettings withBiomeMaterialRules(NoiseGeneratorSettings base) {
@@ -333,34 +370,86 @@ public final class AgeDimensionService {
private static BiomeSource createBiomeSource(
MinecraftServer server,
AgeDefinition age,
net.minecraft.core.HolderGetter<net.minecraft.world.level.biome.MultiNoiseBiomeSourceParameterList> biomeParameters,
ResourceKey<net.minecraft.world.level.biome.MultiNoiseBiomeSourceParameterList> biomePreset
AgeRuntimeProfile profile
) {
List<net.minecraft.core.Holder.Reference<Biome>> biomes = server.registryAccess()
.lookupOrThrow(Registries.BIOME)
.listElements()
.sorted(Comparator.comparing(holder -> holder.key().location().toString()))
.toList();
if (age.traits().biomeDistribution() == AgeTraits.BiomeDistribution.SINGLE && !biomes.isEmpty()) {
int index = Math.floorMod(Long.hashCode(age.seed() ^ 0x53494E474C454249L), biomes.size());
return new FixedBiomeSource(biomes.get(index));
if (age.generationVersion() < AgeDefinition.CURRENT_GENERATION_VERSION) {
return legacyBiomeSource(server, age, profile);
}
AgeTraits.BiomeDistribution distribution = age.traits().biomeDistribution();
if ((distribution == AgeTraits.BiomeDistribution.TILED
|| distribution == AgeTraits.BiomeDistribution.GRID) && biomes.size() >= 2) {
List<net.minecraft.core.Holder.Reference<Biome>> selected = new java.util.ArrayList<>(biomes);
long salt = distribution == AgeTraits.BiomeDistribution.GRID
? 0x4752494442494F4DL
: 0x54494C454442494FL;
Collections.shuffle(selected, new java.util.Random(age.seed() ^ salt));
return new CheckerboardColumnBiomeSource(
HolderSet.direct(List.of(selected.get(0), selected.get(1))),
distribution == AgeTraits.BiomeDistribution.GRID
? GRID_BIOME_SCALE
: TILED_BIOME_SCALE
);
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());
var registry = server.registryAccess().lookupOrThrow(Registries.BIOME);
List<Holder<Biome>> biomes = new ArrayList<>();
List<ResourceLocation> fallbacks = AgeBiomeSelection.eligible(server.registryAccess(), profile);
Set<ResourceLocation> present = new LinkedHashSet<>();
for (ResourceLocation id : selection.biomes()) {
var holder = registry.get(ResourceKey.create(Registries.BIOME, id));
if (holder.isEmpty()) {
ResourceLocation fallback = fallbacks.stream().filter(candidate -> !present.contains(candidate))
.findFirst().orElse(fallbacks.getFirst());
Rivencraft.LOGGER.warn("Age {} biome {} is unavailable; using {} for this load. Restore its data pack to recover the authored biome.",
age.id(), id, fallback);
holder = registry.get(ResourceKey.create(Registries.BIOME, fallback));
}
Holder.Reference<Biome> resolved = holder.orElseThrow();
biomes.add(resolved);
present.add(resolved.key().location());
}
for (ResourceLocation fallback : fallbacks) {
if (present.size() >= AgeBiomeSelection.minimum(selection.distribution())) break;
if (present.add(fallback)) biomes.add(registry.getOrThrow(
ResourceKey.create(Registries.BIOME, fallback)));
}
AgeTraits.BiomeDistribution distribution = selection.distribution();
if (distribution == AgeTraits.BiomeDistribution.NATIVE && !AgeBiomeSelection.isCave(profile)
&& profile.terrain() == AgeRuntimeProfile.Terrain.NOISE) {
var parameters = server.registryAccess()
.lookupOrThrow(Registries.MULTI_NOISE_BIOME_SOURCE_PARAMETER_LIST);
var preset = ResourceKey.create(Registries.MULTI_NOISE_BIOME_SOURCE_PARAMETER_LIST, profile.biomePreset());
return MultiNoiseBiomeSource.createFromPreset(parameters.getOrThrow(preset));
}
if (distribution == AgeTraits.BiomeDistribution.SINGLE || biomes.size() == 1) {
return new FixedBiomeSource(biomes.getFirst());
}
if (distribution == AgeTraits.BiomeDistribution.TILED || distribution == AgeTraits.BiomeDistribution.GRID) {
return new CheckerboardColumnBiomeSource(HolderSet.direct(biomes),
distribution == AgeTraits.BiomeDistribution.GRID ? GRID_BIOME_SCALE : TILED_BIOME_SCALE);
}
int scaledBiomeScale = switch (distribution) {
case NATIVE, TINY -> 0;
case SMALL -> 1;
case MEDIUM -> 2;
case LARGE -> 3;
case HUGE -> 4;
default -> -1;
};
if (biomes.size() >= 2) {
return new ScaledBiomeSource(HolderSet.direct(biomes), age.seed(), scaledBiomeScale);
}
return new CheckerboardColumnBiomeSource(HolderSet.direct(biomes), GRID_BIOME_SCALE);
}
/** Preserve the exact selection algorithm for Ages created before biome pools were frozen. */
private static BiomeSource legacyBiomeSource(MinecraftServer server, AgeDefinition age, AgeRuntimeProfile profile) {
var registry = server.registryAccess().lookupOrThrow(Registries.BIOME);
List<Holder.Reference<Biome>> all = registry.listElements()
.sorted(Comparator.comparing(holder -> holder.key().location().toString())).toList();
AgeTraits.BiomeDistribution distribution = age.traits().biomeDistribution();
if (distribution == AgeTraits.BiomeDistribution.SINGLE && !all.isEmpty()) {
int index = Math.floorMod(Long.hashCode(age.seed() ^ 0x53494E474C454249L), all.size());
return new FixedBiomeSource(all.get(index));
}
if ((distribution == AgeTraits.BiomeDistribution.TILED || distribution == AgeTraits.BiomeDistribution.GRID)
&& all.size() >= 2) {
List<Holder.Reference<Biome>> selected = new ArrayList<>(all);
long salt = distribution == AgeTraits.BiomeDistribution.GRID
? 0x4752494442494F4DL : 0x54494C454442494FL;
Collections.shuffle(selected, new Random(age.seed() ^ salt));
return new CheckerboardColumnBiomeSource(HolderSet.direct(List.of(selected.get(0), selected.get(1))),
distribution == AgeTraits.BiomeDistribution.GRID ? GRID_BIOME_SCALE : TILED_BIOME_SCALE);
}
int scale = switch (distribution) {
case TINY -> 0;
case SMALL -> 1;
case MEDIUM -> 2;
@@ -368,28 +457,25 @@ public final class AgeDimensionService {
case HUGE -> 4;
default -> -1;
};
if (scaledBiomeScale >= 0 && biomes.size() >= 3) {
List<net.minecraft.core.Holder.Reference<Biome>> selected = new java.util.ArrayList<>(biomes);
if (scale >= 0 && all.size() >= 3) {
List<Holder.Reference<Biome>> selected = new ArrayList<>(all);
long salt = distribution == AgeTraits.BiomeDistribution.TINY
? 0x54494E5942494F4DL
: 0x5343414C45444249L;
Collections.shuffle(selected, new java.util.Random(age.seed() ^ salt));
return new ScaledBiomeSource(
HolderSet.direct(List.of(selected.get(0), selected.get(1), selected.get(2))),
age.seed(),
scaledBiomeScale
);
? 0x54494E5942494F4DL : 0x5343414C45444249L;
Collections.shuffle(selected, new Random(age.seed() ^ salt));
return new ScaledBiomeSource(HolderSet.direct(List.of(selected.get(0), selected.get(1), selected.get(2))),
age.seed(), scale);
}
return MultiNoiseBiomeSource.createFromPreset(
biomeParameters.getOrThrow(biomePreset));
var parameters = server.registryAccess().lookupOrThrow(Registries.MULTI_NOISE_BIOME_SOURCE_PARAMETER_LIST);
return MultiNoiseBiomeSource.createFromPreset(parameters.getOrThrow(ResourceKey.create(
Registries.MULTI_NOISE_BIOME_SOURCE_PARAMETER_LIST, profile.biomePreset())));
}
private static DimensionType createDimensionType(MinecraftServer server, AgeDefinition age) {
AgeRuntimeProfile profile = AgeRuntimeProfiles.resolve(age.generationProfile());
AgeRuntimeProfile profile = runtimeProfile(age);
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 = lighting != AgeTraits.Lighting.DARK;
boolean hasSkyLight = base.hasSkyLight() && lighting != AgeTraits.Lighting.DARK;
float ambientLight = lighting == AgeTraits.Lighting.BRIGHT ? 0.25F : 0.0F;
return new DimensionType(
base.fixedTime(),
@@ -404,7 +490,7 @@ public final class AgeDimensionService {
base.height(),
base.logicalHeight(),
base.infiniburn(),
base.effectsLocation(),
AgeEnvironmentCompiler.skyEffects(age.plan(), base.effectsLocation()),
ambientLight,
base.monsterSettings()
);
@@ -0,0 +1,90 @@
package net.dnorberg.rivencraft.book;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.level.dimension.BuiltinDimensionTypes;
/** Resolves written environment pages without changing the seeded page-free Age path. */
public final class AgeEnvironmentCompiler {
private AgeEnvironmentCompiler() {}
public static AgeTraits apply(AgeGenerationPlan plan, AgeTraits seeded) {
if (plan == null) return seeded;
AgeTraits.Lighting lighting = seeded.lighting();
AgeTraits.Weather weather = seeded.weather();
double period = seeded.celestialPeriod();
float phase = seeded.celestialPhase();
boolean normalTime = plan.symbols().stream()
.anyMatch(symbol -> symbol.semantics().role() == SymbolSemantics.Role.CELESTIAL);
if (normalTime) period = 1.0D;
boolean writtenPeriod = false;
boolean writtenPhase = false;
float phaseDegrees = 0.0F;
for (AgeGenerationPlan.ResolvedSymbol symbol : plan.symbols()) {
SymbolSemantics semantics = symbol.semantics();
switch (semantics.role()) {
case LIGHTING -> lighting = AgeTraits.Lighting.valueOf(
((SymbolSemantics.ChoiceValue) semantics.value()).id().toUpperCase(java.util.Locale.ROOT));
case WEATHER -> {
String choice = ((SymbolSemantics.ChoiceValue) semantics.value()).id();
if (choice.equals("snow")) {
throw new IllegalArgumentException("Always Snow requires optional season integration");
}
if (choice.equals("cloudy") || choice.equals("rain")) {
throw new IllegalArgumentException(choice + " weather needs precipitation rendering support");
}
weather = AgeTraits.Weather.valueOf(choice.toUpperCase(java.util.Locale.ROOT));
}
case PERIOD_MODIFIER -> {
double next = ((SymbolSemantics.NumberValue) semantics.value()).amount();
period = writtenPeriod ? (period + next) / 2.0D : next;
writtenPeriod = true;
}
case PHASE_MODIFIER -> {
float next = (float) ((SymbolSemantics.NumberValue) semantics.value()).amount();
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");
default -> { }
}
}
if (writtenPhase) phase = phaseDegrees / 360.0F;
return new AgeTraits(plan.biomeSelection() == null ? seeded.biomeDistribution()
: plan.biomeSelection().distribution(), lighting, weather, period,
seeded.celestialAngle(), phase);
}
/** 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;
return plan.symbols().stream()
.filter(symbol -> symbol.semantics().role() == SymbolSemantics.Role.SKY)
.map(symbol -> ((SymbolSemantics.ChoiceValue) symbol.semantics().value()).id())
.map(choice -> switch (choice) {
case "overworld" -> BuiltinDimensionTypes.OVERWORLD_EFFECTS;
case "nether" -> BuiltinDimensionTypes.NETHER_EFFECTS;
case "end" -> BuiltinDimensionTypes.END_EFFECTS;
default -> throw new IllegalArgumentException("Unsupported sky effect " + choice);
}).findFirst().orElse(fallback);
}
public static boolean hasWrittenPhase(AgeGenerationPlan plan) {
return plan != null && plan.symbols().stream()
.anyMatch(symbol -> symbol.semantics().role() == SymbolSemantics.Role.PHASE_MODIFIER);
}
public static int previewSkyColor(ResourceLocation effects, int biomeSkyColor) {
if (effects.equals(BuiltinDimensionTypes.NETHER_EFFECTS)) return 0xFF6B2725;
if (effects.equals(BuiltinDimensionTypes.END_EFFECTS)) return 0xFF211835;
return biomeSkyColor;
}
private static float circularMidpoint(float current, float next) {
float difference = (next - current + 540.0F) % 360.0F - 180.0F;
return (current + difference / 2.0F + 360.0F) % 360.0F;
}
}
@@ -0,0 +1,181 @@
package net.dnorberg.rivencraft.book;
import com.mojang.serialization.Codec;
import com.mojang.serialization.codecs.RecordCodecBuilder;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import net.dnorberg.rivencraft.writing.BlockSymbolPages;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.minecraft.core.Holder;
import net.minecraft.core.RegistryAccess;
import net.minecraft.core.registries.BuiltInRegistries;
import net.minecraft.core.registries.Registries;
import net.minecraft.resources.ResourceKey;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.tags.BiomeTags;
import net.minecraft.world.level.biome.Biome;
import net.minecraft.world.level.block.Blocks;
/** Validates and freezes supported feature pages and their preceding material modifiers. */
public final class AgeFeatureSelection {
private AgeFeatureSelection() {}
public record Choice(ResourceLocation id, Optional<ResourceLocation> material) {
public static final Codec<Choice> CODEC = RecordCodecBuilder.create(instance -> instance.group(
ResourceLocation.CODEC.fieldOf("id").forGetter(Choice::id),
ResourceLocation.CODEC.optionalFieldOf("material").forGetter(Choice::material)
).apply(instance, Choice::new));
public Choice {
if (id == null || material == null) throw new IllegalArgumentException("Missing feature choice");
}
}
public static List<Choice> compile(WritingGrammar.Result writing, AgeRuntimeProfile profile,
AgeBiomeSelection biomes, RegistryAccess registries) {
List<Choice> choices = choices(writing.symbols().stream()
.map(symbol -> symbol.semantics()).toList());
for (Choice choice : choices) {
String error = error(choice.id(), profile, registries);
if (error == null) error = materialError(choice);
if (error != null) throw new IllegalArgumentException(error);
if (surfaceVegetation(choice.id()) && biomes.biomes().stream()
.allMatch(id -> !supportsSurfaceVegetation(id, registries))) {
throw new IllegalArgumentException("Feature " + choice.id()
+ " needs at least one surface Overworld biome in the selected pool");
}
}
return choices;
}
private static List<Choice> choices(List<SymbolSemantics> symbols) {
List<Choice> choices = new ArrayList<>();
ResourceLocation pendingMaterial = null;
for (SymbolSemantics semantics : symbols) {
if (semantics.role() == SymbolSemantics.Role.BLOCK) {
pendingMaterial = ((SymbolSemantics.ResourceValue) semantics.value()).id();
} else if (semantics.role() == SymbolSemantics.Role.FEATURE) {
choices.add(new Choice(((SymbolSemantics.ResourceValue) semantics.value()).id(),
Optional.ofNullable(pendingMaterial)));
pendingMaterial = null;
}
}
return List.copyOf(choices);
}
public static List<Choice> resolved(AgeGenerationPlan plan) {
if (plan == null) return List.of();
return choices(plan.symbols().stream().map(symbol -> symbol.semantics()).toList()).stream()
.map(choice -> choice.material().isPresent() || !isRock(choice.id()) && !isLake(choice.id())
? choice : new Choice(choice.id(), Optional.of(randomMaterial(plan.ageSeed(), choice.id()))))
.toList();
}
private static ResourceLocation randomMaterial(long ageSeed, ResourceLocation feature) {
var category = isRock(feature) ? BlockSymbolPages.CATEGORY : BlockSymbolPages.FLUID_CATEGORY;
List<ResourceLocation> pool = BlockSymbolPages.availableBlocks(category).stream()
.filter(id -> materialError(new Choice(feature, Optional.of(id))) == null).toList();
if (pool.isEmpty()) throw new IllegalStateException("No valid material blocks for " + feature);
long mixed = ageSeed ^ (long) feature.hashCode() * 0x9E3779B97F4A7C15L;
mixed = (mixed ^ mixed >>> 30) * 0xBF58476D1CE4E5B9L;
mixed = (mixed ^ mixed >>> 27) * 0x94D049BB133111EBL;
return pool.get(Math.floorMod(mixed ^ mixed >>> 31, pool.size()));
}
public static String error(ResourceLocation choice, AgeRuntimeProfile profile, RegistryAccess registries) {
if (caves(choice) || ravines(choice)) {
if (profile.terrain() != AgeRuntimeProfile.Terrain.NOISE) {
return "Feature " + choice + " requires noise terrain with stone to carve; not Flat or Void";
}
var carvers = registries.lookupOrThrow(Registries.CONFIGURED_CARVER);
List<String> ids = caves(choice) ? List.of("cave", "nether_cave") : List.of("canyon");
for (String path : ids) {
var key = ResourceKey.create(Registries.CONFIGURED_CARVER, ResourceLocation.withDefaultNamespace(path));
if (carvers.get(key).isEmpty()) return "Feature " + choice
+ " requires missing configured carver " + key.location();
}
return null;
}
ResourceLocation placed = placedFeature(choice);
if (placed == null) return "Unsupported feature " + choice
+ "; remove its page (custom structures remain future work)";
if (profile.terrain() != AgeRuntimeProfile.Terrain.NOISE || AgeBiomeSelection.isCave(profile)) {
return "Feature " + choice + " requires surface noise terrain; not Flat, Void, or Cave";
}
if (registries.lookupOrThrow(Registries.PLACED_FEATURE)
.get(ResourceKey.create(Registries.PLACED_FEATURE, placed)).isEmpty()) {
return "Feature " + choice + " requires missing placed feature " + placed;
}
return null;
}
public static String materialError(Choice choice) {
if (choice.material().isEmpty()) return null;
ResourceLocation material = choice.material().orElseThrow();
var block = BuiltInRegistries.BLOCK.getOptional(material);
if (block.isEmpty() || block.orElseThrow() == Blocks.AIR) {
return "Feature " + choice.id() + " references missing block material " + material;
}
if (isRock(choice.id())) {
if (!BlockSymbolPages.isRockMaterial(block.orElseThrow())) {
return "Feature " + choice.id() + " needs a full solid block without a block entity: " + material;
}
} else if (isLake(choice.id())) {
if (!BlockSymbolPages.isFluidMaterial(block.orElseThrow())) {
return "Feature " + choice.id() + " needs a source-fluid block: " + material;
}
} else {
return "Feature " + choice.id() + " cannot consume a block material page";
}
return null;
}
public static boolean isRock(ResourceLocation choice) {
return choice.equals(ResourceLocation.fromNamespaceAndPath("rivencraft", "rocks"));
}
public static boolean isLake(ResourceLocation choice) {
return choice.getNamespace().equals("rivencraft") && List.of(
"surface_lakes", "deep_lakes", "lava_lakes").contains(choice.getPath());
}
public static boolean surfaceVegetation(ResourceLocation choice) {
return choice.getNamespace().equals("rivencraft")
&& List.of("flowers", "trees", "huge_trees").contains(choice.getPath());
}
public static boolean caves(ResourceLocation choice) {
return choice.equals(ResourceLocation.fromNamespaceAndPath("rivencraft", "caves"));
}
public static boolean ravines(ResourceLocation choice) {
return choice.equals(ResourceLocation.fromNamespaceAndPath("rivencraft", "ravines"));
}
public static boolean supportsSurfaceVegetation(ResourceLocation id, RegistryAccess registries) {
var biome = registries.lookupOrThrow(Registries.BIOME)
.get(ResourceKey.create(Registries.BIOME, id));
return biome.isPresent() && supportsSurfaceVegetation(biome.orElseThrow());
}
public static boolean supportsSurfaceVegetation(Holder<Biome> biome) {
return !biome.is(BiomeTags.IS_NETHER) && !biome.is(BiomeTags.IS_END)
&& !biome.is(AgeBiomeSelection.CAVE_BIOMES);
}
/** Fixed 1.21.1 mappings; data-pack symbols must opt in through a future extension. */
public static ResourceLocation placedFeature(ResourceLocation choice) {
if (!choice.getNamespace().equals("rivencraft")) return null;
return switch (choice.getPath()) {
case "flowers" -> ResourceLocation.withDefaultNamespace("flower_default");
case "trees" -> ResourceLocation.withDefaultNamespace("trees_plains");
case "huge_trees" -> ResourceLocation.withDefaultNamespace("trees_old_growth_spruce_taiga");
case "rocks" -> ResourceLocation.withDefaultNamespace("forest_rock");
case "surface_lakes", "lava_lakes" -> ResourceLocation.withDefaultNamespace("lake_lava_surface");
case "deep_lakes" -> ResourceLocation.withDefaultNamespace("lake_lava_underground");
default -> null;
};
}
}
@@ -0,0 +1,178 @@
package net.dnorberg.rivencraft.book;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.dnorberg.rivencraft.writing.WritingEntry;
import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.nbt.ListTag;
import net.minecraft.nbt.StringTag;
import net.minecraft.core.RegistryAccess;
import net.minecraft.resources.ResourceLocation;
/** A frozen interpretation of authored pages. Later slices consume its resolved branches. */
public record AgeGenerationPlan(int version, long ageSeed, OrderedWriting writing, List<ResolvedSymbol> symbols,
AgeRuntimeProfile runtimeProfile, AgeBiomeSelection biomeSelection) {
public static final int CURRENT_VERSION = 2;
public AgeGenerationPlan {
if (version < 1 || version > CURRENT_VERSION) {
throw new IllegalArgumentException("Unsupported Age plan version " + version);
}
Objects.requireNonNull(writing, "writing");
symbols = List.copyOf(symbols);
Objects.requireNonNull(runtimeProfile, "runtimeProfile");
if (runtimeProfile.schemaVersion() != AgeRuntimeProfile.CURRENT_SCHEMA_VERSION) {
throw new IllegalArgumentException("Unsupported runtime profile snapshot version");
}
if (version == CURRENT_VERSION && biomeSelection == null) {
throw new IllegalArgumentException("Version 2 Age plan requires a biome selection snapshot");
}
for (ResolvedSymbol symbol : symbols) {
if (symbol.index() < 0 || symbol.index() >= writing.entries().size()
|| !symbol.reference().equals(writing.entries().get(symbol.index()).symbol().orElse(null))) {
throw new IllegalArgumentException("Resolved symbol does not match original page order");
}
}
}
/** Existing version 1 plans retain their original biome behavior on reload. */
public AgeGenerationPlan(int version, long ageSeed, OrderedWriting writing, List<ResolvedSymbol> symbols,
AgeRuntimeProfile runtimeProfile) {
this(version, ageSeed, writing, symbols, runtimeProfile, null);
}
/** No plan is made for old page-free books or Link-Panel-only random Ages. */
public static AgeGenerationPlan compile(OrderedWriting writing, long ageSeed, ResourceLocation seedProfile,
AgeTraits traits, RegistryAccess registries) {
WritingGrammar.Result parsed = WritingGrammar.parse(writing);
if (!parsed.canCreate()) throw new IllegalArgumentException(parsed.firstError().orElseThrow().message());
if (parsed.randomFallback()) return null;
ResourceLocation terrain = parsed.symbols().stream()
.filter(symbol -> symbol.semantics().role() == SymbolSemantics.Role.TERRAIN)
.map(symbol -> ((SymbolSemantics.ResourceValue) symbol.semantics().value()).id())
.findFirst().orElse(null);
// The seed-selected terrain remains the deterministic completion for a missing branch.
// An explicit terrain must resolve now, before Binder inputs can be consumed.
if (terrain != null && !AgeRuntimeProfiles.profiles().containsKey(terrain)) {
throw new IllegalArgumentException("Unsupported Age terrain profile " + terrain);
}
ResourceLocation selected = terrain == null ? seedProfile : terrain;
AgeRuntimeProfile profile = AgeRuntimeProfiles.profiles().get(selected);
if (profile == null) throw new IllegalArgumentException("Unsupported Age terrain profile " + selected);
AgeBiomeSelection biomes = AgeBiomeSelection.compile(parsed, traits, profile, ageSeed, registries);
AgeFeatureSelection.compile(parsed, profile, biomes, registries);
AgeGenerationPlan plan = new AgeGenerationPlan(CURRENT_VERSION, ageSeed, writing,
parsed.symbols().stream().map(symbol -> new ResolvedSymbol(
symbol.index(), symbol.reference(), symbol.semantics())).toList(),
profile, biomes);
AgeEnvironmentCompiler.apply(plan, traits);
return plan;
}
public ResourceLocation authoredTerrain() {
return symbols.stream().filter(symbol -> symbol.semantics().role() == SymbolSemantics.Role.TERRAIN)
.map(symbol -> ((SymbolSemantics.ResourceValue) symbol.semantics().value()).id())
.findFirst().orElse(null);
}
public CompoundTag save() {
CompoundTag tag = new CompoundTag();
tag.putInt("Version", version);
tag.putLong("AgeSeed", ageSeed);
ListTag pages = new ListTag();
for (WritingEntry entry : writing.entries()) {
CompoundTag page = new CompoundTag();
page.putString("Kind", entry.kind().name());
entry.symbol().ifPresent(symbol -> page.putString("Symbol", symbol.id().toString()));
pages.add(page);
}
tag.put("Writing", pages);
ListTag resolved = new ListTag();
for (ResolvedSymbol symbol : symbols) {
CompoundTag item = new CompoundTag();
item.putInt("Index", symbol.index());
item.putString("Symbol", symbol.reference().id().toString());
item.putString("Role", symbol.semantics().role().name());
SymbolSemantics.Value value = symbol.semantics().value();
item.putString("Value", value instanceof SymbolSemantics.ResourceValue resource
? resource.id().toString() : value instanceof SymbolSemantics.ChoiceValue choice
? choice.id() : Double.toString(((SymbolSemantics.NumberValue) value).amount()));
resolved.add(item);
}
tag.put("Resolved", resolved);
CompoundTag profile = new CompoundTag();
profile.putInt("Version", runtimeProfile.schemaVersion());
profile.putString("Terrain", runtimeProfile.terrain().name());
profile.putString("Noise", runtimeProfile.noiseSettings().toString());
profile.putString("Biomes", runtimeProfile.biomePreset().toString());
profile.putString("Dimension", runtimeProfile.dimensionType().toString());
tag.put("RuntimeProfile", profile);
if (biomeSelection != null) {
CompoundTag biomeTag = new CompoundTag();
biomeTag.putString("Distribution", biomeSelection.distribution().name());
ListTag biomeIds = new ListTag();
biomeSelection.biomes().forEach(id -> biomeIds.add(StringTag.valueOf(id.toString())));
biomeTag.put("Ids", biomeIds);
tag.put("BiomeSelection", biomeTag);
}
return tag;
}
public static AgeGenerationPlan load(CompoundTag tag) {
int version = tag.getInt("Version");
List<WritingEntry> pages = new ArrayList<>();
ListTag writingTags = tag.getList("Writing", CompoundTag.TAG_COMPOUND);
for (int index = 0; index < writingTags.size(); index++) {
CompoundTag page = writingTags.getCompound(index);
pages.add(WritingEntry.Kind.valueOf(page.getString("Kind")) == WritingEntry.Kind.LINK_PANEL
? WritingEntry.linkPanel() : WritingEntry.symbol(new SymbolReference(
ResourceLocation.parse(page.getString("Symbol")))));
}
List<ResolvedSymbol> resolved = new ArrayList<>();
ListTag resolvedTags = tag.getList("Resolved", CompoundTag.TAG_COMPOUND);
for (int index = 0; index < resolvedTags.size(); index++) {
CompoundTag item = resolvedTags.getCompound(index);
SymbolSemantics.Role role = SymbolSemantics.Role.valueOf(item.getString("Role"));
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 ->
new SymbolSemantics.NumberValue(Double.parseDouble(raw));
default -> new SymbolSemantics.ChoiceValue(raw);
};
resolved.add(new ResolvedSymbol(item.getInt("Index"),
new SymbolReference(ResourceLocation.parse(item.getString("Symbol"))),
new SymbolSemantics(role, value)));
}
CompoundTag profile = tag.getCompound("RuntimeProfile");
AgeBiomeSelection selection = null;
if (version >= 2) {
CompoundTag biomeTag = tag.getCompound("BiomeSelection");
ListTag biomeIds = biomeTag.getList("Ids", CompoundTag.TAG_STRING);
List<ResourceLocation> ids = new ArrayList<>();
for (int index = 0; index < biomeIds.size(); index++) {
ids.add(ResourceLocation.parse(biomeIds.getString(index)));
}
selection = new AgeBiomeSelection(AgeTraits.BiomeDistribution.valueOf(
biomeTag.getString("Distribution")), ids);
}
return new AgeGenerationPlan(version, tag.getLong("AgeSeed"), new OrderedWriting(pages), resolved,
new AgeRuntimeProfile(profile.getInt("Version"),
AgeRuntimeProfile.Terrain.valueOf(profile.getString("Terrain")),
ResourceLocation.parse(profile.getString("Noise")),
ResourceLocation.parse(profile.getString("Biomes")),
ResourceLocation.parse(profile.getString("Dimension"))), selection);
}
public record ResolvedSymbol(int index, SymbolReference reference, SymbolSemantics semantics) {
public ResolvedSymbol {
Objects.requireNonNull(reference, "reference");
Objects.requireNonNull(semantics, "semantics");
}
}
}
@@ -1,7 +1,11 @@
package net.dnorberg.rivencraft.book;
import java.util.UUID;
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.minecraft.core.BlockPos;
import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper;
@@ -18,6 +22,54 @@ public final class AgePersistenceGameTests {
private AgePersistenceGameTests() {
}
@GameTest(template = "empty")
public static void authoredPlanRetainsResolvedMeaningAndAgeIdentity(GameTestHelper helper) {
OrderedWriting writing = new OrderedWriting(List.of(
WritingEntry.linkPanel(),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:terrain/standard"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:weather/normal"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:lighting/normal"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:celestial/normal_time"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:feature/flowers")))
));
UUID id = UUID.randomUUID();
AgeReference reference = new AgeReference(id, "Authored Plan " + id);
AgeDefinition created = AgeRegistrySavedData.resolveOrCreate(helper.getLevel(), reference, writing);
helper.assertTrue(created.plan() != null, "Authored writing must create a frozen plan");
helper.assertValueEqual(created.plan().version(), AgeGenerationPlan.CURRENT_VERSION,
"The plan format must be explicitly versioned");
helper.assertValueEqual(created.plan().ageSeed(), created.seed(),
"The Age seed must be captured in the immutable plan");
helper.assertValueEqual(created.plan().writing(), writing, "The original page order must be retained");
helper.assertValueEqual(created.plan().symbols().size(), 5, "Every symbol must be resolved in order");
helper.assertValueEqual(created.generationProfile(), AgeGenerationProfiles.STANDARD,
"Authored terrain must replace the seed-selected random terrain");
helper.assertValueEqual(created.plan().runtimeProfile(), AgeRuntimeProfiles.resolve(AgeGenerationProfiles.STANDARD),
"The plan must snapshot the runtime profile instead of looking it up after reload");
AgeDefinition sameId = AgeRegistrySavedData.resolveOrCreate(helper.getLevel(),
new AgeReference(id, "Renamed"), OrderedWriting.EMPTY);
helper.assertValueEqual(sameId, created, "The same Age UUID must never reroll from a later book");
AgeRegistrySavedData registry = AgeRegistrySavedData.get(helper.getLevel());
AgeDefinition restored = AgeRegistrySavedData.load(
registry.save(new CompoundTag(), helper.getLevel().registryAccess()),
helper.getLevel().registryAccess()).find(id).orElseThrow();
helper.assertValueEqual(restored, created, "The complete plan must survive a saved-data round trip");
helper.succeed();
}
@GameTest(template = "empty")
public static void randomFallbackDoesNotCreateAuthoredPlan(GameTestHelper helper) {
AgeDefinition pageFree = AgeRegistrySavedData.resolveOrCreate(helper.getLevel(),
new AgeReference(UUID.randomUUID(), "Page Free"), OrderedWriting.EMPTY);
AgeDefinition panelOnly = AgeRegistrySavedData.resolveOrCreate(helper.getLevel(),
new AgeReference(UUID.randomUUID(), "Panel Only"),
new OrderedWriting(List.of(WritingEntry.linkPanel())));
helper.assertTrue(pageFree.plan() == null && panelOnly.plan() == null,
"Old and Link-Panel-only books must retain the random Age path");
helper.succeed();
}
@GameTest(template = "empty")
public static void everyTraitCombinationRoundTripsWithoutRerolling(GameTestHelper helper) {
ListTag entries = new ListTag();
@@ -89,6 +141,8 @@ public final class AgePersistenceGameTests {
"Definitions predating named dimensions must retain the UUID-derived dimension");
helper.assertValueEqual(definition.traits(), AgeTraits.LEGACY_DEFAULTS,
"Definitions predating traits must receive stable legacy defaults");
helper.assertTrue(definition.plan() == null,
"Existing Ages must not be reinterpreted as authored plans during migration");
CompoundTag serialized = migrated.save(new CompoundTag(), helper.getLevel().registryAccess());
AgeDefinition reloaded = AgeRegistrySavedData.load(serialized, helper.getLevel().registryAccess())
@@ -5,8 +5,10 @@ import java.util.Map;
import java.util.Optional;
import java.util.UUID;
import java.util.List;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.minecraft.core.BlockPos;
import net.minecraft.core.HolderLookup;
import net.minecraft.core.RegistryAccess;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.nbt.ListTag;
import net.minecraft.resources.ResourceLocation;
@@ -29,6 +31,7 @@ public final class AgeRegistrySavedData extends SavedData {
private static final String SPAWN_Y_TAG = "SpawnY";
private static final String SPAWN_Z_TAG = "SpawnZ";
private static final String TRAITS_TAG = "Traits";
private static final String PLAN_TAG = "GenerationPlan";
private static final String BIOME_DISTRIBUTION_TAG = "BiomeDistribution";
private static final String LIGHTING_TAG = "Lighting";
private static final String WEATHER_TAG = "Weather";
@@ -49,8 +52,34 @@ public final class AgeRegistrySavedData extends SavedData {
/** Resolves a book identity, creating its deterministic random definition exactly once. */
public static AgeDefinition resolveOrCreate(ServerLevel level, AgeReference reference) {
return resolveOrCreate(level, reference, OrderedWriting.EMPTY);
}
public static AgeDefinition resolveOrCreate(ServerLevel level, AgeReference reference, OrderedWriting writing) {
ServerLevel overworld = level.getServer().overworld();
return get(overworld).getOrCreate(reference, overworld.getSeed(), overworld.getGameTime());
return get(overworld).getOrCreate(reference, writing, overworld.getSeed(), overworld.getGameTime(),
overworld.registryAccess());
}
/** Validate with the same name-derived seed and terrain completion used when the Age is created. */
public static void validateNewWriting(ServerLevel level, String name, OrderedWriting writing) {
ServerLevel overworld = level.getServer().overworld();
AgeRegistrySavedData data = get(overworld);
long seed = ageSeed(overworld.getSeed(), data.availableDimensionId(normalizedName(name)));
AgeGenerationPlan.compile(writing, seed,
AgeRuntimeProfiles.selectForWriting(seed, writing, overworld.registryAccess()), AgeTraits.select(seed),
overworld.registryAccess());
}
public static ResourceLocation previewGenerationProfile(ServerLevel level, String name) {
return previewGenerationProfile(level, name, OrderedWriting.EMPTY);
}
public static ResourceLocation previewGenerationProfile(ServerLevel level, String name, OrderedWriting writing) {
ServerLevel overworld = level.getServer().overworld();
AgeRegistrySavedData data = get(overworld);
long seed = ageSeed(overworld.getSeed(), data.availableDimensionId(normalizedName(name)));
return AgeRuntimeProfiles.selectForWriting(seed, writing, overworld.registryAccess());
}
public Optional<AgeDefinition> find(UUID ageId) {
@@ -78,7 +107,8 @@ public final class AgeRegistrySavedData extends SavedData {
return updated;
}
private AgeDefinition getOrCreate(AgeReference reference, long worldSeed, long createdGameTime) {
private AgeDefinition getOrCreate(AgeReference reference, OrderedWriting writing,
long worldSeed, long createdGameTime, RegistryAccess registries) {
AgeDefinition existing = ages.get(reference.id());
if (existing != null) {
return existing;
@@ -87,16 +117,20 @@ public final class AgeRegistrySavedData extends SavedData {
String name = normalizedName(reference.name());
ResourceLocation dimensionId = availableDimensionId(name);
long seed = ageSeed(worldSeed, dimensionId);
ResourceLocation seedProfile = AgeRuntimeProfiles.selectForWriting(seed, writing, registries);
AgeTraits traits = AgeTraits.select(seed);
AgeGenerationPlan plan = AgeGenerationPlan.compile(writing, seed, seedProfile, traits, registries);
AgeDefinition created = new AgeDefinition(
reference.id(),
name,
seed,
AgeRuntimeProfiles.select(seed),
plan == null || plan.authoredTerrain() == null ? seedProfile : plan.authoredTerrain(),
AgeDefinition.CURRENT_GENERATION_VERSION,
createdGameTime,
dimensionId,
null,
AgeTraits.select(seed)
AgeEnvironmentCompiler.apply(plan, traits),
plan
);
ages.put(created.id(), created);
setDirty();
@@ -138,7 +172,9 @@ public final class AgeRegistrySavedData extends SavedData {
entry.getLong(CREATED_TIME_TAG),
dimensionId,
spawn,
readTraits(entry)
readTraits(entry),
entry.contains(PLAN_TAG, CompoundTag.TAG_COMPOUND)
? AgeGenerationPlan.load(entry.getCompound(PLAN_TAG)) : null
));
}
return data;
@@ -171,6 +207,7 @@ public final class AgeRegistrySavedData extends SavedData {
traits.putFloat(CELESTIAL_ANGLE_TAG, age.traits().celestialAngle());
traits.putFloat(CELESTIAL_PHASE_TAG, age.traits().celestialPhase());
entry.put(TRAITS_TAG, traits);
if (age.plan() != null) entry.put(PLAN_TAG, age.plan().save());
serializedAges.add(entry);
});
tag.put(AGES_TAG, serializedAges);
@@ -5,8 +5,12 @@ import com.google.gson.GsonBuilder;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import java.util.Map;
import java.util.List;
import java.util.concurrent.ConcurrentHashMap;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.minecraft.core.RegistryAccess;
import net.minecraft.core.registries.Registries;
import net.minecraft.resources.ResourceKey;
@@ -59,6 +63,27 @@ public final class AgeRuntimeProfiles {
return ids.get(Math.floorMod(Long.hashCode(seed), ids.size()));
}
/** 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.symbols().stream().anyMatch(symbol ->
symbol.semantics().role() == SymbolSemantics.Role.TERRAIN)) return selected;
List<ResourceLocation> features = parsed.symbols().stream()
.filter(symbol -> symbol.semantics().role() == SymbolSemantics.Role.FEATURE)
.map(symbol -> ((SymbolSemantics.ResourceValue) symbol.semantics().value()).id()).toList();
if (features.isEmpty() || PROFILES.isEmpty()) return selected;
AgeRuntimeProfile initial = PROFILES.get(selected);
if (initial != null && features.stream().allMatch(id ->
AgeFeatureSelection.error(id, initial, registries) == null)) return selected;
List<ResourceLocation> compatible = PROFILES.entrySet().stream()
.filter(entry -> features.stream().allMatch(id ->
AgeFeatureSelection.error(id, entry.getValue(), registries) == null))
.map(Map.Entry::getKey).sorted().toList();
return compatible.isEmpty() ? selected
: compatible.get(Math.floorMod(Long.hashCode(seed), compatible.size()));
}
static AgeRuntimeProfile parse(ResourceLocation id, JsonElement json, RegistryAccess registries) {
JsonObject object = json.getAsJsonObject();
int schemaVersion = object.has("schema_version") ? object.get("schema_version").getAsInt() : 1;
@@ -70,14 +95,19 @@ public final class AgeRuntimeProfiles {
ResourceLocation noise = location(object, "noise_settings", "minecraft:overworld");
ResourceLocation biome = location(object, "biome_preset", "minecraft:overworld");
ResourceLocation dimension = location(object, "dimension_type", "minecraft:overworld");
AgeRuntimeProfile profile = new AgeRuntimeProfile(schemaVersion, terrain, noise, biome, dimension);
validateReferences(registries, id, profile);
return profile;
}
if (terrain == AgeRuntimeProfile.Terrain.NOISE) {
requireRegistryEntry(registries, Registries.NOISE_SETTINGS, noise, id, "noise_settings");
/** Recheck frozen plans before loading: a removed registry entry must not crash or silently alter an Age. */
public static void validateReferences(RegistryAccess registries, ResourceLocation id, AgeRuntimeProfile profile) {
if (profile.terrain() == AgeRuntimeProfile.Terrain.NOISE) {
requireRegistryEntry(registries, Registries.NOISE_SETTINGS, profile.noiseSettings(), id, "noise_settings");
requireRegistryEntry(registries, Registries.MULTI_NOISE_BIOME_SOURCE_PARAMETER_LIST,
biome, id, "biome_preset");
profile.biomePreset(), id, "biome_preset");
}
requireRegistryEntry(registries, Registries.DIMENSION_TYPE, dimension, id, "dimension_type");
return new AgeRuntimeProfile(schemaVersion, terrain, noise, biome, dimension);
requireRegistryEntry(registries, Registries.DIMENSION_TYPE, profile.dimensionType(), id, "dimension_type");
}
private static String requiredString(JsonObject object, String name) {
@@ -63,6 +63,10 @@ public record AgeTraits(
return celestialPeriod == STOPPED_CELESTIAL_PERIOD;
}
public AgeTraits withBiomeDistribution(BiomeDistribution distribution) {
return new AgeTraits(distribution, lighting, weather, celestialPeriod, celestialAngle, celestialPhase);
}
public static <E extends Enum<E>> E parseOrDefault(String value, E fallback) {
try {
@SuppressWarnings("unchecked")
@@ -0,0 +1,137 @@
package net.dnorberg.rivencraft.book;
import java.util.List;
import java.util.Set;
import java.util.UUID;
import java.util.stream.Collectors;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.SymbolCatalog;
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.resources.ResourceLocation;
import net.minecraft.world.level.dimension.BuiltinDimensionTypes;
import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
/** Issue #34: written environment effects and the shared creative/JEI page feed. */
@GameTestHolder("rivencraft_archive_environment")
@PrefixGameTestTemplate(false)
public final class EnvironmentWritingGameTests {
private EnvironmentWritingGameTests() {}
@GameTest(template = "empty")
public static void caveBiomesHaveSeparateCreativePages(GameTestHelper helper) {
var registries = helper.getLevel().registryAccess();
var biomePages = PageItem.creativeSymbolPages(registries,
ResourceLocation.fromNamespaceAndPath("rivencraft", "biome"));
var cavePages = PageItem.creativeSymbolPages(registries,
ResourceLocation.fromNamespaceAndPath("rivencraft", "cave_biome"));
helper.assertTrue(PageItem.bundledCreativeCategories().contains(
ResourceLocation.fromNamespaceAndPath("rivencraft", "cave_biome")),
"The cave biome creative tab must be registered");
helper.assertTrue(biomePages.stream().anyMatch(page -> PageItem.content(page).symbol().orElseThrow()
.id().getPath().equals("biome/desert")), "Biome pages must remain in the Biome tab");
helper.assertTrue(cavePages.stream().anyMatch(page -> PageItem.content(page).symbol().orElseThrow()
.id().getPath().equals("biome/lush_caves")), "Cave biomes need their own tab");
helper.assertTrue(cavePages.stream().anyMatch(page -> PageItem.content(page).symbol().orElseThrow()
.id().getPath().equals("biome/crimson_forest")), "Nether biomes belong in the Cave tab");
helper.assertFalse(biomePages.stream().anyMatch(page -> PageItem.content(page).symbol().orElseThrow()
.id().getPath().equals("biome/lush_caves")), "Cave biomes must leave the general Biome tab");
helper.succeed();
}
@GameTest(template = "empty")
public static void environmentPagesEnterCreativeAndJeiFeed(GameTestHelper helper) {
Set<String> expected = Set.of(
"lighting/normal", "lighting/dark", "lighting/bright",
"sky/overworld", "sky/nether", "sky/end",
"weather/normal", "weather/fast", "weather/slow", "weather/off",
"weather/always", "weather/storm", "celestial/normal_time",
"period/zero", "period/half", "period/full", "period/double",
"phase/nadir", "phase/rising", "phase/zenith", "phase/setting");
Set<String> creative = PageItem.creativeSymbolPages(helper.getLevel().registryAccess()).stream()
.map(PageItem::content)
.filter(content -> content.symbol().isPresent())
.map(content -> content.symbol().orElseThrow().id().getPath())
.collect(Collectors.toSet());
helper.assertTrue(PageItem.bundledCreativeSymbols().containsAll(expected)
&& creative.containsAll(expected),
"Every supported environment page must enter the creative index JEI also consumes");
for (String path : expected) {
var id = ResourceLocation.fromNamespaceAndPath("rivencraft", path);
helper.assertTrue(SymbolCatalog.isKnown(new SymbolReference(id))
&& PageItem.isUsableWriting(PageItem.createBundledCreativePage(path)),
"Environment page must resolve as valid writing: " + path);
}
helper.assertFalse(creative.contains("weather/snow") || creative.contains("weather/cloudy")
|| creative.contains("weather/rain"),
"Unsupported precipitation variants must not appear as working pages");
helper.succeed();
}
@GameTest(template = "empty")
public static void writtenEnvironmentPersistsAndPageFreeAgesStaySeeded(GameTestHelper helper) {
OrderedWriting writing = new OrderedWriting(List.of(
WritingEntry.linkPanel(),
page("terrain/standard"), page("weather/off"), page("lighting/dark"),
page("sky/end"), page("period/zero"), page("phase/rising"),
page("celestial/normal_time")));
AgeTraits seeded = AgeTraits.select(42L);
var plan = AgeGenerationPlan.compile(writing, 42L, AgeGenerationProfiles.STANDARD,
seeded, helper.getLevel().registryAccess());
var effective = AgeEnvironmentCompiler.apply(plan, seeded);
helper.assertValueEqual(effective.lighting(), AgeTraits.Lighting.DARK,
"Written Dark Lighting must override the seeded lighting");
helper.assertValueEqual(effective.weather(), AgeTraits.Weather.OFF,
"Written No Weather must override the seeded weather");
helper.assertTrue(effective.hasStoppedCelestialCycle(),
"A written Zero Length page must stop the celestial cycle");
helper.assertValueEqual(effective.celestialPhase(), 0.25F,
"Written Rising phase must be stored as a quarter turn");
helper.assertValueEqual(AgeEnvironmentCompiler.skyEffects(plan, BuiltinDimensionTypes.OVERWORLD_EFFECTS),
BuiltinDimensionTypes.END_EFFECTS, "Written End Sky must select the End sky effects");
helper.assertValueEqual(AgeEnvironmentCompiler.previewSkyColor(BuiltinDimensionTypes.END_EFFECTS, 0xFF77AAFF),
0xFF211835, "End sky preview must not retain an Overworld biome's blue tint");
helper.assertValueEqual(AgeEnvironmentCompiler.previewSkyColor(BuiltinDimensionTypes.NETHER_EFFECTS, 0xFF77AAFF),
0xFF6B2725, "Nether sky preview must use its red tint");
helper.assertValueEqual(AgeEnvironmentCompiler.previewSkyColor(BuiltinDimensionTypes.OVERWORLD_EFFECTS, 0xFF77AAFF),
0xFF77AAFF, "Overworld sky preview must retain the destination biome tint");
helper.assertValueEqual(AgeEnvironmentCompiler.apply(AgeGenerationPlan.load(plan.save()), seeded), effective,
"Written environment values must survive a plan save/load round trip");
helper.assertValueEqual(AgeEnvironmentCompiler.apply(null, seeded), seeded,
"Page-free Ages must retain their seeded environment without recompilation");
var player = helper.makeMockServerPlayerInLevel();
var reference = new AgeReference(UUID.randomUUID(), "Written Environment");
var target = AgeDimensionService.resolve(player, reference, writing).orElseThrow();
var definition = AgeRegistrySavedData.get(helper.getLevel()).find(reference.id()).orElseThrow();
helper.assertValueEqual(definition.traits(), AgeEnvironmentCompiler.apply(
definition.plan(), AgeTraits.select(definition.seed())),
"The effective authored environment must persist with the Age definition");
helper.runAfterDelay(1, () -> {
var level = helper.getLevel().getServer().getLevel(target.location().dimension());
helper.assertTrue(level != null, "Written environment Age must load");
helper.assertFalse(level.dimensionType().hasSkyLight(), "Dark Lighting must remove skylight");
helper.assertValueEqual(level.dimensionType().effectsLocation(), BuiltinDimensionTypes.END_EFFECTS,
"The runtime Age must render the written End sky");
helper.assertValueEqual(level.getDayTimePerTick(), Float.MIN_VALUE,
"Zero Length must use the non-bouncing stopped clock");
helper.assertTrue(Math.floorMod(level.getDayTime(), 24_000L) < 5L,
"Legacy Rising phase must begin at vanilla sunrise");
level.setWeatherParameters(0, 6_000, true, true);
helper.runAfterDelay(2, () -> {
helper.assertFalse(level.isRaining() || level.isThundering(),
"Written No Weather must clear rain and thunder in this Age");
helper.succeed();
});
});
}
private static WritingEntry page(String path) {
return WritingEntry.symbol(new SymbolReference(ResourceLocation.fromNamespaceAndPath("rivencraft", path)));
}
}
@@ -0,0 +1,216 @@
package net.dnorberg.rivencraft.book;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.world.AgeFeatureChunkGenerator;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.BlockSymbolPages;
import net.dnorberg.rivencraft.writing.SymbolCatalog;
import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.writing.WritingEntry;
import net.minecraft.core.registries.Registries;
import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper;
import net.minecraft.resources.ResourceKey;
import net.minecraft.resources.ResourceLocation;
import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
/** Issue #35: authored decorations must resolve to real placed features and survive plan reload. */
@GameTestHolder(Rivencraft.MOD_ID)
@PrefixGameTestTemplate(false)
public final class FeatureWritingGameTests {
private FeatureWritingGameTests() {}
@GameTest(template = "empty")
public static void featurePagesCompileToFrozenVanillaPlacements(GameTestHelper helper) {
var registries = helper.getLevel().registryAccess();
Set<String> pages = Set.of("feature/caves", "feature/flowers", "feature/trees",
"feature/huge_trees", "feature/rocks", "feature/lava_lakes",
"feature/surface_lakes", "feature/deep_lakes", "feature/ravines");
helper.assertTrue(PageItem.bundledCreativeSymbols().containsAll(pages),
"Supported feature pages must appear in the creative and JEI symbol feed");
for (String path : pages) {
helper.assertTrue(PageItem.isUsableWriting(PageItem.createBundledCreativePage(path)),
path + " must be usable in authored writing");
}
OrderedWriting writing = new OrderedWriting(List.of(panel(), page("terrain/standard"),
page("biome/plains"), page("biome/single"), page("feature/caves"), page("feature/flowers"),
page("feature/trees"), page("feature/rocks"), page("feature/lava_lakes")));
AgeGenerationPlan plan = AgeGenerationPlan.compile(writing, 87L, AgeGenerationProfiles.STANDARD,
AgeTraits.select(87L), registries);
List<AgeFeatureSelection.Choice> resolved = AgeFeatureSelection.resolved(plan);
helper.assertValueEqual(resolved.stream().map(AgeFeatureSelection.Choice::id).toList(), List.of(
id("caves"), id("flowers"), id("trees"), id("rocks"), id("lava_lakes")),
"The compiled Age plan must keep feature order and exact semantic IDs");
for (AgeFeatureSelection.Choice choice : resolved) {
if (AgeFeatureSelection.isRock(choice.id()) || AgeFeatureSelection.isLake(choice.id())) {
helper.assertTrue(choice.material().isPresent()
&& AgeFeatureSelection.materialError(choice) == null,
"Unmodified rocks and lakes must choose a valid material from the registry");
}
}
helper.assertValueEqual(AgeFeatureSelection.resolved(AgeGenerationPlan.load(plan.save())),
AgeFeatureSelection.resolved(plan), "Features must survive the saved-plan round trip");
for (AgeFeatureSelection.Choice choice : AgeFeatureSelection.resolved(plan)) {
if (AgeFeatureSelection.caves(choice.id()) || AgeFeatureSelection.ravines(choice.id())) continue;
var placement = AgeFeatureSelection.placedFeature(choice.id());
helper.assertTrue(registries.lookupOrThrow(Registries.PLACED_FEATURE)
.get(ResourceKey.create(Registries.PLACED_FEATURE, placement)).isPresent(),
choice.id() + " must map to an existing vanilla placed feature");
}
helper.succeed();
}
@GameTest(template = "empty")
public static void unsupportedFeaturesAndTerrainsFailBeforeBinding(GameTestHelper helper) {
var registries = helper.getLevel().registryAccess();
helper.assertTrue(AgeFeatureSelection.error(id("unknown"),
AgeRuntimeProfiles.resolve(AgeGenerationProfiles.STANDARD), registries)
.contains("Unsupported feature"),
"Unimplemented feature meanings must report a diagnostic");
rejects(helper, new OrderedWriting(List.of(panel(), page("terrain/flat"), page("feature/flowers"))),
"requires surface noise terrain");
rejects(helper, new OrderedWriting(List.of(panel(), page("terrain/flat"), page("feature/caves"))),
"requires noise terrain");
rejects(helper, new OrderedWriting(List.of(panel(), page("terrain/cave"), page("feature/lava_lakes"))),
"requires surface noise terrain");
helper.assertTrue(AgeGenerationPlan.compile(new OrderedWriting(List.of(panel(),
page("terrain/cave"), page("feature/caves"))), 87L, AgeGenerationProfiles.STANDARD,
AgeTraits.select(87L), registries) != null,
"Caves must add carving to Cave terrain as well as surface noise terrain");
rejects(helper, new OrderedWriting(List.of(panel(), page("terrain/standard"),
page("biome/nether_wastes"), page("biome/single"), page("feature/trees"))),
"surface Overworld biome");
helper.assertTrue(AgeFeatureSelection.compile(net.dnorberg.rivencraft.writing.WritingGrammar.parse(
new OrderedWriting(List.of(panel(), page("terrain/standard"), page("feature/flowers")))),
AgeRuntimeProfiles.resolve(AgeGenerationProfiles.STANDARD),
AgeBiomeSelection.compile(net.dnorberg.rivencraft.writing.WritingGrammar.parse(
new OrderedWriting(List.of(panel(), page("terrain/standard"), page("feature/flowers")))),
AgeTraits.select(87L), AgeRuntimeProfiles.resolve(AgeGenerationProfiles.STANDARD),
87L, registries), registries).contains(choice("flowers")),
"A valid surface feature must still compile");
helper.succeed();
}
@GameTest(template = "empty")
public static void blockPagesModifyFeaturesAndSurviveReload(GameTestHelper helper) {
var stone = ResourceLocation.withDefaultNamespace("stone");
var water = ResourceLocation.withDefaultNamespace("water");
helper.assertTrue(BlockSymbolPages.availableBlocks().contains(stone),
"Registry-derived material pages must include vanilla stone");
helper.assertTrue(BlockSymbolPages.availableBlocks(BlockSymbolPages.CATEGORY).contains(stone),
"Stone must appear among standard Block Pages");
helper.assertTrue(!BlockSymbolPages.availableBlocks(BlockSymbolPages.CATEGORY).contains(water),
"Water must not appear among standard Block Pages");
helper.assertTrue(BlockSymbolPages.availableBlocks(BlockSymbolPages.FLUID_CATEGORY).contains(water),
"Water must appear among Fluid Pages");
for (String path : List.of("fern", "seagrass", "tube_coral")) {
helper.assertTrue(!BlockSymbolPages.availableBlocks().contains(ResourceLocation.withDefaultNamespace(path)),
path + " must not receive a rock or fluid material page");
}
var glowstone = ResourceLocation.withDefaultNamespace("glowstone");
helper.assertTrue(BlockSymbolPages.availableBlocks(BlockSymbolPages.CATEGORY).contains(glowstone),
"Glowstone should be a valid full-collision rock material");
helper.assertTrue(AgeFeatureSelection.materialError(new AgeFeatureSelection.Choice(
id("rocks"), Optional.of(glowstone))) == null,
"Glowstone must bind successfully before Rocks");
helper.assertTrue(!BlockSymbolPages.availableBlocks().contains(ResourceLocation.withDefaultNamespace("chest")),
"Blocks with block entities must not receive generated pages");
helper.assertTrue(!SymbolCatalog.isKnown(new SymbolReference(BlockSymbolPages.symbolId(
ResourceLocation.withDefaultNamespace("chest")))),
"Block-entity pages must not remain valid in the server catalog");
helper.assertTrue(SymbolCatalog.isKnown(new SymbolReference(BlockSymbolPages.symbolId(stone))),
"Generated material pages must be recognized by the server catalog");
helper.assertTrue(PageItem.isUsableWriting(PageItem.createCreativeBlockPage(stone)),
"A generated material page must be a usable authored page");
OrderedWriting writing = new OrderedWriting(List.of(panel(), page("terrain/standard"),
page("biome/plains"), page("biome/single"), block("stone"), page("feature/rocks"),
block("water"), page("feature/lava_lakes"), page("feature/huge_trees"),
page("feature/ravines")));
AgeGenerationPlan plan = AgeGenerationPlan.compile(writing, 87L, AgeGenerationProfiles.STANDARD,
AgeTraits.select(87L), helper.getLevel().registryAccess());
List<AgeFeatureSelection.Choice> expected = List.of(
new AgeFeatureSelection.Choice(id("rocks"), Optional.of(stone)),
new AgeFeatureSelection.Choice(id("lava_lakes"), Optional.of(water)),
choice("huge_trees"), choice("ravines"));
helper.assertValueEqual(AgeFeatureSelection.resolved(plan), expected,
"Each material must attach only to the immediately following feature");
helper.assertValueEqual(AgeFeatureSelection.resolved(AgeGenerationPlan.load(plan.save())), expected,
"Block modifiers must survive the frozen-plan round trip");
helper.succeed();
}
@GameTest(template = "empty")
public static void incompatibleAndMisplacedBlockPagesAreRejected(GameTestHelper helper) {
helper.assertTrue(AgeFeatureSelection.materialError(new AgeFeatureSelection.Choice(
id("rocks"), Optional.of(ResourceLocation.withDefaultNamespace("torch"))))
.contains("full solid block"),
"A non-full block must still be rejected if supplied by old writing");
rejects(helper, new OrderedWriting(List.of(panel(), page("terrain/standard"),
block("stone"), page("feature/surface_lakes"))), "source-fluid block");
rejects(helper, new OrderedWriting(List.of(panel(), page("terrain/standard"),
block("stone"), page("feature/trees"))), "cannot consume a material page");
rejects(helper, new OrderedWriting(List.of(panel(), page("terrain/standard"),
block("stone"))), "immediately before a compatible feature");
helper.succeed();
}
@GameTest(template = "empty", timeoutTicks = 600)
public static void runtimeAgeUsesSavedFeatureGenerator(GameTestHelper helper) {
var player = helper.makeMockServerPlayerInLevel();
OrderedWriting writing = new OrderedWriting(List.of(panel(), page("terrain/standard"),
page("biome/plains"), page("biome/single"), page("feature/caves"), page("feature/rocks")));
AgeReference reference = new AgeReference(UUID.randomUUID(), "Written Flowers");
var target = AgeDimensionService.resolve(player, reference, writing).orElseThrow();
AgeDefinition definition = AgeRegistrySavedData.get(helper.getLevel()).find(reference.id()).orElseThrow();
List<AgeFeatureSelection.Choice> expected = AgeFeatureSelection.resolved(definition.plan());
helper.assertValueEqual(expected.stream().map(AgeFeatureSelection.Choice::id).toList(),
List.of(id("caves"), id("rocks")), "Saved Age definition must retain the written decoration");
helper.assertTrue(expected.get(1).material().isPresent(),
"Unmodified rocks must receive a chosen material");
helper.runAfterDelay(1, () -> {
var level = helper.getLevel().getServer().getLevel(target.location().dimension());
helper.assertTrue(level != null, "The authored feature Age must load");
helper.assertTrue(level.getChunkSource().getGenerator() instanceof AgeFeatureChunkGenerator,
"Runtime world generation must use the feature-aware generator");
var generator = (AgeFeatureChunkGenerator) level.getChunkSource().getGenerator();
helper.assertValueEqual(generator.ageFeatures(), expected,
"Runtime generation must receive the frozen authored feature selection");
helper.succeed();
});
}
private static void rejects(GameTestHelper helper, OrderedWriting writing, String expected) {
try {
AgeGenerationPlan.compile(writing, 87L, AgeGenerationProfiles.STANDARD,
AgeTraits.select(87L), helper.getLevel().registryAccess());
helper.fail("Writing must reject " + expected);
} catch (IllegalArgumentException exception) {
helper.assertTrue(exception.getMessage().contains(expected), exception.getMessage());
}
}
private static ResourceLocation id(String path) {
return ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, path);
}
private static AgeFeatureSelection.Choice choice(String path) {
return new AgeFeatureSelection.Choice(id(path), java.util.Optional.empty());
}
private static WritingEntry page(String path) {
return WritingEntry.symbol(new SymbolReference(id(path)));
}
private static WritingEntry block(String path) {
return WritingEntry.symbol(new SymbolReference(BlockSymbolPages.symbolId(
ResourceLocation.withDefaultNamespace(path))));
}
private static WritingEntry panel() { return WritingEntry.linkPanel(); }
}
@@ -0,0 +1,60 @@
package net.dnorberg.rivencraft.book;
import com.mojang.serialization.Codec;
import io.netty.buffer.ByteBuf;
import java.util.List;
import net.minecraft.ChatFormatting;
import net.minecraft.network.codec.ByteBufCodecs;
import net.minecraft.network.codec.StreamCodec;
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. */
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 LinkProperties NONE = new LinkProperties(0);
public static final Codec<LinkProperties> CODEC = Codec.intRange(0, ALL_FLAGS).xmap(
LinkProperties::new, LinkProperties::flags);
public static final StreamCodec<ByteBuf, LinkProperties> STREAM_CODEC = StreamCodec.of(
(buffer, value) -> ByteBufCodecs.VAR_INT.encode(buffer, value.flags),
buffer -> new LinkProperties(ByteBufCodecs.VAR_INT.decode(buffer)));
public LinkProperties {
if ((flags & ~ALL_FLAGS) != 0 || flags < 0) {
throw new IllegalArgumentException("Unknown Link Panel flags: " + flags);
}
}
public boolean has(int flag) {
return (flags & flag) != 0;
}
/** Intra Linking only governs Linking Books; a Descriptive Book treats that panel as ordinary. */
public LinkProperties forDescriptiveBook() {
return new LinkProperties(flags & ~INTRA_LINKING);
}
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"));
}
private static Component propertyName(String name) {
return Component.translatable("item.rivencraft.link_property." + name)
.withStyle(ChatFormatting.DARK_PURPLE);
}
public static Component name(int flag) {
return switch (flag) {
case DISARM -> propertyName("disarm");
case MAINTAIN_MOMENTUM -> propertyName("maintain_momentum");
case INTRA_LINKING -> propertyName("intra_linking");
default -> throw new IllegalArgumentException("Unknown link property flag: " + flag);
};
}
}
@@ -25,7 +25,11 @@ public final class LinkingService {
}
public static LinkResult travel(ServerPlayer player, LinkTarget target) {
return travel(player, target, false);
return travel(player, target, LinkProperties.NONE);
}
public static LinkResult travel(ServerPlayer player, LinkTarget target, LinkProperties properties) {
return travel(player, target, false, properties);
}
public static Optional<Vec3> resolveDestination(ServerLevel level, BlockPos origin, boolean ageArrival) {
@@ -36,27 +40,36 @@ public final class LinkingService {
/** Travels to an Age-style destination, which must have solid footing. */
public static LinkResult travelWithFooting(ServerPlayer player, LinkTarget target) {
return travelWithFooting(player, target, LinkProperties.NONE);
}
public static LinkResult travelWithFooting(ServerPlayer player, LinkTarget target, LinkProperties properties) {
ServerLevel destinationLevel = player.getServer().getLevel(target.location().dimension());
if (destinationLevel == null) {
return LinkResult.MISSING_DIMENSION;
}
Optional<Vec3> destination = resolveDestination(destinationLevel, target.location().pos(), 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);
player.resetFallDistance();
return LinkResult.SUCCESS;
}
private static LinkResult travel(ServerPlayer player, LinkTarget target, boolean requiresFooting) {
private static LinkResult travel(ServerPlayer player, LinkTarget target, boolean requiresFooting,
LinkProperties properties) {
ServerLevel destinationLevel = player.getServer().getLevel(target.location().dimension());
if (destinationLevel == null) {
return LinkResult.MISSING_DIMENSION;
}
if (destinationLevel == player.level() && !properties.has(LinkProperties.INTRA_LINKING))
return LinkResult.INTRA_LINKING_REQUIRED;
Optional<Vec3> destination = resolveDestination(destinationLevel, target.location().pos(), requiresFooting);
if (destination.isEmpty()) {
@@ -64,11 +77,26 @@ public final class LinkingService {
}
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);
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();
}
private static void teleport(
ServerPlayer player,
ServerLevel destinationLevel,
@@ -166,6 +194,7 @@ public final class LinkingService {
public enum LinkResult {
SUCCESS,
MISSING_DIMENSION,
INTRA_LINKING_REQUIRED,
NO_SAFE_DESTINATION
}
}
@@ -0,0 +1,354 @@
package net.dnorberg.rivencraft.book;
import com.google.gson.JsonParser;
import java.util.List;
import java.util.UUID;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolCatalog;
import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.dnorberg.rivencraft.writing.WritingEntry;
import net.dnorberg.rivencraft.item.PageItem;
import net.minecraft.core.BlockPos;
import net.minecraft.core.registries.Registries;
import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper;
import net.minecraft.resources.ResourceKey;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.level.block.Blocks;
import net.minecraft.world.level.dimension.BuiltinDimensionTypes;
import net.dnorberg.rivencraft.world.AgeFlatChunkGenerator;
import net.minecraft.world.level.levelgen.NoiseBasedChunkGenerator;
import net.minecraft.world.level.biome.Biomes;
import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
/** Issue #32: authored terrain must drive actual runtime generation and survive reload. */
@GameTestHolder("rivencraft_archive_linking")
@PrefixGameTestTemplate(false)
public final class TerrainWritingGameTests {
private TerrainWritingGameTests() {}
@GameTest(template = "empty")
public static void seedSelectedCavePreflightRejectsSurfaceBiome(GameTestHelper helper) {
String candidate = null;
for (int index = 0; index < 1000; index++) {
String name = "Cave preflight " + index;
if (AgeRegistrySavedData.previewGenerationProfile(helper.getLevel(), name)
.equals(AgeGenerationProfiles.CAVE)) {
candidate = name;
break;
}
}
helper.assertTrue(candidate != null, "A deterministic name must select Cave terrain");
OrderedWriting writing = new OrderedWriting(List.of(WritingEntry.linkPanel(),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/plains")))));
boolean rejected = false;
try {
AgeRegistrySavedData.validateNewWriting(helper.getLevel(), candidate, writing);
} catch (IllegalArgumentException exception) {
rejected = exception.getMessage().contains("not a cave or Nether biome");
}
helper.assertTrue(rejected, "The preflight must use the actual seed-selected terrain profile");
helper.succeed();
}
@GameTest(template = "empty", timeoutTicks = 600)
public static void caveBiomePagesControlGeneratedPool(GameTestHelper helper) {
var player = helper.makeMockServerPlayerInLevel();
helper.assertTrue(PageItem.bundledCreativeSymbols().contains("biome/desert"),
"Desert must remain in the bundled creative page index");
var creativePages = PageItem.creativeSymbolPages(helper.getLevel().registryAccess());
helper.assertTrue(creativePages.stream().anyMatch(page -> PageItem.content(page).symbol()
.map(symbol -> symbol.id().equals(ResourceLocation.parse("rivencraft:biome/desert")))
.orElse(false))
&& creativePages.stream().anyMatch(page -> PageItem.content(page).symbol()
.map(symbol -> symbol.id().equals(ResourceLocation.parse("rivencraft:biome/jungle")))
.orElse(false)),
"Both bundled and registry-generated biome pages must be available to creative and JEI");
var jungle = ResourceLocation.withDefaultNamespace("jungle");
helper.assertTrue(SymbolCatalog.isKnown(new SymbolReference(ResourceLocation.parse("rivencraft:biome/jungle")))
&& PageItem.isUsableWriting(PageItem.createCreativeBiomePage(jungle)),
"A generated Jungle page must be usable as server-authored writing");
helper.getLevel().registryAccess().lookupOrThrow(Registries.BIOME).listElements()
.map(holder -> holder.key().location())
.filter(id -> id.getNamespace().equals("minecraft"))
.forEach(id -> helper.assertTrue(SymbolCatalog.isKnown(new SymbolReference(
ResourceLocation.fromNamespaceAndPath("rivencraft", "biome/" + id.getPath()))),
"Every registered vanilla biome must have a usable symbol page: " + id));
var overworldPool = AgeBiomeSelection.eligible(helper.getLevel().registryAccess(),
AgeRuntimeProfiles.resolve(AgeGenerationProfiles.STANDARD));
helper.assertTrue(overworldPool.containsAll(List.of(Biomes.LUSH_CAVES.location(),
Biomes.DRIPSTONE_CAVES.location(), Biomes.DEEP_DARK.location())),
"Standard terrain must retain the vanilla Overworld underground cave biomes");
OrderedWriting standardCaveWriting = new OrderedWriting(List.of(WritingEntry.linkPanel(),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:terrain/standard"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/dripstone_caves"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/single")))));
helper.assertValueEqual(AgeGenerationPlan.compile(standardCaveWriting, 45L,
AgeGenerationProfiles.STANDARD, AgeTraits.select(45L), helper.getLevel().registryAccess())
.biomeSelection().biomes(), List.of(Biomes.DRIPSTONE_CAVES.location()),
"A standard Age must accept an explicitly written cave biome");
OrderedWriting writing = new OrderedWriting(List.of(
WritingEntry.linkPanel(),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:terrain/cave"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/lush_caves"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/nether_wastes"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/tiled")))));
var reference = new AgeReference(UUID.randomUUID(), "Written Cave Biomes");
var target = AgeDimensionService.resolve(player, reference, writing).orElseThrow();
var age = AgeRegistrySavedData.get(helper.getLevel()).find(reference.id()).orElseThrow();
var selection = age.plan().biomeSelection();
helper.assertValueEqual(selection.distribution(), AgeTraits.BiomeDistribution.TILED,
"The authored distribution must override the random trait");
helper.assertValueEqual(selection.biomes(), List.of(Biomes.LUSH_CAVES.location(), Biomes.NETHER_WASTES.location()),
"An authored cave pool must include only its selected cave and Nether biomes");
helper.assertValueEqual(AgeGenerationPlan.load(age.plan().save()).biomeSelection(), selection,
"Biome IDs, count and distribution must survive a plan save/reload");
helper.runAfterDelay(1, () -> {
var level = helper.getLevel().getServer().getLevel(target.location().dimension());
helper.assertTrue(level != null, "The cave Age must load");
helper.assertValueEqual(level.getChunkSource().getGenerator().getBiomeSource().possibleBiomes().size(), 2,
"The runtime generator must expose both authored biomes");
helper.succeed();
});
}
@GameTest(template = "empty")
public static void authoredBiomeMinimumAndRandomAgeRange(GameTestHelper helper) {
var registries = helper.getLevel().registryAccess();
var profile = AgeRuntimeProfiles.resolve(AgeGenerationProfiles.STANDARD);
OrderedWriting twoBiomeTiny = new OrderedWriting(List.of(
WritingEntry.linkPanel(),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/plains"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/desert"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/tiny")))));
var written = AgeBiomeSelection.compile(net.dnorberg.rivencraft.writing.WritingGrammar.parse(twoBiomeTiny),
AgeTraits.select(42L), profile, 42L, registries);
helper.assertValueEqual(written.biomes(), List.of(Biomes.PLAINS.location(), Biomes.DESERT.location()),
"Two authored Tiny biomes must not acquire a third random biome");
var biomeRegistry = registries.lookupOrThrow(Registries.BIOME);
var scaled = new net.dnorberg.rivencraft.world.ScaledBiomeSource(net.minecraft.core.HolderSet.direct(
biomeRegistry.getOrThrow(Biomes.PLAINS), biomeRegistry.getOrThrow(Biomes.DESERT)), 42L, 0);
helper.assertValueEqual(scaled.possibleBiomes().size(), 2,
"The Tiny runtime biome source must accept exactly two authored biomes");
OrderedWriting oneBiomeTiny = new OrderedWriting(List.of(
WritingEntry.linkPanel(),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/plains"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/tiny")))));
var partial = AgeBiomeSelection.compile(net.dnorberg.rivencraft.writing.WritingGrammar.parse(oneBiomeTiny),
AgeTraits.select(42L), profile, 42L, registries);
helper.assertValueEqual(partial.biomes().size(), 2,
"One authored Tiny biome must receive only the missing second biome");
helper.assertValueEqual(partial.biomes().getFirst(), Biomes.PLAINS.location(),
"Random completion must preserve the authored biome first");
var randomWriting = net.dnorberg.rivencraft.writing.WritingGrammar.parse(OrderedWriting.EMPTY);
var traits = new AgeTraits(AgeTraits.BiomeDistribution.TINY, AgeTraits.Lighting.NORMAL,
AgeTraits.Weather.NORMAL, 1.0D, 0.0F, 0.0F);
int availableBiomeCount = new java.util.LinkedHashSet<>(AgeBiomeSelection.eligible(registries, profile)).size();
java.util.Set<Integer> counts = new java.util.HashSet<>();
for (long seed = 0; seed < 64; seed++) {
var random = AgeBiomeSelection.compile(randomWriting, traits, profile, seed, registries);
helper.assertTrue(random.biomes().size() >= 2 && random.biomes().size() <= availableBiomeCount,
"Random Tiny ages must not exceed their available biome pool");
helper.assertValueEqual(random, AgeBiomeSelection.compile(randomWriting, traits, profile, seed, registries),
"The random count and chosen biomes must be deterministic for an Age seed");
counts.add(random.biomes().size());
}
helper.assertTrue(counts.size() > 1, "Random Ages must vary their biome count across seeds");
if (availableBiomeCount > 6) {
helper.assertTrue(counts.stream().anyMatch(count -> count > 6),
"The available biome pool, not the old fixed cap, must bound random Ages");
}
var tiledTraits = new AgeTraits(AgeTraits.BiomeDistribution.TILED, AgeTraits.Lighting.NORMAL,
AgeTraits.Weather.NORMAL, 1.0D, 0.0F, 0.0F);
if (availableBiomeCount > 4) {
boolean exceededOldCap = false;
for (long seed = 0; seed < 64; seed++) {
var random = AgeBiomeSelection.compile(randomWriting, tiledTraits, profile, seed, registries);
helper.assertTrue(random.biomes().size() >= 2 && random.biomes().size() <= availableBiomeCount,
"Random Tiled ages must not exceed their available biome pool");
exceededOldCap |= random.biomes().size() > 4;
}
helper.assertTrue(exceededOldCap, "Tiled Ages must also be able to exceed the old fixed cap");
}
var caveProfile = AgeRuntimeProfiles.resolve(AgeGenerationProfiles.CAVE);
int caveBiomeCount = new java.util.LinkedHashSet<>(AgeBiomeSelection.eligible(registries, caveProfile)).size();
for (long seed = 0; seed < 64; seed++) {
var random = AgeBiomeSelection.compile(randomWriting, traits, caveProfile, seed, registries);
helper.assertTrue(random.biomes().size() >= 2 && random.biomes().size() <= caveBiomeCount,
"Random Cave ages must use the cave biome pool as their upper bound");
}
helper.succeed();
}
@GameTest(template = "empty", timeoutTicks = 600)
public static void skyIslandAllowsExplicitEndBiome(GameTestHelper helper) {
var player = helper.makeMockServerPlayerInLevel();
OrderedWriting writing = new OrderedWriting(List.of(
WritingEntry.linkPanel(),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:terrain/island"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/the_end"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/single")))));
var reference = new AgeReference(UUID.randomUUID(), "End Island Biome");
var target = AgeDimensionService.resolve(player, reference, writing).orElseThrow();
var age = AgeRegistrySavedData.get(helper.getLevel()).find(reference.id()).orElseThrow();
helper.assertValueEqual(age.plan().biomeSelection().biomes(), List.of(Biomes.THE_END.location()),
"A sky island may use an explicitly authored End biome");
helper.runAfterDelay(1, () -> {
var server = helper.getLevel().getServer();
var level = server.getLevel(target.location().dimension());
helper.assertTrue(level != null, "The island Age must load");
helper.assertTrue(level.getChunkSource().getGenerator().getBiomeSource().possibleBiomes().stream()
.allMatch(biome -> biome.is(Biomes.THE_END)),
"The runtime sky-island generator must use the End biome page");
helper.assertValueEqual(AgeGenerationPlan.load(age.plan().save()).biomeSelection(),
age.plan().biomeSelection(), "The authored End biome must survive a plan save/load round trip");
helper.succeed();
});
}
@GameTest(template = "empty", timeoutTicks = 600)
public static void writtenTerrainFamiliesGenerateSafely(GameTestHelper helper) {
var player = helper.makeMockServerPlayerInLevel();
checkWrittenTerrain(helper, player, AgeGenerationProfiles.all(), 0);
}
private static void checkWrittenTerrain(GameTestHelper helper,
net.minecraft.server.level.ServerPlayer player,
List<ResourceLocation> profiles, int index) {
if (index >= profiles.size()) {
helper.succeed();
return;
}
var server = helper.getLevel().getServer();
ResourceLocation profileId = profiles.get(index);
SymbolReference symbol = new SymbolReference(ResourceLocation.fromNamespaceAndPath(
"rivencraft", "terrain/" + profileId.getPath()));
var semantics = SymbolCatalog.find(symbol).orElseThrow().semantics().orElseThrow();
helper.assertValueEqual(semantics.role(), SymbolSemantics.Role.TERRAIN,
"A built-in terrain page must have terrain semantics");
helper.assertValueEqual(((SymbolSemantics.ResourceValue) semantics.value()).id(), profileId,
"A terrain page must point at its matching profile");
OrderedWriting writing = new OrderedWriting(List.of(
WritingEntry.linkPanel(), WritingEntry.symbol(symbol)));
AgeReference reference = new AgeReference(UUID.randomUUID(),
"Written " + profileId.getPath() + " " + UUID.randomUUID());
var target = AgeDimensionService.resolve(player, reference, writing).orElseThrow();
AgeDefinition age = AgeRegistrySavedData.get(helper.getLevel()).find(reference.id()).orElseThrow();
helper.assertValueEqual(age.generationProfile(), profileId,
"Written terrain must override the random profile chosen from the seed");
helper.assertValueEqual(age.plan().runtimeProfile(), AgeRuntimeProfiles.profiles().get(profileId),
"The selected noise and dimension-type resources must be frozen in the plan");
helper.runAfterDelay(1, () -> {
var level = server.getLevel(target.location().dimension());
helper.assertTrue(level != null, "The written Age must create a runtime dimension");
assertGenerator(helper, level, age.plan().runtimeProfile());
BlockPos spawn = target.location().pos();
helper.assertTrue(level.getBlockState(spawn.below()).is(Blocks.COBBLESTONE)
&& level.getBlockState(spawn).isAir()
&& level.getBlockState(spawn.above()).isAir(),
"Every written terrain family must retain a safe arrival platform");
helper.assertValueEqual(AgeGenerationPlan.load(age.plan().save()).runtimeProfile(),
age.plan().runtimeProfile(), "The written terrain profile must survive plan persistence");
helper.runAfterDelay(1, () -> checkWrittenTerrain(helper, player, profiles, index + 1));
});
}
@GameTest(template = "empty")
public static void missingRegistryResourcesRejectProfileAndPreserveAge(GameTestHelper helper) {
ResourceLocation missing = ResourceLocation.parse("rivencraft:missing_noise");
var json = JsonParser.parseString("""
{"schema_version":1,"terrain":"noise","noise_settings":"rivencraft:missing_noise",
"biome_preset":"minecraft:overworld","dimension_type":"minecraft:overworld"}
""");
boolean rejected = false;
try {
AgeRuntimeProfiles.parse(missing, json, helper.getLevel().registryAccess());
} catch (IllegalArgumentException exception) {
rejected = exception.getMessage().contains("noise_settings")
&& exception.getMessage().contains(missing.toString());
}
helper.assertTrue(rejected, "A profile with missing noise settings needs an actionable rejection");
long seed = 42L;
OrderedWriting writing = new OrderedWriting(List.of(WritingEntry.linkPanel(),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:terrain/standard")))));
AgeRuntimeProfile broken = new AgeRuntimeProfile(1, AgeRuntimeProfile.Terrain.NOISE,
missing, ResourceLocation.parse("minecraft:overworld"),
ResourceLocation.parse("minecraft:overworld"));
AgeGenerationPlan plan = new AgeGenerationPlan(1, seed, writing,
List.of(new AgeGenerationPlan.ResolvedSymbol(1,
writing.entries().get(1).symbol().orElseThrow(),
new SymbolSemantics(SymbolSemantics.Role.TERRAIN,
new SymbolSemantics.ResourceValue(AgeGenerationProfiles.STANDARD)))), broken);
AgeDefinition age = new AgeDefinition(UUID.randomUUID(), "Missing Resource", seed,
AgeGenerationProfiles.STANDARD, AgeDefinition.CURRENT_GENERATION_VERSION,
helper.getLevel().getGameTime(),
ResourceLocation.parse("rivencraft:gametest/missing_resource_" + UUID.randomUUID()),
null, AgeTraits.select(seed), plan);
helper.assertTrue(AgeDimensionService.ensureLoaded(helper.getLevel().getServer(), age) == null,
"A removed resource must not silently turn an authored Age into a different terrain");
helper.assertValueEqual(age.plan(), plan, "Failed loading must not mutate the saved plan");
helper.succeed();
}
@GameTest(template = "empty")
public static void dimensionTypeSnapshotKeepsNetherSkylightRules(GameTestHelper helper) {
var profile = AgeRuntimeProfiles.parse(ResourceLocation.parse("rivencraft:gametest_nether"),
JsonParser.parseString("""
{"schema_version":1,"terrain":"noise","noise_settings":"minecraft:nether",
"biome_preset":"minecraft:nether","dimension_type":"minecraft:the_nether"}
"""), helper.getLevel().registryAccess());
long seed = 99L;
OrderedWriting writing = new OrderedWriting(List.of(WritingEntry.linkPanel(),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:feature/caves")))));
var parsed = net.dnorberg.rivencraft.writing.WritingGrammar.parse(writing);
AgeGenerationPlan plan = new AgeGenerationPlan(1, seed, writing,
parsed.symbols().stream().map(symbol -> new AgeGenerationPlan.ResolvedSymbol(
symbol.index(), symbol.reference(), symbol.semantics())).toList(), profile);
AgeDefinition age = new AgeDefinition(UUID.randomUUID(), "Nether Type Snapshot", seed,
ResourceLocation.parse("rivencraft:gametest_nether"), AgeDefinition.CURRENT_GENERATION_VERSION,
helper.getLevel().getGameTime(),
ResourceLocation.parse("rivencraft:gametest/nether_type_" + UUID.randomUUID()),
null, AgeTraits.LEGACY_DEFAULTS, plan);
var level = AgeDimensionService.ensureLoaded(helper.getLevel().getServer(), age);
helper.assertTrue(level != null, "A valid custom dimension-type snapshot must load");
helper.assertFalse(level.dimensionType().hasSkyLight(),
"Normal lighting must not add skylight to a Nether-style dimension type");
helper.assertValueEqual(level.dimensionType().effectsLocation(), BuiltinDimensionTypes.NETHER_EFFECTS,
"The authored profile's dimension effects must reach the runtime Age");
helper.succeed();
}
private static void assertGenerator(GameTestHelper helper, net.minecraft.server.level.ServerLevel level,
AgeRuntimeProfile profile) {
var generator = level.getChunkSource().getGenerator();
if (profile.terrain() == AgeRuntimeProfile.Terrain.NOISE) {
helper.assertTrue(generator instanceof NoiseBasedChunkGenerator,
"Noise terrain must use a noise-based chunk generator");
var expected = level.registryAccess().lookupOrThrow(Registries.NOISE_SETTINGS).getOrThrow(
ResourceKey.create(Registries.NOISE_SETTINGS, profile.noiseSettings())).value();
helper.assertValueEqual(((NoiseBasedChunkGenerator) generator).generatorSettings().value().noiseSettings(),
expected.noiseSettings(), "Written noise settings must be applied to the generator");
} else {
helper.assertTrue(generator instanceof AgeFlatChunkGenerator,
"Flat and Void terrain must use a flat-source generator");
if (profile.terrain() == AgeRuntimeProfile.Terrain.VOID) {
helper.assertTrue(generator.getBiomeSource().possibleBiomes().stream()
.allMatch(biome -> biome.is(net.minecraft.world.level.biome.Biomes.THE_VOID)),
"Void terrain must use the Void biome");
}
}
var expectedType = level.registryAccess().lookupOrThrow(Registries.DIMENSION_TYPE).getOrThrow(
ResourceKey.create(Registries.DIMENSION_TYPE, profile.dimensionType())).value();
helper.assertValueEqual(level.dimensionType().effectsLocation(), expectedType.effectsLocation(),
"The profile's dimension-type effects must be applied");
}
}
@@ -1,5 +1,6 @@
package net.dnorberg.rivencraft.client.screen;
import java.util.Locale;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.block.entity.BookBinderBlockEntity;
import net.dnorberg.rivencraft.item.PageItem;
@@ -32,6 +33,7 @@ public final class BookBinderScreen extends AbstractContainerScreen<BookBinderMe
private EditBox titleInput;
private int firstVisible;
private int lastGrammarErrorStripIndex = -1;
private boolean stripClickPendingRelease;
public BookBinderScreen(BookBinderMenu menu, Inventory inventory, Component title) {
@@ -86,6 +88,13 @@ public final class BookBinderScreen extends AbstractContainerScreen<BookBinderMe
@Override public void render(GuiGraphics graphics, int mouseX, int mouseY, float partialTick) {
super.render(graphics, mouseX, mouseY, partialTick);
firstVisible = Math.min(firstVisible, maxFirstVisible());
int errorStripIndex = menu.grammarErrorStripIndex();
if (errorStripIndex != lastGrammarErrorStripIndex) {
if (errorStripIndex >= 0
&& (errorStripIndex < firstVisible || errorStripIndex >= firstVisible + VISIBLE_PAGES))
firstVisible = Math.clamp(errorStripIndex - VISIBLE_PAGES + 1, 0, maxFirstVisible());
lastGrammarErrorStripIndex = errorStripIndex;
}
graphics.enableScissor(leftPos + STRIP_X + 8, topPos + STRIP_Y,
leftPos + STRIP_X + STRIP_WIDTH - 8, topPos + STRIP_Y + STRIP_HEIGHT);
int count = visiblePageCount();
@@ -97,6 +106,16 @@ public final class BookBinderScreen extends AbstractContainerScreen<BookBinderMe
}
graphics.disableScissor();
drawScrollEnds(graphics);
Component grammarTooltip = menu.grammarError().map(code -> Component.translatable(
"screen.rivencraft.book_binder.grammar." + code.name().toLowerCase(Locale.ROOT),
errorStripIndex + 1)).orElse(null);
if (menu.getSlot(BookBinderMenu.RESULT).getItem().isEmpty()
&& mouseX >= leftPos + 152 && mouseX < leftPos + 168
&& mouseY >= topPos + 27 && mouseY < topPos + 43
&& grammarTooltip != null) {
graphics.renderTooltip(font, grammarTooltip, mouseX, mouseY);
return;
}
if (mouseY >= topPos + STRIP_Y && mouseY < topPos + STRIP_Y + STRIP_HEIGHT) {
if (firstVisible > 0 && mouseX >= leftPos + STRIP_X && mouseX < leftPos + STRIP_X + 8)
graphics.renderTooltip(font, Component.translatable("screen.rivencraft.book_binder.previous_pages"), mouseX, mouseY);
@@ -111,7 +130,9 @@ public final class BookBinderScreen extends AbstractContainerScreen<BookBinderMe
return;
}
int hovered = pageIndexAt(mouseX, mouseY);
if (hovered >= 0 && hovered < displayedPages() && !pageAtIndex(hovered).isEmpty())
if (hovered >= 0 && hovered == errorStripIndex && grammarTooltip != null)
graphics.renderTooltip(font, grammarTooltip, mouseX, mouseY);
else if (hovered >= 0 && hovered < displayedPages() && !pageAtIndex(hovered).isEmpty())
graphics.renderTooltip(font, pageAtIndex(hovered), mouseX, mouseY);
else renderTooltip(graphics, mouseX, mouseY);
}
@@ -148,6 +169,10 @@ public final class BookBinderScreen extends AbstractContainerScreen<BookBinderMe
case SYMBOL, UNRESOLVED_SYMBOL -> graphics.blit(NotebookScreen.symbolTexture(page),
x + 1, y + 5, 24, 24, 0, 0, 128, 128, 128, 128);
}
if (index == menu.grammarErrorStripIndex() && menu.grammarError().isPresent()) {
graphics.fill(x, y, x + PAGE_WIDTH, y + PAGE_HEIGHT, 0x55FF2020);
graphics.renderOutline(x, y, PAGE_WIDTH, PAGE_HEIGHT, 0xFFFF3030);
}
}
private void drawScrollEnds(GuiGraphics graphics) {
@@ -247,8 +247,6 @@ public final class DescriptiveBookScreen extends Screen implements ExplorableBoo
x, top + 39, 126, color);
drawWrappedWithoutShadow(graphics, Component.literal(display.id().toString()),
x, top + 64, 126, color);
drawWrappedWithoutShadow(graphics, Component.translatable("screen.rivencraft.age.pages_not_applied"),
x, top + 137, 126);
}
private void turnPage(int direction) {
@@ -8,11 +8,20 @@ import net.minecraft.client.gui.screens.inventory.AbstractContainerScreen;
import net.minecraft.network.chat.Component;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.entity.player.Inventory;
import net.minecraft.world.inventory.ClickType;
/** Legacy Ink Mixer atlas with a server-synced, sixteen-use basin. */
public final class InkMixerScreen extends AbstractContainerScreen<InkMixerMenu> {
private static final ResourceLocation BACKGROUND = ResourceLocation.fromNamespaceAndPath(
Rivencraft.MOD_ID, "textures/gui/ink_mixer_legacy.png");
private static final int BASIN_X = 88;
private static final int BASIN_Y = 49;
private static final int BASIN_RADIUS = 30;
// Legacy's registered property colors: Disarm red, Momentum blue, Intra green.
private static final int[] PROPERTY_COLORS = {0xFFE84848, 0xFF5555FF, 0xFF55EF55};
private final int[] lastChances = new int[3];
private boolean basinClickPendingRelease;
private long lastAdditionTime;
public InkMixerScreen(InkMixerMenu menu, Inventory inventory, Component title) {
super(menu, inventory, title);
@@ -26,16 +35,14 @@ public final class InkMixerScreen extends AbstractContainerScreen<InkMixerMenu>
renderBg(graphics, partialTick, mouseX, mouseY);
}
@Override protected void renderBg(GuiGraphics graphics, float partialTick, int mouseX, int mouseY) {
graphics.blit(BACKGROUND, leftPos, topPos, 0, 0, imageWidth, imageHeight, 256, 256);
int centerX = leftPos + 88;
int centerY = topPos + 49;
int fillTop = centerY + 26 - Math.round(menu.inkRemaining() / (float) InkVialItem.CAPACITY * 52);
// Legacy draws this inset behind the transparent center of the main atlas.
graphics.blit(BACKGROUND, leftPos + 54, topPos + 16, 179, 16, 66, 65, 256, 256);
if (menu.inkRemaining() > 0) {
for (int y = Math.max(centerY - 26, fillTop); y <= centerY + 26; y++) {
int halfWidth = (int) Math.sqrt(26 * 26 - (y - centerY) * (y - centerY));
graphics.fill(centerX - halfWidth, y, centerX + halfWidth + 1, y + 1, 0xFF241228);
}
// Ink is a full dark basin in Legacy, rather than a vertical meter.
graphics.fill(leftPos + 54, topPos + 16, leftPos + 120, topPos + 81, 0xFF101014);
renderPropertyGlyph(graphics);
}
graphics.blit(BACKGROUND, leftPos, topPos, 0, 0, imageWidth, imageHeight, 256, 256);
}
@Override protected void renderLabels(GuiGraphics graphics, int mouseX, int mouseY) {
graphics.drawString(font, playerInventoryTitle, inventoryLabelX, inventoryLabelY, 0x404040, false);
@@ -43,10 +50,112 @@ public final class InkMixerScreen extends AbstractContainerScreen<InkMixerMenu>
@Override public void render(GuiGraphics graphics, int mouseX, int mouseY, float partialTick) {
super.render(graphics, mouseX, mouseY, partialTick);
renderTooltip(graphics, mouseX, mouseY);
int x = mouseX - (leftPos + 88);
int y = mouseY - (topPos + 49);
if (x * x + y * y <= 26 * 26)
graphics.renderTooltip(font, Component.translatable("screen.rivencraft.ink_mixer.ink",
menu.inkRemaining(), InkVialItem.CAPACITY), mouseX, mouseY);
if (overBasin(mouseX, mouseY)) {
var lines = new java.util.ArrayList<Component>();
lines.add(Component.translatable("screen.rivencraft.ink_mixer.ink",
menu.inkRemaining(), InkVialItem.CAPACITY));
lines.add(Component.translatable("screen.rivencraft.ink_mixer.additive_hint"));
for (int index = 0; index < 3; index++) {
int chance = menu.modifierChancePermille(index);
if (chance > 0) lines.add(Component.translatable("screen.rivencraft.ink_mixer.chance",
switch (index) {
case 0 -> Component.translatable("item.rivencraft.link_property.disarm");
case 1 -> Component.translatable("item.rivencraft.link_property.maintain_momentum");
default -> Component.translatable("item.rivencraft.link_property.intra_linking");
}, chance / 10.0));
}
graphics.renderTooltip(font, lines, java.util.Optional.empty(), mouseX, mouseY);
}
}
@Override public boolean mouseClicked(double mouseX, double mouseY, int button) {
if ((button == 0 || button == 1) && overBasin(mouseX, mouseY)
&& !menu.getCarried().isEmpty()) {
slotClicked(menu.getSlot(InkMixerMenu.MODIFIER), InkMixerMenu.MODIFIER, button, ClickType.PICKUP);
basinClickPendingRelease = true;
return true;
}
return super.mouseClicked(mouseX, mouseY, button);
}
@Override public boolean mouseReleased(double mouseX, double mouseY, int button) {
if (basinClickPendingRelease) {
basinClickPendingRelease = false;
return true;
}
return super.mouseReleased(mouseX, mouseY, button);
}
private boolean overBasin(double mouseX, double mouseY) {
double x = mouseX - leftPos - BASIN_X;
double y = mouseY - topPos - BASIN_Y;
return x * x + y * y < BASIN_RADIUS * BASIN_RADIUS;
}
/** A GUI-scale projection of Legacy's colored, rotating D'ni ink effect. */
private void renderPropertyGlyph(GuiGraphics graphics) {
long now = System.currentTimeMillis();
int[] active = new int[3];
int count = 0;
int strongest = 0;
for (int index = 0; index < lastChances.length; index++) {
int chance = menu.modifierChancePermille(index);
if (chance > lastChances[index]) lastAdditionTime = now;
lastChances[index] = chance;
if (chance > 0) {
active[count++] = index;
strongest = Math.max(strongest, chance);
}
}
if (count == 0) {
lastAdditionTime = 0;
return;
}
double cycle = now / 1800.0;
int first = active[(int) cycle % count];
int second = active[((int) cycle + 1) % count];
double blend = (1.0 - Math.cos((cycle % 1.0) * Math.PI)) / 2.0;
int rgb = blendRgb(PROPERTY_COLORS[first], PROPERTY_COLORS[second], blend);
double pulse = Math.max(0.0, 1.0 - (now - lastAdditionTime) / 700.0);
int alpha = Math.clamp((int) (70 + strongest * 0.14 + pulse * 45), 0, 255);
int color = alpha << 24 | rgb;
int centerX = leftPos + BASIN_X;
int centerY = topPos + BASIN_Y;
double turn = now / 1200.0;
for (int spoke = 0; spoke < 4; spoke++) {
for (int step = 0; step <= 30; step++) {
double progress = step / 30.0;
double angle = turn + spoke * Math.PI / 2.0 + progress * 0.9;
double radius = 3.0 + progress * (15.0 + pulse * 3.0);
plot(graphics, centerX + Math.cos(angle) * radius,
centerY + Math.sin(angle) * radius, color);
}
}
for (int step = 0; step < 96; step++) {
double angle = step * Math.PI / 48.0 + turn * 0.3;
plot(graphics, centerX + Math.cos(angle) * 19.0,
centerY + Math.sin(angle) * 19.0, color);
if (strongest >= 990 && step % 2 == 0) {
plot(graphics, centerX + Math.cos(angle) * 23.0,
centerY + Math.sin(angle) * 23.0, color);
}
}
}
private static int blendRgb(int first, int second, double amount) {
int red = (int) (((first >> 16) & 0xFF) * (1.0 - amount)
+ ((second >> 16) & 0xFF) * amount);
int green = (int) (((first >> 8) & 0xFF) * (1.0 - amount)
+ ((second >> 8) & 0xFF) * amount);
int blue = (int) ((first & 0xFF) * (1.0 - amount) + (second & 0xFF) * amount);
return red << 16 | green << 8 | blue;
}
private static void plot(GuiGraphics graphics, double x, double y, int color) {
int pixelX = (int) Math.round(x);
int pixelY = (int) Math.round(y);
graphics.fill(pixelX, pixelY, pixelX + 1, pixelY + 1, color);
}
}
@@ -6,6 +6,7 @@ import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.client.SymbolPageTextures;
import net.dnorberg.rivencraft.menu.NotebookMenu;
import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.writing.PageContent;
import net.minecraft.client.gui.GuiGraphics;
import net.minecraft.client.gui.components.Button;
import net.minecraft.client.gui.components.EditBox;
@@ -115,7 +116,8 @@ public final class NotebookScreen extends AbstractContainerScreen<NotebookMenu>
if (index >= 0 && (button == 0 || button == 1)) {
ItemStack page = menu.getSlot(index).getItem();
if ((!page.isEmpty() && !matchesSearch(page))
|| (page.isEmpty() && !menu.getCarried().is(ModItems.PAGE.get()))) {
|| (page.isEmpty() && (!menu.getCarried().is(ModItems.PAGE.get())
|| PageItem.content(menu.getCarried()).kind() == PageContent.Kind.LINK_PANEL))) {
return true;
}
setFocused(null);
@@ -7,6 +7,7 @@ import java.util.Comparator;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.client.SymbolPageTextures;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.menu.WritingDeskMenu;
import net.dnorberg.rivencraft.block.entity.WritingDeskBlockEntity;
import net.dnorberg.rivencraft.registry.ModDataComponents;
@@ -329,7 +330,9 @@ public final class WritingDeskScreen extends AbstractContainerScreen<WritingDesk
int surfaceY = (int) Math.floor(mouseY - topPos - 20);
if ((button == 0 || button == 1) && !menu.getCarried().isEmpty()
&& surfaceX >= 0 && surfaceX < 155 && surfaceY >= 0 && surfaceY < 164) {
if (menu.getCarried().is(ModItems.PAGE.get()) && surfaceX % 31 < 30 && surfaceY % 41 < 40) {
if (menu.getCarried().is(ModItems.PAGE.get())
&& PageItem.content(menu.getCarried()).kind() != PageContent.Kind.LINK_PANEL
&& surfaceX % 31 < 30 && surfaceY % 41 < 40) {
int index = (surfaceY / 41 + scrollRows) * 5 + surfaceX / 31;
List<DisplayPage> entries = filteredPages();
// Only displayed positions are addressable. Filtering never turns
@@ -0,0 +1,33 @@
package net.dnorberg.rivencraft.compat;
import java.util.List;
import java.util.concurrent.atomic.AtomicBoolean;
import net.dnorberg.rivencraft.Rivencraft;
import net.minecraft.core.RegistryAccess;
import net.minecraft.resources.ResourceLocation;
import net.neoforged.fml.ModList;
/** Optional boundary: core Age code never loads TerraBlender API classes. */
public final class TerraBlenderBiomes {
private static final AtomicBoolean WARNED = new AtomicBoolean();
private TerraBlenderBiomes() {}
public static List<ResourceLocation> overworld(RegistryAccess registries) {
return collect(registries, false);
}
public static List<ResourceLocation> nether(RegistryAccess registries) {
return collect(registries, true);
}
private static List<ResourceLocation> collect(RegistryAccess registries, boolean nether) {
if (!ModList.get().isLoaded("terrablender")) return List.of();
try {
return TerraBlenderRegionAdapter.collect(registries, nether);
} catch (RuntimeException | LinkageError exception) {
if (WARNED.compareAndSet(false, true))
Rivencraft.LOGGER.warn("TerraBlender biome regions could not be read; using Rivencraft's biome pool", exception);
return List.of();
}
}
}
@@ -0,0 +1,34 @@
package net.dnorberg.rivencraft.compat;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set;
import net.minecraft.core.RegistryAccess;
import net.minecraft.core.registries.Registries;
import net.minecraft.resources.ResourceKey;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.level.biome.Biome;
import terrablender.api.Region;
import terrablender.api.RegionType;
import terrablender.api.Regions;
/** Loaded only after the optional TerraBlender mod is confirmed present. */
final class TerraBlenderRegionAdapter {
private TerraBlenderRegionAdapter() {}
static List<ResourceLocation> collect(RegistryAccess registries, boolean nether) {
var biomes = registries.registryOrThrow(Registries.BIOME);
RegionType type = nether ? RegionType.NETHER : RegionType.OVERWORLD;
Set<ResourceLocation> ids = new LinkedHashSet<>();
for (Region region : Regions.get(type)) {
region.addBiomes(biomes, mapping -> {
ResourceKey<Biome> key = mapping.getSecond();
ResourceLocation id = key.location();
// Vanilla's default region is always present. Only additions from
// other mods extend an Age's existing deterministic biome pool.
if (!id.getNamespace().equals("minecraft") && biomes.containsKey(id)) ids.add(id);
});
}
return ids.stream().sorted().toList();
}
}
@@ -1,6 +1,9 @@
package net.dnorberg.rivencraft.compat.jei;
import java.util.List;
import java.util.ArrayList;
import java.util.Set;
import java.util.stream.Collectors;
import mezz.jei.api.IModPlugin;
import mezz.jei.api.JeiPlugin;
import mezz.jei.api.constants.VanillaTypes;
@@ -13,12 +16,23 @@ import mezz.jei.api.recipe.category.AbstractRecipeCategory;
import mezz.jei.api.registration.IRecipeCatalystRegistration;
import mezz.jei.api.registration.IRecipeCategoryRegistration;
import mezz.jei.api.registration.IRecipeRegistration;
import mezz.jei.api.registration.ISubtypeRegistration;
import mezz.jei.api.registration.IExtraIngredientRegistration;
import mezz.jei.api.ingredients.subtypes.IIngredientSubtypeInterpreter;
import mezz.jei.api.ingredients.subtypes.UidContext;
import mezz.jei.api.runtime.IJeiRuntime;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.book.LinkProperties;
import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.writing.InkModifierIngredients;
import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.registry.ModItems;
import net.minecraft.client.Minecraft;
import net.minecraft.client.gui.GuiGraphics;
import net.minecraft.network.chat.Component;
import net.minecraft.network.chat.MutableComponent;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items;
@@ -36,6 +50,56 @@ public final class RivencraftJeiPlugin implements IModPlugin {
return ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "jei_writing");
}
@Override
public void registerItemSubtypes(ISubtypeRegistration registration) {
registration.registerSubtypeInterpreter(ModItems.PAGE.get(),
(IIngredientSubtypeInterpreter<ItemStack>) (stack, context) -> {
PageContent content = PageItem.content(stack);
return switch (content.kind()) {
case BLANK -> "blank";
case LINK_PANEL -> "link_panel:" + stack.getOrDefault(
ModDataComponents.LINK_PROPERTIES.get(), LinkProperties.NONE).flags();
case SYMBOL -> "symbol:" + content.symbol().orElseThrow().id();
case UNRESOLVED_SYMBOL -> "unresolved:" + content.symbol().orElseThrow().id();
};
});
}
@Override
public void registerExtraIngredients(IExtraIngredientRegistration registration) {
List<ItemStack> pages = new ArrayList<>();
pages.add(PageItem.createLinkPanelPage());
var connection = Minecraft.getInstance().getConnection();
if (connection != null) {
pages.addAll(PageItem.creativeSymbolPages(connection.registryAccess()));
} else {
PageItem.bundledCreativeSymbols().stream().map(PageItem::createBundledCreativePage)
.forEach(pages::add);
}
registration.addExtraItemStacks(pages);
}
@Override
public void onRuntimeAvailable(IJeiRuntime runtime) {
// JEI discovers the base Page item as a blank stack; only authored pages belong in its list.
runtime.getIngredientVisibility().hideIngredients(VanillaTypes.ITEM_STACK,
List.of(new ItemStack(ModItems.PAGE.get())), List.of(UidContext.Ingredient));
var connection = Minecraft.getInstance().getConnection();
if (connection == null) return;
Set<ResourceLocation> known = runtime.getIngredientManager().getAllItemStacks().stream()
.filter(stack -> stack.is(ModItems.PAGE.get()))
.map(PageItem::content)
.filter(content -> content.kind() == PageContent.Kind.SYMBOL)
.map(content -> content.symbol().orElseThrow().id())
.collect(Collectors.toSet());
List<ItemStack> missing = PageItem.creativeSymbolPages(connection.registryAccess()).stream()
.filter(stack -> !known.contains(PageItem.content(stack).symbol().orElseThrow().id()))
.toList();
if (!missing.isEmpty()) {
runtime.getIngredientManager().addIngredientsAtRuntime(VanillaTypes.ITEM_STACK, missing);
}
}
@Override
public void registerCategories(IRecipeCategoryRegistration registration) {
IGuiHelper guiHelper = registration.getJeiHelpers().getGuiHelper();
@@ -45,17 +109,23 @@ public final class RivencraftJeiPlugin implements IModPlugin {
@Override
public void registerRecipes(IRecipeRegistration registration) {
ItemStack panel = PageItem.createLinkPanelPage();
ItemStack symbolPage = PageItem.createSymbolPage(new SymbolReference(
ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "terrain/standard")));
registration.addRecipes(WRITING, List.of(
new WritingGuide(List.of(new ItemStack(Items.PAPER), new ItemStack(ModItems.INK_VIAL.get())),
panel, "jei.rivencraft.writing.link_panel_hand"),
new WritingGuide(List.of(panel, new ItemStack(Items.PAPER), new ItemStack(ModItems.INK_VIAL.get())),
panel, "jei.rivencraft.writing.copy"),
new WritingGuide(List.of(symbolPage, new ItemStack(Items.PAPER), new ItemStack(ModItems.INK_VIAL.get())),
symbolPage, "jei.rivencraft.writing.copy"),
new WritingGuide(List.of(new ItemStack(Items.LEATHER), panel),
new ItemStack(ModItems.DESCRIPTIVE_BOOK.get()), "jei.rivencraft.writing.bind"),
new WritingGuide(List.of(panel, new ItemStack(Items.LEATHER)),
new ItemStack(ModItems.LINKING_BOOK.get()), "jei.rivencraft.writing.linking_book")
));
registration.addRecipes(INK_MIXER, List.of(new InkMixerGuide(panel)));
List<InkMixerGuide> mixerGuides = new ArrayList<>();
mixerGuides.add(new InkMixerGuide(panel, null));
InkModifierIngredients.builtIn().forEach(ingredient ->
mixerGuides.add(new InkMixerGuide(panel, ingredient)));
registration.addRecipes(INK_MIXER, mixerGuides);
}
@Override
@@ -66,7 +136,7 @@ public final class RivencraftJeiPlugin implements IModPlugin {
}
private record WritingGuide(List<ItemStack> inputs, ItemStack output, String instructionKey) {}
private record InkMixerGuide(ItemStack panel) {}
private record InkMixerGuide(ItemStack panel, InkModifierIngredients.Ingredient additive) {}
private static final class InkMixerCategory extends AbstractRecipeCategory<InkMixerGuide> {
InkMixerCategory(IGuiHelper guiHelper) {
@@ -80,6 +150,9 @@ public final class RivencraftJeiPlugin implements IModPlugin {
builder.addInputSlot(2, 3).setStandardSlotBackground().addItemStack(new ItemStack(Items.PAPER));
builder.addInputSlot(23, 3).setStandardSlotBackground()
.addItemStack(new ItemStack(ModItems.INK_VIAL.get()));
if (recipe.additive() != null)
builder.addInputSlot(44, 3).setStandardSlotBackground()
.addItemStack(recipe.additive().item());
builder.addOutputSlot(112, 3).setOutputSlotBackground().addItemStack(recipe.panel());
builder.addOutputSlot(112, 46).setStandardSlotBackground()
.addItemStack(new ItemStack(Items.GLASS_BOTTLE));
@@ -88,8 +161,20 @@ public final class RivencraftJeiPlugin implements IModPlugin {
@Override
public void draw(InkMixerGuide recipe, IRecipeSlotsView slots, GuiGraphics graphics,
double mouseX, double mouseY) {
graphics.drawWordWrap(Minecraft.getInstance().font,
Component.translatable("jei.rivencraft.ink_mixer.usage"), 2, 27, 104, 0x404040);
Component instructions = recipe.additive() == null
? Component.translatable("jei.rivencraft.ink_mixer.usage")
: additiveInstructions(recipe.additive());
graphics.drawWordWrap(Minecraft.getInstance().font, instructions, 2, 27, 104, 0x404040);
}
private static Component additiveInstructions(InkModifierIngredients.Ingredient additive) {
MutableComponent effects = Component.empty();
for (InkModifierIngredients.Effect effect : additive.effects()) {
if (!effects.getSiblings().isEmpty()) effects.append(", ");
effects.append(Component.translatable("jei.rivencraft.ink_mixer.effect",
LinkProperties.name(effect.flag()), Math.round(effect.chance() * 100)));
}
return Component.translatable("jei.rivencraft.ink_mixer.additive", effects);
}
}
@@ -6,6 +6,9 @@ import net.dnorberg.rivencraft.block.entity.BookBinderBlockEntity;
import net.dnorberg.rivencraft.book.AgeReference;
import net.dnorberg.rivencraft.book.AgeDimensionService;
import net.dnorberg.rivencraft.book.AgeRegistrySavedData;
import net.dnorberg.rivencraft.book.LinkProperties;
import net.dnorberg.rivencraft.book.LinkTarget;
import net.dnorberg.rivencraft.book.LinkingService;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.menu.BookBinderMenu;
import net.dnorberg.rivencraft.registry.ModBlocks;
@@ -14,8 +17,10 @@ import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.writing.NotebookContents;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.writing.SymbolCatalog;
import net.dnorberg.rivencraft.writing.WritingEntry;
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.resources.ResourceLocation;
@@ -58,6 +63,7 @@ public final class BookBinderGameTests {
binder.setItem(BookBinderBlockEntity.FIRST_PAGE, terrainPage());
var saved = binder.saveWithoutMetadata(helper.getLevel().registryAccess());
var restored = new BookBinderBlockEntity(binder.getBlockPos(), binder.getBlockState());
restored.setLevel(helper.getLevel());
restored.loadWithComponents(saved, helper.getLevel().registryAccess());
helper.assertValueEqual(restored.title(), "Ordered Age", "Title must persist");
helper.assertTrue(restored.getItem(BookBinderBlockEntity.COVER).is(Items.LEATHER), "Cover must persist");
@@ -86,12 +92,41 @@ public final class BookBinderGameTests {
restored.loadWithComponents(saved, helper.getLevel().registryAccess());
helper.assertValueEqual(PageItem.content(restored.getItem(BookBinderBlockEntity.FIRST_PAGE))
.symbol().orElseThrow(), missing, "Reload must preserve the removed data-pack symbol ID");
helper.assertFalse(restored.canAssemble(), "Missing symbol cannot create a new written Age");
restored.getItem(BookBinderBlockEntity.FIRST_PAGE).set(ModDataComponents.PAGE_SYMBOL_DISPLAY.get(),
SymbolCatalog.display(new SymbolReference(ResourceLocation.parse("rivencraft:terrain/standard"))));
helper.assertFalse(restored.canAssemble(),
"Forged display metadata cannot make a missing symbol valid for a new Age");
helper.assertTrue(restored.getItem(BookBinderBlockEntity.FIRST_PAGE).is(ModItems.PAGE.get()),
"Rejected writing must remain recoverable as a Page");
helper.succeed();
}
@GameTest(template = "empty")
public static void conflictingGrammarKeepsBinderInputsRecoverable(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper);
binder.setTitle("Recoverable Duplicate");
binder.setItem(BookBinderBlockEntity.COVER, new ItemStack(Items.LEATHER));
binder.setItem(BookBinderBlockEntity.LINK_PANEL, PageItem.createLinkPanelPage());
binder.setItem(BookBinderBlockEntity.FIRST_PAGE, terrainPage());
binder.setItem(BookBinderBlockEntity.FIRST_PAGE + 5, terrainPage());
helper.assertFalse(binder.canAssemble(), "Duplicate terrain must not assemble a new Age");
int errorEntry = binder.writingGrammar().firstError().orElseThrow().index();
helper.assertValueEqual(errorEntry, 2, "Parser must identify the second authored symbol");
helper.assertValueEqual(binder.writingStripIndex(errorEntry), 6,
"A grammar error must highlight the correct strip page despite empty positions");
helper.assertFalse(binder.consumeAssembly(), "Rejected grammar must not consume binder inputs");
helper.assertTrue(binder.getItem(BookBinderBlockEntity.COVER).is(Items.LEATHER),
"Rejected grammar must leave the cover recoverable");
helper.assertTrue(binder.getItem(BookBinderBlockEntity.LINK_PANEL).is(ModItems.PAGE.get()),
"Rejected grammar must leave the Link Panel recoverable");
helper.assertTrue(binder.getItem(BookBinderBlockEntity.FIRST_PAGE + 5).is(ModItems.PAGE.get()),
"Rejected grammar must leave the duplicate page removable");
ItemStack removed = binder.takePage(5);
helper.assertTrue(removed.is(ModItems.PAGE.get()), "Player must be able to correct the duplicate page");
helper.assertTrue(binder.canAssemble(), "Corrected partial writing must become assemblable");
helper.succeed();
}
public static void assemblyIsAtomicAndRetainsPageOrder(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper);
binder.setTitle("A New Age");
@@ -102,7 +137,14 @@ public final class BookBinderGameTests {
helper.assertFalse(binder.consumeAssembly(), "Failure must consume nothing");
helper.assertTrue(binder.getItem(BookBinderBlockEntity.COVER).is(Items.LEATHER),
"Rejected assembly must preserve cover");
binder.setItem(BookBinderBlockEntity.LINK_PANEL, PageItem.createLinkPanelPage());
ItemStack flavoredPanel = PageItem.createLinkPanelPage();
flavoredPanel.set(ModDataComponents.LINK_PROPERTIES.get(),
new net.dnorberg.rivencraft.book.LinkProperties(
net.dnorberg.rivencraft.book.LinkProperties.DISARM
| net.dnorberg.rivencraft.book.LinkProperties.MAINTAIN_MOMENTUM
| net.dnorberg.rivencraft.book.LinkProperties.INTRA_LINKING));
var expectedProperties = flavoredPanel.get(ModDataComponents.LINK_PROPERTIES.get()).forDescriptiveBook();
binder.setItem(BookBinderBlockEntity.LINK_PANEL, flavoredPanel);
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(binder.getBlockPos().getX() + 0.5, binder.getBlockPos().getY() + 0.5,
binder.getBlockPos().getZ() + 0.5);
@@ -112,6 +154,9 @@ public final class BookBinderGameTests {
menu.clicked(BookBinderMenu.RESULT, 0, ClickType.PICKUP, player);
ItemStack book = menu.getCarried();
helper.assertTrue(book.is(ModItems.DESCRIPTIVE_BOOK.get()), "Result must be a Descriptive Book");
helper.assertValueEqual(book.get(ModDataComponents.LINK_PROPERTIES.get()),
expectedProperties,
"Binder must retain Disarm and Momentum but omit Intra Linking");
AgeReference age = book.get(ModDataComponents.AGE_REFERENCE.get());
helper.assertTrue(age != null, "Assembled book must already be a written Age book");
OrderedWriting writing = book.get(ModDataComponents.BOOK_WRITING.get());
@@ -144,6 +189,50 @@ public final class BookBinderGameTests {
helper.succeed();
}
public static void panelOnlyBookRetainsApplicableModifiers(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper);
binder.setTitle("Modified Random Age");
binder.setItem(BookBinderBlockEntity.COVER, new ItemStack(Items.LEATHER));
ItemStack panel = PageItem.createLinkPanelPage();
panel.set(ModDataComponents.LINK_PROPERTIES.get(), new LinkProperties(
LinkProperties.DISARM | LinkProperties.MAINTAIN_MOMENTUM | LinkProperties.INTRA_LINKING));
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(binder.getBlockPos().getX() + 0.5, binder.getBlockPos().getY() + 0.5,
binder.getBlockPos().getZ() + 0.5);
BookBinderMenu menu = new BookBinderMenu(1, player.getInventory(), binder);
menu.setCarried(panel);
helper.assertTrue(menu.clickMenuButton(player, BookBinderMenu.STRIP_CLICK_BASE),
"The link strip must accept the modified panel without symbol pages");
ItemStack result = menu.quickMoveStack(player, BookBinderMenu.RESULT);
helper.assertTrue(result.is(ModItems.DESCRIPTIVE_BOOK.get()),
"A Link Panel alone must create a random-Age Descriptive Book");
LinkProperties expected = new LinkProperties(LinkProperties.DISARM | LinkProperties.MAINTAIN_MOMENTUM);
helper.assertValueEqual(result.get(ModDataComponents.LINK_PROPERTIES.get()), expected,
"The panel-only book must keep travel modifiers but omit Intra Linking");
ItemStack restored = ItemStack.parseOptional(helper.getLevel().registryAccess(),
(net.minecraft.nbt.CompoundTag) result.saveOptional(helper.getLevel().registryAccess()));
helper.assertValueEqual(restored.get(ModDataComponents.LINK_PROPERTIES.get()), expected,
"Panel-only book modifiers must survive save and reload");
BlockPos departure = player.blockPosition();
BlockPos destination = departure.offset(3, 0, 0);
helper.getLevel().setBlock(destination.below(), Blocks.STONE.defaultBlockState(), 3);
helper.getLevel().setBlock(destination, Blocks.AIR.defaultBlockState(), 3);
helper.getLevel().setBlock(destination.above(), Blocks.AIR.defaultBlockState(), 3);
player.getInventory().setItem(4, new ItemStack(Items.DIAMOND, 3));
LinkTarget target = new LinkTarget(GlobalPos.of(helper.getLevel().dimension(), destination), 0.0F, 0.0F);
helper.assertValueEqual(LinkingService.travelWithFooting(player, target,
restored.get(ModDataComponents.LINK_PROPERTIES.get()).forDescriptiveBook()),
LinkingService.LinkResult.SUCCESS,
"The panel-only book's properties must be accepted by grounded travel");
helper.assertTrue(player.getInventory().getItem(4).isEmpty(),
"Disarm must remove the carried items during panel-only book travel");
helper.assertTrue(helper.getLevel().getEntitiesOfClass(ItemEntity.class,
new AABB(departure).inflate(5.0), entity -> entity.getItem().is(Items.DIAMOND))
.stream().mapToInt(entity -> entity.getItem().getCount()).sum() >= 3,
"Disarm must drop the items at the departure location");
helper.succeed();
}
@GameTest(template = "empty")
public static void linkPanelOnlyCreatesCompletedRandomAgeBook(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper);
@@ -1,8 +1,10 @@
package net.dnorberg.rivencraft.gametest;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.writing.BiomeSymbolPages;
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;
@@ -47,6 +49,11 @@ public final class CoreGameTests {
WritingDataGameTests.semanticSchemaIsServerOnlyBoundedAndV1Compatible(helper);
}
@GameTest(template = "empty")
public static void orderedWritingGrammar(GameTestHelper helper) {
WritingGrammarGameTests.orderedGrammarAcceptsPartialWritingAndDiagnosesInvalidSequences(helper);
}
@GameTest(template = "empty")
public static void notebookPersistence(GameTestHelper helper) {
WritingDataGameTests.notebookContentsPreserveOrderGapsNamesAndUnknownPages(helper);
@@ -82,6 +89,26 @@ public final class CoreGameTests {
BookBinderGameTests.assemblyIsAtomicAndRetainsPageOrder(helper);
}
@GameTest(template = "empty")
public static void panelOnlyBookModifiers(GameTestHelper helper) {
BookBinderGameTests.panelOnlyBookRetainsApplicableModifiers(helper);
}
@GameTest(template = "empty")
public static void biomePageNamespaces(GameTestHelper helper) {
helper.assertValueEqual(BiomeSymbolPages.symbolId(ResourceLocation.parse("minecraft:desert")),
ResourceLocation.parse("rivencraft:biome/desert"), "Vanilla biome page IDs must remain stable");
helper.assertFalse(BiomeSymbolPages.symbolId(ResourceLocation.parse("example:orchard"))
.equals(BiomeSymbolPages.symbolId(ResourceLocation.parse("another:orchard"))),
"Equal biome paths from different mods must not share a page ID");
helper.succeed();
}
@GameTest(template = "empty")
public static void binderRejectsConflictingGrammar(GameTestHelper helper) {
BookBinderGameTests.conflictingGrammarKeepsBinderInputsRecoverable(helper);
}
@GameTest(template = "empty")
public static void binderRejectsForgedAndReplayedActions(GameTestHelper helper) {
BookBinderGameTests.forgedBinderActionsAndReplayedOutputCannotDuplicateBook(helper);
@@ -92,6 +119,11 @@ public final class CoreGameTests {
InkMixerGameTests.linkPanelRequiresTakingOutputAndPersistsInk(helper);
}
@GameTest(template = "empty")
public static void mixerModifierTransaction(GameTestHelper helper) {
InkMixerGameTests.modifierClickPersistsPreviewAndConsumesOnce(helper);
}
@GameTest(template = "empty")
public static void linkingBookRecipe(GameTestHelper helper) {
LinkingBookRecipeGameTests.legacyRecipeRequiresExactlyLeatherAndLinkPanel(helper);
@@ -4,7 +4,6 @@ import net.dnorberg.rivencraft.block.entity.InkMixerBlockEntity;
import net.dnorberg.rivencraft.menu.InkMixerMenu;
import net.dnorberg.rivencraft.registry.ModBlocks;
import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.writing.WritingInkService;
import net.minecraft.core.BlockPos;
import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper;
@@ -28,6 +27,69 @@ public final class InkMixerGameTests {
return (InkMixerBlockEntity) helper.getLevel().getBlockEntity(pos);
}
public static void modifierClickPersistsPreviewAndConsumesOnce(GameTestHelper helper) {
InkMixerBlockEntity mixer = place(helper);
mixer.setItem(InkMixerBlockEntity.PAPER, new ItemStack(Items.PAPER, 2));
mixer.setItem(InkMixerBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(mixer.getBlockPos().getX() + 0.5, mixer.getBlockPos().getY() + 0.5,
mixer.getBlockPos().getZ() + 0.5);
InkMixerMenu menu = new InkMixerMenu(1, player.getInventory(), mixer);
menu.setCarried(new ItemStack(Items.GUNPOWDER, 2));
menu.clicked(InkMixerMenu.MODIFIER, 1, ClickType.PICKUP, player);
helper.assertValueEqual(menu.getCarried().getCount(), 1, "Right click must consume one additive");
helper.assertValueEqual(mixer.modifierChancePermille(0), 200,
"Gunpowder must add Legacy's 20% Disarm chance");
menu.setCarried(new ItemStack(Items.STONE));
menu.clicked(InkMixerMenu.MODIFIER, 0, ClickType.PICKUP, player);
helper.assertValueEqual(menu.getCarried().getCount(), 1, "Invalid additive must remain carried");
helper.assertValueEqual(mixer.modifierChancePermille(0), 200,
"Invalid additive must not change the mixture");
ItemStack preview = mixer.previewLinkPanel();
var saved = mixer.saveWithoutMetadata(helper.getLevel().registryAccess());
var restored = new InkMixerBlockEntity(mixer.getBlockPos(), ModBlocks.INK_MIXER.get().defaultBlockState());
restored.loadWithComponents(saved, helper.getLevel().registryAccess());
helper.assertTrue(ItemStack.matches(preview, restored.previewLinkPanel()),
"Saving must retain the mixture and deterministic next-panel preview");
menu.setCarried(ItemStack.EMPTY);
menu.clicked(InkMixerMenu.RESULT, 0, ClickType.PICKUP, player);
helper.assertTrue(menu.getCarried().is(ModItems.PAGE.get()), "Taking result must give a panel");
helper.assertValueEqual(mixer.modifierChancePermille(0), 0,
"Mixture must be spent only when a panel is taken");
helper.assertValueEqual(mixer.getItem(InkMixerBlockEntity.PAPER).getCount(), 1,
"Taking the panel must consume exactly one paper");
helper.succeed();
}
@GameTest(template = "empty")
public static void enderPearlsRaiseBothPropertiesIndependentlyAndResetOnOutput(GameTestHelper helper) {
InkMixerBlockEntity mixer = place(helper);
mixer.setItem(InkMixerBlockEntity.PAPER, new ItemStack(Items.PAPER, 2));
mixer.setItem(InkMixerBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
ItemStack pearls = new ItemStack(Items.ENDER_PEARL, 20);
helper.assertTrue(mixer.addModifier(pearls, 20), "Ender Pearls must infuse the basin");
helper.assertTrue(pearls.isEmpty(), "Twenty pearls must be consumed exactly once");
helper.assertValueEqual(mixer.modifierChancePermille(0), 961,
"Disarm must approach 100% independently");
helper.assertValueEqual(mixer.modifierChancePermille(2), 961,
"Intra Linking must approach 100% independently");
helper.assertValueEqual(mixer.modifierChancePermille(1), 0,
"Ender Pearls must not add Momentum");
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(mixer.getBlockPos().getX() + 0.5, mixer.getBlockPos().getY() + 0.5,
mixer.getBlockPos().getZ() + 0.5);
InkMixerMenu menu = new InkMixerMenu(1, player.getInventory(), mixer);
menu.clicked(InkMixerMenu.RESULT, 0, ClickType.PICKUP, player);
helper.assertTrue(menu.getCarried().is(ModItems.PAGE.get()), "Taking output must yield one panel");
for (int index = 0; index < 3; index++)
helper.assertValueEqual(mixer.modifierChancePermille(index), 0,
"Every modifier chance must reset when output is taken");
helper.assertValueEqual(mixer.getItem(InkMixerBlockEntity.PAPER).getCount(), 1,
"Taking output must consume one paper");
helper.succeed();
}
public static void linkPanelRequiresTakingOutputAndPersistsInk(GameTestHelper helper) {
InkMixerBlockEntity mixer = place(helper);
mixer.setItem(InkMixerBlockEntity.PAPER, new ItemStack(Items.PAPER, 2));
@@ -48,8 +110,9 @@ public final class InkMixerGameTests {
helper.assertTrue(menu.getCarried().is(ModItems.PAGE.get()), "Taking result must give a Link Panel");
helper.assertValueEqual(mixer.getItem(InkMixerBlockEntity.PAPER).getCount(), 1,
"Taking result must use exactly one paper");
helper.assertValueEqual(mixer.inkRemaining(), 16 - WritingInkService.linkPanelCost(),
"Taking result must spend the configured ink cost");
helper.assertValueEqual(mixer.inkRemaining(), 0,
"Taking one panel must spend the entire Ink Vial");
helper.assertFalse(mixer.canCreateLinkPanel(), "A second panel needs another Ink Vial");
var saved = mixer.saveWithoutMetadata(helper.getLevel().registryAccess());
var restored = new InkMixerBlockEntity(mixer.getBlockPos(), ModBlocks.INK_MIXER.get().defaultBlockState());
restored.loadWithComponents(saved, helper.getLevel().registryAccess());
@@ -59,6 +122,24 @@ public final class InkMixerGameTests {
helper.succeed();
}
@GameTest(template = "empty")
public static void eachLinkPanelConsumesOneInkVial(GameTestHelper helper) {
InkMixerBlockEntity mixer = place(helper);
mixer.setItem(InkMixerBlockEntity.PAPER, new ItemStack(Items.PAPER, 3));
mixer.setItem(InkMixerBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get(), 2));
helper.assertTrue(mixer.canCreateLinkPanel(), "First vial must enable the first panel");
helper.assertTrue(mixer.consumeLinkPanelMaterials(), "First panel must be produced");
helper.assertValueEqual(mixer.inkRemaining(), 16, "Second vial must refill after first panel");
helper.assertValueEqual(mixer.getItem(InkMixerBlockEntity.BOTTLES).getCount(), 2,
"Both spent vials must return bottles");
helper.assertTrue(mixer.consumeLinkPanelMaterials(), "Second panel must be produced");
helper.assertValueEqual(mixer.inkRemaining(), 0, "Second panel must use the whole second vial");
helper.assertFalse(mixer.canCreateLinkPanel(), "Two vials must not make a third panel");
helper.assertValueEqual(mixer.getItem(InkMixerBlockEntity.PAPER).getCount(), 1,
"Each panel must also use one paper");
helper.succeed();
}
@GameTest(template = "empty")
public static void bottleCapacityBlocksAndThenPermitsRefill(GameTestHelper helper) {
InkMixerBlockEntity mixer = place(helper);
@@ -2,6 +2,7 @@ package net.dnorberg.rivencraft.gametest;
import java.util.List;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.book.LinkProperties;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.registry.ModItems;
@@ -48,6 +49,8 @@ public final class LinkingBookRecipeGameTests {
public static void outputIsUnwrittenAndRegisteredRecipeLoads(GameTestHelper helper) {
ItemStack panel = PageItem.createLinkPanelPage();
panel.set(DataComponents.CUSTOM_NAME, Component.literal("Home Panel"));
panel.set(ModDataComponents.LINK_PROPERTIES.get(),
new LinkProperties(LinkProperties.INTRA_LINKING | LinkProperties.MAINTAIN_MOMENTUM));
CraftingInput input = CraftingInput.of(2, 1, List.of(panel, new ItemStack(Items.LEATHER)));
var holder = helper.getLevel().getRecipeManager()
.getRecipeFor(RecipeType.CRAFTING, input, helper.getLevel()).orElseThrow();
@@ -60,6 +63,14 @@ public final class LinkingBookRecipeGameTests {
helper.assertFalse(result.has(ModDataComponents.PAGE_CONTENT.get()), "Page identity must not leak onto the book");
helper.assertValueEqual(result.get(DataComponents.CUSTOM_NAME), Component.literal("Home Panel"),
"The panel's custom name must survive crafting");
helper.assertValueEqual(result.get(ModDataComponents.LINK_PROPERTIES.get()),
panel.get(ModDataComponents.LINK_PROPERTIES.get()),
"The panel's link properties must survive crafting");
ItemStack restored = ItemStack.parseOptional(helper.getLevel().registryAccess(),
(net.minecraft.nbt.CompoundTag) result.saveOptional(helper.getLevel().registryAccess()));
helper.assertValueEqual(restored.get(ModDataComponents.LINK_PROPERTIES.get()),
panel.get(ModDataComponents.LINK_PROPERTIES.get()),
"The crafted book's link properties must persist through save/load");
helper.succeed();
}
}
@@ -2,6 +2,8 @@ package net.dnorberg.rivencraft.gametest;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.book.AgeDefinition;
import net.dnorberg.rivencraft.book.AgeBiomeSelection;
import net.dnorberg.rivencraft.book.AgeGenerationPlan;
import net.dnorberg.rivencraft.book.AgeDimensionService;
import net.dnorberg.rivencraft.book.AgeGenerationProfiles;
import net.dnorberg.rivencraft.book.AgeReference;
@@ -9,9 +11,11 @@ import net.dnorberg.rivencraft.book.AgeRegistrySavedData;
import net.dnorberg.rivencraft.book.AgeRuntimeProfile;
import net.dnorberg.rivencraft.book.AgeRuntimeProfiles;
import net.dnorberg.rivencraft.book.LinkTarget;
import net.dnorberg.rivencraft.book.LinkProperties;
import net.dnorberg.rivencraft.book.LinkingService;
import net.dnorberg.rivencraft.book.AgeVisitSavedData;
import net.dnorberg.rivencraft.book.AgeTraits;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.compat.PreviewBackendSelector;
import net.dnorberg.rivencraft.config.RivencraftClientConfig;
import net.dnorberg.rivencraft.item.DescriptiveBookItem;
@@ -310,42 +314,6 @@ public final class LinkingGameTests {
throw new IllegalStateException("Could not select profile " + profile);
}
@GameTest(template = "empty", timeoutTicks = 100)
public static void unloadedAgeReloadsWithTheSameDefinition(GameTestHelper helper) {
UUID id = UUID.randomUUID();
AgeDefinition definition = AgeRegistrySavedData.resolveOrCreate(
helper.getLevel(),
new AgeReference(id, "Lifecycle Test Age " + id)
);
var server = helper.getLevel().getServer();
var first = AgeDimensionService.ensureLoaded(server, definition);
helper.assertTrue(first != null, "The lifecycle test Age must load");
helper.runAfterDelay(1, () -> {
helper.assertValueEqual(
AgeDimensionService.unload(server, definition),
AgeDimensionService.UnloadResult.UNLOADED,
"A loaded Age must unload without deleting its definition"
);
helper.runAfterDelay(1, () -> {
helper.assertTrue(server.getLevel(AgeDimensionService.dimensionKey(definition)) == null,
"An unloaded Age must leave the active server level map");
var reloaded = AgeDimensionService.ensureLoaded(server, definition);
helper.assertTrue(reloaded != null, "A book must be able to reload an archived Age");
helper.runAfterDelay(1, () -> {
var registered = server.getLevel(AgeDimensionService.dimensionKey(definition));
helper.assertTrue(registered != null, "The reloaded Age must rejoin the active server level map");
helper.assertValueEqual(registered.getSeed(), definition.seed(),
"Reloading an Age must preserve its immutable seed");
helper.assertValueEqual(registered.dimension().location(), definition.dimensionId(),
"Reloading an Age must preserve its dimension identifier");
helper.succeed();
});
});
});
}
@GameTest(template = "empty", timeoutTicks = 200)
public static void legacyBaseTerrainProfilesLoadRuntimeDimensions(GameTestHelper helper) {
for (var profile : AgeGenerationProfiles.all()) {
@@ -418,46 +386,40 @@ public final class LinkingGameTests {
}
if (profile.equals(AgeGenerationProfiles.AMPLIFIED)) {
var biomeSource = level.getChunkSource().getGenerator().getBiomeSource();
helper.assertValueEqual(
biomeSource.possibleBiomes().size(),
2,
"Tiled Biome Distribution must expose exactly two seeded biomes"
);
int availableBiomes = AgeBiomeSelection.eligible(helper.getLevel().registryAccess(),
AgeRuntimeProfiles.resolve(profile)).size();
helper.assertTrue(biomeSource.possibleBiomes().size() >= 2
&& biomeSource.possibleBiomes().size() <= availableBiomes,
"Random Tiled distribution must stay within the available biome pool");
var origin = biomeSource.getNoiseBiome(0, 0, 0, null);
var eastTile = biomeSource.getNoiseBiome(64, 0, 0, null);
var diagonalTile = biomeSource.getNoiseBiome(64, 0, 64, null);
helper.assertFalse(origin.equals(eastTile),
"Adjacent 256-block Tiled squares must alternate biomes");
helper.assertTrue(origin.equals(diagonalTile),
"Diagonal 256-block Tiled squares must repeat the biome");
"Adjacent 256-block Tiled squares must use different biomes");
}
if (profile.equals(AgeGenerationProfiles.ISLAND)) {
var biomeSource = level.getChunkSource().getGenerator().getBiomeSource();
helper.assertValueEqual(
biomeSource.possibleBiomes().size(),
2,
"Grid Biome Distribution must expose exactly two seeded biomes"
);
int availableBiomes = AgeBiomeSelection.eligible(helper.getLevel().registryAccess(),
AgeRuntimeProfiles.resolve(profile)).size();
helper.assertTrue(biomeSource.possibleBiomes().size() >= 2
&& biomeSource.possibleBiomes().size() <= availableBiomes,
"Random Grid distribution must stay within the available biome pool");
var origin = biomeSource.getNoiseBiome(0, 0, 0, null);
var insideOriginChunk = biomeSource.getNoiseBiome(3, 0, 3, null);
var eastChunk = biomeSource.getNoiseBiome(4, 0, 0, null);
var diagonalChunk = biomeSource.getNoiseBiome(4, 0, 4, null);
helper.assertTrue(origin.equals(insideOriginChunk),
"Grid biomes must remain constant inside each 16-block chunk");
helper.assertFalse(origin.equals(eastChunk),
"Adjacent Grid chunks must alternate biomes");
helper.assertTrue(origin.equals(diagonalChunk),
"Diagonal Grid chunks must repeat the biome");
"Adjacent Grid chunks must use different biomes");
}
if (profile.equals(AgeGenerationProfiles.CAVE)) {
var biomeSource = level.getChunkSource().getGenerator().getBiomeSource();
int caveBiomeCount = AgeBiomeSelection.eligible(helper.getLevel().registryAccess(),
AgeRuntimeProfiles.resolve(profile)).size();
helper.assertTrue(biomeSource instanceof net.dnorberg.rivencraft.world.ScaledBiomeSource,
"Tiny Biome Distribution must use the serializable scaled biome source");
helper.assertValueEqual(
biomeSource.possibleBiomes().size(),
3,
"Tiny Biome Distribution must expose exactly three seeded biomes"
);
helper.assertTrue(biomeSource.possibleBiomes().size() >= 2
&& biomeSource.possibleBiomes().size() <= caveBiomeCount,
"Random cave Tiny distribution must use only eligible cave biomes");
java.util.Set<net.minecraft.core.Holder<net.minecraft.world.level.biome.Biome>> sampled =
new java.util.HashSet<>();
for (int x = -32; x <= 32; x += 4) {
@@ -529,13 +491,13 @@ public final class LinkingGameTests {
continue;
}
var biomeSource = level.getChunkSource().getGenerator().getBiomeSource();
int availableBiomes = AgeBiomeSelection.eligible(helper.getLevel().registryAccess(),
AgeRuntimeProfiles.resolve(AgeGenerationProfiles.STANDARD)).size();
helper.assertTrue(biomeSource instanceof net.dnorberg.rivencraft.world.ScaledBiomeSource,
distribution + " Biome Distribution must use the serializable scaled biome source");
helper.assertValueEqual(
biomeSource.possibleBiomes().size(),
3,
distribution + " Biome Distribution must expose exactly three seeded biomes"
);
helper.assertTrue(biomeSource.possibleBiomes().size() >= 2
&& biomeSource.possibleBiomes().size() <= availableBiomes,
distribution + " random distribution must stay within the available biome pool");
helper.assertValueEqual(
((net.dnorberg.rivencraft.world.ScaledBiomeSource)biomeSource).scale(),
scale,
@@ -553,23 +515,10 @@ public final class LinkingGameTests {
net.minecraft.resources.ResourceKey<net.minecraft.world.level.biome.Biome> biome,
net.minecraft.world.level.block.Block expectedBlock
) {
var biomeRegistry = helper.getLevel().registryAccess().lookupOrThrow(net.minecraft.core.registries.Registries.BIOME);
var sortedBiomes = biomeRegistry.listElements()
.sorted(java.util.Comparator.comparing(holder -> holder.key().location().toString()))
.toList();
int targetIndex = -1;
for (int index = 0; index < sortedBiomes.size(); index++) {
if (sortedBiomes.get(index).is(biome)) {
targetIndex = index;
break;
}
}
helper.assertTrue(targetIndex >= 0, "The requested material-test biome must be registered");
long seed = 0L;
while (Math.floorMod(Long.hashCode(seed ^ 0x53494E474C454249L), sortedBiomes.size()) != targetIndex) {
seed++;
}
var plan = new AgeGenerationPlan(AgeGenerationPlan.CURRENT_VERSION, seed, OrderedWriting.EMPTY,
java.util.List.of(), AgeRuntimeProfiles.resolve(AgeGenerationProfiles.STANDARD),
new AgeBiomeSelection(AgeTraits.BiomeDistribution.SINGLE, java.util.List.of(biome.location())));
UUID id = UUID.randomUUID();
AgeDefinition definition = new AgeDefinition(
id,
@@ -589,7 +538,8 @@ public final class LinkingGameTests {
1.0D,
0.0F,
0.0F
)
),
plan
);
var level = AgeDimensionService.ensureLoaded(helper.getLevel().getServer(), definition);
helper.assertTrue(level != null, biome.location() + " material test Age must load");
@@ -629,7 +579,8 @@ public final class LinkingGameTests {
ServerPlayer player = helper.makeMockServerPlayerInLevel();
LinkTarget target = new LinkTarget(GlobalPos.of(helper.getLevel().dimension(), destination), 90.0F, 15.0F);
LinkingService.LinkResult result = LinkingService.travel(player, target);
LinkingService.LinkResult result = LinkingService.travel(player, target,
new LinkProperties(LinkProperties.INTRA_LINKING));
helper.assertValueEqual(result, LinkingService.LinkResult.SUCCESS,
"A Linking Book must accept leaf blocks even without a floor");
@@ -654,7 +605,8 @@ public final class LinkingGameTests {
ServerPlayer player = helper.makeMockServerPlayerInLevel();
LinkTarget target = new LinkTarget(GlobalPos.of(helper.getLevel().dimension(), absoluteOrigin), 0.0F, 0.0F);
helper.assertValueEqual(LinkingService.travelWithFooting(player, target), LinkingService.LinkResult.SUCCESS,
helper.assertValueEqual(LinkingService.travelWithFooting(player, target,
new LinkProperties(LinkProperties.INTRA_LINKING)), LinkingService.LinkResult.SUCCESS,
"Descriptive Book travel must find an alternate grounded arrival");
BlockPos landing = player.blockPosition();
helper.assertTrue(helper.getLevel().getBlockState(landing.below()).isFaceSturdy(
@@ -675,8 +627,10 @@ public final class LinkingGameTests {
ServerPlayer player = helper.makeMockServerPlayerInLevel();
LinkTarget target = new LinkTarget(GlobalPos.of(helper.getLevel().dimension(), absoluteOrigin), 0.0F, 0.0F);
helper.assertValueEqual(LinkingService.travel(player, target), LinkingService.LinkResult.NO_SAFE_DESTINATION,
helper.assertValueEqual(LinkingService.travel(player, target,
new LinkProperties(LinkProperties.INTRA_LINKING)), LinkingService.LinkResult.NO_SAFE_DESTINATION,
"Linking must fail rather than placing a player inside a blocked destination");
helper.succeed();
}
}
@@ -106,6 +106,22 @@ public final class WritingDataGameTests {
helper.succeed();
}
@GameTest(template = "empty")
public static void creativePagesIncludeEveryBuiltInTerrain(GameTestHelper helper) {
for (String terrain : List.of("standard", "amplified", "cave", "island", "flat", "void")) {
String path = "terrain/" + terrain;
helper.assertTrue(PageItem.bundledCreativeSymbols().contains(path),
"The matching symbol-page creative tab must include " + path);
ItemStack page = PageItem.createBundledCreativePage(path);
helper.assertValueEqual(PageItem.content(page).symbol().orElseThrow().id(),
ResourceLocation.fromNamespaceAndPath("rivencraft", path),
"The creative starter page must contain the matching terrain symbol");
helper.assertTrue(page.get(ModDataComponents.PAGE_SYMBOL_DISPLAY.get()).resolved(),
"The creative starter page must have display metadata before catalog reload");
}
helper.succeed();
}
@GameTest(template = "empty")
public static void semanticSchemaIsServerOnlyBoundedAndV1Compatible(GameTestHelper helper) {
var builtIn = SymbolCatalog.find(reference("rivencraft:terrain/standard")).orElseThrow();
@@ -271,6 +287,8 @@ public final class WritingDataGameTests {
helper.assertFalse(menu.getSlot(0).mayPlace(new ItemStack(Items.DIRT)),
"Notebook slots must reject non-Page items");
helper.assertFalse(menu.getSlot(0).mayPlace(PageItem.createLinkPanelPage()),
"Notebook slots must reject Link Panels");
menu.getSlot(0).set(first);
menu.getSlot(1).set(second);
helper.assertTrue(menu.clickMenuButton(player, NotebookMenu.MOVE_NEXT_BASE),
@@ -97,7 +97,7 @@ public final class WritingDeskGameTests {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
ItemStack source = PageItem.createLinkPanelPage();
ItemStack source = terrainPage();
desk.setItem(0, source.copy());
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER, 2));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
@@ -180,7 +180,7 @@ public final class WritingDeskGameTests {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
desk.setItem(0, PageItem.createLinkPanelPage());
desk.setItem(0, terrainPage());
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER, 2));
desk.setItem(WritingDeskBlockEntity.RETURN, new ItemStack(Items.GLASS_BOTTLE, 64));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
@@ -210,7 +210,7 @@ public final class WritingDeskGameTests {
WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
ItemStack notebook = new ItemStack(ModItems.NOTEBOOK.get());
notebook.set(ModDataComponents.NOTEBOOK_CONTENTS.get(),
new NotebookContents(List.of(ItemStack.EMPTY, PageItem.createLinkPanelPage())));
new NotebookContents(List.of(ItemStack.EMPTY, terrainPage())));
desk.setItem(0, notebook);
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
@@ -232,7 +232,7 @@ public final class WritingDeskGameTests {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
desk.setItem(0, PageItem.createLinkPanelPage());
desk.setItem(0, terrainPage());
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
var first = helper.makeMockServerPlayerInLevel();
@@ -258,7 +258,7 @@ public final class WritingDeskGameTests {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
desk.setItem(0, PageItem.createLinkPanelPage());
desk.setItem(0, terrainPage());
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
var player = helper.makeMockServerPlayerInLevel();
@@ -319,7 +319,7 @@ public final class WritingDeskGameTests {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
desk.setItem(0, PageItem.createLinkPanelPage());
desk.setItem(0, terrainPage());
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
var player = helper.makeMockServerPlayerInLevel();
@@ -446,7 +446,7 @@ public final class WritingDeskGameTests {
helper.assertTrue(menu.clickMenuButton(player, 87), "Tab 88 must be selectable without page-ID collisions");
helper.assertValueEqual(desk.activeCollection(), 87, "Tab 88 must become active");
helper.assertFalse(menu.clickMenuButton(player, 88), "Tab 89 must not exist");
desk.setItem(87, PageItem.createLinkPanelPage());
desk.setItem(87, terrainPage());
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.ALL_PAGE_BUTTON_BASE + 87 * NotebookContents.MAX_PAGES),
@@ -502,7 +502,7 @@ public final class WritingDeskGameTests {
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(pos.getX() + 0.5, pos.getY() + 0.5, pos.getZ() + 0.5);
var menu = new WritingDeskMenu(1, player.getInventory(), desk);
ItemStack held = PageItem.createLinkPanelPage().copyWithCount(3);
ItemStack held = terrainPage().copyWithCount(3);
ItemStack expectedPage = held.copyWithCount(1);
player.getInventory().setItem(9, held);
menu.clicked(WritingDeskMenu.COPY_RESULT + 1, 0, ClickType.PICKUP, player);
@@ -520,7 +520,7 @@ public final class WritingDeskGameTests {
helper.assertValueEqual(menu.pageCapacity(87), NotebookContents.MAX_PAGES, "Notebook tab must expose normal notebook capacity");
helper.assertValueEqual(menu.pageCapacity(0), 0, "Empty tab has no page storage");
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.PLACE_PAGE_BUTTON_BASE), "Empty tab must require a collection first");
desk.setItem(0, PageItem.createLinkPanelPage());
desk.setItem(0, terrainPage());
helper.assertValueEqual(menu.pageCapacity(0), 1, "Loose page tab must expose exactly one position");
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.PLACE_PAGE_BUTTON_BASE), "Loose page must not be replaced");
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.PLACE_PAGE_BUTTON_BASE + 1), "Loose page tab must not grow extra positions");
@@ -543,14 +543,13 @@ public final class WritingDeskGameTests {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
var desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
ItemStack linkPanel = PageItem.createLinkPanelPage();
ItemStack terrain = PageItem.createSymbolPage(new SymbolReference(
ResourceLocation.parse("rivencraft:terrain/standard")));
ItemStack movingPage = terrainPage();
ItemStack terrain = terrainPage();
ItemStack firstBook = new ItemStack(ModItems.NOTEBOOK.get());
firstBook.set(ModDataComponents.NOTEBOOK_CONTENTS.get(), new NotebookContents(List.of(linkPanel, terrain)));
firstBook.set(ModDataComponents.NOTEBOOK_CONTENTS.get(), new NotebookContents(List.of(movingPage, terrain)));
desk.setItem(0, firstBook);
desk.setItem(1, new ItemStack(ModItems.NOTEBOOK.get()));
desk.setItem(2, PageItem.createLinkPanelPage());
desk.setItem(2, terrainPage());
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(pos.getX() + 0.5, pos.getY() + 0.5, pos.getZ() + 0.5);
var menu = new WritingDeskMenu(1, player.getInventory(), desk);
@@ -558,18 +557,18 @@ public final class WritingDeskGameTests {
helper.assertTrue(menu.clickMenuButton(player, moveToEmpty), "Drag must move to a distant empty notebook position");
var pages = desk.getItem(0).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pages();
helper.assertTrue(pages.get(0).isEmpty(), "Moving must clear the source position");
helper.assertTrue(ItemStack.matches(pages.get(26), linkPanel), "Moving must preserve page components");
helper.assertTrue(ItemStack.matches(pages.get(26), movingPage), "Moving must preserve page components");
helper.assertValueEqual(desk.getItem(0).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pageCount(), 2,
"Moving must preserve total page count");
helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.movePageButtonId(0, 26, 0, 1)),
"Drag onto an occupied position must swap pages");
pages = desk.getItem(0).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pages();
helper.assertTrue(ItemStack.matches(pages.get(1), linkPanel) && ItemStack.matches(pages.get(26), terrain),
helper.assertTrue(ItemStack.matches(pages.get(1), movingPage) && ItemStack.matches(pages.get(26), terrain),
"Swap must preserve both pages");
helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.movePageButtonId(0, 1, 1, 5)),
"Drag into another notebook must work");
var otherPages = desk.getItem(1).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pages();
helper.assertTrue(ItemStack.matches(otherPages.get(5), linkPanel)
helper.assertTrue(ItemStack.matches(otherPages.get(5), movingPage)
&& desk.getItem(0).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pages().get(1).isEmpty(),
"Cross notebook move must have one destination and no old source");
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.movePageButtonId(0, 1, 1, 6)),
@@ -584,7 +583,7 @@ public final class WritingDeskGameTests {
menu.setCarried(new ItemStack(Items.DIAMOND));
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.movePageButtonId(1, 5, 1, 6)),
"Held inventory items must not be moved by a panel drag");
helper.assertTrue(ItemStack.matches(desk.getItem(1).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pages().get(5), linkPanel),
helper.assertTrue(ItemStack.matches(desk.getItem(1).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pages().get(5), movingPage),
"Rejected drags must leave notebook data intact");
helper.succeed();
}
@@ -594,7 +593,7 @@ public final class WritingDeskGameTests {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
var desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
ItemStack page = PageItem.createLinkPanelPage();
ItemStack page = terrainPage();
ItemStack source = new ItemStack(ModItems.NOTEBOOK.get());
source.set(ModDataComponents.NOTEBOOK_CONTENTS.get(),
new NotebookContents(List.of(page, page, page, page, page, page)));
@@ -643,4 +642,47 @@ public final class WritingDeskGameTests {
"Extracting a loose page must empty its tab and return the same item");
helper.succeed();
}
@GameTest(template = "empty")
public static void linkPanelsCannotBeStoredOrCopiedButOldPanelsCanBeRecovered(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
var desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
ItemStack panel = PageItem.createLinkPanelPage();
ItemStack oldNotebook = new ItemStack(ModItems.NOTEBOOK.get());
oldNotebook.set(ModDataComponents.NOTEBOOK_CONTENTS.get(), new NotebookContents(List.of(panel)));
helper.assertFalse(desk.canPlaceItem(0, panel), "Desk tab must reject a Link Panel");
helper.assertFalse(desk.canPlaceItem(0, oldNotebook),
"Desk tab must reject a Notebook containing an old Link Panel");
// A preexisting desk is loaded without discarding its contents.
desk.setItem(0, panel.copy());
desk.setItem(1, new ItemStack(ModItems.NOTEBOOK.get()));
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(pos.getX() + 0.5, pos.getY() + 0.5, pos.getZ() + 0.5);
var menu = new WritingDeskMenu(1, player.getInventory(), desk);
menu.broadcastChanges();
helper.assertTrue(menu.getSlot(WritingDeskMenu.COPY_RESULT).getItem().isEmpty(),
"Existing Link Panels must not produce a Desk copy");
helper.assertTrue(menu.quickMoveStack(player, WritingDeskMenu.COPY_RESULT).isEmpty(),
"Shift-click must not bypass the Link Panel copy rule");
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.movePageButtonId(0, 0, 1, 0)),
"An old Link Panel must not move into a Notebook");
menu.setCarried(panel.copy());
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.PLACE_PAGE_BUTTON_BASE
+ NotebookContents.MAX_PAGES), "A carried Link Panel must not enter a Notebook");
menu.setCarried(ItemStack.EMPTY);
helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.extractPageButtonId(0, 0, -1)),
"A stored legacy Link Panel must remain recoverable to the cursor");
helper.assertTrue(ItemStack.matches(menu.getCarried(), panel),
"Recovery must preserve the original Link Panel");
helper.succeed();
}
private static ItemStack terrainPage() {
return PageItem.createSymbolPage(new SymbolReference(
ResourceLocation.parse("rivencraft:terrain/standard")));
}
}
@@ -0,0 +1,143 @@
package net.dnorberg.rivencraft.gametest;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolCatalog;
import net.dnorberg.rivencraft.writing.SymbolDefinition;
import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
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;
/** Issue #30: parsing must not mutate writing or trust client display metadata. */
@GameTestHolder("rivencraft_archive_grammar")
@PrefixGameTestTemplate(false)
public final class WritingGrammarGameTests {
private WritingGrammarGameTests() {}
@GameTest(template = "empty")
public static void orderedGrammarAcceptsPartialWritingAndDiagnosesInvalidSequences(GameTestHelper helper) {
SymbolReference terrain = ref("rivencraft:terrain/standard");
SymbolReference nativeBiomes = ref("rivencraft:biome/native");
SymbolReference weather = ref("rivencraft:weather/normal");
SymbolReference lighting = ref("rivencraft:lighting/normal");
SymbolReference celestial = ref("rivencraft:celestial/normal_time");
SymbolReference caves = ref("rivencraft:feature/caves");
SymbolReference plains = ref("test:biome/plains");
SymbolReference forest = ref("test:biome/forest");
SymbolReference single = ref("test:controller/single");
SymbolReference alternateTerrain = ref("test:terrain/alternate");
SymbolReference periodHalf = ref("test:period/half");
SymbolReference periodFull = ref("test:period/full");
SymbolReference displayOnly = ref("test:display_only");
Map<SymbolReference, SymbolDefinition> definitions = Map.of(
plains, definition(SymbolSemantics.Role.BIOME,
new SymbolSemantics.ResourceValue(ResourceLocation.parse("minecraft:plains"))),
forest, definition(SymbolSemantics.Role.BIOME,
new SymbolSemantics.ResourceValue(ResourceLocation.parse("minecraft:forest"))),
single, definition(SymbolSemantics.Role.BIOME_CONTROLLER,
new SymbolSemantics.ChoiceValue("single")),
alternateTerrain, definition(SymbolSemantics.Role.TERRAIN,
new SymbolSemantics.ResourceValue(ResourceLocation.parse("test:alternate"))),
periodHalf, definition(SymbolSemantics.Role.PERIOD_MODIFIER,
new SymbolSemantics.NumberValue(0.5)),
periodFull, definition(SymbolSemantics.Role.PERIOD_MODIFIER,
new SymbolSemantics.NumberValue(1.0)),
displayOnly, new SymbolDefinition(1, "symbol.test", "symbol.test.description",
ResourceLocation.parse("test:display"), Optional.empty(), ""));
java.util.function.Function<SymbolReference, Optional<SymbolDefinition>> resolver = reference ->
Optional.ofNullable(definitions.get(reference)).or(() -> SymbolCatalog.find(reference));
helper.assertTrue(parse(resolver, WritingEntry.linkPanel()).randomFallback(),
"Link-Panel-only writing must retain the random Age path");
helper.assertTrue(WritingGrammar.parse(OrderedWriting.EMPTY, resolver).randomFallback(),
"Old page-free books must retain the random Age path");
OrderedWriting partial = writing(WritingEntry.linkPanel(), WritingEntry.symbol(terrain));
WritingGrammar.Result incomplete = WritingGrammar.parse(partial, resolver);
helper.assertTrue(incomplete.canCreate() && !incomplete.randomFallback(),
"Partial authored writing must remain valid, without pretending it is page-free");
helper.assertTrue(incomplete.diagnostics().stream().anyMatch(d -> d.code() == WritingGrammar.Code.INCOMPLETE),
"Missing branches must be reported for deterministic completion");
helper.assertValueEqual(partial.entries().size(), 2, "Parsing must not rewrite saved page order");
WritingGrammar.Result complete = parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(terrain),
WritingEntry.symbol(plains), WritingEntry.symbol(single), WritingEntry.symbol(weather),
WritingEntry.symbol(lighting), WritingEntry.symbol(periodHalf), WritingEntry.symbol(celestial),
WritingEntry.symbol(caves));
helper.assertTrue(complete.canCreate(), "Legacy-ordered categories and prefix modifiers must parse");
helper.assertValueEqual(complete.symbols().size(), 8, "Parsed symbols must preserve every authored page");
helper.assertValueEqual(complete.symbols().get(1).reference(), plains,
"A biome page must precede the controller that consumes it");
helper.assertValueEqual(WritingGrammar.parse(writing(WritingEntry.linkPanel(), WritingEntry.symbol(terrain),
WritingEntry.symbol(plains), WritingEntry.symbol(single), WritingEntry.symbol(weather),
WritingEntry.symbol(lighting), WritingEntry.symbol(periodHalf), WritingEntry.symbol(celestial),
WritingEntry.symbol(caves)), resolver), complete,
"Identical ordered writing and server definitions must parse deterministically");
WritingGrammar.Result repeatedModifiers = parse(resolver, WritingEntry.linkPanel(),
WritingEntry.symbol(periodHalf), WritingEntry.symbol(periodFull), WritingEntry.symbol(celestial));
helper.assertTrue(repeatedModifiers.canCreate(), "Repeated period modifiers must remain legal");
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(terrain),
WritingEntry.symbol(terrain)), WritingGrammar.Code.DUPLICATE);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(terrain),
WritingEntry.symbol(alternateTerrain)), WritingGrammar.Code.CONFLICT);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(weather),
WritingEntry.symbol(terrain)), WritingGrammar.Code.OUT_OF_ORDER);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(celestial),
WritingEntry.symbol(periodHalf)), WritingGrammar.Code.MISPLACED_MODIFIER);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(nativeBiomes),
WritingEntry.symbol(plains)), WritingGrammar.Code.OUT_OF_ORDER);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(plains),
WritingEntry.symbol(nativeBiomes)), WritingGrammar.Code.CONFLICT);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(plains),
WritingEntry.symbol(forest), WritingEntry.symbol(single)), WritingGrammar.Code.CONFLICT);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(caves),
WritingEntry.symbol(caves)), WritingGrammar.Code.DUPLICATE);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(ref("test:missing"))),
WritingGrammar.Code.UNRESOLVED);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(displayOnly)),
WritingGrammar.Code.UNSUPPORTED);
assertCode(helper, parse(resolver, WritingEntry.symbol(terrain)), WritingGrammar.Code.MISSING_PANEL);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.linkPanel()),
WritingGrammar.Code.DUPLICATE_PANEL);
List<WritingEntry> oversized = new ArrayList<>();
for (int index = 0; index <= WritingGrammar.MAX_NEW_ENTRIES; index++)
oversized.add(WritingEntry.linkPanel());
assertCode(helper, WritingGrammar.parse(new OrderedWriting(oversized), resolver), WritingGrammar.Code.TOO_MANY);
helper.succeed();
}
private static SymbolReference ref(String id) {
return new SymbolReference(ResourceLocation.parse(id));
}
private static SymbolDefinition definition(SymbolSemantics.Role role, SymbolSemantics.Value value) {
return new SymbolDefinition(2, "symbol.test", "symbol.test.description",
ResourceLocation.parse("test:" + role.id()), Optional.of(new SymbolSemantics(role, value)), "");
}
private static OrderedWriting writing(WritingEntry... entries) {
return new OrderedWriting(List.of(entries));
}
private static WritingGrammar.Result parse(
java.util.function.Function<SymbolReference, Optional<SymbolDefinition>> resolver,
WritingEntry... entries) {
return WritingGrammar.parse(writing(entries), resolver);
}
private static void assertCode(GameTestHelper helper, WritingGrammar.Result result, WritingGrammar.Code code) {
helper.assertFalse(result.canCreate(), "Writing with " + code + " must not create a new Age");
helper.assertTrue(result.diagnostics().stream().anyMatch(diagnostic -> diagnostic.code() == code),
"Writing must report " + code + " rather than silently dropping a page");
}
}
@@ -4,6 +4,7 @@ import java.util.List;
import net.dnorberg.rivencraft.book.AgeReference;
import net.dnorberg.rivencraft.book.AgeVisitSavedData;
import net.dnorberg.rivencraft.book.LinkTarget;
import net.dnorberg.rivencraft.book.LinkProperties;
import net.dnorberg.rivencraft.book.LinkingService;
import net.dnorberg.rivencraft.book.AgeDimensionService;
import net.dnorberg.rivencraft.config.RivencraftConfig;
@@ -54,7 +55,9 @@ public final class DescriptiveBookItem extends Item {
ServerLevel sourceLevel = player.serverLevel();
var sourcePosition = player.blockPosition();
LinkingService.LinkResult result = LinkingService.travelWithFooting(player, ageTarget);
LinkProperties properties = stack.getOrDefault(ModDataComponents.LINK_PROPERTIES.get(), LinkProperties.NONE)
.forDescriptiveBook();
LinkingService.LinkResult result = LinkingService.travelWithFooting(player, ageTarget, properties);
if (result != LinkingService.LinkResult.SUCCESS) {
player.displayClientMessage(Component.translatable("message.rivencraft.descriptive_book.unsafe"), true);
return false;
@@ -109,5 +112,7 @@ public final class DescriptiveBookItem extends Item {
? Component.translatable("item.rivencraft.descriptive_book.unwritten")
: Component.translatable("item.rivencraft.descriptive_book.age", age.name());
tooltipComponents.add(status.withStyle(ChatFormatting.GRAY));
stack.getOrDefault(ModDataComponents.LINK_PROPERTIES.get(), LinkProperties.NONE)
.forDescriptiveBook().appendTooltip(tooltipComponents);
}
}
@@ -4,6 +4,7 @@ import java.util.List;
import net.dnorberg.rivencraft.book.LinkTarget;
import net.dnorberg.rivencraft.book.AgeRegistrySavedData;
import net.dnorberg.rivencraft.book.LinkingService;
import net.dnorberg.rivencraft.book.LinkProperties;
import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.registry.ModSounds;
import net.minecraft.ChatFormatting;
@@ -49,7 +50,8 @@ public final class LinkingBookItem extends Item {
Level sourceLevel = player.level();
BlockPos sourcePosition = player.blockPosition();
LinkingService.LinkResult result = LinkingService.travel(player, target);
LinkProperties properties = stack.getOrDefault(ModDataComponents.LINK_PROPERTIES.get(), LinkProperties.NONE);
LinkingService.LinkResult result = LinkingService.travel(player, target, properties);
if (result == LinkingService.LinkResult.SUCCESS) {
sourceLevel.playSound(null, sourcePosition, ModSounds.LINK.get(), SoundSource.PLAYERS,
0.8F, sourceLevel.random.nextFloat() * 0.2F + 0.9F);
@@ -65,9 +67,11 @@ public final class LinkingBookItem extends Item {
return InteractionResultHolder.success(stack);
}
String errorKey = result == LinkingService.LinkResult.MISSING_DIMENSION
? "message.rivencraft.linking_book.missing_dimension"
: "message.rivencraft.linking_book.unsafe";
String errorKey = switch (result) {
case MISSING_DIMENSION -> "message.rivencraft.linking_book.missing_dimension";
case INTRA_LINKING_REQUIRED -> "message.rivencraft.linking_book.intra_required";
default -> "message.rivencraft.linking_book.unsafe";
};
player.displayClientMessage(Component.translatable(errorKey), true);
return InteractionResultHolder.fail(stack);
}
@@ -85,9 +89,11 @@ public final class LinkingBookItem extends Item {
TooltipFlag tooltipFlag
) {
LinkTarget target = stack.get(ModDataComponents.LINK_TARGET.get());
LinkProperties properties = stack.getOrDefault(ModDataComponents.LINK_PROPERTIES.get(), LinkProperties.NONE);
if (target == null) {
tooltipComponents.add(Component.translatable("item.rivencraft.linking_book.unbound")
.withStyle(ChatFormatting.GRAY));
properties.appendTooltip(tooltipComponents);
return;
}
@@ -101,6 +107,7 @@ public final class LinkingBookItem extends Item {
position.getZ()
)
.withStyle(ChatFormatting.GRAY));
properties.appendTooltip(tooltipComponents);
}
public static String destinationName(ServerLevel level) {
@@ -1,23 +1,53 @@
package net.dnorberg.rivencraft.item;
import com.google.gson.JsonParser;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.ArrayList;
import java.util.LinkedHashSet;
import java.util.Set;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.book.AgeBiomeSelection;
import net.dnorberg.rivencraft.book.LinkProperties;
import net.dnorberg.rivencraft.compat.TerraBlenderBiomes;
import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.SymbolCatalog;
import net.dnorberg.rivencraft.writing.SymbolDefinition;
import net.dnorberg.rivencraft.writing.BiomeSymbolPages;
import net.dnorberg.rivencraft.writing.BlockSymbolPages;
import net.dnorberg.rivencraft.writing.SymbolDisplayMetadata;
import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.writing.SymbolPoems;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.minecraft.ChatFormatting;
import net.minecraft.core.component.DataComponents;
import net.minecraft.core.HolderLookup;
import net.minecraft.core.RegistryAccess;
import net.minecraft.core.registries.Registries;
import net.minecraft.network.chat.Component;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.tags.BiomeTags;
import net.minecraft.world.item.Item;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.TooltipFlag;
/** One stackable Page item whose server-owned component identifies its writing state. */
public final class PageItem extends Item {
private static final ResourceLocation BIOME_GENERATION_CATEGORY =
ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "biome_generation");
private static final ResourceLocation CAVE_BIOME_CATEGORY =
ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "cave_biome");
private static final ResourceLocation BIOME_CATEGORY =
ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "biome");
private static final Map<String, CreativeSymbol> CREATIVE_SYMBOLS = loadCreativeSymbols();
private record CreativeSymbol(SymbolDisplayMetadata display, ResourceLocation creativeCategory) {}
public PageItem(Properties properties) {
super(properties);
}
@@ -29,23 +59,153 @@ public final class PageItem extends Item {
return create(PageContent.symbol(reference));
}
/** Fixed starter examples for the creative tab; the server still validates catalog membership on use. */
public static ItemStack createCreativeStarterPage(String path) {
if (!List.of("terrain/standard", "biome/native", "lighting/normal", "weather/normal",
"celestial/normal_time", "feature/caves").contains(path)) {
throw new IllegalArgumentException("Not a starter symbol: " + path);
public static List<String> bundledCreativeSymbols() {
return List.copyOf(CREATIVE_SYMBOLS.keySet());
}
/** Bundled categories become separate creative tabs without a Java page list. */
public static List<ResourceLocation> bundledCreativeCategories() {
LinkedHashSet<ResourceLocation> categories = CREATIVE_SYMBOLS.values().stream()
.map(CreativeSymbol::creativeCategory)
.collect(java.util.stream.Collectors.toCollection(LinkedHashSet::new));
categories.add(BlockSymbolPages.CATEGORY);
categories.add(BlockSymbolPages.FLUID_CATEGORY);
categories.add(CAVE_BIOME_CATEGORY);
return List.copyOf(categories);
}
public static ItemStack bundledCreativeCategoryIcon(ResourceLocation category) {
if (category.equals(CAVE_BIOME_CATEGORY)) {
return createCreativeBiomePage(ResourceLocation.withDefaultNamespace("lush_caves"));
}
SymbolReference reference = new SymbolReference(
net.minecraft.resources.ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, path));
if (category.equals(BlockSymbolPages.CATEGORY) || category.equals(BlockSymbolPages.FLUID_CATEGORY)) {
return createCreativeBlockPage(ResourceLocation.withDefaultNamespace(
category.equals(BlockSymbolPages.FLUID_CATEGORY) ? "water" : "stone"));
}
return CREATIVE_SYMBOLS.entrySet().stream()
.filter(entry -> entry.getValue().creativeCategory().equals(category))
.findFirst()
.map(entry -> createBundledCreativePage(entry.getKey()))
.orElseThrow(() -> new IllegalArgumentException("No bundled pages for category " + category));
}
/** Exact symbol-page variants offered in the creative tab and to optional ingredient viewers. */
public static List<ItemStack> creativeSymbolPages(HolderLookup.Provider registries) {
List<ItemStack> pages = creativeBundledAndBiomePages(registries);
BlockSymbolPages.availableBlocks().forEach(id -> pages.add(createCreativeBlockPage(id)));
return List.copyOf(pages);
}
private static List<ItemStack> creativeBundledAndBiomePages(HolderLookup.Provider registries) {
List<ItemStack> pages = new ArrayList<>();
CREATIVE_SYMBOLS.keySet().forEach(id -> pages.add(createBundledCreativePage(id)));
Set<String> bundled = CREATIVE_SYMBOLS.keySet();
registries.lookupOrThrow(Registries.BIOME).listElements()
.map(holder -> holder.key().location())
.filter(id -> !bundled.contains(BiomeSymbolPages.symbolId(id).getPath()))
.sorted()
.forEach(id -> pages.add(createCreativeBiomePage(id)));
return pages;
}
public static List<ItemStack> creativeSymbolPages(HolderLookup.Provider registries,
ResourceLocation category) {
if (category.equals(BlockSymbolPages.CATEGORY) || category.equals(BlockSymbolPages.FLUID_CATEGORY)) {
return BlockSymbolPages.availableBlocks(category).stream()
.map(PageItem::createCreativeBlockPage).toList();
}
Set<ResourceLocation> caveBiomes = category.equals(BIOME_CATEGORY) || category.equals(CAVE_BIOME_CATEGORY)
? caveBiomeIds(registries) : Set.of();
return creativeBundledAndBiomePages(registries).stream()
.filter(page -> category.equals(creativeCategory(page, caveBiomes)))
.toList();
}
public static ResourceLocation creativeCategory(ItemStack page, HolderLookup.Provider registries) {
return creativeCategory(page, caveBiomeIds(registries));
}
private static ResourceLocation creativeCategory(ItemStack page, Set<ResourceLocation> caveBiomes) {
ResourceLocation category = creativeCategory(page);
if (!category.equals(BIOME_CATEGORY)) return category;
ResourceLocation symbolId = content(page).symbol().orElseThrow().id();
ResourceLocation biomeId = BiomeSymbolPages.biomeId(symbolId);
return caveBiomes.contains(biomeId) ? CAVE_BIOME_CATEGORY : category;
}
private static Set<ResourceLocation> caveBiomeIds(HolderLookup.Provider registries) {
LinkedHashSet<ResourceLocation> ids = new LinkedHashSet<>();
registries.lookupOrThrow(Registries.BIOME).listElements()
.filter(holder -> holder.is(AgeBiomeSelection.CAVE_BIOMES) || holder.is(BiomeTags.IS_NETHER))
.forEach(holder -> ids.add(holder.key().location()));
if (registries instanceof RegistryAccess access) ids.addAll(TerraBlenderBiomes.nether(access));
return ids;
}
public static ResourceLocation creativeCategory(ItemStack page) {
SymbolDisplayMetadata metadata = page.get(ModDataComponents.PAGE_SYMBOL_DISPLAY.get());
if (metadata == null) throw new IllegalArgumentException("Page has no symbol display metadata");
if (metadata.id().getNamespace().equals(Rivencraft.MOD_ID)) {
CreativeSymbol bundled = CREATIVE_SYMBOLS.get(metadata.id().getPath());
if (bundled != null) return bundled.creativeCategory();
}
return metadata.category();
}
/** Bundled symbols for the creative tab; the server still validates catalog membership on use. */
public static ItemStack createBundledCreativePage(String path) {
CreativeSymbol symbol = CREATIVE_SYMBOLS.get(path);
if (symbol == null) {
throw new IllegalArgumentException("Not a bundled symbol: " + path);
}
SymbolDisplayMetadata metadata = symbol.display();
SymbolReference reference = new SymbolReference(metadata.id());
ItemStack page = create(PageContent.symbol(reference));
String key = "symbol.rivencraft." + path.replace('/', '.');
page.set(ModDataComponents.PAGE_SYMBOL_DISPLAY.get(), new SymbolDisplayMetadata(
reference.id(), key, key + ".description",
net.minecraft.resources.ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, path.split("/")[0]),
true, SymbolPoems.builtIn(reference.id())));
page.set(ModDataComponents.PAGE_SYMBOL_DISPLAY.get(), metadata);
return page;
}
public static ItemStack createCreativeBiomePage(net.minecraft.resources.ResourceLocation biomeId) {
var symbolId = BiomeSymbolPages.symbolId(biomeId);
ItemStack page = create(PageContent.symbol(new SymbolReference(symbolId)));
page.set(ModDataComponents.PAGE_SYMBOL_DISPLAY.get(), BiomeSymbolPages.definition(biomeId).display(symbolId));
return page;
}
public static ItemStack createCreativeBlockPage(ResourceLocation blockId) {
var symbolId = BlockSymbolPages.symbolId(blockId);
ItemStack page = create(PageContent.symbol(new SymbolReference(symbolId)));
page.set(ModDataComponents.PAGE_SYMBOL_DISPLAY.get(), BlockSymbolPages.definition(blockId).display(symbolId));
return page;
}
private static Map<String, CreativeSymbol> loadCreativeSymbols() {
String resource = "/assets/rivencraft/creative_symbol_pages.json";
try (var stream = PageItem.class.getResourceAsStream(resource)) {
if (stream == null) {
throw new IllegalStateException("Missing generated creative symbol index " + resource);
}
var json = JsonParser.parseReader(new InputStreamReader(stream, StandardCharsets.UTF_8))
.getAsJsonObject();
Map<String, CreativeSymbol> symbols = new LinkedHashMap<>();
json.entrySet().forEach(entry -> {
var id = net.minecraft.resources.ResourceLocation.parse(entry.getKey());
if (!id.getNamespace().equals(Rivencraft.MOD_ID)) {
throw new IllegalStateException("Creative symbol is not a Rivencraft page: " + id);
}
SymbolDefinition definition = SymbolDefinition.parse(entry.getValue());
ResourceLocation creativeCategory = definition.semantics()
.filter(semantics -> semantics.role() == SymbolSemantics.Role.BIOME_CONTROLLER)
.map(ignored -> BIOME_GENERATION_CATEGORY)
.orElse(definition.category());
symbols.put(id.getPath(), new CreativeSymbol(definition.display(id), creativeCategory));
});
return Collections.unmodifiableMap(symbols);
} catch (java.io.IOException exception) {
throw new IllegalStateException("Could not read generated creative symbol index " + resource, exception);
}
}
public static ItemStack createLinkPanelPage() {
return create(PageContent.LINK_PANEL);
}
@@ -98,6 +258,8 @@ public final class PageItem extends Item {
if (content.kind() == PageContent.Kind.LINK_PANEL) {
tooltipComponents.add(Component.translatable("item.rivencraft.page.link_panel.description")
.withStyle(ChatFormatting.GRAY));
stack.getOrDefault(ModDataComponents.LINK_PROPERTIES.get(), LinkProperties.NONE)
.appendTooltip(tooltipComponents);
return;
}
SymbolReference reference = content.symbol().orElseThrow();
@@ -128,9 +290,16 @@ public final class PageItem extends Item {
private static Component symbolName(ItemStack stack, SymbolReference reference) {
SymbolDisplayMetadata metadata = stack.getOrDefault(
ModDataComponents.PAGE_SYMBOL_DISPLAY.get(), SymbolCatalog.display(reference));
return metadata.resolved()
? Component.translatable(metadata.nameTranslationKey())
: Component.translatable("item.rivencraft.page.unresolved");
if (!metadata.resolved()) return Component.translatable("item.rivencraft.page.unresolved");
return reference.id().getNamespace().equals(Rivencraft.MOD_ID)
&& reference.id().getPath().startsWith("biome/")
? Component.translatableWithFallback(metadata.nameTranslationKey(),
BiomeSymbolPages.fallbackName(reference.id()))
: reference.id().getNamespace().equals(Rivencraft.MOD_ID)
&& reference.id().getPath().startsWith("block/")
? Component.translatableWithFallback(metadata.nameTranslationKey(),
BlockSymbolPages.fallbackName(BlockSymbolPages.blockId(reference.id())))
: Component.translatable(metadata.nameTranslationKey());
}
}
@@ -1,10 +1,12 @@
package net.dnorberg.rivencraft.menu;
import java.util.Optional;
import net.dnorberg.rivencraft.block.entity.BookBinderBlockEntity;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.registry.ModMenus;
import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.world.Container;
import net.minecraft.world.SimpleContainer;
@@ -32,6 +34,8 @@ public final class BookBinderMenu extends AbstractContainerMenu {
private final SimpleContainer result = new SimpleContainer(1);
private final boolean clientSide;
private int selectedPage = -1;
private int grammarErrorCode = -1;
private int grammarErrorStripIndex = -1;
public BookBinderMenu(int id, Inventory inventory, RegistryFriendlyByteBuf data) {
this(id, inventory, inventory.player.level().getBlockEntity(data.readBlockPos())
@@ -47,6 +51,20 @@ public final class BookBinderMenu extends AbstractContainerMenu {
@Override public int get() { return selectedPage; }
@Override public void set(int value) { selectedPage = value; }
});
addDataSlot(new DataSlot() {
@Override public int get() {
return clientSide || binder == null ? grammarErrorCode : binder.writingGrammar().firstError()
.map(error -> error.code().ordinal()).orElse(-1);
}
@Override public void set(int value) { grammarErrorCode = value; }
});
addDataSlot(new DataSlot() {
@Override public int get() {
return clientSide || binder == null ? grammarErrorStripIndex : binder.writingGrammar().firstError()
.map(error -> binder.writingStripIndex(error.index())).orElse(-1);
}
@Override public void set(int value) { grammarErrorStripIndex = value; }
});
addSlot(new BinderSlot(BookBinderBlockEntity.COVER, 8, 27, 64));
addSlot(new BinderSlot(BookBinderBlockEntity.LINK_PANEL, -1000, -1000, 1));
addSlot(new BinderSlot(BookBinderBlockEntity.NOTEBOOK, -1000, -1000, 1));
@@ -66,6 +84,12 @@ public final class BookBinderMenu extends AbstractContainerMenu {
}
public int selectedPage() { return selectedPage; }
public Optional<WritingGrammar.Code> grammarError() {
WritingGrammar.Code[] codes = WritingGrammar.Code.values();
return grammarErrorCode >= 0 && grammarErrorCode < codes.length
? Optional.of(codes[grammarErrorCode]) : Optional.empty();
}
public int grammarErrorStripIndex() { return grammarErrorStripIndex; }
public String title() { return binder == null ? "" : binder.title(); }
public boolean setTitle(Player player, String title) {
if (clientSide || !stillValid(player) || title == null
@@ -10,6 +10,7 @@ import net.minecraft.world.SimpleContainer;
import net.minecraft.world.entity.player.Inventory;
import net.minecraft.world.entity.player.Player;
import net.minecraft.world.inventory.AbstractContainerMenu;
import net.minecraft.world.inventory.ClickType;
import net.minecraft.world.inventory.DataSlot;
import net.minecraft.world.inventory.Slot;
import net.minecraft.world.item.ItemStack;
@@ -17,13 +18,15 @@ import net.minecraft.world.item.Items;
/** Server-owned virtual output; taking it spends paper and the configured ink cost once. */
public final class InkMixerMenu extends AbstractContainerMenu {
public static final int RESULT = InkMixerBlockEntity.SIZE;
public static final int MODIFIER = InkMixerBlockEntity.SIZE;
public static final int RESULT = MODIFIER + 1;
private static final int PLAYER_START = RESULT + 1;
private final InkMixerBlockEntity mixer;
private final Container inputs;
private final SimpleContainer result = new SimpleContainer(1);
private final boolean clientSide;
private int inkRemaining;
private final int[] modifierChances = new int[3];
public InkMixerMenu(int id, Inventory inventory, RegistryFriendlyByteBuf data) {
this(id, inventory, inventory.player.level().getBlockEntity(data.readBlockPos())
@@ -39,9 +42,19 @@ public final class InkMixerMenu extends AbstractContainerMenu {
@Override public int get() { return clientSide ? inkRemaining : mixer.inkRemaining(); }
@Override public void set(int value) { inkRemaining = value; }
});
for (int index = 0; index < modifierChances.length; index++) {
final int chanceIndex = index;
addDataSlot(new DataSlot() {
@Override public int get() {
return clientSide ? modifierChances[chanceIndex] : mixer.modifierChancePermille(chanceIndex);
}
@Override public void set(int value) { modifierChances[chanceIndex] = value; }
});
}
addSlot(new MixerSlot(InkMixerBlockEntity.INK, 8, 27));
addSlot(new MixerSlot(InkMixerBlockEntity.PAPER, 8, 48));
addSlot(new MixerSlot(InkMixerBlockEntity.BOTTLES, 152, 27));
addSlot(new ModifierSlot(79, 40));
addSlot(new ResultSlot(152, 48));
for (int row = 0; row < 3; row++)
for (int column = 0; column < 9; column++)
@@ -52,6 +65,24 @@ public final class InkMixerMenu extends AbstractContainerMenu {
}
public int inkRemaining() { return inkRemaining; }
public int modifierChancePermille(int index) { return modifierChances[index]; }
@Override public void clicked(int slotId, int button, ClickType clickType, Player player) {
if (slotId == MODIFIER) {
if (!clientSide && stillValid(player) && clickType == ClickType.PICKUP
&& (button == 0 || button == 1)) {
ItemStack carried = getCarried();
int amount = button == 1 ? 1 : carried.getCount();
if (mixer.addModifier(carried, amount)) {
setCarried(carried);
refreshResult();
broadcastChanges();
}
}
return;
}
super.clicked(slotId, button, clickType, player);
}
@Override public boolean stillValid(Player player) {
return mixer != null && mixer.stillValid(player);
@@ -64,8 +95,7 @@ public final class InkMixerMenu extends AbstractContainerMenu {
private void refreshResult() {
if (clientSide) return;
ItemStack preview = mixer != null && mixer.canCreateLinkPanel()
? PageItem.createLinkPanelPage() : ItemStack.EMPTY;
ItemStack preview = mixer == null ? ItemStack.EMPTY : mixer.previewLinkPanel();
if (!ItemStack.matches(result.getItem(0), preview)) result.setItem(0, preview);
}
@@ -87,7 +117,7 @@ public final class InkMixerMenu extends AbstractContainerMenu {
ItemStack source = slot.getItem();
ItemStack original = source.copy();
boolean moved;
if (index < RESULT) moved = moveItemStackTo(source, PLAYER_START, slots.size(), true);
if (index < MODIFIER) moved = moveItemStackTo(source, PLAYER_START, slots.size(), true);
else if (source.is(ModItems.INK_VIAL.get()))
moved = moveItemStackTo(source, InkMixerBlockEntity.INK, InkMixerBlockEntity.INK + 1, false);
else if (source.is(Items.PAPER))
@@ -105,6 +135,12 @@ public final class InkMixerMenu extends AbstractContainerMenu {
@Override public boolean mayPlace(ItemStack stack) { return inputs.canPlaceItem(getContainerSlot(), stack); }
}
private static final class ModifierSlot extends Slot {
ModifierSlot(int x, int y) { super(new SimpleContainer(1), 0, x, y); }
@Override public boolean mayPlace(ItemStack stack) { return false; }
@Override public boolean mayPickup(Player player) { return false; }
}
private final class ResultSlot extends Slot {
ResultSlot(int x, int y) { super(result, 0, x, y); }
@Override public boolean mayPlace(ItemStack stack) { return false; }
@@ -5,6 +5,8 @@ import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.registry.ModMenus;
import net.dnorberg.rivencraft.writing.NotebookContents;
import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.item.PageItem;
import net.minecraft.core.NonNullList;
import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.world.Container;
@@ -82,6 +84,7 @@ public final class NotebookMenu extends AbstractContainerMenu {
}
} else {
if (!source.is(ModItems.PAGE.get())
|| PageItem.content(source).kind() == PageContent.Kind.LINK_PANEL
|| !moveItemStackTo(source, 0, PLAYER_INVENTORY_START, false)) {
return ItemStack.EMPTY;
}
@@ -135,7 +138,10 @@ public final class NotebookMenu extends AbstractContainerMenu {
super(container, slot, x, y);
}
@Override public boolean mayPlace(ItemStack stack) { return stack.is(ModItems.PAGE.get()); }
@Override public boolean mayPlace(ItemStack stack) {
return stack.is(ModItems.PAGE.get())
&& PageItem.content(stack).kind() != PageContent.Kind.LINK_PANEL;
}
@Override public int getMaxStackSize() { return 1; }
}
@@ -180,7 +180,7 @@ public final class WritingDeskMenu extends AbstractContainerMenu {
private boolean placeCarriedPage(int collectionIndex, int pageIndex) {
// Resolve the actual storage position on the server, never a filtered list index.
ItemStack carried = getCarried();
if (clientSide || !carried.is(ModItems.PAGE.get())) return false;
if (clientSide || !storablePage(carried)) return false;
ItemStack collection = desk.getItem(collectionIndex);
if (collection.is(ModItems.NOTEBOOK.get())) {
var pages = new java.util.ArrayList<>(collection.getOrDefault(
@@ -215,12 +215,14 @@ public final class WritingDeskMenu extends AbstractContainerMenu {
if (sourceNotebook && (sourcePage >= sourcePages.size() || sourcePages.get(sourcePage).isEmpty())) return false;
ItemStack moving = sourceNotebook ? sourcePages.get(sourcePage) : sourceBook;
if (moving.getCount() != 1) return false;
if (!storablePage(moving)) return false;
if (!targetNotebook && targetBook.getCount() != 1) return false;
var targetPages = targetNotebook ? sourceCollection == targetCollection ? sourcePages
: new java.util.ArrayList<>(targetBook.getOrDefault(
ModDataComponents.NOTEBOOK_CONTENTS.get(), NotebookContents.EMPTY).pages()) : null;
if (targetNotebook) while (targetPages.size() <= targetPage) targetPages.add(ItemStack.EMPTY);
ItemStack displaced = targetNotebook ? targetPages.get(targetPage) : targetBook;
if (!displaced.isEmpty() && !storablePage(displaced)) return false;
if (targetNotebook) targetPages.set(targetPage, moving);
if (sourceNotebook) {
sourcePages.set(sourcePage, displaced);
@@ -256,6 +258,7 @@ public final class WritingDeskMenu extends AbstractContainerMenu {
setCarried(moving);
} else {
if (targetSlot >= WritingDeskBlockEntity.COLLECTIONS && targetSlot < PLAYER_START) return false;
if (targetSlot < WritingDeskBlockEntity.COLLECTIONS && !storablePage(moving)) return false;
Slot target = slots.get(targetSlot);
if (!target.isActive() || !target.mayPlace(moving)) return false;
ItemStack current = target.getItem();
@@ -340,10 +343,15 @@ public final class WritingDeskMenu extends AbstractContainerMenu {
if (moving.is(Items.PAPER))
return moveItemStackTo(moving, WritingDeskBlockEntity.PAPER,
WritingDeskBlockEntity.PAPER + 1, false);
if (moving.is(ModItems.PAGE.get())) return moveItemStackTo(moving, firstVisibleTab, firstVisibleTab + VISIBLE_TABS, false);
if (storablePage(moving)) return moveItemStackTo(moving, firstVisibleTab, firstVisibleTab + VISIBLE_TABS, false);
return false;
}
private static boolean storablePage(ItemStack stack) {
return stack.is(ModItems.PAGE.get())
&& PageItem.content(stack).kind() != PageContent.Kind.LINK_PANEL;
}
private ItemStack selectedSource() {
if (selectedSymbol != null) {
SymbolReference reference = new SymbolReference(selectedSymbol);
@@ -375,6 +383,7 @@ public final class WritingDeskMenu extends AbstractContainerMenu {
ItemStack source = selectedSource();
return blockEntity != null && source.is(ModItems.PAGE.get())
&& PageItem.content(source).kind() != PageContent.Kind.BLANK
&& PageItem.content(source).kind() != PageContent.Kind.LINK_PANEL
&& PageItem.isUsableWriting(source) && blockEntity.canConsumeCopyMaterials();
}
@@ -5,6 +5,9 @@ import net.dnorberg.rivencraft.book.LinkingService;
import net.dnorberg.rivencraft.book.AgeReference;
import net.dnorberg.rivencraft.book.AgeRegistrySavedData;
import net.dnorberg.rivencraft.book.AgeDimensionService;
import net.dnorberg.rivencraft.book.AgeGenerationPlan;
import net.dnorberg.rivencraft.book.AgeGenerationProfiles;
import net.dnorberg.rivencraft.book.AgeEnvironmentCompiler;
import net.dnorberg.rivencraft.block.entity.BookStandBlockEntity;
import net.dnorberg.rivencraft.client.ClientLinkPreviewHandler;
import net.dnorberg.rivencraft.client.ClientBookInteractionHandler;
@@ -20,6 +23,7 @@ import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolCatalog;
import net.dnorberg.rivencraft.writing.SymbolDisplayMetadata;
import net.dnorberg.rivencraft.writing.WritingEntry;
import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.minecraft.core.component.DataComponents;
import net.minecraft.core.BlockPos;
import net.minecraft.core.GlobalPos;
@@ -115,7 +119,9 @@ public final class ModNetworking {
PacketDistributor.sendToPlayer(player, new OpenDescriptiveBookScreenPayload(
payload.fromStand(), payload.offhand(),
GlobalPos.of(player.level().dimension(), payload.standPos()), access.stack().copy(),
definition == null ? null : definition.traits(), writingSymbols));
definition == null ? null : definition.plan() != null && definition.plan().biomeSelection() != null
? definition.traits().withBiomeDistribution(definition.plan().biomeSelection().distribution())
: definition.traits(), writingSymbols));
}
private static void bindDescriptiveBook(BindDescriptiveBookPayload payload, IPayloadContext context) {
@@ -133,10 +139,27 @@ public final class ModNetworking {
return;
}
var grammar = WritingGrammar.parse(access.stack()
.getOrDefault(ModDataComponents.BOOK_WRITING.get(), OrderedWriting.EMPTY));
if (!grammar.canCreate()) {
player.displayClientMessage(Component.translatable("message.rivencraft.descriptive_book.invalid_writing",
grammar.firstError().orElseThrow().message()), true);
return;
}
try {
AgeRegistrySavedData.validateNewWriting(player.serverLevel(), title,
access.stack().getOrDefault(ModDataComponents.BOOK_WRITING.get(), OrderedWriting.EMPTY));
} catch (IllegalArgumentException exception) {
player.displayClientMessage(Component.translatable("message.rivencraft.descriptive_book.invalid_writing",
exception.getMessage()), true);
return;
}
WRITING_BOOKS.add(access.stack());
try {
AgeReference reference = new AgeReference(UUID.randomUUID(), title);
if (AgeDimensionService.resolve(player, reference).isEmpty()) {
if (AgeDimensionService.resolve(player, reference, access.stack()
.getOrDefault(ModDataComponents.BOOK_WRITING.get(), OrderedWriting.EMPTY)).isEmpty()) {
player.displayClientMessage(Component.translatable("message.rivencraft.descriptive_book.unavailable"), true);
return;
}
@@ -291,15 +314,10 @@ public final class ModNetworking {
}
}
/** Vanilla Nether and End renderers do not use their biomes' blue Overworld sky tint. */
/** Sky effects, not dimension IDs, decide the backdrop for custom Ages. */
private static int previewSkyColor(ServerLevel level, BlockPos origin) {
if (level.dimension().equals(Level.NETHER)) {
return 0xFF6B2725;
}
if (level.dimension().equals(Level.END)) {
return 0xFF211835;
}
return level.getBiome(origin).value().getSkyColor();
return AgeEnvironmentCompiler.previewSkyColor(level.dimensionType().effectsLocation(),
level.getBiome(origin).value().getSkyColor());
}
private static InteractionHand hand(boolean offhand) {
@@ -0,0 +1,25 @@
package net.dnorberg.rivencraft.registry;
import com.mojang.serialization.MapCodec;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.world.AgeFlatChunkGenerator;
import net.dnorberg.rivencraft.world.AgeFeatureChunkGenerator;
import net.minecraft.core.registries.Registries;
import net.minecraft.world.level.chunk.ChunkGenerator;
import net.neoforged.bus.api.IEventBus;
import net.neoforged.neoforge.registries.DeferredRegister;
/** Serializable generators for Age profiles. */
public final class ModChunkGenerators {
private static final DeferredRegister<MapCodec<? extends ChunkGenerator>> GENERATORS =
DeferredRegister.create(Registries.CHUNK_GENERATOR, Rivencraft.MOD_ID);
static {
GENERATORS.register("age_flat", () -> AgeFlatChunkGenerator.CODEC);
GENERATORS.register("age_features", () -> AgeFeatureChunkGenerator.CODEC);
}
private ModChunkGenerators() { }
public static void register(IEventBus bus) { GENERATORS.register(bus); }
}
@@ -1,9 +1,15 @@
package net.dnorberg.rivencraft.registry;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.item.PageItem;
import net.minecraft.core.registries.Registries;
import net.minecraft.network.chat.Component;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.item.CreativeModeTab;
import net.neoforged.bus.api.IEventBus;
import net.neoforged.neoforge.registries.DeferredHolder;
@@ -28,20 +34,39 @@ public final class ModCreativeTabs {
})
.build());
public static final DeferredHolder<CreativeModeTab, CreativeModeTab> PAGES =
CREATIVE_TABS.register("rivencraft_pages", () -> CreativeModeTab.builder()
.title(Component.translatable("itemGroup.rivencraft.pages"))
public static final DeferredHolder<CreativeModeTab, CreativeModeTab> LINK_PAGES =
CREATIVE_TABS.register("rivencraft_link_pages", () -> CreativeModeTab.builder()
.title(Component.translatable("itemGroup.rivencraft.pages.link"))
.icon(PageItem::createLinkPanelPage)
.displayItems((parameters, output) -> {
output.accept(ModItems.PAGE.get());
output.accept(PageItem.createLinkPanelPage());
for (String id : new String[] {"terrain/standard", "biome/native", "lighting/normal",
"weather/normal", "celestial/normal_time", "feature/caves"}) {
output.accept(PageItem.createCreativeStarterPage(id));
}
})
.displayItems((parameters, output) -> output.accept(PageItem.createLinkPanelPage()))
.build());
private static final List<String> CATEGORY_ORDER = List.of(
"terrain", "biome", "cave_biome", "biome_generation", "weather", "lighting", "sky", "celestial", "block", "fluid", "feature");
public static final Map<ResourceLocation, DeferredHolder<CreativeModeTab, CreativeModeTab>> SYMBOL_PAGES =
registerSymbolPageTabs();
private static Map<ResourceLocation, DeferredHolder<CreativeModeTab, CreativeModeTab>> registerSymbolPageTabs() {
List<ResourceLocation> categories = new ArrayList<>(PageItem.bundledCreativeCategories());
categories.sort(Comparator.comparingInt((ResourceLocation id) -> {
int index = CATEGORY_ORDER.indexOf(id.getPath());
return index < 0 ? CATEGORY_ORDER.size() : index;
}).thenComparing(ResourceLocation::toString));
Map<ResourceLocation, DeferredHolder<CreativeModeTab, CreativeModeTab>> tabs = new LinkedHashMap<>();
for (ResourceLocation category : categories) {
String key = "rivencraft_pages_" + category.getNamespace() + "_" + category.getPath().replace('/', '_');
tabs.put(category, CREATIVE_TABS.register(key, () -> CreativeModeTab.builder()
.title(Component.translatableWithFallback("itemGroup.rivencraft.pages." + category.getPath(),
"Rivencraft " + category.getPath() + " Pages"))
.icon(() -> PageItem.bundledCreativeCategoryIcon(category))
.displayItems((parameters, output) -> PageItem.creativeSymbolPages(parameters.holders(), category)
.forEach(output::accept))
.build()));
}
return Map.copyOf(tabs);
}
private ModCreativeTabs() {
}
@@ -2,6 +2,7 @@ package net.dnorberg.rivencraft.registry;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.book.LinkTarget;
import net.dnorberg.rivencraft.book.LinkProperties;
import net.dnorberg.rivencraft.book.AgeReference;
import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.NotebookContents;
@@ -26,6 +27,12 @@ public final class ModDataComponents {
.networkSynchronized(LinkTarget.STREAM_CODEC)
.cacheEncoding()
.build());
public static final DeferredHolder<DataComponentType<?>, DataComponentType<LinkProperties>> LINK_PROPERTIES =
DATA_COMPONENTS.register("link_properties", () -> DataComponentType.<LinkProperties>builder()
.persistent(LinkProperties.CODEC)
.networkSynchronized(LinkProperties.STREAM_CODEC)
.cacheEncoding()
.build());
public static final DeferredHolder<DataComponentType<?>, DataComponentType<AgeReference>> AGE_REFERENCE =
DATA_COMPONENTS.register("age_reference", () -> DataComponentType.<AgeReference>builder()
.persistent(AgeReference.CODEC)
@@ -0,0 +1,155 @@
package net.dnorberg.rivencraft.world;
import com.mojang.serialization.Codec;
import com.mojang.serialization.MapCodec;
import com.mojang.serialization.codecs.RecordCodecBuilder;
import java.util.List;
import net.dnorberg.rivencraft.book.AgeFeatureSelection;
import net.minecraft.world.level.levelgen.Heightmap;
import net.minecraft.core.BlockPos;
import net.minecraft.core.Holder;
import net.minecraft.core.registries.Registries;
import net.minecraft.core.registries.BuiltInRegistries;
import net.minecraft.core.QuartPos;
import net.minecraft.resources.ResourceKey;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.util.RandomSource;
import net.minecraft.world.level.ChunkPos;
import net.minecraft.world.level.StructureManager;
import net.minecraft.world.level.WorldGenLevel;
import net.minecraft.server.level.WorldGenRegion;
import net.minecraft.world.level.biome.BiomeManager;
import net.minecraft.world.level.biome.BiomeSource;
import net.minecraft.world.level.chunk.ChunkAccess;
import net.minecraft.world.level.chunk.ChunkGenerator;
import net.minecraft.world.level.chunk.ProtoChunk;
import net.minecraft.world.level.levelgen.GenerationStep;
import net.minecraft.world.level.levelgen.LegacyRandomSource;
import net.minecraft.world.level.levelgen.NoiseBasedChunkGenerator;
import net.minecraft.world.level.levelgen.NoiseGeneratorSettings;
import net.minecraft.world.level.levelgen.RandomState;
import net.minecraft.world.level.levelgen.WorldgenRandom;
import net.minecraft.world.level.levelgen.carver.CarvingContext;
import net.minecraft.world.level.levelgen.carver.ConfiguredWorldCarver;
import net.minecraft.world.level.levelgen.placement.BiomeFilter;
import net.minecraft.world.level.levelgen.placement.PlacedFeature;
import net.minecraft.world.level.levelgen.placement.RarityFilter;
import net.minecraft.world.level.levelgen.feature.ConfiguredFeature;
import net.minecraft.world.level.levelgen.feature.Feature;
import net.minecraft.world.level.levelgen.feature.LakeFeature;
import net.minecraft.world.level.levelgen.feature.configurations.BlockStateConfiguration;
import net.minecraft.world.level.levelgen.feature.stateproviders.BlockStateProvider;
import net.minecraft.world.level.block.Blocks;
/** Adds frozen authored decorations after vanilla's biome features, without changing shared biome registries. */
public final class AgeFeatureChunkGenerator extends NoiseBasedChunkGenerator {
public static final MapCodec<AgeFeatureChunkGenerator> CODEC = RecordCodecBuilder.mapCodec(instance ->
instance.group(BiomeSource.CODEC.fieldOf("biome_source").forGetter(generator -> generator.getBiomeSource()),
NoiseGeneratorSettings.CODEC.fieldOf("settings").forGetter(generator -> generator.settings),
AgeFeatureSelection.Choice.CODEC.listOf().fieldOf("age_features").forGetter(generator -> generator.features),
Codec.LONG.fieldOf("age_seed").forGetter(generator -> generator.ageSeed))
.apply(instance, AgeFeatureChunkGenerator::new));
private final Holder<NoiseGeneratorSettings> settings;
private final List<AgeFeatureSelection.Choice> features;
private final long ageSeed;
public AgeFeatureChunkGenerator(BiomeSource biomes, Holder<NoiseGeneratorSettings> settings,
List<AgeFeatureSelection.Choice> features, long ageSeed) {
super(biomes, settings);
this.settings = settings;
this.features = List.copyOf(features);
this.ageSeed = ageSeed;
}
public List<AgeFeatureSelection.Choice> ageFeatures() { return features; }
@Override
protected MapCodec<? extends ChunkGenerator> codec() { return CODEC; }
@Override
public void applyCarvers(WorldGenRegion level, long seed, RandomState random, BiomeManager biomes,
StructureManager structures, ChunkAccess chunk, GenerationStep.Carving step) {
super.applyCarvers(level, seed, random, biomes, structures, chunk, step);
if (step != GenerationStep.Carving.AIR || features.stream().noneMatch(choice ->
AgeFeatureSelection.caves(choice.id()) || AgeFeatureSelection.ravines(choice.id()))) return;
var noiseChunk = chunk.getOrCreateNoiseChunk(ignored -> {
throw new IllegalStateException("Vanilla carver did not initialize the Age noise chunk");
});
var context = new CarvingContext(this, level.registryAccess(), chunk.getHeightAccessorForGeneration(),
noiseChunk, random, settings.value().surfaceRule());
var mask = ((ProtoChunk) chunk).getOrCreateCarvingMask(step);
var carvers = level.registryAccess().lookupOrThrow(Registries.CONFIGURED_CARVER);
var sourceRandom = new WorldgenRandom(new LegacyRandomSource(0L));
ChunkPos target = chunk.getPos();
BiomeManager sourceBiomes = biomes.withDifferentSource((qx, qy, qz) ->
getBiomeSource().getNoiseBiome(qx, qy, qz, random.sampler()));
for (AgeFeatureSelection.Choice choice : features) {
if (!AgeFeatureSelection.caves(choice.id()) && !AgeFeatureSelection.ravines(choice.id())) continue;
for (int dx = -8; dx <= 8; dx++) {
for (int dz = -8; dz <= 8; dz++) {
ChunkPos source = new ChunkPos(target.x + dx, target.z + dz);
var biome = getBiomeSource().getNoiseBiome(QuartPos.fromBlock(source.getMinBlockX()), 0,
QuartPos.fromBlock(source.getMinBlockZ()), random.sampler());
if (AgeFeatureSelection.ravines(choice.id())
&& biome.is(net.minecraft.tags.BiomeTags.IS_NETHER)) continue;
ResourceLocation carverId = ResourceLocation.withDefaultNamespace(
AgeFeatureSelection.ravines(choice.id()) ? "canyon"
: biome.is(net.minecraft.tags.BiomeTags.IS_NETHER) ? "nether_cave" : "cave");
ConfiguredWorldCarver<?> carver = carvers.getOrThrow(
ResourceKey.create(Registries.CONFIGURED_CARVER, carverId)).value();
sourceRandom.setLargeFeatureSeed(ageSeed ^ (AgeFeatureSelection.ravines(choice.id())
? 0x524156494E45534CL : 0x4341564553464541L), source.x, source.z);
if (carver.isStartChunk(sourceRandom)) {
carver.carve(context, chunk, sourceBiomes::getBiome, sourceRandom,
noiseChunk.aquifer(), source, mask);
}
}
}
}
}
@Override
public void applyBiomeDecoration(WorldGenLevel level, ChunkAccess chunk, StructureManager structures) {
super.applyBiomeDecoration(level, chunk, structures);
var registry = level.registryAccess().lookupOrThrow(Registries.PLACED_FEATURE);
int x = chunk.getPos().getMinBlockX();
int z = chunk.getPos().getMinBlockZ();
BlockPos origin = new BlockPos(x, level.getMinBuildHeight(), z);
for (int index = 0; index < features.size(); index++) {
AgeFeatureSelection.Choice choice = features.get(index);
if (AgeFeatureSelection.surfaceVegetation(choice.id())) {
int surface = chunk.getHeight(Heightmap.Types.WORLD_SURFACE_WG, 8, 8);
if (!AgeFeatureSelection.supportsSurfaceVegetation(
level.getBiome(new BlockPos(x + 8, surface, z + 8)))) continue;
}
ResourceLocation key = AgeFeatureSelection.placedFeature(choice.id());
if (key == null) continue; // Carvers are applied before decoration.
PlacedFeature vanilla = registry.getOrThrow(ResourceKey.create(Registries.PLACED_FEATURE, key)).value();
// Vanilla's biome filter only admits a feature already in that biome's list. An
// authored page intentionally adds it, so preserve all other vanilla placement rules.
Holder<ConfiguredFeature<?, ?>> configured = vanilla.feature();
if (choice.material().isPresent()) {
var material = BuiltInRegistries.BLOCK.get(choice.material().orElseThrow()).defaultBlockState();
if (AgeFeatureSelection.isRock(choice.id())) {
configured = Holder.direct(new ConfiguredFeature<>(Feature.FOREST_ROCK,
new BlockStateConfiguration(material)));
} else if (AgeFeatureSelection.isLake(choice.id())) {
configured = Holder.direct(new ConfiguredFeature<>(Feature.LAKE,
new LakeFeature.Configuration(BlockStateProvider.simple(material),
BlockStateProvider.simple(Blocks.STONE))));
}
}
PlacedFeature authored = new PlacedFeature(configured, vanilla.placement().stream()
.filter(modifier -> !(modifier instanceof BiomeFilter))
.map(modifier -> AgeFeatureSelection.isLake(choice.id())
&& !choice.id().getPath().equals("deep_lakes")
&& modifier instanceof RarityFilter
? RarityFilter.onAverageOnceEvery(12) : modifier)
.toList());
long seed = ageSeed ^ (long) x * 341873128712L ^ (long) z * 132897987541L
^ (long) choice.hashCode() * 0x9E3779B97F4A7C15L;
authored.place(level, this, RandomSource.create(seed), origin);
}
}
}
@@ -0,0 +1,112 @@
package net.dnorberg.rivencraft.world;
import com.mojang.serialization.MapCodec;
import com.mojang.serialization.codecs.RecordCodecBuilder;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.stream.Stream;
import net.minecraft.Util;
import net.minecraft.core.BlockPos;
import net.minecraft.core.Holder;
import net.minecraft.core.HolderLookup;
import net.minecraft.core.HolderSet;
import net.minecraft.server.level.WorldGenRegion;
import net.minecraft.world.level.LevelHeightAccessor;
import net.minecraft.world.level.NoiseColumn;
import net.minecraft.world.level.StructureManager;
import net.minecraft.world.level.biome.BiomeManager;
import net.minecraft.world.level.biome.BiomeSource;
import net.minecraft.world.level.block.Blocks;
import net.minecraft.world.level.block.state.BlockState;
import net.minecraft.world.level.chunk.ChunkAccess;
import net.minecraft.world.level.chunk.ChunkGenerator;
import net.minecraft.world.level.chunk.ChunkGeneratorStructureState;
import net.minecraft.world.level.levelgen.GenerationStep;
import net.minecraft.world.level.levelgen.Heightmap;
import net.minecraft.world.level.levelgen.RandomState;
import net.minecraft.world.level.levelgen.blending.Blender;
import net.minecraft.world.level.levelgen.flat.FlatLevelGeneratorSettings;
import net.minecraft.world.level.levelgen.structure.StructureSet;
/** Vanilla flat layers with a serializable authored biome source instead of a fixed biome. */
public final class AgeFlatChunkGenerator extends ChunkGenerator {
public static final MapCodec<AgeFlatChunkGenerator> CODEC = RecordCodecBuilder.mapCodec(instance ->
instance.group(BiomeSource.CODEC.fieldOf("biome_source").forGetter(generator -> generator.biomeSource),
FlatLevelGeneratorSettings.CODEC.fieldOf("settings").forGetter(AgeFlatChunkGenerator::settings))
.apply(instance, AgeFlatChunkGenerator::new));
private final FlatLevelGeneratorSettings settings;
public AgeFlatChunkGenerator(BiomeSource biomeSource, FlatLevelGeneratorSettings settings) {
super(biomeSource, Util.memoize(settings::adjustGenerationSettings));
this.settings = settings;
}
public FlatLevelGeneratorSettings settings() { return settings; }
@Override
protected MapCodec<? extends ChunkGenerator> codec() { return CODEC; }
@Override
public ChunkGeneratorStructureState createState(HolderLookup<StructureSet> structures, RandomState random, long seed) {
Stream<Holder<StructureSet>> entries = settings.structureOverrides()
.map(HolderSet::stream)
.orElseGet(() -> structures.listElements().map(holder -> (Holder<StructureSet>) holder));
return ChunkGeneratorStructureState.createForFlat(random, seed, biomeSource, entries);
}
@Override
public void buildSurface(WorldGenRegion level, StructureManager structures, RandomState random, ChunkAccess chunk) { }
@Override
public int getSpawnHeight(LevelHeightAccessor level) {
return level.getMinBuildHeight() + Math.min(level.getHeight(), settings.getLayers().size());
}
@Override
public CompletableFuture<ChunkAccess> fillFromNoise(Blender blender, RandomState random,
StructureManager structures, ChunkAccess chunk) {
List<BlockState> layers = settings.getLayers();
BlockPos.MutableBlockPos position = new BlockPos.MutableBlockPos();
Heightmap floor = chunk.getOrCreateHeightmapUnprimed(Heightmap.Types.OCEAN_FLOOR_WG);
Heightmap surface = chunk.getOrCreateHeightmapUnprimed(Heightmap.Types.WORLD_SURFACE_WG);
for (int i = 0; i < Math.min(chunk.getHeight(), layers.size()); i++) {
BlockState state = layers.get(i);
if (state == null) continue;
int y = chunk.getMinBuildHeight() + i;
for (int x = 0; x < 16; x++) {
for (int z = 0; z < 16; z++) {
chunk.setBlockState(position.set(x, y, z), state, false);
floor.update(x, y, z, state);
surface.update(x, y, z, state);
}
}
}
return CompletableFuture.completedFuture(chunk);
}
@Override
public int getBaseHeight(int x, int z, Heightmap.Types type, LevelHeightAccessor level, RandomState random) {
List<BlockState> layers = settings.getLayers();
for (int i = Math.min(layers.size(), level.getHeight()) - 1; i >= 0; i--) {
BlockState state = layers.get(i);
if (state != null && type.isOpaque().test(state)) return level.getMinBuildHeight() + i + 1;
}
return level.getMinBuildHeight();
}
@Override
public NoiseColumn getBaseColumn(int x, int z, LevelHeightAccessor level, RandomState random) {
return new NoiseColumn(level.getMinBuildHeight(), settings.getLayers().stream()
.limit(level.getHeight()).map(state -> state == null ? Blocks.AIR.defaultBlockState() : state)
.toArray(BlockState[]::new));
}
@Override public void addDebugScreenInfo(List<String> info, RandomState random, BlockPos position) { }
@Override public void applyCarvers(WorldGenRegion level, long seed, RandomState random, BiomeManager biomes,
StructureManager structures, ChunkAccess chunk, GenerationStep.Carving step) { }
@Override public void spawnOriginalMobs(WorldGenRegion level) { }
@Override public int getMinY() { return 0; }
@Override public int getGenDepth() { return 384; }
@Override public int getSeaLevel() { return -63; }
}
@@ -24,8 +24,8 @@ public final class ScaledBiomeSource extends BiomeSource {
private final int cellWidth;
public ScaledBiomeSource(HolderSet<Biome> biomes, long seed, int scale) {
if (biomes.size() < 3) {
throw new IllegalArgumentException("Scaled biome distributions require at least three biomes");
if (biomes.size() < 2) {
throw new IllegalArgumentException("Scaled biome distributions require at least two biomes");
}
this.biomes = biomes;
this.seed = seed;
@@ -0,0 +1,64 @@
package net.dnorberg.rivencraft.writing;
import java.util.Arrays;
import java.util.Locale;
import java.util.Optional;
import net.dnorberg.rivencraft.Rivencraft;
import net.minecraft.resources.ResourceLocation;
/** Registry-derived pages for biomes without hand-authored symbol JSON. */
public final class BiomeSymbolPages {
private static final ResourceLocation CATEGORY = ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "biome");
private BiomeSymbolPages() { }
public static ResourceLocation symbolId(ResourceLocation biomeId) {
// Preserve old vanilla page IDs, while keeping modded namespaces distinct.
return ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "biome/"
+ (biomeId.getNamespace().equals("minecraft") ? "" : biomeId.getNamespace() + "/")
+ biomeId.getPath());
}
public static ResourceLocation biomeId(ResourceLocation symbolId) {
String path = symbolId.getPath();
if (!symbolId.getNamespace().equals(Rivencraft.MOD_ID) || !path.startsWith("biome/"))
throw new IllegalArgumentException("Not a biome symbol: " + symbolId);
path = path.substring("biome/".length());
int separator = path.indexOf('/');
return separator < 0 ? ResourceLocation.withDefaultNamespace(path)
: ResourceLocation.fromNamespaceAndPath(path.substring(0, separator), path.substring(separator + 1));
}
public static SymbolDefinition definition(ResourceLocation biomeId) {
String path = biomeId.getPath();
String glyphWord = Arrays.stream(path.split("_"))
.map(part -> part.replaceAll("[^A-Za-z]", ""))
.filter(part -> !part.isEmpty())
.map(part -> part.substring(0, 1).toUpperCase(Locale.ROOT) + part.substring(1))
.reduce("", String::concat);
if (glyphWord.isEmpty()) glyphWord = "World";
if (glyphWord.length() > 48) glyphWord = glyphWord.substring(0, 48);
return new SymbolDefinition(SymbolDefinition.CURRENT_SCHEMA_VERSION,
biomeId.getNamespace().equals("minecraft")
? "symbol.rivencraft.biome." + path
: "biome." + biomeId.getNamespace() + "." + path.replace('/', '.'),
"symbol.rivencraft.biome.generated.description",
CATEGORY,
Optional.of(new SymbolSemantics(SymbolSemantics.Role.BIOME,
new SymbolSemantics.ResourceValue(biomeId))),
"Nature Form " + glyphWord + " Biome");
}
public static String fallbackName(ResourceLocation symbolId) {
String path = symbolId.getPath().substring("biome/".length());
int separator = path.indexOf('/');
String namespace = separator < 0 ? "" : path.substring(0, separator);
if (separator >= 0) path = path.substring(separator + 1);
String label = path.replace('/', '_');
String name = Arrays.stream(label.split("_"))
.filter(part -> !part.isEmpty())
.map(part -> part.substring(0, 1).toUpperCase(Locale.ROOT) + part.substring(1))
.reduce((left, right) -> left + " " + right).orElse("Unknown") + " Biome";
return namespace.isEmpty() ? name : name + " (" + namespace + ")";
}
}
@@ -0,0 +1,97 @@
package net.dnorberg.rivencraft.writing;
import java.util.Arrays;
import java.util.Locale;
import java.util.Optional;
import net.dnorberg.rivencraft.Rivencraft;
import net.minecraft.core.BlockPos;
import net.minecraft.core.registries.BuiltInRegistries;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.level.EmptyBlockGetter;
import net.minecraft.world.level.block.Block;
import net.minecraft.world.level.block.Blocks;
import net.minecraft.world.level.block.EntityBlock;
import net.minecraft.world.level.block.state.BlockState;
/** Registry-derived material pages; binding validates the material for its consumer. */
public final class BlockSymbolPages {
public static final ResourceLocation CATEGORY = ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "block");
public static final ResourceLocation FLUID_CATEGORY = ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "fluid");
private BlockSymbolPages() {}
public static ResourceLocation symbolId(ResourceLocation blockId) {
return ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID,
"block/" + blockId.getNamespace() + "/" + blockId.getPath());
}
public static ResourceLocation blockId(ResourceLocation symbolId) {
String path = symbolId.getPath();
if (!path.startsWith("block/")) return null;
String rest = path.substring("block/".length());
int separator = rest.indexOf('/');
return separator < 1 ? null : ResourceLocation.tryParse(
rest.substring(0, separator) + ":" + rest.substring(separator + 1));
}
public static java.util.List<ResourceLocation> availableBlocks() {
return BuiltInRegistries.BLOCK.keySet().stream()
.filter(id -> isRockMaterial(BuiltInRegistries.BLOCK.get(id))
|| isFluidMaterial(BuiltInRegistries.BLOCK.get(id)))
.sorted().toList();
}
public static java.util.List<ResourceLocation> availableBlocks(ResourceLocation category) {
if (!category.equals(CATEGORY) && !category.equals(FLUID_CATEGORY)) return java.util.List.of();
return availableBlocks().stream().filter(id -> category(id).equals(category)).toList();
}
public static ResourceLocation category(ResourceLocation blockId) {
return isFluidMaterial(BuiltInRegistries.BLOCK.get(blockId)) ? FLUID_CATEGORY : CATEGORY;
}
public static boolean isRockMaterial(Block block) {
if (excluded(block)) return false;
BlockState state = block.defaultBlockState();
return state.getFluidState().isEmpty()
&& state.isCollisionShapeFullBlock(EmptyBlockGetter.INSTANCE, BlockPos.ZERO);
}
public static boolean isFluidMaterial(Block block) {
if (excluded(block)) return false;
var fluid = block.defaultBlockState().getFluidState();
// A waterlogged coral or seagrass block contains water, but is not a fluid block.
return fluid.isSource() && fluid.createLegacyBlock().getBlock() == block;
}
private static boolean excluded(Block block) {
return block == Blocks.AIR || block == Blocks.CAVE_AIR || block == Blocks.VOID_AIR
|| block instanceof EntityBlock || block.defaultBlockState().hasBlockEntity();
}
public static SymbolDefinition definition(ResourceLocation blockId) {
String path = blockId.getPath().replace('/', '_');
String word = Arrays.stream(path.split("_"))
.map(part -> part.replaceAll("[^A-Za-z]", ""))
.filter(part -> !part.isEmpty())
.map(part -> part.substring(0, 1).toUpperCase(Locale.ROOT) + part.substring(1))
.reduce("", String::concat);
if (word.isEmpty()) word = "Stone";
// A modded registry path can be arbitrarily long; poems have a bounded codec.
if (word.length() > 48) word = word.substring(0, 48);
return new SymbolDefinition(SymbolDefinition.CURRENT_SCHEMA_VERSION,
"block." + blockId.getNamespace() + "." + path,
"symbol.rivencraft.block.generated.description", category(blockId),
Optional.of(new SymbolSemantics(SymbolSemantics.Role.BLOCK,
new SymbolSemantics.ResourceValue(blockId))),
"Modifier Constraint " + word + " Form");
}
public static String fallbackName(ResourceLocation blockId) {
return Arrays.stream(blockId.getPath().replace('/', '_').split("_"))
.filter(part -> !part.isEmpty())
.map(part -> part.substring(0, 1).toUpperCase(Locale.ROOT) + part.substring(1))
.reduce((left, right) -> left + " " + right).orElse("Unknown")
+ (category(blockId).equals(FLUID_CATEGORY) ? " Fluid" : " Material");
}
}
@@ -0,0 +1,33 @@
package net.dnorberg.rivencraft.writing;
import java.util.List;
import net.dnorberg.rivencraft.book.LinkProperties;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items;
/** Built-in Legacy ink additives. Optional mod dusts will be mapped through tags separately. */
public final class InkModifierIngredients {
public record Effect(int flag, double chance) {}
public record Ingredient(ItemStack item, List<Effect> effects) {}
private static final List<Ingredient> BUILT_IN = List.of(
new Ingredient(new ItemStack(Items.GUNPOWDER), List.of(new Effect(LinkProperties.DISARM, 0.20))),
new Ingredient(new ItemStack(Items.MUSHROOM_STEW), List.of(new Effect(LinkProperties.DISARM, 0.05))),
new Ingredient(new ItemStack(Items.EXPERIENCE_BOTTLE), List.of(new Effect(LinkProperties.INTRA_LINKING, 0.15))),
new Ingredient(new ItemStack(Items.ENDER_PEARL), List.of(
new Effect(LinkProperties.INTRA_LINKING, 0.15),
new Effect(LinkProperties.DISARM, 0.15))),
new Ingredient(new ItemStack(Items.FEATHER), List.of(new Effect(LinkProperties.MAINTAIN_MOMENTUM, 0.15))),
new Ingredient(new ItemStack(Items.FIRE_CHARGE), List.of(new Effect(LinkProperties.DISARM, 0.25)))
);
private InkModifierIngredients() {}
public static List<Ingredient> builtIn() {
return BUILT_IN;
}
public static Ingredient find(ItemStack stack) {
return BUILT_IN.stream().filter(ingredient -> stack.is(ingredient.item().getItem())).findFirst().orElse(null);
}
}
@@ -1,6 +1,7 @@
package net.dnorberg.rivencraft.writing;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.registry.ModRecipeSerializers;
import net.minecraft.core.HolderLookup;
@@ -50,11 +51,13 @@ public final class LinkingBookRecipe extends CustomRecipe {
ItemStack panel = findPanel(input);
if (panel.isEmpty()) return ItemStack.EMPTY;
ItemStack book = new ItemStack(ModItems.LINKING_BOOK.get());
// Legacy copied the panel's data. Only its custom name is meaningful to a
// 1.21.1 Linking Book today; page-only components must not reach the book.
// Copy book-relevant panel data, never the Page identity component.
if (panel.has(DataComponents.CUSTOM_NAME)) {
book.set(DataComponents.CUSTOM_NAME, panel.get(DataComponents.CUSTOM_NAME));
}
if (panel.has(ModDataComponents.LINK_PROPERTIES.get())) {
book.set(ModDataComponents.LINK_PROPERTIES.get(), panel.get(ModDataComponents.LINK_PROPERTIES.get()));
}
return book;
}
@@ -8,6 +8,8 @@ import java.util.Map;
import java.util.Optional;
import net.dnorberg.rivencraft.Rivencraft;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.core.RegistryAccess;
import net.minecraft.core.registries.Registries;
import net.minecraft.server.packs.resources.ResourceManager;
import net.minecraft.server.packs.resources.SimpleJsonResourceReloadListener;
import net.minecraft.util.profiling.ProfilerFiller;
@@ -23,7 +25,7 @@ public final class SymbolCatalog {
}
public static void register(AddReloadListenerEvent event) {
event.addListener(new Loader());
event.addListener(new Loader(event.getRegistryAccess()));
}
public static Optional<SymbolDefinition> find(SymbolReference reference) {
@@ -46,8 +48,11 @@ public final class SymbolCatalog {
}
private static final class Loader extends SimpleJsonResourceReloadListener {
private Loader() {
private final RegistryAccess registries;
private Loader(RegistryAccess registries) {
super(GSON, DIRECTORY);
this.registries = registries;
}
@Override
@@ -62,6 +67,12 @@ public final class SymbolCatalog {
Rivencraft.LOGGER.error("Ignoring invalid writing symbol {}: {}", id, exception.getMessage());
}
});
registries.lookupOrThrow(Registries.BIOME).listElements()
.map(holder -> holder.key().location())
.forEach(id -> loaded.putIfAbsent(BiomeSymbolPages.symbolId(id),
BiomeSymbolPages.definition(id)));
BlockSymbolPages.availableBlocks().forEach(id -> loaded.putIfAbsent(
BlockSymbolPages.symbolId(id), BlockSymbolPages.definition(id)));
symbols = Map.copyOf(loaded);
Rivencraft.LOGGER.info("Loaded {} writing symbols", loaded.size());
}
@@ -10,6 +10,11 @@ public final class SymbolPoems {
if (!id.getNamespace().equals("rivencraft")) return "";
return switch (id.getPath()) {
case "terrain/standard" -> "Terrain Form Tradition Flow";
case "terrain/amplified" -> "Terrain Form Tradition Spur";
case "terrain/cave" -> "Terrain Transform Void Flow";
case "terrain/island" -> "Terrain Transform Form Celestial";
case "terrain/flat" -> "Terrain Form Inhibit Motion";
case "terrain/void" -> "Terrain Form Infinite Void";
case "biome/native" -> "Constraint Nature Tradition Sustain";
case "lighting/normal" -> "Ethereal Dynamic Cycle Balance";
case "weather/normal" -> "Sustain Dynamic Tradition Balance";
@@ -77,12 +77,14 @@ public record SymbolSemantics(Role role, Value value) {
"native", "single", "tiled", "grid", "tiny", "small", "medium", "large", "huge"),
BIOME("biome", Kind.RESOURCE),
LIGHTING("lighting", Kind.CHOICE, "normal", "dark", "bright"),
SKY("sky", Kind.CHOICE, "overworld", "nether", "end"),
WEATHER("weather", Kind.CHOICE,
"normal", "fast", "slow", "off", "always", "cloudy", "rain", "snow", "storm"),
CELESTIAL("celestial", Kind.CHOICE, "normal_time"),
PERIOD_MODIFIER("period_modifier", Kind.NUMBER),
ANGLE_MODIFIER("angle_modifier", Kind.NUMBER),
PHASE_MODIFIER("phase_modifier", Kind.NUMBER),
BLOCK("block", Kind.RESOURCE),
FEATURE("feature", Kind.RESOURCE);
private final String id;
@@ -0,0 +1,210 @@
package net.dnorberg.rivencraft.writing;
import java.util.ArrayList;
import java.util.EnumMap;
import java.util.HashSet;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.function.Function;
import net.dnorberg.rivencraft.writing.SymbolSemantics.ChoiceValue;
import net.dnorberg.rivencraft.writing.SymbolSemantics.Role;
import net.minecraft.resources.ResourceLocation;
/** Server-owned interpretation of ordered writing; compilation belongs to the next release slice. */
public final class WritingGrammar {
// A newly assembled book has one Link Panel plus at most 27 page positions.
public static final int MAX_NEW_ENTRIES = NotebookContents.MAX_PAGES + 1;
private WritingGrammar() {}
public static Result parse(OrderedWriting writing) {
return parse(writing, SymbolCatalog::find);
}
/** The resolver must be the authoritative server catalog, never page display metadata. */
public static Result parse(OrderedWriting writing,
Function<SymbolReference, Optional<SymbolDefinition>> resolver) {
Objects.requireNonNull(writing, "writing");
Objects.requireNonNull(resolver, "resolver");
List<ParsedSymbol> symbols = new ArrayList<>();
List<Diagnostic> diagnostics = new ArrayList<>();
if (writing.entries().size() > MAX_NEW_ENTRIES) {
diagnostics.add(new Diagnostic(Code.TOO_MANY, -1, "At most " + MAX_NEW_ENTRIES + " entries are allowed"));
return new Result(symbols, diagnostics);
}
if (writing.entries().isEmpty()) return new Result(symbols, diagnostics);
EnumMap<Role, ParsedSymbol> singular = new EnumMap<>(Role.class);
Set<ResourceLocation> features = new HashSet<>();
int panels = 0;
int lastStage = -1;
int biomeCount = 0;
ParsedSymbol pendingBlock = null;
for (int index = 0; index < writing.entries().size(); index++) {
WritingEntry entry = writing.entries().get(index);
if (entry.kind() == WritingEntry.Kind.LINK_PANEL) {
panels++;
if (panels > 1) diagnostics.add(new Diagnostic(Code.DUPLICATE_PANEL, index,
"Use exactly one Link Panel"));
else if (index != 0) diagnostics.add(new Diagnostic(Code.PANEL_ORDER, index,
"Move the Link Panel to the first position"));
continue;
}
SymbolReference reference = entry.symbol().orElseThrow();
Optional<SymbolDefinition> definition = resolver.apply(reference);
if (definition.isEmpty()) {
diagnostics.add(new Diagnostic(Code.UNRESOLVED, index,
"Restore the data pack for " + reference.id() + " or remove this page"));
continue;
}
Optional<SymbolSemantics> semantics = definition.orElseThrow().semantics();
if (semantics.isEmpty()) {
diagnostics.add(new Diagnostic(Code.UNSUPPORTED, index,
"Update " + reference.id() + " to semantic schema v2 or remove this page"));
continue;
}
Role role = semantics.orElseThrow().role();
ParsedSymbol parsed = new ParsedSymbol(index, reference, semantics.orElseThrow());
symbols.add(parsed);
if (pendingBlock != null && role != Role.FEATURE) {
diagnostics.add(new Diagnostic(Code.MISPLACED_MODIFIER, pendingBlock.index(),
"Place this material page immediately before a compatible feature"));
pendingBlock = null;
}
if (role == Role.BLOCK) {
pendingBlock = parsed;
} else if (role == Role.FEATURE && pendingBlock != null) {
ResourceLocation feature = ((SymbolSemantics.ResourceValue) parsed.semantics().value()).id();
if (!Set.of("rocks", "surface_lakes", "deep_lakes", "lava_lakes")
.contains(feature.getPath()) || !feature.getNamespace().equals("rivencraft")) {
diagnostics.add(new Diagnostic(Code.MISPLACED_MODIFIER, pendingBlock.index(),
"This feature cannot consume a material page"));
}
pendingBlock = null;
}
if (role == Role.ANGLE_MODIFIER || role == Role.WEATHER
&& parsed.semantics().value() instanceof ChoiceValue choice
&& Set.of("snow", "cloudy", "rain").contains(choice.id())) {
diagnostics.add(new Diagnostic(Code.UNSUPPORTED_ENVIRONMENT, index,
"This environment effect needs renderer or precipitation support"));
}
if (singular(role)) {
ParsedSymbol previous = singular.putIfAbsent(role, parsed);
if (previous != null) {
Code code = previous.semantics().value().equals(parsed.semantics().value())
? Code.DUPLICATE : Code.CONFLICT;
diagnostics.add(new Diagnostic(code, index,
"Remove this " + role.id() + " page; position " + (previous.index() + 1)
+ " already supplies that category"));
continue;
}
} else if (role == Role.FEATURE && !features.add(reference.id())) {
diagnostics.add(new Diagnostic(Code.DUPLICATE, index,
"Remove the repeated feature page " + reference.id()));
continue;
}
if (role == Role.BIOME) biomeCount++;
int stage = stage(role);
if (stage < lastStage) {
diagnostics.add(new Diagnostic(modifier(role) ? Code.MISPLACED_MODIFIER : Code.OUT_OF_ORDER,
index, "Move this " + role.id() + " page before later grammar categories"));
} else {
lastStage = stage;
}
}
if (pendingBlock != null) diagnostics.add(new Diagnostic(Code.MISPLACED_MODIFIER, pendingBlock.index(),
"Place this material page immediately before a compatible feature"));
if (panels == 0) diagnostics.add(new Diagnostic(Code.MISSING_PANEL, -1,
"Add a Link Panel as the first page"));
if (symbols.isEmpty()) return new Result(symbols, diagnostics);
ParsedSymbol controller = singular.get(Role.BIOME_CONTROLLER);
if (controller != null && controller.semantics().value() instanceof ChoiceValue choice
&& choice.id().equals("native") && biomeCount > 0) {
diagnostics.add(new Diagnostic(Code.CONFLICT, controller.index(),
"Native biome distribution cannot use authored biome pages"));
} else if (controller != null && controller.semantics().value() instanceof ChoiceValue choice
&& choice.id().equals("single") && biomeCount > 1) {
diagnostics.add(new Diagnostic(Code.CONFLICT, controller.index(),
"Single-biome distribution accepts only one authored biome page"));
}
for (Role required : List.of(Role.TERRAIN, Role.BIOME_CONTROLLER, Role.WEATHER,
Role.LIGHTING, Role.CELESTIAL)) {
if (!singular.containsKey(required)) diagnostics.add(new Diagnostic(Code.INCOMPLETE, -1,
"The Age compiler will fill the missing " + required.id() + " branch from the Age seed"));
}
if (controller != null && controller.semantics().value() instanceof ChoiceValue choice) {
int minimum = switch (choice.id()) {
case "single" -> 1;
case "tiled", "grid" -> 2;
case "native" -> 0;
default -> 2;
};
if (biomeCount < minimum) diagnostics.add(new Diagnostic(Code.INCOMPLETE, -1,
"The Age compiler will fill " + (minimum - biomeCount) + " missing biome page(s)"));
}
return new Result(symbols, diagnostics);
}
private static boolean singular(Role role) {
return switch (role) {
case TERRAIN, BIOME_CONTROLLER, WEATHER, LIGHTING, SKY, CELESTIAL -> true;
default -> false;
};
}
private static boolean modifier(Role role) {
return role == Role.PERIOD_MODIFIER || role == Role.ANGLE_MODIFIER || role == Role.PHASE_MODIFIER;
}
private static int stage(Role role) {
return switch (role) {
case TERRAIN -> 0;
case BIOME -> 1;
case BIOME_CONTROLLER -> 2;
case WEATHER -> 3;
case LIGHTING -> 4;
case SKY -> 5;
case PERIOD_MODIFIER, ANGLE_MODIFIER, PHASE_MODIFIER -> 6;
case CELESTIAL -> 7;
case BLOCK, FEATURE -> 8;
};
}
public enum Code {
TOO_MANY, MISSING_PANEL, PANEL_ORDER, DUPLICATE_PANEL, UNRESOLVED, UNSUPPORTED,
DUPLICATE, CONFLICT, OUT_OF_ORDER, MISPLACED_MODIFIER, INCOMPLETE, UNSUPPORTED_PROFILE,
UNKNOWN_BIOME, UNSUPPORTED_BIOME, UNSUPPORTED_ENVIRONMENT, UNSUPPORTED_FEATURE
}
public record Diagnostic(Code code, int index, String message) {
public Diagnostic {
Objects.requireNonNull(code, "code");
Objects.requireNonNull(message, "message");
}
public boolean error() { return code != Code.INCOMPLETE; }
}
public record ParsedSymbol(int index, SymbolReference reference, SymbolSemantics semantics) {
public ParsedSymbol {
Objects.requireNonNull(reference, "reference");
Objects.requireNonNull(semantics, "semantics");
}
}
public record Result(List<ParsedSymbol> symbols, List<Diagnostic> diagnostics) {
public Result {
symbols = List.copyOf(symbols);
diagnostics = List.copyOf(diagnostics);
}
public boolean randomFallback() { return symbols.isEmpty() && diagnostics.isEmpty(); }
public boolean canCreate() { return diagnostics.stream().noneMatch(Diagnostic::error); }
public Optional<Diagnostic> firstError() { return diagnostics.stream().filter(Diagnostic::error).findFirst(); }
}
}
@@ -10,7 +10,10 @@
"item.rivencraft.page.blank": "Blank Page",
"item.rivencraft.page.blank.description": "Ready for writing at a Writing Desk.",
"item.rivencraft.page.link_panel": "Link Panel Page",
"item.rivencraft.page.link_panel.description": "The baseline panel required to assemble a Descriptive Book.",
"item.rivencraft.page.link_panel.description": "A Link Panel for assembling books.",
"item.rivencraft.link_property.disarm": "Disarm",
"item.rivencraft.link_property.maintain_momentum": "Maintain Momentum",
"item.rivencraft.link_property.intra_linking": "Intra Linking",
"item.rivencraft.page.unresolved": "Unresolved Symbol Page",
"item.rivencraft.notebook": "Notebook",
"item.rivencraft.notebook.pages": "Pages: %s/%s",
@@ -23,6 +26,8 @@
"block.rivencraft.ink_mixer": "Ink Mixer",
"container.rivencraft.ink_mixer": "Ink Mixer",
"screen.rivencraft.ink_mixer.ink": "Ink: %s/%s",
"screen.rivencraft.ink_mixer.additive_hint": "Click the basin with an additive; right-click adds one.",
"screen.rivencraft.ink_mixer.chance": "%s: %s%%",
"screen.rivencraft.book_binder.title": "Book title",
"screen.rivencraft.book_binder.title_hint": "Name the book",
"screen.rivencraft.book_binder.missing_panel": "Link Panel required as the first page",
@@ -34,6 +39,18 @@
"screen.rivencraft.book_binder.previous_pages": "Scroll pages left (Left Arrow)",
"screen.rivencraft.book_binder.next_pages": "Scroll pages right (Right Arrow)",
"screen.rivencraft.book_binder.select_hint": "Right-click page to select",
"screen.rivencraft.book_binder.grammar.too_many": "Too many pages for a new Age; remove excess pages",
"screen.rivencraft.book_binder.grammar.missing_panel": "Add a Link Panel as the first page",
"screen.rivencraft.book_binder.grammar.panel_order": "Page %s: move the Link Panel to the first position",
"screen.rivencraft.book_binder.grammar.duplicate_panel": "Page %s: remove the extra Link Panel",
"screen.rivencraft.book_binder.grammar.unresolved": "Page %s: missing symbol definition; restore its data pack or remove it",
"screen.rivencraft.book_binder.grammar.unsupported": "Page %s: this symbol needs semantic schema v2; update its data pack or remove it",
"screen.rivencraft.book_binder.grammar.unsupported_profile": "Page %s: its Age profile is unavailable; restore the data pack or remove this page",
"screen.rivencraft.book_binder.grammar.unsupported_environment": "Page %s: this weather or sky effect is not supported yet",
"screen.rivencraft.book_binder.grammar.duplicate": "Page %s: remove the duplicate symbol",
"screen.rivencraft.book_binder.grammar.conflict": "Page %s: replace the conflicting symbol",
"screen.rivencraft.book_binder.grammar.out_of_order": "Page %s: move this symbol before later categories",
"screen.rivencraft.book_binder.grammar.misplaced_modifier": "Page %s: move this modifier before its celestial page",
"screen.rivencraft.writing_desk.ink": "Ink: %s/%s",
"screen.rivencraft.writing_desk.search": "Search",
"screen.rivencraft.writing_desk.sort": "Sort pages by name (A–Z)",
@@ -55,9 +72,11 @@
"message.rivencraft.linking_book.linked": "Linked",
"message.rivencraft.linking_book.missing_dimension": "That dimension is unavailable",
"message.rivencraft.linking_book.unsafe": "No safe destination was found near the link",
"message.rivencraft.linking_book.intra_required": "This book needs an Intra Linking panel for same-dimension travel",
"message.rivencraft.descriptive_book.unwritten": "This Descriptive Book is unwritten",
"message.rivencraft.descriptive_book.created": "Created Age: %s",
"message.rivencraft.descriptive_book.unavailable": "That Age is unavailable",
"message.rivencraft.descriptive_book.invalid_writing": "Writing cannot create an Age: %s",
"message.rivencraft.descriptive_book.unsafe": "No safe destination was found in that Age",
"message.rivencraft.descriptive_book.linked_first": "Linked to %s — a Return Link was created",
"message.rivencraft.descriptive_book.linked": "Linked to %s",
@@ -75,7 +94,6 @@
"screen.rivencraft.age.pages": "Pages",
"screen.rivencraft.age.details": "Details",
"screen.rivencraft.age.pages_count": "Writing %s/%s",
"screen.rivencraft.age.pages_not_applied": "Symbols not applied yet",
"screen.rivencraft.age.trait.biomes": "Biomes: %s",
"screen.rivencraft.age.trait.lighting": "Lighting: %s",
"screen.rivencraft.age.trait.weather": "Weather: %s",
@@ -108,16 +126,112 @@
"symbol.rivencraft.unresolved.description": "Missing symbol: %s",
"symbol.rivencraft.terrain.standard": "Standard Terrain",
"symbol.rivencraft.terrain.standard.description": "A familiar continental terrain foundation.",
"symbol.rivencraft.terrain.amplified": "Amplified Terrain",
"symbol.rivencraft.terrain.amplified.description": "Tall, sharply varied Overworld terrain.",
"symbol.rivencraft.terrain.cave": "Cave Terrain",
"symbol.rivencraft.terrain.cave.description": "An enclosed cave-shaped world with a sheltered arrival.",
"symbol.rivencraft.terrain.island": "Island Terrain",
"symbol.rivencraft.terrain.island.description": "Floating-island terrain above the void.",
"symbol.rivencraft.terrain.flat": "Flat Terrain",
"symbol.rivencraft.terrain.flat.description": "A level Overworld-style landscape.",
"symbol.rivencraft.terrain.void": "Void Terrain",
"symbol.rivencraft.terrain.void.description": "An empty world with a safe arrival platform.",
"symbol.rivencraft.biome.native": "Native Biomes",
"symbol.rivencraft.biome.native.description": "Use the terrain profile's native biome climate.",
"symbol.rivencraft.biome.the_end": "The End Biome",
"symbol.rivencraft.biome.the_end.description": "Use the End biome in a written Age, including sky islands.",
"symbol.rivencraft.biome.lush_caves": "Lush Caves Biome",
"symbol.rivencraft.biome.lush_caves.description": "Add lush cave regions to a cave Age.",
"symbol.rivencraft.biome.dripstone_caves": "Dripstone Caves Biome",
"symbol.rivencraft.biome.dripstone_caves.description": "Add dripstone cave regions to a cave Age.",
"symbol.rivencraft.biome.deep_dark": "Deep Dark Biome",
"symbol.rivencraft.biome.deep_dark.description": "Add deep dark regions to a cave Age.",
"symbol.rivencraft.biome.nether_wastes": "Nether Wastes Biome",
"symbol.rivencraft.biome.nether_wastes.description": "Add Nether Wastes regions to a cave Age.",
"symbol.rivencraft.biome.plains": "Plains Biome",
"symbol.rivencraft.biome.plains.description": "Add plains regions to a written Age.",
"symbol.rivencraft.biome.forest": "Forest Biome",
"symbol.rivencraft.biome.forest.description": "Add forest regions to a written Age.",
"symbol.rivencraft.biome.desert": "Desert Biome",
"symbol.rivencraft.biome.desert.description": "Add desert regions to a written Age.",
"symbol.rivencraft.biome.generated.description": "Selects this biome for a written Age.",
"symbol.rivencraft.biome.single": "Single Biome",
"symbol.rivencraft.biome.single.description": "Use one biome across the Age.",
"symbol.rivencraft.biome.tiled": "Tiled Biomes",
"symbol.rivencraft.biome.tiled.description": "Alternate selected biomes in large tiles.",
"symbol.rivencraft.biome.grid": "Grid Biomes",
"symbol.rivencraft.biome.grid.description": "Alternate selected biomes in smaller grid cells.",
"symbol.rivencraft.biome.tiny": "Tiny Biome Regions",
"symbol.rivencraft.biome.tiny.description": "Distribute selected biomes in tiny regions.",
"symbol.rivencraft.biome.small": "Small Biome Regions",
"symbol.rivencraft.biome.small.description": "Distribute selected biomes in small regions.",
"symbol.rivencraft.biome.medium": "Medium Biome Regions",
"symbol.rivencraft.biome.medium.description": "Distribute selected biomes in medium regions.",
"symbol.rivencraft.biome.large": "Large Biome Regions",
"symbol.rivencraft.biome.large.description": "Distribute selected biomes in large regions.",
"symbol.rivencraft.biome.huge": "Huge Biome Regions",
"symbol.rivencraft.biome.huge.description": "Distribute selected biomes in huge regions.",
"symbol.rivencraft.lighting.normal": "Normal Lighting",
"symbol.rivencraft.lighting.normal.description": "Use normal skylight and ambient brightness.",
"symbol.rivencraft.lighting.dark": "Dark Lighting",
"symbol.rivencraft.lighting.dark.description": "Remove skylight from this Age.",
"symbol.rivencraft.lighting.bright": "Bright Lighting",
"symbol.rivencraft.lighting.bright.description": "Increase this Age's ambient brightness.",
"symbol.rivencraft.sky.overworld": "Overworld Sky",
"symbol.rivencraft.sky.overworld.description": "Use the Overworld sky and biome sky tint.",
"symbol.rivencraft.sky.nether": "Nether Sky",
"symbol.rivencraft.sky.nether.description": "Use the Nether sky and red preview background.",
"symbol.rivencraft.sky.end": "End Sky",
"symbol.rivencraft.sky.end.description": "Use the End sky and dark preview background.",
"symbol.rivencraft.weather.normal": "Normal Weather",
"symbol.rivencraft.weather.normal.description": "Use the normal weather cycle.",
"symbol.rivencraft.weather.fast": "Fast Weather",
"symbol.rivencraft.weather.fast.description": "Change weather more quickly.",
"symbol.rivencraft.weather.slow": "Slow Weather",
"symbol.rivencraft.weather.slow.description": "Change weather more slowly.",
"symbol.rivencraft.weather.off": "No Weather",
"symbol.rivencraft.weather.off.description": "Keep the Age clear.",
"symbol.rivencraft.weather.always": "Always Weather",
"symbol.rivencraft.weather.always.description": "Keep the Age rainy.",
"symbol.rivencraft.weather.storm": "Storm Weather",
"symbol.rivencraft.weather.storm.description": "Keep the Age rainy and thundering.",
"symbol.rivencraft.celestial.normal_time": "Normal Time",
"symbol.rivencraft.celestial.normal_time.description": "Use a normal-length celestial cycle.",
"symbol.rivencraft.period.zero": "Zero Length",
"symbol.rivencraft.period.zero.description": "Stop the celestial cycle at its written phase.",
"symbol.rivencraft.period.half": "Half Length",
"symbol.rivencraft.period.half.description": "Use a half-length celestial cycle.",
"symbol.rivencraft.period.full": "Full Length",
"symbol.rivencraft.period.full.description": "Use a normal-length celestial cycle.",
"symbol.rivencraft.period.double": "Double Length",
"symbol.rivencraft.period.double.description": "Use a double-length celestial cycle.",
"symbol.rivencraft.phase.nadir": "Nadir Phase",
"symbol.rivencraft.phase.nadir.description": "Set the celestial phase to nadir.",
"symbol.rivencraft.phase.rising": "Rising Phase",
"symbol.rivencraft.phase.rising.description": "Set the celestial phase to rising.",
"symbol.rivencraft.phase.zenith": "Zenith Phase",
"symbol.rivencraft.phase.zenith.description": "Set the celestial phase to zenith.",
"symbol.rivencraft.phase.setting": "Setting Phase",
"symbol.rivencraft.phase.setting.description": "Set the celestial phase to setting.",
"symbol.rivencraft.feature.caves": "Caves",
"symbol.rivencraft.feature.caves.description": "Describe underground cave features.",
"symbol.rivencraft.feature.caves.description": "Add extra caves to the chosen noise terrain.",
"symbol.rivencraft.block.generated.description": "Material modifier; place immediately before a compatible feature page.",
"symbol.rivencraft.feature.flowers": "Flowers",
"symbol.rivencraft.feature.flowers.description": "Add vanilla flower patches to surface terrain.",
"symbol.rivencraft.feature.trees": "Trees",
"symbol.rivencraft.feature.trees.description": "Add vanilla plains trees to surface terrain.",
"symbol.rivencraft.feature.rocks": "Rocks",
"symbol.rivencraft.feature.rocks.description": "Add boulders using a random solid material, or specify one with a block page.",
"symbol.rivencraft.feature.huge_trees": "Huge Trees",
"symbol.rivencraft.feature.huge_trees.description": "Add vanilla old-growth spruce trees to surface terrain.",
"symbol.rivencraft.feature.surface_lakes": "Surface Lakes",
"symbol.rivencraft.feature.surface_lakes.description": "Add surface lakes using a random fluid, or specify one with a fluid page.",
"symbol.rivencraft.feature.deep_lakes": "Deep Lakes",
"symbol.rivencraft.feature.deep_lakes.description": "Add underground lakes using a random fluid, or specify one with a fluid page.",
"symbol.rivencraft.feature.ravines": "Ravines",
"symbol.rivencraft.feature.ravines.description": "Add vanilla canyon carving to noise terrain.",
"symbol.rivencraft.feature.lava_lakes": "Small Lakes",
"symbol.rivencraft.feature.lava_lakes.description": "Add small surface lakes using a random fluid, or specify one with a fluid page.",
"generator.rivencraft.standard": "Standard",
"generator.rivencraft.amplified": "Amplified",
"generator.rivencraft.island": "Island",
@@ -135,9 +249,22 @@
"jei.rivencraft.writing.link_panel_hand": "Hold paper and an Ink Vial in opposite hands; use the vial to make a Link Panel.",
"jei.rivencraft.ink_mixer": "Ink Mixer",
"jei.rivencraft.ink_mixer.usage": "Paper + ink makes a Link Panel. One vial fills 16 ink; each panel uses the configured ink cost. The empty vial returns as a glass bottle.",
"jei.rivencraft.ink_mixer.additive": "Click this additive into the ink basin: %s. Effects roll when the panel is taken.",
"jei.rivencraft.ink_mixer.effect": "%s %s%%",
"jei.rivencraft.writing.copy": "At a Writing Desk, select a stored Page, add paper and ink, then take the copy. The source Page stays.",
"jei.rivencraft.writing.bind": "At a Book Binder, name the Age and add a cover plus Link Panel. Optional symbol Pages follow the panel.",
"jei.rivencraft.writing.linking_book": "Craft one Link Panel Page with leather to make an unwritten Linking Book. Open it to name and bind it.",
"itemGroup.rivencraft": "Rivencraft",
"itemGroup.rivencraft.pages": "Rivencraft Pages"
"itemGroup.rivencraft.pages.link": "Rivencraft Link Pages",
"itemGroup.rivencraft.pages.terrain": "Rivencraft Terrain Pages",
"itemGroup.rivencraft.pages.biome": "Rivencraft Biome Pages",
"itemGroup.rivencraft.pages.cave_biome": "Rivencraft Cave Biome Pages",
"itemGroup.rivencraft.pages.biome_generation": "Rivencraft Biome Generation Pages",
"itemGroup.rivencraft.pages.weather": "Rivencraft Weather Pages",
"itemGroup.rivencraft.pages.lighting": "Rivencraft Lighting Pages",
"itemGroup.rivencraft.pages.sky": "Rivencraft Sky Pages",
"itemGroup.rivencraft.pages.celestial": "Rivencraft Celestial Pages",
"itemGroup.rivencraft.pages.block": "Rivencraft Block Pages",
"itemGroup.rivencraft.pages.fluid": "Rivencraft Fluid Pages",
"itemGroup.rivencraft.pages.feature": "Rivencraft Feature Pages"
}
@@ -0,0 +1,8 @@
{
"schema_version": 2,
"name": "symbol.rivencraft.biome.deep_dark",
"description": "symbol.rivencraft.biome.deep_dark.description",
"category": "rivencraft:biome",
"semantics": { "role": "biome", "value": "minecraft:deep_dark" },
"poem": "Dark Cavern Silence Depth"
}
@@ -0,0 +1,8 @@
{
"schema_version": 2,
"name": "symbol.rivencraft.biome.desert",
"description": "symbol.rivencraft.biome.desert.description",
"category": "rivencraft:biome",
"semantics": { "role": "biome", "value": "minecraft:desert" },
"poem": "Sand Sun Heat Dry"
}
@@ -0,0 +1,8 @@
{
"schema_version": 2,
"name": "symbol.rivencraft.biome.dripstone_caves",
"description": "symbol.rivencraft.biome.dripstone_caves.description",
"category": "rivencraft:biome",
"semantics": { "role": "biome", "value": "minecraft:dripstone_caves" },
"poem": "Stone Cavern Point Water"
}
@@ -0,0 +1,8 @@
{
"schema_version": 2,
"name": "symbol.rivencraft.biome.forest",
"description": "symbol.rivencraft.biome.forest.description",
"category": "rivencraft:biome",
"semantics": { "role": "biome", "value": "minecraft:forest" },
"poem": "Trees Land Shade Growth"
}
@@ -0,0 +1 @@
{"schema_version":2,"name":"symbol.rivencraft.biome.grid","description":"symbol.rivencraft.biome.grid.description","category":"rivencraft:biome","semantics":{"role":"biome_controller","value":"grid"},"poem":"Constraint Nature Pattern Grid"}
@@ -0,0 +1 @@
{"schema_version":2,"name":"symbol.rivencraft.biome.huge","description":"symbol.rivencraft.biome.huge.description","category":"rivencraft:biome","semantics":{"role":"biome_controller","value":"huge"},"poem":"Constraint Nature Region Huge"}
@@ -0,0 +1 @@
{"schema_version":2,"name":"symbol.rivencraft.biome.large","description":"symbol.rivencraft.biome.large.description","category":"rivencraft:biome","semantics":{"role":"biome_controller","value":"large"},"poem":"Constraint Nature Region Large"}
@@ -0,0 +1,8 @@
{
"schema_version": 2,
"name": "symbol.rivencraft.biome.lush_caves",
"description": "symbol.rivencraft.biome.lush_caves.description",
"category": "rivencraft:biome",
"semantics": { "role": "biome", "value": "minecraft:lush_caves" },
"poem": "Growth Cavern Moss Water"
}
@@ -0,0 +1 @@
{"schema_version":2,"name":"symbol.rivencraft.biome.medium","description":"symbol.rivencraft.biome.medium.description","category":"rivencraft:biome","semantics":{"role":"biome_controller","value":"medium"},"poem":"Constraint Nature Region Medium"}
@@ -0,0 +1,8 @@
{
"schema_version": 2,
"name": "symbol.rivencraft.biome.nether_wastes",
"description": "symbol.rivencraft.biome.nether_wastes.description",
"category": "rivencraft:biome",
"semantics": { "role": "biome", "value": "minecraft:nether_wastes" },
"poem": "Fire Cavern Waste Heat"
}
@@ -0,0 +1,8 @@
{
"schema_version": 2,
"name": "symbol.rivencraft.biome.plains",
"description": "symbol.rivencraft.biome.plains.description",
"category": "rivencraft:biome",
"semantics": { "role": "biome", "value": "minecraft:plains" },
"poem": "Grass Land Open Wind"
}
@@ -0,0 +1 @@
{"schema_version":2,"name":"symbol.rivencraft.biome.single","description":"symbol.rivencraft.biome.single.description","category":"rivencraft:biome","semantics":{"role":"biome_controller","value":"single"},"poem":"Constraint Nature Solitary Form"}
@@ -0,0 +1 @@
{"schema_version":2,"name":"symbol.rivencraft.biome.small","description":"symbol.rivencraft.biome.small.description","category":"rivencraft:biome","semantics":{"role":"biome_controller","value":"small"},"poem":"Constraint Nature Region Small"}
@@ -0,0 +1,8 @@
{
"schema_version": 2,
"name": "symbol.rivencraft.biome.the_end",
"description": "symbol.rivencraft.biome.the_end.description",
"category": "rivencraft:biome",
"semantics": { "role": "biome", "value": "minecraft:the_end" },
"poem": "Island Void Sky Eternity"
}
@@ -0,0 +1 @@
{"schema_version":2,"name":"symbol.rivencraft.biome.tiled","description":"symbol.rivencraft.biome.tiled.description","category":"rivencraft:biome","semantics":{"role":"biome_controller","value":"tiled"},"poem":"Constraint Nature Pattern Tile"}
@@ -0,0 +1 @@
{"schema_version":2,"name":"symbol.rivencraft.biome.tiny","description":"symbol.rivencraft.biome.tiny.description","category":"rivencraft:biome","semantics":{"role":"biome_controller","value":"tiny"},"poem":"Constraint Nature Region Tiny"}
@@ -0,0 +1,8 @@
{
"schema_version": 2,
"name": "symbol.rivencraft.feature.deep_lakes",
"description": "symbol.rivencraft.feature.deep_lakes.description",
"category": "rivencraft:feature",
"semantics": { "role": "feature", "value": "rivencraft:deep_lakes" },
"poem": "Nature Flow Static Explore"
}
@@ -0,0 +1,8 @@
{
"schema_version": 2,
"name": "symbol.rivencraft.feature.flowers",
"description": "symbol.rivencraft.feature.flowers.description",
"category": "rivencraft:feature",
"semantics": { "role": "feature", "value": "rivencraft:flowers" },
"poem": "Nature Grow Color Bloom"
}
@@ -0,0 +1,8 @@
{
"schema_version": 2,
"name": "symbol.rivencraft.feature.huge_trees",
"description": "symbol.rivencraft.feature.huge_trees.description",
"category": "rivencraft:feature",
"semantics": { "role": "feature", "value": "rivencraft:huge_trees" },
"poem": "Nature Stimulate Spur Elevate"
}
@@ -0,0 +1,8 @@
{
"schema_version": 2,
"name": "symbol.rivencraft.feature.lava_lakes",
"description": "symbol.rivencraft.feature.lava_lakes.description",
"category": "rivencraft:feature",
"semantics": { "role": "feature", "value": "rivencraft:lava_lakes" },
"poem": "Fire Fluid Basin Transform"
}
@@ -0,0 +1,8 @@
{
"schema_version": 2,
"name": "symbol.rivencraft.feature.ravines",
"description": "symbol.rivencraft.feature.ravines.description",
"category": "rivencraft:feature",
"semantics": { "role": "feature", "value": "rivencraft:ravines" },
"poem": "Terrain Transform Void Weave"
}
@@ -0,0 +1,8 @@
{
"schema_version": 2,
"name": "symbol.rivencraft.feature.rocks",
"description": "symbol.rivencraft.feature.rocks.description",
"category": "rivencraft:feature",
"semantics": { "role": "feature", "value": "rivencraft:rocks" },
"poem": "Earth Form Moss Stone"
}
@@ -0,0 +1,8 @@
{
"schema_version": 2,
"name": "symbol.rivencraft.feature.surface_lakes",
"description": "symbol.rivencraft.feature.surface_lakes.description",
"category": "rivencraft:feature",
"semantics": { "role": "feature", "value": "rivencraft:surface_lakes" },
"poem": "Nature Flow Static Elevate"
}
@@ -0,0 +1,8 @@
{
"schema_version": 2,
"name": "symbol.rivencraft.feature.trees",
"description": "symbol.rivencraft.feature.trees.description",
"category": "rivencraft:feature",
"semantics": { "role": "feature", "value": "rivencraft:trees" },
"poem": "Nature Grow Life Forest"
}
@@ -0,0 +1 @@
{"schema_version":2,"name":"symbol.rivencraft.lighting.bright","description":"symbol.rivencraft.lighting.bright.description","category":"rivencraft:lighting","semantics":{"role":"lighting","value":"bright"},"poem":"Ethereal Sustain Cycle Balance"}
@@ -0,0 +1 @@
{"schema_version":2,"name":"symbol.rivencraft.lighting.dark","description":"symbol.rivencraft.lighting.dark.description","category":"rivencraft:lighting","semantics":{"role":"lighting","value":"dark"},"poem":"Ethereal Void Cycle Balance"}
@@ -0,0 +1 @@
{"schema_version":2,"name":"symbol.rivencraft.period.double","description":"symbol.rivencraft.period.double.description","category":"rivencraft:celestial","semantics":{"role":"period_modifier","value":2.0},"poem":"Transform Time Cycle Dynamic"}
@@ -0,0 +1 @@
{"schema_version":2,"name":"symbol.rivencraft.period.full","description":"symbol.rivencraft.period.full.description","category":"rivencraft:celestial","semantics":{"role":"period_modifier","value":1.0},"poem":"Transform Time Cycle Balance"}
@@ -0,0 +1 @@
{"schema_version":2,"name":"symbol.rivencraft.period.half","description":"symbol.rivencraft.period.half.description","category":"rivencraft:celestial","semantics":{"role":"period_modifier","value":0.5},"poem":"Transform Time Cycle Constraint"}
@@ -0,0 +1 @@
{"schema_version":2,"name":"symbol.rivencraft.period.zero","description":"symbol.rivencraft.period.zero.description","category":"rivencraft:celestial","semantics":{"role":"period_modifier","value":0.0},"poem":"Transform Time Void Balance"}
@@ -0,0 +1 @@
{"schema_version":2,"name":"symbol.rivencraft.phase.nadir","description":"symbol.rivencraft.phase.nadir.description","category":"rivencraft:celestial","semantics":{"role":"phase_modifier","value":0.0},"poem":"Transform Time Void Tradition"}
Loaded 100 of 117 files, more files were not shown because too many files have changed in this diff. Show more