Compare commits

...
11 Commits
Author SHA1 Message Date
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
dnorberg 5538ca6aa6 Render Legacy glyph pages and base-25 desk numerals
Build / build (push) Canceled after 0s
2026-09-30 13:20:56 -04:00
dnorberg 3c900634c9 Define server-authoritative symbol semantics (#29)
Build / build (push) Canceled after 0s
2026-09-30 07:17:14 -04:00
dnorberg 8cce41fd71 docs: audit Legacy age grammar and symbol page composition (#28)
Build / build (push) Canceled after 0s
2026-09-30 06:46:45 -04:00
dnorberg 114a6ee21e Streamline GameTests and writing workstation logic
Build / build (push) Canceled after 0s
2026-09-29 23:12:35 -04:00
135 changed files with 4621 additions and 501 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. All required GameTests should pass before distributing a build.
GameTests use `build/gametest-run/world`, separate from the normal development 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. world. Gradle starts each default run with a fresh world and removes it after
Override the limit with `-PgameTestMaxWorldMiB=NUMBER`. A caller-supplied every run, whether tests pass or fail. The GameTest server always uses seed `0`,
`-PgameTestRunDir` is never removed automatically. 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: To run the suite in a fresh temporary directory instead, use:
+18 -4
View File
@@ -77,6 +77,11 @@ larger ordered collection of Pages between desks and the binder.
With JEI installed, Rivencraft displays the Ink Mixer operation in its own 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. 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 JEI is optional; vanilla crafting
recipes and all writing interactions work without it. For a development client recipes and all writing interactions work without it. For a development client
with JEI, run `./gradlew runClient -PwithJei=true`. with JEI, run `./gradlew runClient -PwithJei=true`.
@@ -92,10 +97,15 @@ outputs a Descriptive Book once the title, cover, and Link Panel are present.
Inputs are consumed only when the result is taken. Inputs are consumed only when the result is taken.
The completed book receives its Age identity when assembled. With only a Link 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 Panel, it describes a randomly generated Age. Authored writing is compiled once
book; the Descriptive Book screen's turned pages show ordered symbols and into a versioned, server-owned Age plan. The plan freezes the Age seed, resolved
unresolved IDs. Until Milestone 5, symbols do not affect generation and written symbol meanings, page order, and runtime profile, so later data-pack changes do
books use the same random Age fallback. The Descriptive Book screen follows 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 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 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 symbol pages appear before the final blank spread; their pictograms await
@@ -189,6 +199,10 @@ known upstream limits are documented in
``` ```
The built mod is written to `build/libs/`. The built mod is written to `build/libs/`.
The default dedicated-server GameTest run is deliberately small. Use
`./gradlew runGameTestServer -PwithArchivedGameTests=true` for the complete
regression suite before a release or when investigating a related issue. See
[docs/GAMETESTS.md](docs/GAMETESTS.md).
## Versioning ## Versioning
+92 -32
View File
@@ -17,6 +17,18 @@ tasks.named('wrapper', Wrapper).configure {
version = mod_version version = mod_version
group = mod_group_id group = mod_group_id
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()
.split(',').collect { it.trim() }.findAll { !it.isEmpty() }
if (!archivedGameTestSuites.containsAll(selectedArchivedGameTestSuites)) {
throw new GradleException("Unknown archived GameTest suite. Choose from: ${archivedGameTestSuites.join(', ')}")
}
String enabledGameTestNamespaces = ([mod_id] + selectedArchivedGameTestSuites.collect {
"rivencraft_archive_${it}"
}).join(',')
sourceSets.main.resources { sourceSets.main.resources {
// Include resources generated by data generators. // Include resources generated by data generators.
srcDir('src/generated/resources') srcDir('src/generated/resources')
@@ -26,6 +38,44 @@ sourceSets.main.resources {
exclude("src/generated/**/.cache") // datagen cache files 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 ->
from('src/main/resources/data/rivencraft/structure/empty.nbt') {
into "data/rivencraft_archive_${suite}/structure"
}
}
}
repositories { repositories {
maven { maven {
name = 'JaredsMaven' name = 'JaredsMaven'
@@ -89,7 +139,7 @@ neoForge {
// Keep generated test Ages separate from worlds used by the dev client/server. // Keep generated test Ages separate from worlds used by the dev client/server.
gameDirectory = project.file(project.findProperty('gameTestRunDir') gameDirectory = project.file(project.findProperty('gameTestRunDir')
?: layout.buildDirectory.dir('gametest-run').get().asFile) ?: layout.buildDirectory.dir('gametest-run').get().asFile)
systemProperty 'neoforge.enabledGameTestNamespaces', project.mod_id systemProperty 'neoforge.enabledGameTestNamespaces', enabledGameTestNamespaces
} }
data { data {
@@ -127,42 +177,52 @@ neoForge {
} }
} }
// GameTests generate Ages, so their dedicated world can grow quickly across runs. // Vanilla's GameTestServer uses a fixed world seed of 0. Every default run
// Never auto-delete a caller-supplied gameTestRunDir or a normal dev world. // regenerates its world; custom run directories are never managed here.
long gameTestWorldLimitMiB = providers.gradleProperty('gameTestMaxWorldMiB').orElse('512').get().toLong()
if (gameTestWorldLimitMiB <= 0) {
throw new GradleException('gameTestMaxWorldMiB must be a positive number')
}
boolean customGameTestRunDir = providers.gradleProperty('gameTestRunDir').isPresent() boolean customGameTestRunDir = providers.gradleProperty('gameTestRunDir').isPresent()
File dedicatedGameTestDir = layout.buildDirectory.dir('gametest-run').get().asFile.canonicalFile File dedicatedGameTestBuildDir = layout.buildDirectory.get().asFile
File dedicatedGameTestWorld = new File(dedicatedGameTestDir, 'world') File dedicatedGameTestDir = layout.buildDirectory.dir('gametest-run').get().asFile
def cleanOversizedGameTestWorld = tasks.register('cleanOversizedGameTestWorld') { def prepareGameTestWorld = tasks.register('prepareGameTestWorld') {
onlyIf { !customGameTestRunDir }
doLast { doLast {
if (customGameTestRunDir) { GameTestWorlds.clean(dedicatedGameTestBuildDir, dedicatedGameTestDir)
getLogger().lifecycle('Skipping automatic GameTest world cleanup for custom gameTestRunDir') }
return }
} def finishGameTestWorld = tasks.register('finishGameTestWorld') {
onlyIf { !customGameTestRunDir }
def worldDir = dedicatedGameTestWorld doLast {
if (!worldDir.isDirectory() || java.nio.file.Files.isSymbolicLink(worldDir.toPath())) { GameTestWorlds.clean(dedicatedGameTestBuildDir, dedicatedGameTestDir)
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) }
}
} }
} }
tasks.named('runGameTestServer').configure { 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'. // Sets up a dependency configuration called 'localRuntime'.
+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 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. 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 ## Persistence and reload behavior
An Age permanently stores its selected profile ID, generation version, seed, An Age permanently stores its selected profile ID, generation version, seed,
and rolled traits. `/reload` replaces the profile definitions but does not and rolled traits. For an **authored** Age, the generation plan also stores a
reroll those immutable values. An unloaded Age resolves its stored profile copy of the resolved runtime profile: terrain shape, noise settings, biome
again when it loads, so intentional profile overrides affect its runtime preset, and dimension type. `/reload` cannot reinterpret that plan; an unloaded
resources and newly generated chunks. 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`. The legacy `rivencraft:random_vanilla` alias also resolves to `standard`.
Rivencraft logs this fallback. Invalid built-in overrides do not replace the 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 required built-in definitions; a reload fails if a required built-in profile
+2 -1
View File
@@ -23,7 +23,8 @@ project's GNU LGPL v3 license. Rivencraft itself uses the same license.
| `assets/rivencraft/textures/block/ink_mixer_top.png`, `ink_mixer_side.png`, `ink_mixer_bottom.png` | `assets/mystcraft/textures/blocks/inkmixer_top.png`, `inkmixer_side.png`, `inkmixer_bottom.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; Rivencraft supplies its own block model | | `assets/rivencraft/textures/block/ink_mixer_top.png`, `ink_mixer_side.png`, `ink_mixer_bottom.png` | `assets/mystcraft/textures/blocks/inkmixer_top.png`, `inkmixer_side.png`, `inkmixer_bottom.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; Rivencraft supplies its own block model |
| `assets/rivencraft/textures/item/linking_book_unwritten.png` | `assets/mystcraft/textures/items/unlinked.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only | | `assets/rivencraft/textures/item/linking_book_unwritten.png` | `assets/mystcraft/textures/items/unlinked.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only |
| `assets/rivencraft/textures/item/page_link_panel.png` | `page_background.png` and `PageBuilder.BasicPageSprite` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Reproduces the legacy 160 px scale, black panel at `(25,30)`–`(135,75)`, and 128 px resample | | `assets/rivencraft/textures/item/page_link_panel.png` | `page_background.png` and `PageBuilder.BasicPageSprite` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Reproduces the legacy 160 px scale, black panel at `(25,30)`–`(135,75)`, and 128 px resample |
| `assets/rivencraft/textures/item/page_symbol*.png` and `page_unresolved.png` | `page_background.png`, `textures/symbolcomponents.png`, `WordData`, `ModSymbols`, and `PageBuilder.PageSprite` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Static 1.21.1 renditions of the legacy runtime-composed four-word symbol pages; `normal_time` uses the legacy Full Length poem | | `assets/rivencraft/textures/gui/symbolcomponents.png` | `assets/mystcraft/textures/symbolcomponents.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Byte-identical shared 512×512 component sheet for client-side page composition |
| Runtime-composed symbol pages (`SymbolPageTextures`) | `page_background.png`, `textures/symbolcomponents.png`, `WordData`, `ModSymbols`, and `PageBuilder.PageSprite` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Replaces the six pre-generated symbol PNGs; layers four poem words on the shared page background and caches bounded client textures |
Mystcraft Legacy identifies XCompWiz as its project developer and includes the Mystcraft Legacy identifies XCompWiz as its project developer and includes the
full LGPL v3 text in its root `LICENSE` file. Rivencraft's root `LICENSE` full LGPL v3 text in its root `LICENSE` file. Rivencraft's root `LICENSE`
+99
View File
@@ -0,0 +1,99 @@
# GameTest suites
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.
```shell
./gradlew runGameTestServer
```
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
core tests when investigating an issue:
```shell
./gradlew runGameTestServer -ParchivedGameTestSuites=desk
./gradlew runGameTestServer -ParchivedGameTestSuites=grammar,binder
```
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
./gradlew runGameTestServer -PwithArchivedGameTests=true
```
Each archive is selected by its `rivencraft_archive_<suite>` GameTest namespace.
The suites share the normal empty test structure and do not need Create, Ponder, or
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. 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 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.
+58
View File
@@ -0,0 +1,58 @@
# Mystcraft Legacy Age grammar audit (milestone 5, issue #28)
Reference: [Mystcraft-Legacy commit `9bc8ddc`](https://github.com/Mystcraft/Mystcraft-Legacy/tree/9bc8ddc061845df0cd5ea47f4fdef773cff786ae), whose [build properties](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/build.properties) identify version 0.13.7.06. The user-provided local Minecraft 1.12.2 extraction (`mystcraft-1.12.2-0.13.7.06`) has the same version in `mcmod.info`; its `assets/mystcraft/textures/symbolcomponents.png` is byte-identical to the source checkout. That extraction contains compiled classes and assets, but no shipped `.cfg` or `.java` files. Source-linked behavioral claims below use the corresponding GitHub Java source. This is a behavior specification, not a code port. Any later adapted code needs its own copyright/provenance record under [PORTING.md](PORTING.md).
## What Legacy actually does
Legacy's [root rule](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/data/GrammarRules.java#L62) produces, in order: terrain, biome controller, weather, lighting, optional spawning, suns, moons, starfields, doodads, visuals, small/medium/large features, and effects. Each symbol declares the rule it can satisfy and any preceding modifier tokens it needs in [SymbolRules](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/data/SymbolRules.java). The written page order therefore matters: modifiers appear before their consumer, while missing grammar branches can be generated. The [grammar tree](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/grammar/GrammarTree.java#L158-L222) connects authored terminals and inserts missing branches; [AgeData](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/world/agedata/AgeData.java#L230-L258) does this on first link with an Age-seeded RNG. Weighted rule *ranks* choose generated symbols; a `null` rank is not randomly generated, though such a rule can connect authored pages ([GrammarGenerator](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/grammar/GrammarGenerator.java#L28-L112)).
Legacy does **not** reject a book just because it omits terrain, biome, weather, or lighting. It fills the gaps. It also has separate instability accounting for dangling/excess symbols; this audit records those as diagnostics, not as milestone 5 generation effects ([AgeController](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/world/AgeController.java#L196-L247)).
## Symbol-to-Rivencraft mapping
| Legacy category and symbols | Existing Rivencraft path | Milestone 5 disposition |
| --- | --- | --- |
| `TerrainNormal`, `TerrainAmplified`, `TerrainFlat`, `TerrainVoid`, `TerrainNether`, `TerrainEnd`; terrain and sea block modifiers | `AgeProfile` selects noise/flat/void and registered noise settings; random profiles already persist per Age | Compile supported terrain shapes into profile/resources. Nether/End and material modifiers require explicit compatible data-pack resources; do not claim exact 1.12 terrain parity. |
| `BioConNative`, `Single`, `Tiled`, `Grid`, `Tiny`, `Small`, `Medium`, `Large`, `Huge`, plus biome pages | `AgeTraits.BiomeDistribution` has all nine modes; `AgeDimensionService` has sources for these modes | Map modes, consume authored biome IDs in order, then deterministically fill required minimums. Native uses the profile's modern biome preset, not the old `BiomeProvider`. |
| `LightingNormal`, `Dark`, `Bright` | `AgeTraits.Lighting`, dimension type construction | Compile the choice to a stable dimension type/light behavior. Exact Legacy 1.12 brightness-table rendering is not guaranteed by NeoForge's dimension-type fields. |
| `WeatherNorm`, `Fast`, `Slow`, `Off`, `On`, `Cloudy`, `Rain`, `Snow`, `Storm` | `AgeTraits.Weather` has matching names except Legacy `On` maps to `ALWAYS` | Compile weather semantics separately from biome selection. `Snow` must remain deferred until optional season integration; do not silently substitute another weather mode. |
| Suns, moons, starfields; angle, phase, period, color/gradient/sunset modifiers | One `celestialPeriod`, `celestialAngle`, `celestialPhase` on `AgeTraits` | Compile only the representable single-cycle subset first. Multiple celestial bodies, independent periods, custom stars, gradients and sunsets need a richer definition and renderer, not flattening into one value. |
| Sky/fog/cloud/grass/foliage/water colors, natural variants, horizon, rainbow | Existing sky/dimension visuals and preview | Require an explicit modern client/biome-color design; metadata-only symbol pages must not pretend to change rendering. |
| Caves, ores, huge trees, lakes, floating islands, tendrils, skylands, spheres, spikes, crystals; vanilla villages, strongholds, mineshafts, dungeons, fortresses, obelisks, fissures | Current cave profile and vanilla data-pack generation | Compile only features for which registered 1.21.1 placed features/structures exist. Defer bespoke structures and polish to milestone 7. |
| `EnvAccel`, explosions, lightning, meteors, scorching; PvP and dummy suppression pages | No equivalent Age-definition effect | Defer environmental hazards/instability effects to milestone 6, PvP rule to a separately scoped server policy; retain authored IDs without fake behavior. |
The Legacy symbol list and page names come from [ModSymbols](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/data/ModSymbols.java#L129-L240) and [SymbolRules](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/data/SymbolRules.java#L19-L137). Rivencraft's [catalog](../src/main/java/net/dnorberg/rivencraft/writing/SymbolCatalog.java) currently holds display metadata only; its built-in set is just standard terrain, native biomes, normal weather, normal lighting, normal time, and caves. [OrderedWriting](../src/main/java/net/dnorberg/rivencraft/writing/OrderedWriting.java) preserves page order, but no compiler yet connects it to [AgeTraits](../src/main/java/net/dnorberg/rivencraft/book/AgeTraits.java) or [Age profiles](AGE_PROFILES.md).
## Symbol-page artwork: `symbolcomponents.png`
Legacy does not allocate one image tile to each complete Age symbol. The [default word image source](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/api/java/com/xcompwiz/mystcraft/api/word/DrawableWord.java#L24-L75) is `mystcraft:textures/symbolcomponents.png`, a 512×512 RGBA sheet. It has an 8×8 grid of 64×64 component cells. For zero-based component index `n`, source pixels begin at `x = (n % 8) * 64`, `y = (n / 8) * 64`. [GuiUtils.drawComponent](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/client/gui/GuiUtils.java#L131-L152) uses that mapping for GUI drawing; [PageBuilder.PageSprite.stitchWord](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/client/render/PageBuilder.java#L287-L331) uses it when composing an item sprite. Cell `0` is the missing-word/question-mark fallback. Each component may be tinted and its alpha layered with the other components of a word.
The complete lookup chain for a unique page is:
1. [WordData.init](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/api/java/com/xcompwiz/mystcraft/api/word/WordData.java#L96-L166) registers a list of component indices for each named word (for example, `Nature` uses `5, 6, 8, 10, 11, 12, 15, 16, 17, 22`). [DrawableWord](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/api/java/com/xcompwiz/mystcraft/api/word/DrawableWord.java#L26-L75) also permits per-component colors and an alternate image source. Unregistered words get a deterministic component list from their lowercase name hash ([DrawableWordManager](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/words/DrawableWordManager.java#L34-L56)).
2. [ModSymbols.registerSymbol](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/data/ModSymbols.java#L105-L116) assigns four poem words to each Age symbol. For example, `LightingNormal` is `Ethereal, Dynamic, Cycle, Balance` ([registration](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/data/ModSymbols.java#L184-L186)). The poem, not the symbol ID, selects the component layers.
3. [PageBuilder.PageSprite](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/client/render/PageBuilder.java#L232-L279) draws those words above, right, below, and left of the page center, respectively. Their target rectangles on its 160×160 working image are `(48,0)`, `(96,48)`, `(48,96)`, `(0,48)`, each 64×64 ([getPageTarget](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/client/render/PageBuilder.java#L360-L378)). It scales the composed image to a 128×128 item sprite. [GuiUtils.drawSymbol](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/client/gui/GuiUtils.java#L74-L96) renders the same four-word arrangement directly in book/workstation GUIs.
For Rivencraft, keep **symbol semantics** (`SymbolReference`/catalog ID) separate from **page artwork** (four ordered word names, their component indices/colors, and the shared sheet). Existing built-in page images are static renditions of this process ([asset provenance](ASSET_PROVENANCE.md)); future symbol pages can compose it at build time or in a client-only renderer. Unknown words and missing symbols need distinct fallbacks, and data-pack-only symbols must remain usable without silently borrowing another symbol's image. Do not copy the Legacy renderer wholesale: its texture-atlas and GUI APIs target 1.12.2.
## Verified numeric defaults and bounds
These values are from code, **not** a supposed shipped `.cfg`: the inspected Legacy repository contains no default configuration file with numeric min/max fields for age grammar. [MystConfig](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/config/MystConfig.java) supplies typed config helpers, while symbol enablement uses a Boolean `<symbol>.enabled` option ([SymbolManager](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/symbol/SymbolManager.java#L91-L107)). Do not label Rivencraft's present numeric range as a Legacy config range.
| Parameter | Legacy source value/rule | Implementation consequence |
| --- | --- | --- |
| Period pages | `Zero=0`, `Half=0.5`, `Full=1`, `Double=2` ([ModSymbols](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/data/ModSymbols.java#L194-L201)); repeated period modifiers average pairwise ([SymbolLength](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/symbol/modifiers/SymbolLength.java#L25-L37)) | Authored basic values have min 0 and max 2; no arbitrary continuous written range is established. A sun without a period uses `0.8 + 0.4 * nextDouble()`—`[0.8, 1.2)`—before conversion to ticks ([SymbolSunNormal](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/symbol/symbols/SymbolSunNormal.java#L47-L73)). Rivencraft's random nonzero `[0.2, 2.0)` is its own existing policy. |
| Angle pages | North/East/South/West = `0/90/180/270` degrees ([ModSymbols](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/data/ModSymbols.java#L187-L190)); repeated values use shortest-arc averaging ([ModifierUtils](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/api/java/com/xcompwiz/mystcraft/api/symbol/ModifierUtils.java#L54-L73)) | Canonical angle is `[0, 360)`; consumers may seed a random angle if omitted. |
| Phase pages | Nadir/Rising/Zenith/Setting = `0/90/180/270` degrees ([ModSymbols](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/data/ModSymbols.java#L198-L201)); the sun divides by 360 ([SymbolSunNormal](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/symbol/symbols/SymbolSunNormal.java#L65-L73)) | Written phase is `[0, 360)` degrees, represented by Rivencraft as `[0, 1)` turns. |
| Biome count | Grammar requires one page for `Single`, `Tiled`, `Grid`; `Tiny`–`Huge` have two explicit biome slots plus a biome-list branch ([SymbolRules](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/data/SymbolRules.java#L91-L99)). `Single` fills to 1 ([source](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/symbol/symbols/SymbolBiomeControllerSingle.java#L22-L37)), `Tiled`/`Grid` to 2 ([source](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/symbol/symbols/SymbolBiomeControllerTiled.java#L25-L38)), and `Tiny`–`Huge` to 3 ([source](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/symbol/symbols/SymbolBiomeControllerLarge.java#L61-L84)) | These are **minimums**, not maximums. `Native` uses vanilla's provider and has no authored biome-list requirement ([source](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/symbol/symbols/SymbolBiomeControllerNative.java#L34-L44)). Preserve additional authored biomes where the chosen controller can accept them. |
| Weather normal | Rain duration/base `12000/12000`, cooldown/base `168000/12000`; thunder duration/base `12000/3600`, cooldown/base `168000/12000` ticks ([SymbolWeatherNormal](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/symbol/symbols/SymbolWeatherNormal.java#L25-L36)) | These are source constants, not configurable min/max bounds. Other weather controllers need individual review before parity claims. |
## Compilation and fallback contract for the next issues
1. A Link-Panel-only book, a legacy page-free book, and any book with no effective supported Age symbols retain the current seed-derived random Age path. Preserve the saved writing untouched.
2. A supported partial sequence is **not** invalid: complete missing required branches deterministically from the Age seed, then compile the result. Authored symbols take precedence over generated fillers. This follows Legacy's grammar tree, rather than requiring a full hand-written list.
3. Unknown/unresolved IDs, unsupported-but-known effects, misplaced modifiers, duplicates, and conflicts must be reported distinctly. Do not silently apply a different effect or discard an authored page. A first compiler may use the existing random Age path for combinations it cannot represent, with an explicit diagnostic; it must never claim such a book was successfully compiled.
4. Grammar diagnostics are not instability. Milestone 5 decides recognition, ordering, completion, and whether a supported combination can compile. Milestone 6 may use dangling/excess/conflict diagnostics for instability effects. Milestone 7 owns bespoke structures and polish.
5. Freeze the completed, effective generation definition with the Age identity before creating chunks. Keep page order and original IDs for display/migration, and keep seeded completion deterministic across reloads. New symbol behavior belongs in versioned server data, not the schema-1 display catalog.
The mapping is intentionally narrower than all Legacy symbols. The exact rule and compiler schema are follow-up issues #29–#31; terrain, biome, environment, and feature implementations are #32–#35. No generation behavior or release version changes in this audit.
+2 -1
View File
@@ -39,7 +39,8 @@ acceptance issue and all required implementation issues are complete.
and [writing-system data and migration](WRITING_DATA.md). and [writing-system data and migration](WRITING_DATA.md).
5. **Age grammar** — translate symbol combinations into modern biome, noise, 5. **Age grammar** — translate symbol combinations into modern biome, noise,
dimension-type, and world-generation configuration. Optional integrations dimension-type, and world-generation configuration. Optional integrations
may add composable biome regions and seasonal behavior. may add composable biome regions and seasonal behavior. See the
[Legacy grammar audit](LEGACY_AGE_GRAMMAR_AUDIT.md).
6. **Instability** — deterministic validation and server-safe effects. 6. **Instability** — deterministic validation and server-safe effects.
7. **Structures and polish** — libraries, crystals, portals, recipes, models, 7. **Structures and polish** — libraries, crystals, portals, recipes, models,
sounds, advancements, compatibility, and migration tests. sounds, advancements, compatibility, and migration tests.
+1 -2
View File
@@ -66,7 +66,7 @@ unstable in a particular graphics or mod configuration.
For preview-related releases: For preview-related releases:
1. Run `./gradlew runGameTestServer` to verify the complete selection matrix, 1. Run `./gradlew runGameTestServer -PwithArchivedGameTests=true` to verify the complete selection matrix,
core Age creation, persistence, and travel without optional renderers. core Age creation, persistence, and travel without optional renderers.
2. Open held Linking and Descriptive Books once with each available backend. 2. Open held Linking and Descriptive Books once with each available backend.
3. Open both book types from a Book Stand and confirm Explore is disabled. 3. Open both book types from a Book Stand and confirm Explore is disabled.
@@ -75,4 +75,3 @@ For preview-related releases:
preview loader remains active. preview loader remains active.
5. With Ponder, reopen different destinations and confirm the previous 5. With Ponder, reopen different destinations and confirm the previous
snapshot does not bleed into the next one. snapshot does not bleed into the next one.
+44
View File
@@ -0,0 +1,44 @@
# Server-authoritative symbol semantics (schema v2)
Milestone 5 issue #29 adds typed meaning to the existing data-pack symbol catalog. Put definitions at `data/<namespace>/rivencraft/symbols/<path>.json`; the file ID becomes the stable symbol ID. For example, `data/example/rivencraft/symbols/terrain/highlands.json` defines `example:terrain/highlands`:
```json
{
"schema_version": 2,
"name": "symbol.example.terrain.highlands",
"description": "symbol.example.terrain.highlands.description",
"category": "example:terrain",
"semantics": {
"role": "terrain",
"value": "example:highlands"
},
"poem": "Terrain Form Tradition Flow"
}
```
`name` and `description` are translation keys. `category` is for display and sorting; it does not determine grammar. `semantics.role` and its typed `value` are server-owned. The terrain value above names an Age runtime profile that a later compiler must resolve and validate. A syntactically valid resource ID alone does not guarantee the profile or feature exists.
`poem` is optional, client-safe artwork metadata: exactly four alphabetic words, ordered top, right, bottom, left. The client layers their glyphs from the shared Legacy component sheet at runtime. GUI thumbnails use the full transparent artwork over their page backgrounds; item icons use the same artwork reduced from 16 to 13 pixels across, over the page texture. Unregistered words use a stable generated component combination; when a symbol has no poem, the six original built-in IDs retain their Legacy poems and other IDs produce four stable fallback words. This affects appearance only, never Age generation. Generated images are cached up to 256 entries and discarded on resource reload.
The Writing Desk's 88 collection tabs use Legacy's number components, chiefly the bottom row of `symbolcomponents.png`, rather than word sigils. Legacy's `ModWords.constructNumber` combines four unit marks (1–4) with four five-step marks (5–20) to form 1–24 and uses a separate zero mark. Rivencraft extends these marks positionally in base 25 for tabs 25–88 (for example, 25 is 1 followed by 0). Hovering still reveals the decimal number for accessibility. The former arbitrary-word glyph generator remains useful for rendering text: on page-free Descriptive Books, the generated Age description now appears as a sequence of layered word glyphs instead of Minecraft's enchantment font. The Age name stays readable.
| Role | Value type and allowed values |
| --- | --- |
| `terrain` | Canonical namespaced Age profile ID. |
| `biome_controller` | `native`, `single`, `tiled`, `grid`, `tiny`, `small`, `medium`, `large`, or `huge`. |
| `biome` | Canonical namespaced biome ID. |
| `lighting` | `normal`, `dark`, or `bright`. |
| `weather` | `normal`, `fast`, `slow`, `off`, `always`, `cloudy`, `rain`, `snow`, or `storm`. |
| `celestial` | `normal_time` (the first representable single-cycle behavior). |
| `period_modifier` | JSON number in `[0, 2]`; zero is stopped time. |
| `angle_modifier` | JSON number in `[0, 360)` degrees. |
| `phase_modifier` | JSON number in `[0, 360)` degrees; the compiler will convert to turns. |
| `feature` | Canonical namespaced feature-effect ID; future generation mapping must recognize it. |
These are schema bounds, not claims that Legacy shipped numeric config ranges. See the [Legacy grammar audit](LEGACY_AGE_GRAMMAR_AUDIT.md) for the source values and biome-count rules. Roles outside this table—including multiple suns, gradients, special structures, and hazards—are intentionally unsupported by schema v2. Their meaning requires a later versioned extension, not an unvalidated free-form field.
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 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.
+15 -10
View File
@@ -1,9 +1,11 @@
# Writing and symbol data # Writing and symbol data
Milestone 4 stores what a player wrote without deciding what that writing does Milestone 4 stores what a player wrote without deciding what that writing does
to an Age. Milestone 5 owns grammar validation, symbol interaction, instability, to an Age. Milestone 5 owns grammar validation and symbol interaction,
and translation into biome, noise, dimension-type, and other world-generation and translation into biome, noise, dimension-type, and other world-generation
configuration. configuration. Milestone 6 owns instability effects. See the
[Legacy grammar audit](LEGACY_AGE_GRAMMAR_AUDIT.md) for the source-backed
Milestone 5 contract.
## Symbol catalog ## Symbol catalog
@@ -25,13 +27,16 @@ Schema version 1 contains display metadata only:
`name` and `description` are translation keys, not arbitrary formatted text or `name` and `description` are translation keys, not arbitrary formatted text or
executable behavior. `category` is a namespaced organizational identifier. executable behavior. `category` is a namespaced organizational identifier.
Milestone 5 adds [server-authoritative schema v2 semantics](SYMBOL_SEMANTICS.md)
with a typed role and bounded value. Existing v1 definitions remain readable
but display-only; updating an ID to v2 never rewrites saved pages or books.
Invalid definitions are logged and excluded by the server. Menus and future Invalid definitions are logged and excluded by the server. Menus and future
page synchronization must obtain resolved display metadata from the server; page synchronization must obtain resolved display metadata from the server;
clients never make a symbol valid by naming it. clients never make a symbol valid by naming it.
Rivencraft ships a small catalog covering terrain, biomes, lighting, weather, Rivencraft ships a catalog covering terrain, biomes, lighting, weather,
celestial behavior, and features. It exists to exercise the complete writing sky, celestial behavior, and features. The parser and compiler apply supported
workflow before Milestone 5 implements the full legacy grammar. schema-v2 pages to newly created Ages; omitted branches retain seeded defaults.
## Persistent writing ## Persistent writing
@@ -48,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. 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 Descriptive Book screen can inspect the ordered pages by turning them from
the bottom corners and identifies unresolved IDs using server-provided symbol the bottom corners and identifies unresolved IDs using server-provided symbol
metadata. Until Milestone 5, the metadata. Page-free books continue to use random Age generation.
saved symbols are informational only: Age creation uses the existing random
fallback and does not apply them to generation.
Removing a data pack never removes its IDs from saved writing. A missing ID is 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 resolved as client-safe **Unresolved Symbol** display metadata while retaining
@@ -102,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 The preview result is virtual. Taking the completed Descriptive Book commits the
inputs once, creates its Age identity, and saves schema-versioned inputs once, creates its Age identity, and saves schema-versioned
`OrderedWriting` plus the Age reference on the book. Link-Panel-only books `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 Inputs, title, and pending Age identity survive Binder save/load; breaking the
Binder returns stored inputs. The completed book retains both its writing and Binder returns stored inputs. The completed book retains both its writing and
Age identity through item save/load and copying. Age identity through item save/load and copying.
@@ -145,7 +149,8 @@ saved inputs are never silently discarded. Missing symbol IDs survive page,
Notebook, Binder, and assembled-book persistence instead of being substituted Notebook, Binder, and assembled-book persistence instead of being substituted
or erased. or erased.
Dedicated-server GameTests exercise codec and item round-trips, legacy data, The core and archived dedicated-server [GameTests](GAMETESTS.md) together
exercise codec and item round-trips, legacy data,
workstation NBT reload, break drops, full-inventory refusal, forged menu IDs, workstation NBT reload, break drops, full-inventory refusal, forged menu IDs,
and replayed output requests. World saves and chunk unloads use the same block and replayed output requests. World saves and chunk unloads use the same block
entity NBT persistence path as those reload tests. This does not replace a entity NBT persistence path as those reload tests. This does not replace a
+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.
+1 -1
View File
@@ -36,7 +36,7 @@ mod_name=Rivencraft
# The license of the mod. Review your options at https://choosealicense.com/. All Rights Reserved is the default. # 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 mod_license=LGPL-3.0-or-later
# The mod version. Rivencraft uses the x.y.z.b policy documented in README.md. # The mod version. Rivencraft uses the x.y.z.b policy documented in README.md.
mod_version=0.4.0.0 mod_version=0.4.6.9
immersive_portals_version=6.0.7 immersive_portals_version=6.0.7
# The group ID for the mod. It is only important when publishing as an artifact to a Maven repository. # 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. # This should match the base package used for the mod sources.
@@ -10,6 +10,7 @@ import net.dnorberg.rivencraft.registry.ModSounds;
import net.dnorberg.rivencraft.registry.ModBlocks; import net.dnorberg.rivencraft.registry.ModBlocks;
import net.dnorberg.rivencraft.registry.ModBlockEntities; import net.dnorberg.rivencraft.registry.ModBlockEntities;
import net.dnorberg.rivencraft.registry.ModBiomeSources; import net.dnorberg.rivencraft.registry.ModBiomeSources;
import net.dnorberg.rivencraft.registry.ModChunkGenerators;
import net.dnorberg.rivencraft.event.BookStandConversionHandler; import net.dnorberg.rivencraft.event.BookStandConversionHandler;
import net.dnorberg.rivencraft.event.AgeCelestialAngleSync; import net.dnorberg.rivencraft.event.AgeCelestialAngleSync;
import net.dnorberg.rivencraft.event.AgeLifecycleEvents; import net.dnorberg.rivencraft.event.AgeLifecycleEvents;
@@ -40,6 +41,7 @@ public final class Rivencraft {
modEventBus.addListener(ModNetworking::register); modEventBus.addListener(ModNetworking::register);
ModDataComponents.register(modEventBus); ModDataComponents.register(modEventBus);
ModBiomeSources.register(modEventBus); ModBiomeSources.register(modEventBus);
ModChunkGenerators.register(modEventBus);
ModBlocks.register(modEventBus); ModBlocks.register(modEventBus);
ModBlockEntities.register(modEventBus); ModBlockEntities.register(modEventBus);
ModItems.register(modEventBus); ModItems.register(modEventBus);
@@ -5,6 +5,9 @@ import java.util.List;
import java.util.UUID; import java.util.UUID;
import net.dnorberg.rivencraft.book.AgeReference; import net.dnorberg.rivencraft.book.AgeReference;
import net.dnorberg.rivencraft.book.AgeRegistrySavedData; 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.item.PageItem;
import net.dnorberg.rivencraft.registry.ModBlockEntities; import net.dnorberg.rivencraft.registry.ModBlockEntities;
import net.dnorberg.rivencraft.registry.ModDataComponents; import net.dnorberg.rivencraft.registry.ModDataComponents;
@@ -12,10 +15,17 @@ import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.writing.NotebookContents; import net.dnorberg.rivencraft.writing.NotebookContents;
import net.dnorberg.rivencraft.writing.OrderedWriting; import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.PageContent; import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.dnorberg.rivencraft.writing.WritingEntry; import net.dnorberg.rivencraft.writing.WritingEntry;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.minecraft.core.BlockPos; import net.minecraft.core.BlockPos;
import net.minecraft.core.HolderLookup; import net.minecraft.core.HolderLookup;
import net.minecraft.core.NonNullList; 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.tags.BiomeTags;
import net.minecraft.core.component.DataComponents; import net.minecraft.core.component.DataComponents;
import net.minecraft.nbt.CompoundTag; import net.minecraft.nbt.CompoundTag;
import net.minecraft.network.chat.Component; import net.minecraft.network.chat.Component;
@@ -108,7 +118,115 @@ public final class BookBinderBlockEntity extends BlockEntity implements Containe
if (!page.isEmpty() && (!validPage(page) || !PageItem.isUsableWriting(page) || page.getCount() != 1 if (!page.isEmpty() && (!validPage(page) || !PageItem.isUsableWriting(page) || page.getCount() != 1
|| PageItem.content(page).kind() == PageContent.Kind.BLANK)) return false; || 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 && !holder.orElseThrow().is(AgeBiomeSelection.CAVE_BIOMES)
&& !holder.orElseThrow().is(BiomeTags.IS_NETHER)) {
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() { public ItemStack previewBook() {
@@ -117,15 +235,9 @@ public final class BookBinderBlockEntity extends BlockEntity implements Containe
pendingAgeId = UUID.randomUUID(); pendingAgeId = UUID.randomUUID();
setChanged(); 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()); ItemStack book = new ItemStack(ModItems.DESCRIPTIVE_BOOK.get());
book.set(ModDataComponents.AGE_REFERENCE.get(), new AgeReference(pendingAgeId, title)); 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());
book.set(DataComponents.CUSTOM_NAME, Component.literal(title)); book.set(DataComponents.CUSTOM_NAME, Component.literal(title));
return book; return book;
} }
@@ -135,7 +247,7 @@ public final class BookBinderBlockEntity extends BlockEntity implements Containe
if (!canAssemble()) return false; if (!canAssemble()) return false;
if (pendingAgeId == null) pendingAgeId = UUID.randomUUID(); if (pendingAgeId == null) pendingAgeId = UUID.randomUUID();
if (level instanceof ServerLevel serverLevel) 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); items.get(COVER).shrink(1);
if (items.get(COVER).isEmpty()) items.set(COVER, ItemStack.EMPTY); if (items.get(COVER).isEmpty()) items.set(COVER, ItemStack.EMPTY);
items.get(LINK_PANEL).shrink(1); items.get(LINK_PANEL).shrink(1);
@@ -195,26 +307,19 @@ public final class BookBinderBlockEntity extends BlockEntity implements Containe
if (pages.isEmpty()) return ItemStack.EMPTY; if (pages.isEmpty()) return ItemStack.EMPTY;
int end = nextPageIndex(); int end = nextPageIndex();
if (index < 0 || index > end) return ItemStack.EMPTY; if (index < 0 || index > end) return ItemStack.EMPTY;
boolean link = false; ItemStack linkPanel = ItemStack.EMPTY;
List<ItemStack> writing = new ArrayList<>(); List<ItemStack> writing = new ArrayList<>();
for (ItemStack page : pages) { for (ItemStack page : pages) {
if (page.isEmpty()) continue; if (page.isEmpty()) continue;
if (!page.is(ModItems.PAGE.get()) || page.getCount() != 1) return ItemStack.EMPTY; if (!page.is(ModItems.PAGE.get()) || page.getCount() != 1) return ItemStack.EMPTY;
if (PageItem.content(page).kind() == PageContent.Kind.LINK_PANEL) { if (PageItem.content(page).kind() == PageContent.Kind.LINK_PANEL) {
if (link || !items.get(LINK_PANEL).isEmpty()) return ItemStack.EMPTY; if (!linkPanel.isEmpty() || !items.get(LINK_PANEL).isEmpty()) return ItemStack.EMPTY;
link = true; linkPanel = page;
} else if (validPage(page)) writing.add(page); } else if (validPage(page)) writing.add(page);
else return ItemStack.EMPTY; else return ItemStack.EMPTY;
} }
if (end + writing.size() > PAGE_COUNT || writing.isEmpty() && !link) return ItemStack.EMPTY; if (end + writing.size() > PAGE_COUNT || writing.isEmpty() && linkPanel.isEmpty()) return ItemStack.EMPTY;
if (link) { if (!linkPanel.isEmpty()) items.set(LINK_PANEL, linkPanel.copy());
for (ItemStack page : pages) {
if (!page.isEmpty() && PageItem.content(page).kind() == PageContent.Kind.LINK_PANEL) {
items.set(LINK_PANEL, page.copy());
break;
}
}
}
for (int current = end - 1; current >= index; current--) for (int current = end - 1; current >= index; current--)
items.set(FIRST_PAGE + current + writing.size(), items.get(FIRST_PAGE + current)); items.set(FIRST_PAGE + current + writing.size(), items.get(FIRST_PAGE + current));
for (ItemStack page : writing) items.set(FIRST_PAGE + index++, page.copy()); for (ItemStack page : writing) items.set(FIRST_PAGE + index++, page.copy());
@@ -1,6 +1,7 @@
package net.dnorberg.rivencraft.block.entity; package net.dnorberg.rivencraft.block.entity;
import net.dnorberg.rivencraft.item.InkVialItem; import net.dnorberg.rivencraft.item.InkVialItem;
import net.dnorberg.rivencraft.writing.InkVialExchange;
import net.dnorberg.rivencraft.registry.ModBlockEntities; import net.dnorberg.rivencraft.registry.ModBlockEntities;
import net.dnorberg.rivencraft.registry.ModItems; import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.writing.WritingInkService; import net.dnorberg.rivencraft.writing.WritingInkService;
@@ -64,35 +65,21 @@ public final class InkMixerBlockEntity extends BlockEntity implements Container
worldPosition.getZ() + 0.5) <= 64.0; worldPosition.getZ() + 0.5) <= 64.0;
} }
private boolean hasBottleSpace() {
ItemStack bottles = items.get(BOTTLES);
return bottles.isEmpty() || bottles.is(Items.GLASS_BOTTLE)
&& bottles.getCount() < bottles.getMaxStackSize();
}
/** No server tick: refill only when ink, bottle space, or consumption changes. */ /** No server tick: refill only when ink, bottle space, or consumption changes. */
private void refillEmptyBasin() { private void refillEmptyBasin() {
if (level == null || level.isClientSide || inkRemaining != 0 || !hasBottleSpace()) return; if (level != null && !level.isClientSide && inkRemaining == 0) {
ItemStack vial = items.get(INK); int addedInk = InkVialExchange.exchange(items, INK, BOTTLES);
if (!vial.is(ModItems.INK_VIAL.get())) return; if (addedInk > 0) {
int amount = Math.clamp(InkVialItem.remaining(vial), 0, InkVialItem.CAPACITY); inkRemaining = addedInk;
if (amount == 0) return; setChanged();
inkRemaining = amount; }
vial.shrink(1); }
if (vial.isEmpty()) items.set(INK, ItemStack.EMPTY);
ItemStack bottles = items.get(BOTTLES);
if (bottles.isEmpty()) items.set(BOTTLES, new ItemStack(Items.GLASS_BOTTLE));
else bottles.grow(1);
setChanged();
} }
public boolean canCreateLinkPanel() { public boolean canCreateLinkPanel() {
if (!items.get(PAPER).is(Items.PAPER)) return false; if (!items.get(PAPER).is(Items.PAPER)) return false;
int cost = WritingInkService.linkPanelCost(); int cost = WritingInkService.linkPanelCost();
if (inkRemaining >= cost) return true; return InkVialExchange.canPay(items, INK, BOTTLES, inkRemaining, cost);
ItemStack vial = items.get(INK);
return vial.is(ModItems.INK_VIAL.get()) && hasBottleSpace()
&& inkRemaining + InkVialItem.remaining(vial) >= cost;
} }
/** Commit inputs only when a virtual output is actually taken. */ /** Commit inputs only when a virtual output is actually taken. */
@@ -100,13 +87,7 @@ public final class InkMixerBlockEntity extends BlockEntity implements Container
if (!canCreateLinkPanel()) return false; if (!canCreateLinkPanel()) return false;
int cost = WritingInkService.linkPanelCost(); int cost = WritingInkService.linkPanelCost();
if (inkRemaining < cost) { if (inkRemaining < cost) {
ItemStack vial = items.get(INK); inkRemaining += InkVialExchange.exchange(items, INK, BOTTLES);
inkRemaining += Math.clamp(InkVialItem.remaining(vial), 0, InkVialItem.CAPACITY);
vial.shrink(1);
if (vial.isEmpty()) items.set(INK, ItemStack.EMPTY);
ItemStack bottles = items.get(BOTTLES);
if (bottles.isEmpty()) items.set(BOTTLES, new ItemStack(Items.GLASS_BOTTLE));
else bottles.grow(1);
} }
inkRemaining -= cost; inkRemaining -= cost;
items.get(PAPER).shrink(1); items.get(PAPER).shrink(1);
@@ -1,6 +1,7 @@
package net.dnorberg.rivencraft.block.entity; package net.dnorberg.rivencraft.block.entity;
import net.dnorberg.rivencraft.item.InkVialItem; import net.dnorberg.rivencraft.item.InkVialItem;
import net.dnorberg.rivencraft.writing.InkVialExchange;
import net.dnorberg.rivencraft.writing.WritingInkService; import net.dnorberg.rivencraft.writing.WritingInkService;
import net.dnorberg.rivencraft.registry.ModBlockEntities; import net.dnorberg.rivencraft.registry.ModBlockEntities;
import net.dnorberg.rivencraft.registry.ModItems; import net.dnorberg.rivencraft.registry.ModItems;
@@ -92,26 +93,15 @@ public final class WritingDeskBlockEntity extends BlockEntity implements Contain
}; };
} }
private boolean hasBottleSpace() {
ItemStack returned = items.get(RETURN);
return returned.isEmpty() || returned.is(Items.GLASS_BOTTLE)
&& returned.getCount() < returned.getMaxStackSize();
}
/** Consume one vial only when the empty meter can return its glass bottle. */ /** Consume one vial only when the empty meter can return its glass bottle. */
private void refillEmptyInkBar() { private void refillEmptyInkBar() {
if (level == null || level.isClientSide || inkRemaining != 0 || !hasBottleSpace()) return; if (level != null && !level.isClientSide && inkRemaining == 0) {
ItemStack vial = items.get(INK); int addedInk = InkVialExchange.exchange(items, INK, RETURN);
if (!vial.is(ModItems.INK_VIAL.get())) return; if (addedInk > 0) {
int ink = Math.clamp(InkVialItem.remaining(vial), 0, InkVialItem.CAPACITY); inkRemaining = addedInk;
if (ink == 0) return; setChanged();
inkRemaining = ink; }
vial.shrink(1); }
if (vial.isEmpty()) items.set(INK, ItemStack.EMPTY);
ItemStack returned = items.get(RETURN);
if (returned.isEmpty()) items.set(RETURN, new ItemStack(Items.GLASS_BOTTLE));
else returned.grow(1);
setChanged();
} }
/** The output is virtual; inputs are committed only after a result can be given to a player. */ /** The output is virtual; inputs are committed only after a result can be given to a player. */
@@ -119,23 +109,14 @@ public final class WritingDeskBlockEntity extends BlockEntity implements Contain
ItemStack paper = items.get(PAPER); ItemStack paper = items.get(PAPER);
if (!canPlaceItem(PAPER, paper) || paper.isEmpty()) return false; if (!canPlaceItem(PAPER, paper) || paper.isEmpty()) return false;
int cost = WritingInkService.symbolCopyCost(); int cost = WritingInkService.symbolCopyCost();
if (inkRemaining >= cost) return true; return InkVialExchange.canPay(items, INK, RETURN, inkRemaining, cost);
ItemStack vial = items.get(INK);
return vial.is(ModItems.INK_VIAL.get()) && inkRemaining + InkVialItem.remaining(vial) >= cost
&& hasBottleSpace();
} }
public boolean consumeCopyMaterials() { public boolean consumeCopyMaterials() {
if (!canConsumeCopyMaterials()) return false; if (!canConsumeCopyMaterials()) return false;
int cost = WritingInkService.symbolCopyCost(); int cost = WritingInkService.symbolCopyCost();
if (inkRemaining < cost) { if (inkRemaining < cost) {
ItemStack vial = items.get(INK); inkRemaining += InkVialExchange.exchange(items, INK, RETURN);
inkRemaining += Math.clamp(InkVialItem.remaining(vial), 0, InkVialItem.CAPACITY);
vial.shrink(1);
if (vial.isEmpty()) items.set(INK, ItemStack.EMPTY);
ItemStack returned = items.get(RETURN);
if (returned.isEmpty()) items.set(RETURN, new ItemStack(Items.GLASS_BOTTLE));
else returned.grow(1);
} }
inkRemaining -= cost; inkRemaining -= cost;
removeItem(PAPER, 1); removeItem(PAPER, 1);
@@ -148,7 +129,6 @@ public final class WritingDeskBlockEntity extends BlockEntity implements Contain
refillEmptyInkBar(); refillEmptyInkBar();
} }
@Override public void clearContent() { @Override public void clearContent() {
items.clear();
items = NonNullList.withSize(SIZE, ItemStack.EMPTY); items = NonNullList.withSize(SIZE, ItemStack.EMPTY);
inkRemaining = 0; inkRemaining = 0;
displayPage = ItemStack.EMPTY; displayPage = ItemStack.EMPTY;
@@ -0,0 +1,134 @@
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.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 && !holder.is(CAVE_BIOMES) && !holder.is(BiomeTags.IS_NETHER)) {
throw new IllegalArgumentException("Biome " + id
+ " is not a cave or Nether biome; use #rivencraft:cave_biomes or #minecraft:is_nether");
}
}
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")) : availableBiomes);
}
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. For Cave terrain,
// eligible() returns the cave tag; other terrains use their preset.
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();
if (!tagged.isEmpty()) return tagged;
return 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();
}
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 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, long createdGameTime,
ResourceLocation dimensionId, ResourceLocation dimensionId,
BlockPos spawn, BlockPos spawn,
AgeTraits traits AgeTraits traits,
AgeGenerationPlan plan
) { ) {
public static final ResourceLocation RANDOM_VANILLA_PROFILE = ResourceLocation.fromNamespaceAndPath( public static final ResourceLocation RANDOM_VANILLA_PROFILE = ResourceLocation.fromNamespaceAndPath(
Rivencraft.MOD_ID, "random_vanilla" Rivencraft.MOD_ID, "random_vanilla"
); );
public static final int CURRENT_GENERATION_VERSION = 13; public static final int CURRENT_GENERATION_VERSION = 16;
public AgeDefinition { public AgeDefinition {
Objects.requireNonNull(id, "id"); Objects.requireNonNull(id, "id");
@@ -29,6 +30,16 @@ public record AgeDefinition(
Objects.requireNonNull(generationProfile, "generationProfile"); Objects.requireNonNull(generationProfile, "generationProfile");
Objects.requireNonNull(dimensionId, "dimensionId"); Objects.requireNonNull(dimensionId, "dimensionId");
Objects.requireNonNull(traits, "traits"); 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) { public static ResourceLocation dimensionId(UUID ageId) {
@@ -59,6 +70,6 @@ public record AgeDefinition(
public AgeDefinition withSpawn(BlockPos spawn) { public AgeDefinition withSpawn(BlockPos spawn) {
return new AgeDefinition(id, name, seed, generationProfile, generationVersion, 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 dev.galacticraft.dynamicdimensions.api.event.DynamicDimensionLoadCallback;
import java.util.Optional; import java.util.Optional;
import java.util.List; 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.Collections;
import java.util.Comparator;
import java.util.Random;
import net.dnorberg.rivencraft.Rivencraft; import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.compat.ImmersivePortalsChunkLoaders; import net.dnorberg.rivencraft.compat.ImmersivePortalsChunkLoaders;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.minecraft.core.BlockPos; import net.minecraft.core.BlockPos;
import net.minecraft.core.GlobalPos; import net.minecraft.core.GlobalPos;
import net.minecraft.core.Holder; 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.FixedBiomeSource;
import net.minecraft.world.level.biome.MultiNoiseBiomeSource; import net.minecraft.world.level.biome.MultiNoiseBiomeSource;
import net.dnorberg.rivencraft.world.ScaledBiomeSource; 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.chunk.ChunkGenerator;
import net.minecraft.world.level.dimension.BuiltinDimensionTypes; import net.minecraft.world.level.dimension.BuiltinDimensionTypes;
import net.minecraft.world.level.dimension.DimensionType; 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.Heightmap;
import net.minecraft.world.level.levelgen.NoiseBasedChunkGenerator; 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.NoiseGeneratorSettings;
import net.minecraft.world.level.levelgen.SurfaceRules; import net.minecraft.world.level.levelgen.SurfaceRules;
import net.minecraft.world.level.levelgen.flat.FlatLevelGeneratorSettings; import net.minecraft.world.level.levelgen.flat.FlatLevelGeneratorSettings;
@@ -59,6 +66,7 @@ public final class AgeDimensionService {
DynamicDimensionLoadCallback.register((server, loader) -> { DynamicDimensionLoadCallback.register((server, loader) -> {
ServerLevel overworld = server.overworld(); ServerLevel overworld = server.overworld();
for (AgeDefinition age : AgeRegistrySavedData.get(overworld).definitions()) { for (AgeDefinition age : AgeRegistrySavedData.get(overworld).definitions()) {
if (!canLoadProfile(server, age)) continue;
ServerLevel level = loader.loadDynamicDimension( ServerLevel level = loader.loadDynamicDimension(
age.dimensionId(), age.dimensionId(),
createGenerator(server, age), createGenerator(server, age),
@@ -73,7 +81,12 @@ public final class AgeDimensionService {
} }
public static Optional<LinkTarget> resolve(ServerPlayer player, AgeReference reference) { 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); ServerLevel level = ensureLoaded(player.getServer(), definition);
if (level == null) { if (level == null) {
return Optional.empty(); return Optional.empty();
@@ -100,6 +113,8 @@ public final class AgeDimensionService {
return existing; return existing;
} }
if (!canLoadProfile(server, definition)) return null;
ServerLevel overworld = server.overworld(); ServerLevel overworld = server.overworld();
ServerLevel loaded = DynamicDimensionRegistry.from(server).loadDynamicDimension( ServerLevel loaded = DynamicDimensionRegistry.from(server).loadDynamicDimension(
definition.dimensionId(), 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) { private static void applyInitialCelestialPhase(ServerLevel level, AgeDefinition age) {
long phaseTime = (long)(age.traits().celestialPhase() * Level.TICKS_PER_DAY); 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); level.setDayTime(phaseTime);
} }
@@ -261,13 +296,16 @@ public final class AgeDimensionService {
} }
private static ChunkGenerator createGenerator(MinecraftServer server, AgeDefinition age) { 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) { if (profile.terrain() == AgeRuntimeProfile.Terrain.FLAT) {
return new FlatLevelSource(FlatLevelGeneratorSettings.getDefault( var settings = FlatLevelGeneratorSettings.getDefault(
server.registryAccess().lookupOrThrow(Registries.BIOME), server.registryAccess().lookupOrThrow(Registries.BIOME),
server.registryAccess().lookupOrThrow(Registries.STRUCTURE_SET), server.registryAccess().lookupOrThrow(Registries.STRUCTURE_SET),
server.registryAccess().lookupOrThrow(Registries.PLACED_FEATURE) 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) { if (profile.terrain() == AgeRuntimeProfile.Terrain.VOID) {
FlatLevelGeneratorSettings settings = new FlatLevelGeneratorSettings( FlatLevelGeneratorSettings settings = new FlatLevelGeneratorSettings(
@@ -276,19 +314,18 @@ public final class AgeDimensionService {
List.of() List.of()
); );
settings.updateLayers(); 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); var noiseSettings = server.registryAccess().lookupOrThrow(Registries.NOISE_SETTINGS);
ResourceKey<NoiseGeneratorSettings> settingsKey = ResourceKey.create( ResourceKey<NoiseGeneratorSettings> settingsKey = ResourceKey.create(
Registries.NOISE_SETTINGS, profile.noiseSettings()); 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(); 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) { private static NoiseGeneratorSettings withBiomeMaterialRules(NoiseGeneratorSettings base) {
@@ -333,34 +370,86 @@ public final class AgeDimensionService {
private static BiomeSource createBiomeSource( private static BiomeSource createBiomeSource(
MinecraftServer server, MinecraftServer server,
AgeDefinition age, AgeDefinition age,
net.minecraft.core.HolderGetter<net.minecraft.world.level.biome.MultiNoiseBiomeSourceParameterList> biomeParameters, AgeRuntimeProfile profile
ResourceKey<net.minecraft.world.level.biome.MultiNoiseBiomeSourceParameterList> biomePreset
) { ) {
List<net.minecraft.core.Holder.Reference<Biome>> biomes = server.registryAccess() if (age.generationVersion() < AgeDefinition.CURRENT_GENERATION_VERSION) {
.lookupOrThrow(Registries.BIOME) return legacyBiomeSource(server, age, profile);
.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));
} }
AgeTraits.BiomeDistribution distribution = age.traits().biomeDistribution(); AgeBiomeSelection selection = age.plan() != null && age.plan().biomeSelection() != null
if ((distribution == AgeTraits.BiomeDistribution.TILED ? age.plan().biomeSelection()
|| distribution == AgeTraits.BiomeDistribution.GRID) && biomes.size() >= 2) { : AgeBiomeSelection.compile(net.dnorberg.rivencraft.writing.WritingGrammar.parse(OrderedWriting.EMPTY),
List<net.minecraft.core.Holder.Reference<Biome>> selected = new java.util.ArrayList<>(biomes); age.traits(), profile, age.seed(), server.registryAccess());
long salt = distribution == AgeTraits.BiomeDistribution.GRID var registry = server.registryAccess().lookupOrThrow(Registries.BIOME);
? 0x4752494442494F4DL List<Holder<Biome>> biomes = new ArrayList<>();
: 0x54494C454442494FL; List<ResourceLocation> fallbacks = AgeBiomeSelection.eligible(server.registryAccess(), profile);
Collections.shuffle(selected, new java.util.Random(age.seed() ^ salt)); Set<ResourceLocation> present = new LinkedHashSet<>();
return new CheckerboardColumnBiomeSource( for (ResourceLocation id : selection.biomes()) {
HolderSet.direct(List.of(selected.get(0), selected.get(1))), var holder = registry.get(ResourceKey.create(Registries.BIOME, id));
distribution == AgeTraits.BiomeDistribution.GRID if (holder.isEmpty()) {
? GRID_BIOME_SCALE ResourceLocation fallback = fallbacks.stream().filter(candidate -> !present.contains(candidate))
: TILED_BIOME_SCALE .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) { 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 TINY -> 0;
case SMALL -> 1; case SMALL -> 1;
case MEDIUM -> 2; case MEDIUM -> 2;
@@ -368,28 +457,25 @@ public final class AgeDimensionService {
case HUGE -> 4; case HUGE -> 4;
default -> -1; default -> -1;
}; };
if (scaledBiomeScale >= 0 && biomes.size() >= 3) { if (scale >= 0 && all.size() >= 3) {
List<net.minecraft.core.Holder.Reference<Biome>> selected = new java.util.ArrayList<>(biomes); List<Holder.Reference<Biome>> selected = new ArrayList<>(all);
long salt = distribution == AgeTraits.BiomeDistribution.TINY long salt = distribution == AgeTraits.BiomeDistribution.TINY
? 0x54494E5942494F4DL ? 0x54494E5942494F4DL : 0x5343414C45444249L;
: 0x5343414C45444249L; Collections.shuffle(selected, new Random(age.seed() ^ salt));
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))),
return new ScaledBiomeSource( age.seed(), scale);
HolderSet.direct(List.of(selected.get(0), selected.get(1), selected.get(2))),
age.seed(),
scaledBiomeScale
);
} }
return MultiNoiseBiomeSource.createFromPreset( var parameters = server.registryAccess().lookupOrThrow(Registries.MULTI_NOISE_BIOME_SOURCE_PARAMETER_LIST);
biomeParameters.getOrThrow(biomePreset)); return MultiNoiseBiomeSource.createFromPreset(parameters.getOrThrow(ResourceKey.create(
Registries.MULTI_NOISE_BIOME_SOURCE_PARAMETER_LIST, profile.biomePreset())));
} }
private static DimensionType createDimensionType(MinecraftServer server, AgeDefinition age) { 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) DimensionType base = server.registryAccess().lookupOrThrow(Registries.DIMENSION_TYPE)
.getOrThrow(ResourceKey.create(Registries.DIMENSION_TYPE, profile.dimensionType())).value(); .getOrThrow(ResourceKey.create(Registries.DIMENSION_TYPE, profile.dimensionType())).value();
AgeTraits.Lighting lighting = age.traits().lighting(); 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; float ambientLight = lighting == AgeTraits.Lighting.BRIGHT ? 0.25F : 0.0F;
return new DimensionType( return new DimensionType(
base.fixedTime(), base.fixedTime(),
@@ -404,7 +490,7 @@ public final class AgeDimensionService {
base.height(), base.height(),
base.logicalHeight(), base.logicalHeight(),
base.infiniburn(), base.infiniburn(),
base.effectsLocation(), AgeEnvironmentCompiler.skyEffects(age.plan(), base.effectsLocation()),
ambientLight, ambientLight,
base.monsterSettings() 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; package net.dnorberg.rivencraft.book;
import java.util.UUID; import java.util.UUID;
import java.util.List;
import net.dnorberg.rivencraft.Rivencraft; 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.core.BlockPos;
import net.minecraft.gametest.framework.GameTest; import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper; import net.minecraft.gametest.framework.GameTestHelper;
@@ -18,6 +22,54 @@ public final class AgePersistenceGameTests {
private 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") @GameTest(template = "empty")
public static void everyTraitCombinationRoundTripsWithoutRerolling(GameTestHelper helper) { public static void everyTraitCombinationRoundTripsWithoutRerolling(GameTestHelper helper) {
ListTag entries = new ListTag(); ListTag entries = new ListTag();
@@ -89,6 +141,8 @@ public final class AgePersistenceGameTests {
"Definitions predating named dimensions must retain the UUID-derived dimension"); "Definitions predating named dimensions must retain the UUID-derived dimension");
helper.assertValueEqual(definition.traits(), AgeTraits.LEGACY_DEFAULTS, helper.assertValueEqual(definition.traits(), AgeTraits.LEGACY_DEFAULTS,
"Definitions predating traits must receive stable 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()); CompoundTag serialized = migrated.save(new CompoundTag(), helper.getLevel().registryAccess());
AgeDefinition reloaded = AgeRegistrySavedData.load(serialized, 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.Optional;
import java.util.UUID; import java.util.UUID;
import java.util.List; import java.util.List;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.minecraft.core.BlockPos; import net.minecraft.core.BlockPos;
import net.minecraft.core.HolderLookup; import net.minecraft.core.HolderLookup;
import net.minecraft.core.RegistryAccess;
import net.minecraft.nbt.CompoundTag; import net.minecraft.nbt.CompoundTag;
import net.minecraft.nbt.ListTag; import net.minecraft.nbt.ListTag;
import net.minecraft.resources.ResourceLocation; 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_Y_TAG = "SpawnY";
private static final String SPAWN_Z_TAG = "SpawnZ"; private static final String SPAWN_Z_TAG = "SpawnZ";
private static final String TRAITS_TAG = "Traits"; 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 BIOME_DISTRIBUTION_TAG = "BiomeDistribution";
private static final String LIGHTING_TAG = "Lighting"; private static final String LIGHTING_TAG = "Lighting";
private static final String WEATHER_TAG = "Weather"; 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. */ /** Resolves a book identity, creating its deterministic random definition exactly once. */
public static AgeDefinition resolveOrCreate(ServerLevel level, AgeReference reference) { 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(); 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) { public Optional<AgeDefinition> find(UUID ageId) {
@@ -78,7 +107,8 @@ public final class AgeRegistrySavedData extends SavedData {
return updated; 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()); AgeDefinition existing = ages.get(reference.id());
if (existing != null) { if (existing != null) {
return existing; return existing;
@@ -87,16 +117,20 @@ public final class AgeRegistrySavedData extends SavedData {
String name = normalizedName(reference.name()); String name = normalizedName(reference.name());
ResourceLocation dimensionId = availableDimensionId(name); ResourceLocation dimensionId = availableDimensionId(name);
long seed = ageSeed(worldSeed, dimensionId); 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( AgeDefinition created = new AgeDefinition(
reference.id(), reference.id(),
name, name,
seed, seed,
AgeRuntimeProfiles.select(seed), plan == null || plan.authoredTerrain() == null ? seedProfile : plan.authoredTerrain(),
AgeDefinition.CURRENT_GENERATION_VERSION, AgeDefinition.CURRENT_GENERATION_VERSION,
createdGameTime, createdGameTime,
dimensionId, dimensionId,
null, null,
AgeTraits.select(seed) AgeEnvironmentCompiler.apply(plan, traits),
plan
); );
ages.put(created.id(), created); ages.put(created.id(), created);
setDirty(); setDirty();
@@ -138,7 +172,9 @@ public final class AgeRegistrySavedData extends SavedData {
entry.getLong(CREATED_TIME_TAG), entry.getLong(CREATED_TIME_TAG),
dimensionId, dimensionId,
spawn, spawn,
readTraits(entry) readTraits(entry),
entry.contains(PLAN_TAG, CompoundTag.TAG_COMPOUND)
? AgeGenerationPlan.load(entry.getCompound(PLAN_TAG)) : null
)); ));
} }
return data; return data;
@@ -171,6 +207,7 @@ public final class AgeRegistrySavedData extends SavedData {
traits.putFloat(CELESTIAL_ANGLE_TAG, age.traits().celestialAngle()); traits.putFloat(CELESTIAL_ANGLE_TAG, age.traits().celestialAngle());
traits.putFloat(CELESTIAL_PHASE_TAG, age.traits().celestialPhase()); traits.putFloat(CELESTIAL_PHASE_TAG, age.traits().celestialPhase());
entry.put(TRAITS_TAG, traits); entry.put(TRAITS_TAG, traits);
if (age.plan() != null) entry.put(PLAN_TAG, age.plan().save());
serializedAges.add(entry); serializedAges.add(entry);
}); });
tag.put(AGES_TAG, serializedAges); tag.put(AGES_TAG, serializedAges);
@@ -5,8 +5,12 @@ import com.google.gson.GsonBuilder;
import com.google.gson.JsonElement; import com.google.gson.JsonElement;
import com.google.gson.JsonObject; import com.google.gson.JsonObject;
import java.util.Map; import java.util.Map;
import java.util.List;
import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentHashMap;
import net.dnorberg.rivencraft.Rivencraft; 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.RegistryAccess;
import net.minecraft.core.registries.Registries; import net.minecraft.core.registries.Registries;
import net.minecraft.resources.ResourceKey; import net.minecraft.resources.ResourceKey;
@@ -59,6 +63,27 @@ public final class AgeRuntimeProfiles {
return ids.get(Math.floorMod(Long.hashCode(seed), ids.size())); 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) { static AgeRuntimeProfile parse(ResourceLocation id, JsonElement json, RegistryAccess registries) {
JsonObject object = json.getAsJsonObject(); JsonObject object = json.getAsJsonObject();
int schemaVersion = object.has("schema_version") ? object.get("schema_version").getAsInt() : 1; 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 noise = location(object, "noise_settings", "minecraft:overworld");
ResourceLocation biome = location(object, "biome_preset", "minecraft:overworld"); ResourceLocation biome = location(object, "biome_preset", "minecraft:overworld");
ResourceLocation dimension = location(object, "dimension_type", "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) { /** Recheck frozen plans before loading: a removed registry entry must not crash or silently alter an Age. */
requireRegistryEntry(registries, Registries.NOISE_SETTINGS, noise, id, "noise_settings"); 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, 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"); requireRegistryEntry(registries, Registries.DIMENSION_TYPE, profile.dimensionType(), id, "dimension_type");
return new AgeRuntimeProfile(schemaVersion, terrain, noise, biome, dimension);
} }
private static String requiredString(JsonObject object, String name) { private static String requiredString(JsonObject object, String name) {
@@ -63,6 +63,10 @@ public record AgeTraits(
return celestialPeriod == STOPPED_CELESTIAL_PERIOD; 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) { public static <E extends Enum<E>> E parseOrDefault(String value, E fallback) {
try { try {
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
@@ -0,0 +1,154 @@
package net.dnorberg.rivencraft.book;
import java.util.HashSet;
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.registry.ModCreativeTabs;
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 symbolCategoriesPartitionCreativePages(GameTestHelper helper) {
var registries = helper.getLevel().registryAccess();
var allPages = PageItem.creativeSymbolPages(registries);
Set<ResourceLocation> collected = new HashSet<>();
helper.assertTrue(ModCreativeTabs.SYMBOL_PAGES.keySet().containsAll(PageItem.bundledCreativeCategories()),
"Every bundled page category must receive a creative tab");
for (ResourceLocation category : PageItem.bundledCreativeCategories()) {
var categoryPages = PageItem.creativeSymbolPages(registries, category);
helper.assertFalse(categoryPages.isEmpty(), "Every category tab must contain pages: " + category);
for (var page : categoryPages) {
helper.assertValueEqual(PageItem.creativeCategory(page), category,
"Category tabs must not mix symbol pages");
helper.assertTrue(collected.add(PageItem.content(page).symbol().orElseThrow().id()),
"A symbol page must appear in exactly one category tab");
}
}
helper.assertValueEqual(collected.size(), allPages.size(),
"Category tabs must contain every bundled and generated biome page");
var biomePages = PageItem.creativeSymbolPages(registries,
ResourceLocation.fromNamespaceAndPath("rivencraft", "biome"));
var generationPages = PageItem.creativeSymbolPages(registries,
ResourceLocation.fromNamespaceAndPath("rivencraft", "biome_generation"));
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.assertFalse(biomePages.stream().anyMatch(page -> PageItem.content(page).symbol().orElseThrow()
.id().getPath().equals("biome/tiny")), "Biome generation types must leave the Biome tab");
helper.assertTrue(generationPages.stream().anyMatch(page -> PageItem.content(page).symbol().orElseThrow()
.id().getPath().equals("biome/tiny")), "Biome generation types need their own tab");
helper.assertTrue(allPages.stream().noneMatch(page -> PageItem.content(page).kind() == PageContent.Kind.BLANK),
"Blank pages must not enter the creative or JEI symbol-page feed");
helper.assertValueEqual(PageItem.content(PageItem.createLinkPanelPage()).kind(), PageContent.Kind.LINK_PANEL,
"Link pages must stay separate from symbol categories");
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,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");
}
}
@@ -13,6 +13,10 @@ import net.neoforged.fml.event.lifecycle.FMLClientSetupEvent;
import net.neoforged.neoforge.common.NeoForge; import net.neoforged.neoforge.common.NeoForge;
import net.neoforged.neoforge.client.event.EntityRenderersEvent; import net.neoforged.neoforge.client.event.EntityRenderersEvent;
import net.neoforged.neoforge.client.event.RegisterMenuScreensEvent; import net.neoforged.neoforge.client.event.RegisterMenuScreensEvent;
import net.neoforged.neoforge.client.event.RegisterClientReloadListenersEvent;
import net.neoforged.neoforge.client.extensions.common.IClientItemExtensions;
import net.neoforged.neoforge.client.extensions.common.RegisterClientExtensionsEvent;
import net.minecraft.client.renderer.BlockEntityWithoutLevelRenderer;
import net.dnorberg.rivencraft.client.screen.NotebookScreen; import net.dnorberg.rivencraft.client.screen.NotebookScreen;
import net.dnorberg.rivencraft.client.screen.WritingDeskScreen; import net.dnorberg.rivencraft.client.screen.WritingDeskScreen;
import net.dnorberg.rivencraft.client.screen.BookBinderScreen; import net.dnorberg.rivencraft.client.screen.BookBinderScreen;
@@ -38,6 +42,24 @@ public final class ClientEvents {
event.register(ModMenus.INK_MIXER.get(), InkMixerScreen::new); event.register(ModMenus.INK_MIXER.get(), InkMixerScreen::new);
} }
@SubscribeEvent
public static void registerPageItemRenderer(RegisterClientExtensionsEvent event) {
event.registerItem(new IClientItemExtensions() {
private final SymbolPageItemRenderer renderer = new SymbolPageItemRenderer();
@Override
public BlockEntityWithoutLevelRenderer getCustomRenderer() {
return renderer;
}
}, ModItems.PAGE.get());
}
@SubscribeEvent
public static void registerPageTextureReload(RegisterClientReloadListenersEvent event) {
event.registerReloadListener((net.minecraft.server.packs.resources.ResourceManagerReloadListener)
manager -> SymbolPageTextures.clear());
}
@SubscribeEvent @SubscribeEvent
public static void clientSetup(FMLClientSetupEvent event) { public static void clientSetup(FMLClientSetupEvent event) {
event.enqueueWork(() -> ItemProperties.register( event.enqueueWork(() -> ItemProperties.register(
@@ -0,0 +1,47 @@
package net.dnorberg.rivencraft.client;
import com.mojang.blaze3d.vertex.PoseStack;
import com.mojang.blaze3d.vertex.VertexConsumer;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.item.PageItem;
import net.minecraft.client.Minecraft;
import net.minecraft.client.renderer.BlockEntityWithoutLevelRenderer;
import net.minecraft.client.renderer.MultiBufferSource;
import net.minecraft.client.renderer.RenderType;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.item.ItemDisplayContext;
import net.minecraft.world.item.ItemStack;
/** Flat page model whose symbol artwork is resolved from the stack at render time. */
public final class SymbolPageItemRenderer extends BlockEntityWithoutLevelRenderer {
public SymbolPageItemRenderer() {
super(Minecraft.getInstance().getBlockEntityRenderDispatcher(), Minecraft.getInstance().getEntityModels());
}
@Override
public void renderByItem(ItemStack stack, ItemDisplayContext context, PoseStack pose,
MultiBufferSource buffers, int light, int overlay) {
ResourceLocation texture = switch (PageItem.content(stack).kind()) {
case BLANK -> texture("page");
case LINK_PANEL -> texture("page_link_panel");
case UNRESOLVED_SYMBOL -> texture("page_unresolved");
case SYMBOL -> SymbolPageTextures.forItem(stack);
};
VertexConsumer vertices = buffers.getBuffer(RenderType.entityCutoutNoCull(texture));
var matrix = pose.last().pose();
vertex(vertices, matrix, 0, 0, 0, 1, light, overlay);
vertex(vertices, matrix, 1, 0, 1, 1, light, overlay);
vertex(vertices, matrix, 1, 1, 1, 0, light, overlay);
vertex(vertices, matrix, 0, 1, 0, 0, light, overlay);
}
private static void vertex(VertexConsumer vertices, org.joml.Matrix4f matrix,
float x, float y, float u, float v, int light, int overlay) {
vertices.addVertex(matrix, x, y, 0.5F).setColor(255, 255, 255, 255)
.setUv(u, v).setOverlay(overlay).setLight(light).setNormal(0, 0, 1);
}
private static ResourceLocation texture(String name) {
return ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "textures/item/" + name + ".png");
}
}
@@ -0,0 +1,240 @@
package net.dnorberg.rivencraft.client;
import com.mojang.blaze3d.platform.NativeImage;
import java.io.IOException;
import java.io.InputStream;
import java.util.LinkedHashMap;
import java.util.Locale;
import java.util.Map;
import java.util.Random;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.SymbolDisplayMetadata;
import net.dnorberg.rivencraft.writing.SymbolPoems;
import net.dnorberg.rivencraft.writing.SymbolNumerals;
import net.minecraft.client.Minecraft;
import net.minecraft.client.gui.GuiGraphics;
import net.minecraft.client.renderer.texture.DynamicTexture;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.server.packs.resources.ResourceManager;
import net.minecraft.world.item.ItemStack;
/** Client-only, bounded cache of Legacy-style page compositions; no per-symbol PNGs. */
public final class SymbolPageTextures {
private static final int SIZE = 128;
private static final int GLYPH = 51;
// A 16 px item icon displays a 13 px symbol: three pixels narrower overall.
private static final int ITEM_SYMBOL_SIZE = 13;
private static final int ICON_SIZE = 16;
private static final int CACHE_LIMIT = 256;
private static final ResourceLocation BASE = texture("item/page");
private static final ResourceLocation COMPONENTS = texture("gui/symbolcomponents");
private static final ResourceLocation FALLBACK = texture("item/page_symbol");
private static final Map<String, ResourceLocation> CACHE = new LinkedHashMap<>(16, .75F, true);
private static final Map<String, int[]> WORD_CACHE = new LinkedHashMap<>(16, .75F, true);
private static NativeImage base;
private static NativeImage components;
private static int nextId;
// WordData from Mystcraft Legacy 0.13.7.06. Other words get a stable generated glyph.
private static final Map<String, int[]> WORDS = Map.ofEntries(
Map.entry("Terrain", new int[] {6,10,12,13,16,19,24,25,27}),
Map.entry("Form", new int[] {4,6,8,9,10,11,13,14,16,23}),
Map.entry("Tradition", new int[] {4,6,7,8,9,14,17,18,20}),
Map.entry("Flow", new int[] {4,7,12,13,17,18}),
Map.entry("Constraint", new int[] {5,6,9,11,13,20,22,23}),
Map.entry("Nature", new int[] {5,6,8,10,11,12,15,16,17,22}),
Map.entry("Sustain", new int[] {6,16,19,20,21,23}),
Map.entry("Ethereal", new int[] {4,6,8,13,14,16,18,21,23}),
Map.entry("Dynamic", new int[] {4,5,6,12,13,17,18,22,23}),
Map.entry("Cycle", new int[] {4,5,7,16,17,18}),
Map.entry("Balance", new int[] {4,6,9,10,16,19}),
Map.entry("Transform", new int[] {4,5,6,8,11,14,18,20,21}),
Map.entry("Time", new int[] {4,5,7,12,13,19,20,21,22,23}),
Map.entry("System", new int[] {10,12,14,15,16,20,21,22}),
Map.entry("Void", new int[] {4,5,6,16,17,18,23})
);
private SymbolPageTextures() {}
/** Transparent full-size artwork for GUI thumbnails drawn over their own page background. */
public static ResourceLocation forPage(ItemStack stack) {
return forPage(stack, false);
}
/** Full page texture with artwork reduced by three pixels at 16 px item-icon scale. */
public static ResourceLocation forItem(ItemStack stack) {
return forPage(stack, true);
}
private static ResourceLocation forPage(ItemStack stack, boolean item) {
PageContent content = PageItem.content(stack);
if (content.kind() == PageContent.Kind.UNRESOLVED_SYMBOL) return texture("item/page_unresolved");
if (content.kind() != PageContent.Kind.SYMBOL) return FALLBACK;
SymbolDisplayMetadata metadata = stack.get(ModDataComponents.PAGE_SYMBOL_DISPLAY.get());
ResourceLocation id = content.symbol().orElseThrow().id();
return forSymbol(id, metadata == null ? "" : metadata.poem(), item);
}
private static ResourceLocation forSymbol(ResourceLocation id, String poem, boolean item) {
if (poem.length() > 96 || !poem.matches("[A-Za-z]+(?: [A-Za-z]+){3}")) poem = "";
if (poem.isEmpty()) poem = SymbolPoems.builtIn(id);
String key = id + "|" + poem + (item ? "|item" : "|thumbnail");
ResourceLocation cached = CACHE.get(key);
if (cached != null) return cached;
try {
loadSources(Minecraft.getInstance().getResourceManager());
NativeImage image = compose(id, poem, item);
ResourceLocation location = ResourceLocation.fromNamespaceAndPath(
Rivencraft.MOD_ID, "generated/page_" + nextId++);
Minecraft.getInstance().getTextureManager().register(location, new DynamicTexture(image));
CACHE.put(key, location);
if (CACHE.size() > CACHE_LIMIT) {
String eldest = CACHE.keySet().iterator().next();
Minecraft.getInstance().getTextureManager().release(CACHE.remove(eldest));
}
return location;
} catch (IOException exception) {
Rivencraft.LOGGER.error("Could not compose symbol page {}", id, exception);
return FALLBACK;
}
}
public static void clear() {
var textures = Minecraft.getInstance().getTextureManager();
CACHE.values().forEach(textures::release);
CACHE.clear();
WORD_CACHE.clear();
if (base != null) base.close();
if (components != null) components.close();
base = null;
components = null;
}
private static void loadSources(ResourceManager manager) throws IOException {
if (base != null && components != null) return;
try (InputStream page = manager.getResourceOrThrow(BASE).open();
InputStream sheet = manager.getResourceOrThrow(COMPONENTS).open()) {
base = NativeImage.read(page);
components = NativeImage.read(sheet);
}
}
private static NativeImage compose(ResourceLocation id, String poem, boolean item) {
// GUI variants have no parchment layer, so their untouched pixels must be transparent.
NativeImage image = new NativeImage(SIZE, SIZE, true);
if (item) {
for (int y = 0; y < SIZE; y++) for (int x = 0; x < SIZE; x++) {
image.setPixelRGBA(x, y, base.getPixelRGBA(x * base.getWidth() / SIZE,
y * base.getHeight() / SIZE));
}
}
String[] words = poem.isBlank() ? generatedWords(id) : poem.split(" ");
int[] offsetsX = {38, 77, 38, 0};
int[] offsetsY = {0, 38, 77, 38};
int glyphSize = item ? GLYPH * ITEM_SYMBOL_SIZE / ICON_SIZE : GLYPH;
for (int word = 0; word < 4; word++) {
int originX = item ? scaleForItem(offsetsX[word]) : offsetsX[word];
int originY = item ? scaleForItem(offsetsY[word]) : offsetsY[word];
for (int component : glyphs(words[word])) {
for (int y = 0; y < glyphSize; y++) for (int x = 0; x < glyphSize; x++) {
int pixel = components.getPixelRGBA((component % 8) * 64 + x * 64 / glyphSize,
(component / 8) * 64 + y * 64 / glyphSize);
int alpha = pixel >>> 24;
if (alpha != 0) image.blendPixel(originX + x, originY + y,
(alpha << 24) | 0x001A212B);
}
}
}
return image;
}
private static int scaleForItem(int coordinate) {
return SIZE / 2 + Math.round((coordinate - SIZE / 2F) * ITEM_SYMBOL_SIZE / ICON_SIZE);
}
private static String[] generatedWords(ResourceLocation id) {
String stem = id.toString();
return new String[] {stem + 'a', stem + 'b', stem + 'c', stem + 'd'};
}
private static int[] glyphs(String word) {
int[] known = WORDS.get(word);
if (known != null) return known;
String key = word.toLowerCase(Locale.ROOT);
int[] cached = WORD_CACHE.get(key);
if (cached != null) return cached;
Random random = new Random(key.hashCode());
int[] components = new int[random.nextInt(10) + 3];
for (int index = 0; index < components.length; index++) components[index] = random.nextInt(20) + 4;
WORD_CACHE.put(key, components);
if (WORD_CACHE.size() > CACHE_LIMIT) WORD_CACHE.remove(WORD_CACHE.keySet().iterator().next());
return components;
}
/** Draw a word as a layered Legacy glyph, or a number with Legacy's number components. */
public static void drawWordGlyph(GuiGraphics graphics, String word, int x, int y, int size) {
if (word.matches("[0-9]+")) {
try {
drawNumeral(graphics, Integer.parseInt(word), x, y, size);
return;
} catch (NumberFormatException ignored) {
// Oversized numerals still receive a stable word glyph.
}
}
graphics.setColor(0.13F, 0.10F, 0.08F, 1F);
for (int component : glyphs(word)) drawComponent(graphics, component, x, y, size);
graphics.setColor(1F, 1F, 1F, 1F);
}
/** Legacy's single-number marks; numbers above 24 use positional base 25. */
public static void drawNumeral(GuiGraphics graphics, int number, int x, int y, int size) {
int[] digits = SymbolNumerals.digitsFor(number);
int digitSize = digits.length == 1 ? size : Math.max(8, size * 3 / 4);
graphics.setColor(0.13F, 0.10F, 0.08F, 1F);
for (int digit : digits) {
for (int component : SymbolNumerals.componentsForDigit(digit))
drawComponent(graphics, component, x, y + (size - digitSize) / 2, digitSize);
x += digitSize + 1;
}
graphics.setColor(1F, 1F, 1F, 1F);
}
/** Render translated prose as a sequence of word glyphs within a fixed-width book page. */
public static int drawGlyphText(GuiGraphics graphics, String text, int x, int y, int maxWidth) {
int cursor = x;
boolean drew = false;
for (String word : text.split("[^\\p{L}\\p{N}]+")) {
if (word.isEmpty()) continue;
int width = word.matches("[0-9]+") ? numeralWidth(word, 12) : 12;
if (cursor != x && cursor + width > x + maxWidth) {
cursor = x;
y += 13;
}
drawWordGlyph(graphics, word, cursor, y, 12);
cursor += width + 3;
drew = true;
}
return y + (drew ? 13 : 0);
}
private static int numeralWidth(String word, int size) {
try {
int count = SymbolNumerals.digitsFor(Integer.parseInt(word)).length;
return count == 1 ? size : count * (size * 3 / 4 + 1) - 1;
} catch (NumberFormatException ignored) {
return size;
}
}
private static void drawComponent(GuiGraphics graphics, int component, int x, int y, int size) {
graphics.blit(COMPONENTS, x, y, size, size,
(component % 8) * 64, (component / 8) * 64, 64, 64, 512, 512);
}
private static ResourceLocation texture(String path) {
return ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "textures/" + path + ".png");
}
}
@@ -1,5 +1,6 @@
package net.dnorberg.rivencraft.client.screen; package net.dnorberg.rivencraft.client.screen;
import java.util.Locale;
import net.dnorberg.rivencraft.Rivencraft; import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.block.entity.BookBinderBlockEntity; import net.dnorberg.rivencraft.block.entity.BookBinderBlockEntity;
import net.dnorberg.rivencraft.item.PageItem; import net.dnorberg.rivencraft.item.PageItem;
@@ -32,6 +33,7 @@ public final class BookBinderScreen extends AbstractContainerScreen<BookBinderMe
private EditBox titleInput; private EditBox titleInput;
private int firstVisible; private int firstVisible;
private int lastGrammarErrorStripIndex = -1;
private boolean stripClickPendingRelease; private boolean stripClickPendingRelease;
public BookBinderScreen(BookBinderMenu menu, Inventory inventory, Component title) { 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) { @Override public void render(GuiGraphics graphics, int mouseX, int mouseY, float partialTick) {
super.render(graphics, mouseX, mouseY, partialTick); super.render(graphics, mouseX, mouseY, partialTick);
firstVisible = Math.min(firstVisible, maxFirstVisible()); 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, graphics.enableScissor(leftPos + STRIP_X + 8, topPos + STRIP_Y,
leftPos + STRIP_X + STRIP_WIDTH - 8, topPos + STRIP_Y + STRIP_HEIGHT); leftPos + STRIP_X + STRIP_WIDTH - 8, topPos + STRIP_Y + STRIP_HEIGHT);
int count = visiblePageCount(); int count = visiblePageCount();
@@ -97,6 +106,16 @@ public final class BookBinderScreen extends AbstractContainerScreen<BookBinderMe
} }
graphics.disableScissor(); graphics.disableScissor();
drawScrollEnds(graphics); 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 (mouseY >= topPos + STRIP_Y && mouseY < topPos + STRIP_Y + STRIP_HEIGHT) {
if (firstVisible > 0 && mouseX >= leftPos + STRIP_X && mouseX < leftPos + STRIP_X + 8) 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); 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; return;
} }
int hovered = pageIndexAt(mouseX, mouseY); 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); graphics.renderTooltip(font, pageAtIndex(hovered), mouseX, mouseY);
else renderTooltip(graphics, mouseX, mouseY); else renderTooltip(graphics, mouseX, mouseY);
} }
@@ -146,7 +167,11 @@ public final class BookBinderScreen extends AbstractContainerScreen<BookBinderMe
case BLANK -> { } case BLANK -> { }
case LINK_PANEL -> graphics.fill(x + 5, y + 6, x + 22, y + 17, 0xFF000000); case LINK_PANEL -> graphics.fill(x + 5, y + 6, x + 22, y + 17, 0xFF000000);
case SYMBOL, UNRESOLVED_SYMBOL -> graphics.blit(NotebookScreen.symbolTexture(page), case SYMBOL, UNRESOLVED_SYMBOL -> graphics.blit(NotebookScreen.symbolTexture(page),
x + 1, y + 5, 24, 24, 16, 16, 96, 96, 128, 128); 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);
} }
} }
@@ -5,6 +5,7 @@ import java.util.Locale;
import net.dnorberg.rivencraft.book.AgeReference; import net.dnorberg.rivencraft.book.AgeReference;
import net.dnorberg.rivencraft.book.AgeTraits; import net.dnorberg.rivencraft.book.AgeTraits;
import net.dnorberg.rivencraft.client.ClientBookExploreOverlay; import net.dnorberg.rivencraft.client.ClientBookExploreOverlay;
import net.dnorberg.rivencraft.client.SymbolPageTextures;
import net.dnorberg.rivencraft.network.UseDescriptiveBookPayload; import net.dnorberg.rivencraft.network.UseDescriptiveBookPayload;
import net.dnorberg.rivencraft.network.BindDescriptiveBookPayload; import net.dnorberg.rivencraft.network.BindDescriptiveBookPayload;
import net.dnorberg.rivencraft.network.ModNetworking; import net.dnorberg.rivencraft.network.ModNetworking;
@@ -37,7 +38,6 @@ import org.jetbrains.annotations.Nullable;
public final class DescriptiveBookScreen extends Screen implements ExplorableBookScreen { public final class DescriptiveBookScreen extends Screen implements ExplorableBookScreen {
private static final int BOOK_TEXT_COLOR = 0xFF3B281B; private static final int BOOK_TEXT_COLOR = 0xFF3B281B;
private static final int UNRESOLVED_TEXT_COLOR = 0xFF9B302C; private static final int UNRESOLVED_TEXT_COLOR = 0xFF9B302C;
private static final ResourceLocation ENCHANTMENT_FONT = ResourceLocation.withDefaultNamespace("alt");
private static final int BOOK_WIDTH = 327; private static final int BOOK_WIDTH = 327;
private static final int BOOK_HEIGHT = 199; private static final int BOOK_HEIGHT = 199;
private static final int LINK_PANEL_X = 173; private static final int LINK_PANEL_X = 173;
@@ -211,7 +211,7 @@ public final class DescriptiveBookScreen extends Screen implements ExplorableBoo
Component profileName = generationProfile.getNamespace().equals("rivencraft") Component profileName = generationProfile.getNamespace().equals("rivencraft")
? Component.translatable("generator.rivencraft." + generationProfile.getPath()) ? Component.translatable("generator.rivencraft." + generationProfile.getPath())
: Component.literal(generationProfile.toString()); : Component.literal(generationProfile.toString());
detailsY = drawWrappedWithoutShadow(graphics, detailsY = drawDescription(graphics,
Component.translatable("screen.rivencraft.age.generator", profileName), Component.translatable("screen.rivencraft.age.generator", profileName),
x, detailsY, 110) + 2; x, detailsY, 110) + 2;
} }
@@ -247,8 +247,6 @@ public final class DescriptiveBookScreen extends Screen implements ExplorableBoo
x, top + 39, 126, color); x, top + 39, 126, color);
drawWrappedWithoutShadow(graphics, Component.literal(display.id().toString()), drawWrappedWithoutShadow(graphics, Component.literal(display.id().toString()),
x, top + 64, 126, color); x, top + 64, 126, color);
drawWrappedWithoutShadow(graphics, Component.translatable("screen.rivencraft.age.pages_not_applied"),
x, top + 137, 126);
} }
private void turnPage(int direction) { private void turnPage(int direction) {
@@ -415,10 +413,16 @@ public final class DescriptiveBookScreen extends Screen implements ExplorableBoo
} }
private int drawTrait(GuiGraphics graphics, String key, Component value, int x, int y) { private int drawTrait(GuiGraphics graphics, String key, Component value, int x, int y) {
return drawWrappedWithoutShadow(graphics, return drawDescription(graphics,
Component.translatable("screen.rivencraft.age.trait." + key, value), x, y, 110) + 2; Component.translatable("screen.rivencraft.age.trait." + key, value), x, y, 110) + 2;
} }
private int drawDescription(GuiGraphics graphics, Component text, int x, int y, int maxWidth) {
return pageFree && age != null
? SymbolPageTextures.drawGlyphText(graphics, text.getString(), x, y, maxWidth)
: drawWrappedWithoutShadow(graphics, text, x, y, maxWidth);
}
private static Component traitName(String group, Enum<?> value) { private static Component traitName(String group, Enum<?> value) {
return Component.translatable("trait.rivencraft." + group + "." return Component.translatable("trait.rivencraft." + group + "."
+ value.name().toLowerCase(Locale.ROOT)); + value.name().toLowerCase(Locale.ROOT));
@@ -429,9 +433,7 @@ public final class DescriptiveBookScreen extends Screen implements ExplorableBoo
} }
private int drawWrappedWithoutShadow(GuiGraphics graphics, Component text, int x, int y, int maxWidth, int color) { private int drawWrappedWithoutShadow(GuiGraphics graphics, Component text, int x, int y, int maxWidth, int color) {
Component displayed = pageFree && age != null && pageIndex == 0 for (FormattedCharSequence line : font.split(text, maxWidth)) {
? text.copy().withStyle(style -> style.withFont(ENCHANTMENT_FONT)) : text;
for (FormattedCharSequence line : font.split(displayed, maxWidth)) {
graphics.drawString(font, line, x, y, color, false); graphics.drawString(font, line, x, y, color, false);
y += font.lineHeight; y += font.lineHeight;
} }
@@ -3,6 +3,7 @@ package net.dnorberg.rivencraft.client.screen;
import java.util.Locale; import java.util.Locale;
import net.dnorberg.rivencraft.Rivencraft; import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.item.PageItem; import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.client.SymbolPageTextures;
import net.dnorberg.rivencraft.menu.NotebookMenu; import net.dnorberg.rivencraft.menu.NotebookMenu;
import net.dnorberg.rivencraft.registry.ModItems; import net.dnorberg.rivencraft.registry.ModItems;
import net.minecraft.client.gui.GuiGraphics; import net.minecraft.client.gui.GuiGraphics;
@@ -26,14 +27,6 @@ public final class NotebookScreen extends AbstractContainerScreen<NotebookMenu>
private static final int PAGE_STEP_Y = 41; private static final int PAGE_STEP_Y = 41;
private static final int PAGE_COLUMNS = 5; private static final int PAGE_COLUMNS = 5;
private static final ResourceLocation PAGE_ATLAS = texture("gui/notebook_pages"); private static final ResourceLocation PAGE_ATLAS = texture("gui/notebook_pages");
private static final ResourceLocation GENERIC_SYMBOL = texture("item/page_symbol");
private static final ResourceLocation UNRESOLVED_SYMBOL = texture("item/page_unresolved");
private static final ResourceLocation STANDARD_TERRAIN = texture("item/page_symbol_terrain_standard");
private static final ResourceLocation NATIVE_BIOMES = texture("item/page_symbol_biome_native");
private static final ResourceLocation NORMAL_LIGHTING = texture("item/page_symbol_lighting_normal");
private static final ResourceLocation NORMAL_WEATHER = texture("item/page_symbol_weather_normal");
private static final ResourceLocation NORMAL_TIME = texture("item/page_symbol_celestial_normal_time");
private static final ResourceLocation CAVES = texture("item/page_symbol_feature_caves");
private EditBox textInput; private EditBox textInput;
private boolean draggingScrollbar; private boolean draggingScrollbar;
private boolean surfaceClickPendingRelease; private boolean surfaceClickPendingRelease;
@@ -262,7 +255,7 @@ public final class NotebookScreen extends AbstractContainerScreen<NotebookMenu>
case BLANK -> { } case BLANK -> { }
case LINK_PANEL -> graphics.fill(x + 5, y + 6, x + 25, y + 20, 0xFF000000); case LINK_PANEL -> graphics.fill(x + 5, y + 6, x + 25, y + 20, 0xFF000000);
case SYMBOL, UNRESOLVED_SYMBOL -> graphics.blit(symbolTexture(page), x + 1, y + 6, case SYMBOL, UNRESOLVED_SYMBOL -> graphics.blit(symbolTexture(page), x + 1, y + 6,
28, 28, 16, 16, 96, 96, 128, 128); 28, 28, 0, 0, 128, 128, 128, 128);
} }
} }
if (dimmed) { if (dimmed) {
@@ -274,23 +267,7 @@ public final class NotebookScreen extends AbstractContainerScreen<NotebookMenu>
} }
static ResourceLocation symbolTexture(ItemStack page) { static ResourceLocation symbolTexture(ItemStack page) {
var content = PageItem.content(page); return SymbolPageTextures.forPage(page);
if (content.kind() == net.dnorberg.rivencraft.writing.PageContent.Kind.UNRESOLVED_SYMBOL) {
return UNRESOLVED_SYMBOL;
}
return symbolTexture(content.symbol().orElseThrow().id());
}
static ResourceLocation symbolTexture(ResourceLocation id) {
return switch (id.toString()) {
case "rivencraft:terrain/standard" -> STANDARD_TERRAIN;
case "rivencraft:biome/native" -> NATIVE_BIOMES;
case "rivencraft:lighting/normal" -> NORMAL_LIGHTING;
case "rivencraft:weather/normal" -> NORMAL_WEATHER;
case "rivencraft:celestial/normal_time" -> NORMAL_TIME;
case "rivencraft:feature/caves" -> CAVES;
default -> GENERIC_SYMBOL;
};
} }
private static ResourceLocation texture(String path) { private static ResourceLocation texture(String path) {
@@ -5,6 +5,7 @@ import java.util.Locale;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Comparator; import java.util.Comparator;
import net.dnorberg.rivencraft.Rivencraft; import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.client.SymbolPageTextures;
import net.dnorberg.rivencraft.item.PageItem; import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.menu.WritingDeskMenu; import net.dnorberg.rivencraft.menu.WritingDeskMenu;
import net.dnorberg.rivencraft.block.entity.WritingDeskBlockEntity; import net.dnorberg.rivencraft.block.entity.WritingDeskBlockEntity;
@@ -148,7 +149,8 @@ public final class WritingDeskScreen extends AbstractContainerScreen<WritingDesk
if (tab == menu.activeCollection() && !allMode) graphics.setColor(0.5F, 0.5F, 1F, 1F); if (tab == menu.activeCollection() && !allMode) graphics.setColor(0.5F, 0.5F, 1F, 1F);
graphics.blit(LEGACY_DESK, x, tabY, 0, 166, 58, 37); graphics.blit(LEGACY_DESK, x, tabY, 0, 166, 58, 37);
graphics.setColor(1F, 1F, 1F, 1F); graphics.setColor(1F, 1F, 1F, 1F);
graphics.drawString(font, Integer.toString(tab + 1), x + 8, tabY + 8, 0xFF181818, false); // Encode the visible one-based tab number with Legacy's numeric word glyph.
SymbolPageTextures.drawNumeral(graphics, tab + 1, x + 8, tabY + 3, 19);
ItemStack collection = menu.getSlot(tab).getItem(); ItemStack collection = menu.getSlot(tab).getItem();
if (!collection.isEmpty()) { if (!collection.isEmpty()) {
String name = collection.getHoverName().getString(); String name = collection.getHoverName().getString();
@@ -220,6 +222,11 @@ public final class WritingDeskScreen extends AbstractContainerScreen<WritingDesk
graphics.renderTooltip(font, Component.translatable("screen.rivencraft.writing_desk.previous_tabs"), mouseX, mouseY); graphics.renderTooltip(font, Component.translatable("screen.rivencraft.writing_desk.previous_tabs"), mouseX, mouseY);
else if (localY >= 177 && localY < 186) else if (localY >= 177 && localY < 186)
graphics.renderTooltip(font, Component.translatable("screen.rivencraft.writing_desk.next_tabs"), mouseX, mouseY); graphics.renderTooltip(font, Component.translatable("screen.rivencraft.writing_desk.next_tabs"), mouseX, mouseY);
else if (mouseX < leftPos + 34 && localY >= 29 && localY < 177) {
int tab = menu.firstVisibleTab() + (localY - 29) / 37;
graphics.renderTooltip(font, Component.translatable("screen.rivencraft.writing_desk.tab_symbol",
tab + 1), mouseX, mouseY);
}
} }
} }
@@ -270,7 +277,7 @@ public final class WritingDeskScreen extends AbstractContainerScreen<WritingDesk
case BLANK -> { } case BLANK -> { }
case LINK_PANEL -> graphics.fill(x + 5, y + 6, x + 25, y + 20, 0xFF000000); case LINK_PANEL -> graphics.fill(x + 5, y + 6, x + 25, y + 20, 0xFF000000);
case SYMBOL, UNRESOLVED_SYMBOL -> graphics.blit(NotebookScreen.symbolTexture(page), x + 1, y + 6, case SYMBOL, UNRESOLVED_SYMBOL -> graphics.blit(NotebookScreen.symbolTexture(page), x + 1, y + 6,
28, 28, 16, 16, 96, 96, 128, 128); 28, 28, 0, 0, 128, 128, 128, 128);
} }
} }
@@ -1,6 +1,9 @@
package net.dnorberg.rivencraft.compat.jei; package net.dnorberg.rivencraft.compat.jei;
import java.util.List; 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.IModPlugin;
import mezz.jei.api.JeiPlugin; import mezz.jei.api.JeiPlugin;
import mezz.jei.api.constants.VanillaTypes; import mezz.jei.api.constants.VanillaTypes;
@@ -13,8 +16,14 @@ import mezz.jei.api.recipe.category.AbstractRecipeCategory;
import mezz.jei.api.registration.IRecipeCatalystRegistration; import mezz.jei.api.registration.IRecipeCatalystRegistration;
import mezz.jei.api.registration.IRecipeCategoryRegistration; import mezz.jei.api.registration.IRecipeCategoryRegistration;
import mezz.jei.api.registration.IRecipeRegistration; 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.Rivencraft;
import net.dnorberg.rivencraft.item.PageItem; import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.registry.ModItems; import net.dnorberg.rivencraft.registry.ModItems;
import net.minecraft.client.Minecraft; import net.minecraft.client.Minecraft;
import net.minecraft.client.gui.GuiGraphics; import net.minecraft.client.gui.GuiGraphics;
@@ -36,6 +45,55 @@ public final class RivencraftJeiPlugin implements IModPlugin {
return ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "jei_writing"); 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";
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 @Override
public void registerCategories(IRecipeCategoryRegistration registration) { public void registerCategories(IRecipeCategoryRegistration registration) {
IGuiHelper guiHelper = registration.getJeiHelpers().getGuiHelper(); IGuiHelper guiHelper = registration.getJeiHelpers().getGuiHelper();
@@ -14,6 +14,7 @@ import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.writing.NotebookContents; import net.dnorberg.rivencraft.writing.NotebookContents;
import net.dnorberg.rivencraft.writing.OrderedWriting; import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolReference; import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.writing.SymbolCatalog;
import net.dnorberg.rivencraft.writing.WritingEntry; import net.dnorberg.rivencraft.writing.WritingEntry;
import net.minecraft.core.BlockPos; import net.minecraft.core.BlockPos;
import net.minecraft.gametest.framework.GameTest; import net.minecraft.gametest.framework.GameTest;
@@ -28,7 +29,7 @@ import net.minecraft.world.phys.AABB;
import net.neoforged.neoforge.gametest.GameTestHolder; import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate; import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
@GameTestHolder(Rivencraft.MOD_ID) @GameTestHolder("rivencraft_archive_binder")
@PrefixGameTestTemplate(false) @PrefixGameTestTemplate(false)
public final class BookBinderGameTests { public final class BookBinderGameTests {
private BookBinderGameTests() {} private BookBinderGameTests() {}
@@ -58,6 +59,7 @@ public final class BookBinderGameTests {
binder.setItem(BookBinderBlockEntity.FIRST_PAGE, terrainPage()); binder.setItem(BookBinderBlockEntity.FIRST_PAGE, terrainPage());
var saved = binder.saveWithoutMetadata(helper.getLevel().registryAccess()); var saved = binder.saveWithoutMetadata(helper.getLevel().registryAccess());
var restored = new BookBinderBlockEntity(binder.getBlockPos(), binder.getBlockState()); var restored = new BookBinderBlockEntity(binder.getBlockPos(), binder.getBlockState());
restored.setLevel(helper.getLevel());
restored.loadWithComponents(saved, helper.getLevel().registryAccess()); restored.loadWithComponents(saved, helper.getLevel().registryAccess());
helper.assertValueEqual(restored.title(), "Ordered Age", "Title must persist"); helper.assertValueEqual(restored.title(), "Ordered Age", "Title must persist");
helper.assertTrue(restored.getItem(BookBinderBlockEntity.COVER).is(Items.LEATHER), "Cover must persist"); helper.assertTrue(restored.getItem(BookBinderBlockEntity.COVER).is(Items.LEATHER), "Cover must persist");
@@ -74,7 +76,6 @@ public final class BookBinderGameTests {
helper.succeed(); helper.succeed();
} }
@GameTest(template = "empty")
public static void missingSymbolPageSurvivesReloadButCannotBeAssembled(GameTestHelper helper) { public static void missingSymbolPageSurvivesReloadButCannotBeAssembled(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper); BookBinderBlockEntity binder = place(helper);
binder.setTitle("Recoverable Writing"); binder.setTitle("Recoverable Writing");
@@ -87,13 +88,41 @@ public final class BookBinderGameTests {
restored.loadWithComponents(saved, helper.getLevel().registryAccess()); restored.loadWithComponents(saved, helper.getLevel().registryAccess());
helper.assertValueEqual(PageItem.content(restored.getItem(BookBinderBlockEntity.FIRST_PAGE)) helper.assertValueEqual(PageItem.content(restored.getItem(BookBinderBlockEntity.FIRST_PAGE))
.symbol().orElseThrow(), missing, "Reload must preserve the removed data-pack symbol ID"); .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()), helper.assertTrue(restored.getItem(BookBinderBlockEntity.FIRST_PAGE).is(ModItems.PAGE.get()),
"Rejected writing must remain recoverable as a Page"); "Rejected writing must remain recoverable as a Page");
helper.succeed(); helper.succeed();
} }
@GameTest(template = "empty") @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) { public static void assemblyIsAtomicAndRetainsPageOrder(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper); BookBinderBlockEntity binder = place(helper);
binder.setTitle("A New Age"); binder.setTitle("A New Age");
@@ -256,7 +285,6 @@ public final class BookBinderGameTests {
helper.succeed(); helper.succeed();
} }
@GameTest(template = "empty")
public static void forgedBinderActionsAndReplayedOutputCannotDuplicateBook(GameTestHelper helper) { public static void forgedBinderActionsAndReplayedOutputCannotDuplicateBook(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper); BookBinderBlockEntity binder = place(helper);
binder.setTitle("Single Assembly"); binder.setTitle("Single Assembly");
@@ -0,0 +1,109 @@
package net.dnorberg.rivencraft.gametest;
import net.dnorberg.rivencraft.Rivencraft;
import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper;
import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
/** Small default smoke suite; the detailed milestone regressions are opt-in. */
@GameTestHolder(Rivencraft.MOD_ID)
@PrefixGameTestTemplate(false)
public final class CoreGameTests {
private CoreGameTests() {}
@GameTest(template = "empty")
public static void previewBackendSelection(GameTestHelper helper) {
LinkingGameTests.previewBackendSelectionCoversOptionalDependencyMatrix(helper);
}
@GameTest(template = "empty")
public static void linkTargetPersistence(GameTestHelper helper) {
LinkingGameTests.linkTargetSurvivesItemSerialization(helper);
}
@GameTest(template = "empty")
public static void deterministicAgeDefinition(GameTestHelper helper) {
LinkingGameTests.ageDefinitionIsCreatedOnceWithDeterministicData(helper);
}
@GameTest(template = "empty")
public static void blockedLinkDestination(GameTestHelper helper) {
LinkingGameTests.travelRejectsBlockedDestination(helper);
}
@GameTest(template = "empty")
public static void legacyWritingAndPageFreeBooks(GameTestHelper helper) {
WritingDataGameTests.oldBareListWritingAndPageFreeBooksRemainReadable(helper);
}
@GameTest(template = "empty")
public static void pagePersistenceAndUnknownSymbols(GameTestHelper helper) {
WritingDataGameTests.pageItemPreservesContentAndRejectsForgedUnknownSymbols(helper);
}
@GameTest(template = "empty")
public static void semanticSymbolSchema(GameTestHelper helper) {
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);
}
@GameTest(template = "empty")
public static void deskCopyTransaction(GameTestHelper helper) {
WritingDeskGameTests.takingCopySpendsPaperAndOneInkThenReturnsGlassBottle(helper);
}
@GameTest(template = "empty")
public static void deskRejectsForgedAndStaleActions(GameTestHelper helper) {
WritingDeskGameTests.forgedDeskSelectionsAndStaleMenuCannotCopy(helper);
}
@GameTest(template = "empty")
public static void twoBlockDeskDropsOnce(GameTestHelper helper) {
WritingDeskGameTests.twoBlockDeskSharesOneInventoryAndBreaksTogether(helper);
}
@GameTest(template = "empty")
public static void oldDeskMigration(GameTestHelper helper) {
WritingDeskGameTests.oldDeskInventoryMigratesAndAll88TabsPersist(helper);
}
@GameTest(template = "empty")
public static void binderKeepsMissingSymbolsRecoverable(GameTestHelper helper) {
BookBinderGameTests.missingSymbolPageSurvivesReloadButCannotBeAssembled(helper);
}
@GameTest(template = "empty")
public static void binderAssemblyTransaction(GameTestHelper helper) {
BookBinderGameTests.assemblyIsAtomicAndRetainsPageOrder(helper);
}
@GameTest(template = "empty")
public static void binderRejectsConflictingGrammar(GameTestHelper helper) {
BookBinderGameTests.conflictingGrammarKeepsBinderInputsRecoverable(helper);
}
@GameTest(template = "empty")
public static void binderRejectsForgedAndReplayedActions(GameTestHelper helper) {
BookBinderGameTests.forgedBinderActionsAndReplayedOutputCannotDuplicateBook(helper);
}
@GameTest(template = "empty")
public static void mixerOutputTransaction(GameTestHelper helper) {
InkMixerGameTests.linkPanelRequiresTakingOutputAndPersistsInk(helper);
}
@GameTest(template = "empty")
public static void linkingBookRecipe(GameTestHelper helper) {
LinkingBookRecipeGameTests.legacyRecipeRequiresExactlyLeatherAndLinkPanel(helper);
}
}
@@ -1,6 +1,5 @@
package net.dnorberg.rivencraft.gametest; package net.dnorberg.rivencraft.gametest;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.block.entity.InkMixerBlockEntity; import net.dnorberg.rivencraft.block.entity.InkMixerBlockEntity;
import net.dnorberg.rivencraft.menu.InkMixerMenu; import net.dnorberg.rivencraft.menu.InkMixerMenu;
import net.dnorberg.rivencraft.registry.ModBlocks; import net.dnorberg.rivencraft.registry.ModBlocks;
@@ -18,7 +17,7 @@ import net.minecraft.world.phys.AABB;
import net.neoforged.neoforge.gametest.GameTestHolder; import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate; import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
@GameTestHolder(Rivencraft.MOD_ID) @GameTestHolder("rivencraft_archive_mixer")
@PrefixGameTestTemplate(false) @PrefixGameTestTemplate(false)
public final class InkMixerGameTests { public final class InkMixerGameTests {
private InkMixerGameTests() {} private InkMixerGameTests() {}
@@ -29,7 +28,6 @@ public final class InkMixerGameTests {
return (InkMixerBlockEntity) helper.getLevel().getBlockEntity(pos); return (InkMixerBlockEntity) helper.getLevel().getBlockEntity(pos);
} }
@GameTest(template = "empty")
public static void linkPanelRequiresTakingOutputAndPersistsInk(GameTestHelper helper) { public static void linkPanelRequiresTakingOutputAndPersistsInk(GameTestHelper helper) {
InkMixerBlockEntity mixer = place(helper); InkMixerBlockEntity mixer = place(helper);
mixer.setItem(InkMixerBlockEntity.PAPER, new ItemStack(Items.PAPER, 2)); mixer.setItem(InkMixerBlockEntity.PAPER, new ItemStack(Items.PAPER, 2));
@@ -19,12 +19,11 @@ import net.minecraft.world.item.crafting.RecipeType;
import net.neoforged.neoforge.gametest.GameTestHolder; import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate; import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
@GameTestHolder(Rivencraft.MOD_ID) @GameTestHolder("rivencraft_archive_recipe")
@PrefixGameTestTemplate(false) @PrefixGameTestTemplate(false)
public final class LinkingBookRecipeGameTests { public final class LinkingBookRecipeGameTests {
private LinkingBookRecipeGameTests() {} private LinkingBookRecipeGameTests() {}
@GameTest(template = "empty")
public static void legacyRecipeRequiresExactlyLeatherAndLinkPanel(GameTestHelper helper) { public static void legacyRecipeRequiresExactlyLeatherAndLinkPanel(GameTestHelper helper) {
LinkingBookRecipe recipe = new LinkingBookRecipe(CraftingBookCategory.MISC); LinkingBookRecipe recipe = new LinkingBookRecipe(CraftingBookCategory.MISC);
ItemStack panel = PageItem.createLinkPanelPage(); ItemStack panel = PageItem.createLinkPanelPage();
@@ -2,6 +2,8 @@ package net.dnorberg.rivencraft.gametest;
import net.dnorberg.rivencraft.Rivencraft; import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.book.AgeDefinition; 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.AgeDimensionService;
import net.dnorberg.rivencraft.book.AgeGenerationProfiles; import net.dnorberg.rivencraft.book.AgeGenerationProfiles;
import net.dnorberg.rivencraft.book.AgeReference; import net.dnorberg.rivencraft.book.AgeReference;
@@ -12,6 +14,7 @@ import net.dnorberg.rivencraft.book.LinkTarget;
import net.dnorberg.rivencraft.book.LinkingService; import net.dnorberg.rivencraft.book.LinkingService;
import net.dnorberg.rivencraft.book.AgeVisitSavedData; import net.dnorberg.rivencraft.book.AgeVisitSavedData;
import net.dnorberg.rivencraft.book.AgeTraits; import net.dnorberg.rivencraft.book.AgeTraits;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.compat.PreviewBackendSelector; import net.dnorberg.rivencraft.compat.PreviewBackendSelector;
import net.dnorberg.rivencraft.config.RivencraftClientConfig; import net.dnorberg.rivencraft.config.RivencraftClientConfig;
import net.dnorberg.rivencraft.item.DescriptiveBookItem; import net.dnorberg.rivencraft.item.DescriptiveBookItem;
@@ -34,7 +37,7 @@ import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate; import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
/** Server-side regression coverage for persistent linking-book data and travel safety. */ /** Server-side regression coverage for persistent linking-book data and travel safety. */
@GameTestHolder(Rivencraft.MOD_ID) @GameTestHolder("rivencraft_archive_linking")
@PrefixGameTestTemplate(false) @PrefixGameTestTemplate(false)
public final class LinkingGameTests { public final class LinkingGameTests {
private static final BlockPos ORIGIN = new BlockPos(0, 1, 0); private static final BlockPos ORIGIN = new BlockPos(0, 1, 0);
@@ -42,7 +45,6 @@ public final class LinkingGameTests {
private LinkingGameTests() { private LinkingGameTests() {
} }
@GameTest(template = "empty")
public static void previewBackendSelectionCoversOptionalDependencyMatrix(GameTestHelper helper) { public static void previewBackendSelectionCoversOptionalDependencyMatrix(GameTestHelper helper) {
assertPreviewBackend(helper, RivencraftClientConfig.PreviewMode.AUTO, true, true, assertPreviewBackend(helper, RivencraftClientConfig.PreviewMode.AUTO, true, true,
PreviewBackendSelector.Backend.IMMERSIVE_PORTALS); PreviewBackendSelector.Backend.IMMERSIVE_PORTALS);
@@ -127,7 +129,6 @@ public final class LinkingGameTests {
helper.succeed(); helper.succeed();
} }
@GameTest(template = "empty")
public static void linkTargetSurvivesItemSerialization(GameTestHelper helper) { public static void linkTargetSurvivesItemSerialization(GameTestHelper helper) {
LinkTarget expected = new LinkTarget( LinkTarget expected = new LinkTarget(
GlobalPos.of(helper.getLevel().dimension(), helper.absolutePos(ORIGIN)), GlobalPos.of(helper.getLevel().dimension(), helper.absolutePos(ORIGIN)),
@@ -181,7 +182,6 @@ public final class LinkingGameTests {
helper.succeed(); helper.succeed();
} }
@GameTest(template = "empty")
public static void ageDefinitionIsCreatedOnceWithDeterministicData(GameTestHelper helper) { public static void ageDefinitionIsCreatedOnceWithDeterministicData(GameTestHelper helper) {
UUID ageId = UUID.randomUUID(); UUID ageId = UUID.randomUUID();
String requestedName = "Test Age " + ageId; String requestedName = "Test Age " + ageId;
@@ -313,42 +313,6 @@ public final class LinkingGameTests {
throw new IllegalStateException("Could not select profile " + profile); 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) @GameTest(template = "empty", timeoutTicks = 200)
public static void legacyBaseTerrainProfilesLoadRuntimeDimensions(GameTestHelper helper) { public static void legacyBaseTerrainProfilesLoadRuntimeDimensions(GameTestHelper helper) {
for (var profile : AgeGenerationProfiles.all()) { for (var profile : AgeGenerationProfiles.all()) {
@@ -421,46 +385,40 @@ public final class LinkingGameTests {
} }
if (profile.equals(AgeGenerationProfiles.AMPLIFIED)) { if (profile.equals(AgeGenerationProfiles.AMPLIFIED)) {
var biomeSource = level.getChunkSource().getGenerator().getBiomeSource(); var biomeSource = level.getChunkSource().getGenerator().getBiomeSource();
helper.assertValueEqual( int availableBiomes = AgeBiomeSelection.eligible(helper.getLevel().registryAccess(),
biomeSource.possibleBiomes().size(), AgeRuntimeProfiles.resolve(profile)).size();
2, helper.assertTrue(biomeSource.possibleBiomes().size() >= 2
"Tiled Biome Distribution must expose exactly two seeded biomes" && biomeSource.possibleBiomes().size() <= availableBiomes,
); "Random Tiled distribution must stay within the available biome pool");
var origin = biomeSource.getNoiseBiome(0, 0, 0, null); var origin = biomeSource.getNoiseBiome(0, 0, 0, null);
var eastTile = biomeSource.getNoiseBiome(64, 0, 0, null); var eastTile = biomeSource.getNoiseBiome(64, 0, 0, null);
var diagonalTile = biomeSource.getNoiseBiome(64, 0, 64, null);
helper.assertFalse(origin.equals(eastTile), helper.assertFalse(origin.equals(eastTile),
"Adjacent 256-block Tiled squares must alternate biomes"); "Adjacent 256-block Tiled squares must use different biomes");
helper.assertTrue(origin.equals(diagonalTile),
"Diagonal 256-block Tiled squares must repeat the biome");
} }
if (profile.equals(AgeGenerationProfiles.ISLAND)) { if (profile.equals(AgeGenerationProfiles.ISLAND)) {
var biomeSource = level.getChunkSource().getGenerator().getBiomeSource(); var biomeSource = level.getChunkSource().getGenerator().getBiomeSource();
helper.assertValueEqual( int availableBiomes = AgeBiomeSelection.eligible(helper.getLevel().registryAccess(),
biomeSource.possibleBiomes().size(), AgeRuntimeProfiles.resolve(profile)).size();
2, helper.assertTrue(biomeSource.possibleBiomes().size() >= 2
"Grid Biome Distribution must expose exactly two seeded biomes" && biomeSource.possibleBiomes().size() <= availableBiomes,
); "Random Grid distribution must stay within the available biome pool");
var origin = biomeSource.getNoiseBiome(0, 0, 0, null); var origin = biomeSource.getNoiseBiome(0, 0, 0, null);
var insideOriginChunk = biomeSource.getNoiseBiome(3, 0, 3, null); var insideOriginChunk = biomeSource.getNoiseBiome(3, 0, 3, null);
var eastChunk = biomeSource.getNoiseBiome(4, 0, 0, null); var eastChunk = biomeSource.getNoiseBiome(4, 0, 0, null);
var diagonalChunk = biomeSource.getNoiseBiome(4, 0, 4, null);
helper.assertTrue(origin.equals(insideOriginChunk), helper.assertTrue(origin.equals(insideOriginChunk),
"Grid biomes must remain constant inside each 16-block chunk"); "Grid biomes must remain constant inside each 16-block chunk");
helper.assertFalse(origin.equals(eastChunk), helper.assertFalse(origin.equals(eastChunk),
"Adjacent Grid chunks must alternate biomes"); "Adjacent Grid chunks must use different biomes");
helper.assertTrue(origin.equals(diagonalChunk),
"Diagonal Grid chunks must repeat the biome");
} }
if (profile.equals(AgeGenerationProfiles.CAVE)) { if (profile.equals(AgeGenerationProfiles.CAVE)) {
var biomeSource = level.getChunkSource().getGenerator().getBiomeSource(); 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, helper.assertTrue(biomeSource instanceof net.dnorberg.rivencraft.world.ScaledBiomeSource,
"Tiny Biome Distribution must use the serializable scaled biome source"); "Tiny Biome Distribution must use the serializable scaled biome source");
helper.assertValueEqual( helper.assertTrue(biomeSource.possibleBiomes().size() >= 2
biomeSource.possibleBiomes().size(), && biomeSource.possibleBiomes().size() <= caveBiomeCount,
3, "Random cave Tiny distribution must use only eligible cave biomes");
"Tiny Biome Distribution must expose exactly three seeded biomes"
);
java.util.Set<net.minecraft.core.Holder<net.minecraft.world.level.biome.Biome>> sampled = java.util.Set<net.minecraft.core.Holder<net.minecraft.world.level.biome.Biome>> sampled =
new java.util.HashSet<>(); new java.util.HashSet<>();
for (int x = -32; x <= 32; x += 4) { for (int x = -32; x <= 32; x += 4) {
@@ -532,13 +490,13 @@ public final class LinkingGameTests {
continue; continue;
} }
var biomeSource = level.getChunkSource().getGenerator().getBiomeSource(); 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, helper.assertTrue(biomeSource instanceof net.dnorberg.rivencraft.world.ScaledBiomeSource,
distribution + " Biome Distribution must use the serializable scaled biome source"); distribution + " Biome Distribution must use the serializable scaled biome source");
helper.assertValueEqual( helper.assertTrue(biomeSource.possibleBiomes().size() >= 2
biomeSource.possibleBiomes().size(), && biomeSource.possibleBiomes().size() <= availableBiomes,
3, distribution + " random distribution must stay within the available biome pool");
distribution + " Biome Distribution must expose exactly three seeded biomes"
);
helper.assertValueEqual( helper.assertValueEqual(
((net.dnorberg.rivencraft.world.ScaledBiomeSource)biomeSource).scale(), ((net.dnorberg.rivencraft.world.ScaledBiomeSource)biomeSource).scale(),
scale, scale,
@@ -556,23 +514,10 @@ public final class LinkingGameTests {
net.minecraft.resources.ResourceKey<net.minecraft.world.level.biome.Biome> biome, net.minecraft.resources.ResourceKey<net.minecraft.world.level.biome.Biome> biome,
net.minecraft.world.level.block.Block expectedBlock 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; long seed = 0L;
while (Math.floorMod(Long.hashCode(seed ^ 0x53494E474C454249L), sortedBiomes.size()) != targetIndex) { var plan = new AgeGenerationPlan(AgeGenerationPlan.CURRENT_VERSION, seed, OrderedWriting.EMPTY,
seed++; java.util.List.of(), AgeRuntimeProfiles.resolve(AgeGenerationProfiles.STANDARD),
} new AgeBiomeSelection(AgeTraits.BiomeDistribution.SINGLE, java.util.List.of(biome.location())));
UUID id = UUID.randomUUID(); UUID id = UUID.randomUUID();
AgeDefinition definition = new AgeDefinition( AgeDefinition definition = new AgeDefinition(
id, id,
@@ -592,7 +537,8 @@ public final class LinkingGameTests {
1.0D, 1.0D,
0.0F, 0.0F,
0.0F 0.0F
) ),
plan
); );
var level = AgeDimensionService.ensureLoaded(helper.getLevel().getServer(), definition); var level = AgeDimensionService.ensureLoaded(helper.getLevel().getServer(), definition);
helper.assertTrue(level != null, biome.location() + " material test Age must load"); helper.assertTrue(level != null, biome.location() + " material test Age must load");
@@ -666,7 +612,6 @@ public final class LinkingGameTests {
helper.succeed(); helper.succeed();
} }
@GameTest(template = "empty")
public static void travelRejectsBlockedDestination(GameTestHelper helper) { public static void travelRejectsBlockedDestination(GameTestHelper helper) {
BlockPos absoluteOrigin = helper.absolutePos(ORIGIN); BlockPos absoluteOrigin = helper.absolutePos(ORIGIN);
for (BlockPos position : BlockPos.betweenClosed( for (BlockPos position : BlockPos.betweenClosed(
@@ -1,14 +1,19 @@
package net.dnorberg.rivencraft.gametest; package net.dnorberg.rivencraft.gametest;
import com.google.gson.JsonParser;
import com.mojang.serialization.JsonOps; import com.mojang.serialization.JsonOps;
import io.netty.buffer.Unpooled; import io.netty.buffer.Unpooled;
import java.util.Arrays;
import java.util.List; import java.util.List;
import java.util.UUID; import java.util.UUID;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.book.AgeReference; import net.dnorberg.rivencraft.book.AgeReference;
import net.dnorberg.rivencraft.writing.OrderedWriting; import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.PageContent; import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.SymbolCatalog; import net.dnorberg.rivencraft.writing.SymbolCatalog;
import net.dnorberg.rivencraft.writing.SymbolDefinition;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.dnorberg.rivencraft.writing.SymbolPoems;
import net.dnorberg.rivencraft.writing.SymbolNumerals;
import net.dnorberg.rivencraft.writing.SymbolReference; import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.writing.WritingEntry; import net.dnorberg.rivencraft.writing.WritingEntry;
import net.dnorberg.rivencraft.writing.NotebookContents; import net.dnorberg.rivencraft.writing.NotebookContents;
@@ -31,7 +36,7 @@ import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate; import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
/** Acceptance coverage for Milestone 4's persistent writing contracts. */ /** Acceptance coverage for Milestone 4's persistent writing contracts. */
@GameTestHolder(Rivencraft.MOD_ID) @GameTestHolder("rivencraft_archive_writing")
@PrefixGameTestTemplate(false) @PrefixGameTestTemplate(false)
public final class WritingDataGameTests { public final class WritingDataGameTests {
private WritingDataGameTests() { private WritingDataGameTests() {
@@ -62,7 +67,6 @@ public final class WritingDataGameTests {
helper.succeed(); helper.succeed();
} }
@GameTest(template = "empty")
public static void oldBareListWritingAndPageFreeBooksRemainReadable(GameTestHelper helper) { public static void oldBareListWritingAndPageFreeBooksRemainReadable(GameTestHelper helper) {
OrderedWriting writing = new OrderedWriting(List.of( OrderedWriting writing = new OrderedWriting(List.of(
WritingEntry.linkPanel(), WritingEntry.symbol(reference("example:removed_symbol")))); WritingEntry.linkPanel(), WritingEntry.symbol(reference("example:removed_symbol"))));
@@ -102,6 +106,96 @@ public final class WritingDataGameTests {
helper.succeed(); 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();
helper.assertValueEqual(builtIn.schemaVersion(), 2, "Built-in symbol must use semantic schema v2");
helper.assertValueEqual(builtIn.semantics().orElseThrow().role(), SymbolSemantics.Role.TERRAIN,
"Built-in terrain symbol must declare its grammar role");
helper.assertValueEqual(builtIn.poem(), "Terrain Form Tradition Flow",
"Built-in page artwork must carry its four-word Legacy poem");
helper.assertValueEqual(SymbolPoems.builtIn(reference("rivencraft:terrain/standard").id()), builtIn.poem(),
"Pre-artwork saved starter pages must retain their original poem");
helper.assertTrue(Arrays.equals(SymbolNumerals.componentsForDigit(0), new int[] {1}),
"Zero must use Legacy's dedicated number mark");
helper.assertTrue(Arrays.equals(SymbolNumerals.componentsForDigit(1), new int[] {56}),
"One must use Legacy's first bottom-row mark");
helper.assertTrue(Arrays.equals(SymbolNumerals.componentsForDigit(24), new int[] {63, 59}),
"Twenty-four must combine Legacy's five and unit marks");
helper.assertTrue(Arrays.equals(SymbolNumerals.digitsFor(25), new int[] {1, 0}),
"Twenty-five must start a second base-25 place");
helper.assertTrue(Arrays.equals(SymbolNumerals.digitsFor(88), new int[] {3, 13}),
"Last writing-desk tab must retain its numeric value");
String display = "\"name\":\"symbol.example.test\","
+ "\"description\":\"symbol.example.test.description\","
+ "\"category\":\"example:terrain\"";
SymbolDefinition legacy = SymbolDefinition.parse(JsonParser.parseString(
"{\"schema_version\":1," + display + "}"));
helper.assertTrue(legacy.semantics().isEmpty(), "Existing v1 definitions must remain display-only");
SymbolDefinition oldCategory = SymbolDefinition.parse(JsonParser.parseString(
"{\"schema_version\":1,\"name\":\"symbol.example.test\","
+ "\"description\":\"symbol.example.test.description\","
+ "\"category\":\"terrain\"}"));
helper.assertValueEqual(oldCategory.category().toString(), "minecraft:terrain",
"A v1 category without a namespace must retain the old ResourceLocation behavior");
helper.assertValueEqual(legacy.display(reference("example:test").id()).id(),
reference("example:test").id(), "Display metadata must preserve the symbol ID");
SymbolDefinition period = SymbolDefinition.parse(JsonParser.parseString(
"{\"schema_version\":2," + display
+ ",\"semantics\":{\"role\":\"period_modifier\",\"value\":0}}"));
helper.assertValueEqual(period.semantics().orElseThrow().role(), SymbolSemantics.Role.PERIOD_MODIFIER,
"Zero-length modifier must be accepted");
rejectDefinition(helper, "{\"schema_version\":2," + display
+ ",\"semantics\":{\"role\":\"unknown\",\"value\":\"normal\"}}", "role");
rejectDefinition(helper, "{\"schema_version\":2," + display
+ ",\"semantics\":{\"role\":\"weather\",\"value\":\"blizzard\"}}", "value");
rejectDefinition(helper, "{\"schema_version\":2," + display
+ ",\"semantics\":{\"role\":\"period_modifier\",\"value\":2.01}}", "value");
rejectDefinition(helper, "{\"schema_version\":2," + display
+ ",\"semantics\":{\"role\":\"terrain\",\"value\":\"minecraft:overworld\",\"extra\":1}}", "extra");
rejectDefinition(helper, "{\"schema_version\":1," + display
+ ",\"semantics\":{\"role\":\"weather\",\"value\":\"normal\"}}", "v1");
var clientJson = builtIn.display(reference("rivencraft:terrain/standard").id());
var encoded = net.dnorberg.rivencraft.writing.SymbolDisplayMetadata.CODEC
.encodeStart(JsonOps.INSTANCE, clientJson).result().orElseThrow();
helper.assertFalse(encoded.getAsJsonObject().has("semantics"),
"Client display payload must never contain generation semantics");
helper.assertValueEqual(encoded.getAsJsonObject().get("poem").getAsString(), builtIn.poem(),
"Client display payload must carry page artwork metadata");
rejectDefinition(helper, "{\"schema_version\":2," + display
+ ",\"semantics\":{\"role\":\"weather\",\"value\":\"normal\"},\"poem\":\"only two\"}", "poem");
helper.succeed();
}
private static void rejectDefinition(GameTestHelper helper, String json, String diagnostic) {
boolean rejected = false;
try {
SymbolDefinition.parse(JsonParser.parseString(json));
} catch (IllegalArgumentException exception) {
rejected = exception.getMessage().contains(diagnostic);
}
helper.assertTrue(rejected, "Invalid symbol must be rejected with diagnostic containing '" + diagnostic + "'");
}
@GameTest(template = "empty") @GameTest(template = "empty")
public static void pageStatesPersistAndNetworkRoundTrip(GameTestHelper helper) { public static void pageStatesPersistAndNetworkRoundTrip(GameTestHelper helper) {
SymbolReference known = reference("rivencraft:terrain/standard"); SymbolReference known = reference("rivencraft:terrain/standard");
@@ -126,7 +220,6 @@ public final class WritingDataGameTests {
helper.succeed(); helper.succeed();
} }
@GameTest(template = "empty")
public static void pageItemPreservesContentAndRejectsForgedUnknownSymbols(GameTestHelper helper) { public static void pageItemPreservesContentAndRejectsForgedUnknownSymbols(GameTestHelper helper) {
SymbolReference known = reference("rivencraft:terrain/standard"); SymbolReference known = reference("rivencraft:terrain/standard");
SymbolReference unknown = reference("example:forged_symbol"); SymbolReference unknown = reference("example:forged_symbol");
@@ -156,7 +249,6 @@ public final class WritingDataGameTests {
} }
} }
@GameTest(template = "empty")
public static void notebookContentsPreserveOrderGapsNamesAndUnknownPages(GameTestHelper helper) { public static void notebookContentsPreserveOrderGapsNamesAndUnknownPages(GameTestHelper helper) {
ItemStack first = PageItem.createSymbolPage(reference("rivencraft:terrain/standard")); ItemStack first = PageItem.createSymbolPage(reference("rivencraft:terrain/standard"));
first.set(net.minecraft.core.component.DataComponents.CUSTOM_NAME, first.set(net.minecraft.core.component.DataComponents.CUSTOM_NAME,
@@ -1,7 +1,6 @@
package net.dnorberg.rivencraft.gametest; package net.dnorberg.rivencraft.gametest;
import java.util.List; import java.util.List;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.block.entity.WritingDeskBlockEntity; import net.dnorberg.rivencraft.block.entity.WritingDeskBlockEntity;
import net.dnorberg.rivencraft.block.WritingDeskBlock; import net.dnorberg.rivencraft.block.WritingDeskBlock;
import net.dnorberg.rivencraft.menu.WritingDeskMenu; import net.dnorberg.rivencraft.menu.WritingDeskMenu;
@@ -26,7 +25,7 @@ import net.minecraft.world.phys.AABB;
import net.neoforged.neoforge.gametest.GameTestHolder; import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate; import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
@GameTestHolder(Rivencraft.MOD_ID) @GameTestHolder("rivencraft_archive_desk")
@PrefixGameTestTemplate(false) @PrefixGameTestTemplate(false)
public final class WritingDeskGameTests { public final class WritingDeskGameTests {
private WritingDeskGameTests() {} private WritingDeskGameTests() {}
@@ -94,7 +93,6 @@ public final class WritingDeskGameTests {
helper.succeed(); helper.succeed();
} }
@GameTest(template = "empty")
public static void takingCopySpendsPaperAndOneInkThenReturnsGlassBottle(GameTestHelper helper) { public static void takingCopySpendsPaperAndOneInkThenReturnsGlassBottle(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1)); BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3); helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
@@ -256,7 +254,6 @@ public final class WritingDeskGameTests {
helper.succeed(); helper.succeed();
} }
@GameTest(template = "empty")
public static void forgedDeskSelectionsAndStaleMenuCannotCopy(GameTestHelper helper) { public static void forgedDeskSelectionsAndStaleMenuCannotCopy(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1)); BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3); helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
@@ -339,7 +336,6 @@ public final class WritingDeskGameTests {
helper.succeed(); helper.succeed();
} }
@GameTest(template = "empty")
public static void twoBlockDeskSharesOneInventoryAndBreaksTogether(GameTestHelper helper) { public static void twoBlockDeskSharesOneInventoryAndBreaksTogether(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1)); BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
var block = ModBlocks.WRITING_DESK.get(); var block = ModBlocks.WRITING_DESK.get();
@@ -462,7 +458,6 @@ public final class WritingDeskGameTests {
helper.succeed(); helper.succeed();
} }
@GameTest(template = "empty")
public static void oldDeskInventoryMigratesAndAll88TabsPersist(GameTestHelper helper) { public static void oldDeskInventoryMigratesAndAll88TabsPersist(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1)); BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
var registries = helper.getLevel().registryAccess(); var registries = helper.getLevel().registryAccess();
@@ -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");
}
}
@@ -1,23 +1,44 @@
package net.dnorberg.rivencraft.item; 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.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.Rivencraft;
import net.dnorberg.rivencraft.registry.ModDataComponents; import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.registry.ModItems; import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.writing.PageContent; import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.SymbolCatalog; 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.SymbolDisplayMetadata;
import net.dnorberg.rivencraft.writing.SymbolReference; import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.minecraft.ChatFormatting; import net.minecraft.ChatFormatting;
import net.minecraft.core.component.DataComponents; import net.minecraft.core.component.DataComponents;
import net.minecraft.core.HolderLookup;
import net.minecraft.core.registries.Registries;
import net.minecraft.network.chat.Component; import net.minecraft.network.chat.Component;
import net.minecraft.world.item.component.CustomModelData; import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.item.Item; import net.minecraft.world.item.Item;
import net.minecraft.world.item.ItemStack; import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.TooltipFlag; import net.minecraft.world.item.TooltipFlag;
/** One stackable Page item whose server-owned component identifies its writing state. */ /** One stackable Page item whose server-owned component identifies its writing state. */
public final class PageItem extends Item { public final class PageItem extends Item {
private static final ResourceLocation BIOME_GENERATION_CATEGORY =
ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "biome_generation");
private static final Map<String, CreativeSymbol> CREATIVE_SYMBOLS = loadCreativeSymbols();
private record CreativeSymbol(SymbolDisplayMetadata display, ResourceLocation creativeCategory) {}
public PageItem(Properties properties) { public PageItem(Properties properties) {
super(properties); super(properties);
} }
@@ -29,23 +50,127 @@ public final class PageItem extends Item {
return create(PageContent.symbol(reference)); return create(PageContent.symbol(reference));
} }
/** Fixed starter examples for the creative tab; the server still validates catalog membership on use. */ public static List<String> bundledCreativeSymbols() {
public static ItemStack createCreativeStarterPage(String path) { return List.copyOf(CREATIVE_SYMBOLS.keySet());
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); /** 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);
return List.copyOf(categories);
}
public static ItemStack bundledCreativeCategoryIcon(ResourceLocation category) {
if (category.equals(BlockSymbolPages.CATEGORY) || category.equals(BlockSymbolPages.FLUID_CATEGORY)) {
return createCreativeBlockPage(ResourceLocation.withDefaultNamespace(
category.equals(BlockSymbolPages.FLUID_CATEGORY) ? "water" : "stone"));
} }
SymbolReference reference = new SymbolReference( return CREATIVE_SYMBOLS.entrySet().stream()
net.minecraft.resources.ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, path)); .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 -> id.getNamespace().equals("minecraft"))
.filter(id -> !bundled.contains("biome/" + 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();
}
return creativeBundledAndBiomePages(registries).stream()
.filter(page -> category.equals(creativeCategory(page)))
.toList();
}
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)); ItemStack page = create(PageContent.symbol(reference));
String key = "symbol.rivencraft." + path.replace('/', '.'); page.set(ModDataComponents.PAGE_SYMBOL_DISPLAY.get(), metadata);
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));
return page; 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() { public static ItemStack createLinkPanelPage() {
return create(PageContent.LINK_PANEL); return create(PageContent.LINK_PANEL);
} }
@@ -118,7 +243,6 @@ public final class PageItem extends Item {
private static ItemStack create(PageContent content) { private static ItemStack create(PageContent content) {
ItemStack stack = new ItemStack(ModItems.PAGE.get()); ItemStack stack = new ItemStack(ModItems.PAGE.get());
stack.set(ModDataComponents.PAGE_CONTENT.get(), content); stack.set(ModDataComponents.PAGE_CONTENT.get(), content);
stack.set(DataComponents.CUSTOM_MODEL_DATA, new CustomModelData(modelIndex(content)));
if (content.kind() == PageContent.Kind.SYMBOL) { if (content.kind() == PageContent.Kind.SYMBOL) {
stack.set(ModDataComponents.PAGE_SYMBOL_DISPLAY.get(), stack.set(ModDataComponents.PAGE_SYMBOL_DISPLAY.get(),
SymbolCatalog.display(content.symbol().orElseThrow())); SymbolCatalog.display(content.symbol().orElseThrow()));
@@ -129,25 +253,16 @@ public final class PageItem extends Item {
private static Component symbolName(ItemStack stack, SymbolReference reference) { private static Component symbolName(ItemStack stack, SymbolReference reference) {
SymbolDisplayMetadata metadata = stack.getOrDefault( SymbolDisplayMetadata metadata = stack.getOrDefault(
ModDataComponents.PAGE_SYMBOL_DISPLAY.get(), SymbolCatalog.display(reference)); ModDataComponents.PAGE_SYMBOL_DISPLAY.get(), SymbolCatalog.display(reference));
return metadata.resolved() if (!metadata.resolved()) return Component.translatable("item.rivencraft.page.unresolved");
? Component.translatable(metadata.nameTranslationKey()) return reference.id().getNamespace().equals(Rivencraft.MOD_ID)
: Component.translatable("item.rivencraft.page.unresolved"); && 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());
} }
private static int modelIndex(PageContent content) {
return switch (content.kind()) {
case BLANK -> 0;
case LINK_PANEL -> 1;
case UNRESOLVED_SYMBOL -> 2;
case SYMBOL -> switch (content.symbol().orElseThrow().id().toString()) {
case "rivencraft:terrain/standard" -> 100;
case "rivencraft:biome/native" -> 101;
case "rivencraft:lighting/normal" -> 102;
case "rivencraft:weather/normal" -> 103;
case "rivencraft:celestial/normal_time" -> 104;
case "rivencraft:feature/caves" -> 105;
default -> 3;
};
};
}
} }
@@ -1,10 +1,12 @@
package net.dnorberg.rivencraft.menu; package net.dnorberg.rivencraft.menu;
import java.util.Optional;
import net.dnorberg.rivencraft.block.entity.BookBinderBlockEntity; import net.dnorberg.rivencraft.block.entity.BookBinderBlockEntity;
import net.dnorberg.rivencraft.item.PageItem; import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.registry.ModItems; import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.registry.ModMenus; import net.dnorberg.rivencraft.registry.ModMenus;
import net.dnorberg.rivencraft.writing.PageContent; import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.minecraft.network.RegistryFriendlyByteBuf; import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.world.Container; import net.minecraft.world.Container;
import net.minecraft.world.SimpleContainer; import net.minecraft.world.SimpleContainer;
@@ -32,6 +34,8 @@ public final class BookBinderMenu extends AbstractContainerMenu {
private final SimpleContainer result = new SimpleContainer(1); private final SimpleContainer result = new SimpleContainer(1);
private final boolean clientSide; private final boolean clientSide;
private int selectedPage = -1; private int selectedPage = -1;
private int grammarErrorCode = -1;
private int grammarErrorStripIndex = -1;
public BookBinderMenu(int id, Inventory inventory, RegistryFriendlyByteBuf data) { public BookBinderMenu(int id, Inventory inventory, RegistryFriendlyByteBuf data) {
this(id, inventory, inventory.player.level().getBlockEntity(data.readBlockPos()) 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 int get() { return selectedPage; }
@Override public void set(int value) { selectedPage = value; } @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.COVER, 8, 27, 64));
addSlot(new BinderSlot(BookBinderBlockEntity.LINK_PANEL, -1000, -1000, 1)); addSlot(new BinderSlot(BookBinderBlockEntity.LINK_PANEL, -1000, -1000, 1));
addSlot(new BinderSlot(BookBinderBlockEntity.NOTEBOOK, -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 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 String title() { return binder == null ? "" : binder.title(); }
public boolean setTitle(Player player, String title) { public boolean setTitle(Player player, String title) {
if (clientSide || !stillValid(player) || title == null if (clientSide || !stillValid(player) || title == null
@@ -166,15 +166,12 @@ public final class WritingDeskMenu extends AbstractContainerMenu {
selectedPage = page; selectedPage = page;
selectedSymbol = null; selectedSymbol = null;
} else if (id >= CATALOG_BUTTON_BASE && id < CATALOG_BUTTON_BASE + catalog.size()) { } else if (id >= CATALOG_BUTTON_BASE && id < CATALOG_BUTTON_BASE + catalog.size()) {
if (!catalog.equals(WritingDeskCatalog.available(blockEntity))) { List<SymbolDisplayMetadata> available = WritingDeskCatalog.available(blockEntity);
refreshCatalog(); if (!catalog.equals(available)) {
refreshCatalog(available);
return false; return false;
} }
ResourceLocation requested = catalog.get(id - CATALOG_BUTTON_BASE).id(); selectedSymbol = available.get(id - CATALOG_BUTTON_BASE).id();
if (!WritingDeskCatalog.available(blockEntity).stream().anyMatch(entry -> entry.id().equals(requested))) {
return false;
}
selectedSymbol = requested;
} else return false; } else return false;
refreshOutput(); refreshOutput();
return true; return true;
@@ -390,7 +387,11 @@ public final class WritingDeskMenu extends AbstractContainerMenu {
private void refreshCatalog() { private void refreshCatalog() {
if (clientSide || blockEntity == null) return; if (clientSide || blockEntity == null) return;
List<SymbolDisplayMetadata> current = WritingDeskCatalog.available(blockEntity); refreshCatalog(WritingDeskCatalog.available(blockEntity));
}
private void refreshCatalog(List<SymbolDisplayMetadata> current) {
if (clientSide || blockEntity == null) return;
if (!current.equals(catalog)) { if (!current.equals(catalog)) {
catalog = current; catalog = current;
if (serverViewer != null && serverViewer.containerMenu == this) { if (serverViewer != null && serverViewer.containerMenu == this) {
@@ -5,6 +5,9 @@ import net.dnorberg.rivencraft.book.LinkingService;
import net.dnorberg.rivencraft.book.AgeReference; import net.dnorberg.rivencraft.book.AgeReference;
import net.dnorberg.rivencraft.book.AgeRegistrySavedData; import net.dnorberg.rivencraft.book.AgeRegistrySavedData;
import net.dnorberg.rivencraft.book.AgeDimensionService; 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.block.entity.BookStandBlockEntity;
import net.dnorberg.rivencraft.client.ClientLinkPreviewHandler; import net.dnorberg.rivencraft.client.ClientLinkPreviewHandler;
import net.dnorberg.rivencraft.client.ClientBookInteractionHandler; 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.SymbolCatalog;
import net.dnorberg.rivencraft.writing.SymbolDisplayMetadata; import net.dnorberg.rivencraft.writing.SymbolDisplayMetadata;
import net.dnorberg.rivencraft.writing.WritingEntry; import net.dnorberg.rivencraft.writing.WritingEntry;
import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.minecraft.core.component.DataComponents; import net.minecraft.core.component.DataComponents;
import net.minecraft.core.BlockPos; import net.minecraft.core.BlockPos;
import net.minecraft.core.GlobalPos; import net.minecraft.core.GlobalPos;
@@ -115,7 +119,9 @@ public final class ModNetworking {
PacketDistributor.sendToPlayer(player, new OpenDescriptiveBookScreenPayload( PacketDistributor.sendToPlayer(player, new OpenDescriptiveBookScreenPayload(
payload.fromStand(), payload.offhand(), payload.fromStand(), payload.offhand(),
GlobalPos.of(player.level().dimension(), payload.standPos()), access.stack().copy(), 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) { private static void bindDescriptiveBook(BindDescriptiveBookPayload payload, IPayloadContext context) {
@@ -133,10 +139,27 @@ public final class ModNetworking {
return; 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()); WRITING_BOOKS.add(access.stack());
try { try {
AgeReference reference = new AgeReference(UUID.randomUUID(), title); 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); player.displayClientMessage(Component.translatable("message.rivencraft.descriptive_book.unavailable"), true);
return; 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) { private static int previewSkyColor(ServerLevel level, BlockPos origin) {
if (level.dimension().equals(Level.NETHER)) { return AgeEnvironmentCompiler.previewSkyColor(level.dimensionType().effectsLocation(),
return 0xFF6B2725; level.getBiome(origin).value().getSkyColor());
}
if (level.dimension().equals(Level.END)) {
return 0xFF211835;
}
return level.getBiome(origin).value().getSkyColor();
} }
private static InteractionHand hand(boolean offhand) { 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; 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.Rivencraft;
import net.dnorberg.rivencraft.item.PageItem; import net.dnorberg.rivencraft.item.PageItem;
import net.minecraft.core.registries.Registries; import net.minecraft.core.registries.Registries;
import net.minecraft.network.chat.Component; import net.minecraft.network.chat.Component;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.item.CreativeModeTab; import net.minecraft.world.item.CreativeModeTab;
import net.neoforged.bus.api.IEventBus; import net.neoforged.bus.api.IEventBus;
import net.neoforged.neoforge.registries.DeferredHolder; import net.neoforged.neoforge.registries.DeferredHolder;
@@ -28,20 +34,39 @@ public final class ModCreativeTabs {
}) })
.build()); .build());
public static final DeferredHolder<CreativeModeTab, CreativeModeTab> PAGES = public static final DeferredHolder<CreativeModeTab, CreativeModeTab> LINK_PAGES =
CREATIVE_TABS.register("rivencraft_pages", () -> CreativeModeTab.builder() CREATIVE_TABS.register("rivencraft_link_pages", () -> CreativeModeTab.builder()
.title(Component.translatable("itemGroup.rivencraft.pages")) .title(Component.translatable("itemGroup.rivencraft.pages.link"))
.icon(PageItem::createLinkPanelPage) .icon(PageItem::createLinkPanelPage)
.displayItems((parameters, output) -> { .displayItems((parameters, output) -> output.accept(PageItem.createLinkPanelPage()))
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));
}
})
.build()); .build());
private static final List<String> CATEGORY_ORDER = List.of(
"terrain", "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() { private ModCreativeTabs() {
} }
@@ -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; private final int cellWidth;
public ScaledBiomeSource(HolderSet<Biome> biomes, long seed, int scale) { public ScaledBiomeSource(HolderSet<Biome> biomes, long seed, int scale) {
if (biomes.size() < 3) { if (biomes.size() < 2) {
throw new IllegalArgumentException("Scaled biome distributions require at least three biomes"); throw new IllegalArgumentException("Scaled biome distributions require at least two biomes");
} }
this.biomes = biomes; this.biomes = biomes;
this.seed = seed; this.seed = seed;
@@ -0,0 +1,43 @@
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;
/** Built-in fallback pages for registered vanilla 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) {
return ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "biome/" + biomeId.getPath());
}
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";
return new SymbolDefinition(SymbolDefinition.CURRENT_SCHEMA_VERSION,
"symbol.rivencraft.biome." + path,
"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());
return Arrays.stream(path.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";
}
}
@@ -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,43 @@
package net.dnorberg.rivencraft.writing;
import net.dnorberg.rivencraft.item.InkVialItem;
import net.dnorberg.rivencraft.registry.ModItems;
import net.minecraft.core.NonNullList;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items;
/** Shared, server-side vial-to-meter exchange for the Desk and Ink Mixer. */
public final class InkVialExchange {
private InkVialExchange() {}
public static boolean canPay(NonNullList<ItemStack> items, int inkSlot, int bottleSlot,
int storedInk, int cost) {
return storedInk >= cost || canExchange(items, inkSlot, bottleSlot)
&& storedInk + vialInk(items.get(inkSlot)) >= cost;
}
/** Returns added ink; zero means no inputs were changed. */
public static int exchange(NonNullList<ItemStack> items, int inkSlot, int bottleSlot) {
if (!canExchange(items, inkSlot, bottleSlot)) return 0;
ItemStack vial = items.get(inkSlot);
int addedInk = vialInk(vial);
vial.shrink(1);
if (vial.isEmpty()) items.set(inkSlot, ItemStack.EMPTY);
ItemStack bottles = items.get(bottleSlot);
if (bottles.isEmpty()) items.set(bottleSlot, new ItemStack(Items.GLASS_BOTTLE));
else bottles.grow(1);
return addedInk;
}
private static boolean canExchange(NonNullList<ItemStack> items, int inkSlot, int bottleSlot) {
ItemStack vial = items.get(inkSlot);
ItemStack bottles = items.get(bottleSlot);
return vial.is(ModItems.INK_VIAL.get()) && vialInk(vial) > 0
&& (bottles.isEmpty() || bottles.is(Items.GLASS_BOTTLE)
&& bottles.getCount() < bottles.getMaxStackSize());
}
private static int vialInk(ItemStack vial) {
return Math.clamp(InkVialItem.remaining(vial), 0, InkVialItem.CAPACITY);
}
}
@@ -3,12 +3,13 @@ package net.dnorberg.rivencraft.writing;
import com.google.gson.Gson; import com.google.gson.Gson;
import com.google.gson.GsonBuilder; import com.google.gson.GsonBuilder;
import com.google.gson.JsonElement; import com.google.gson.JsonElement;
import com.mojang.serialization.JsonOps;
import java.util.HashMap; import java.util.HashMap;
import java.util.Map; import java.util.Map;
import java.util.Optional; import java.util.Optional;
import net.dnorberg.rivencraft.Rivencraft; import net.dnorberg.rivencraft.Rivencraft;
import net.minecraft.resources.ResourceLocation; 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.ResourceManager;
import net.minecraft.server.packs.resources.SimpleJsonResourceReloadListener; import net.minecraft.server.packs.resources.SimpleJsonResourceReloadListener;
import net.minecraft.util.profiling.ProfilerFiller; import net.minecraft.util.profiling.ProfilerFiller;
@@ -24,7 +25,7 @@ public final class SymbolCatalog {
} }
public static void register(AddReloadListenerEvent event) { public static void register(AddReloadListenerEvent event) {
event.addListener(new Loader()); event.addListener(new Loader(event.getRegistryAccess()));
} }
public static Optional<SymbolDefinition> find(SymbolReference reference) { public static Optional<SymbolDefinition> find(SymbolReference reference) {
@@ -47,8 +48,11 @@ public final class SymbolCatalog {
} }
private static final class Loader extends SimpleJsonResourceReloadListener { private static final class Loader extends SimpleJsonResourceReloadListener {
private Loader() { private final RegistryAccess registries;
private Loader(RegistryAccess registries) {
super(GSON, DIRECTORY); super(GSON, DIRECTORY);
this.registries = registries;
} }
@Override @Override
@@ -56,10 +60,20 @@ public final class SymbolCatalog {
ResourceManager resourceManager, ResourceManager resourceManager,
ProfilerFiller profiler) { ProfilerFiller profiler) {
Map<ResourceLocation, SymbolDefinition> loaded = new HashMap<>(); Map<ResourceLocation, SymbolDefinition> loaded = new HashMap<>();
resources.forEach((id, json) -> SymbolDefinition.CODEC.parse(JsonOps.INSTANCE, json) resources.forEach((id, json) -> {
.resultOrPartial(error -> Rivencraft.LOGGER.error( try {
"Ignoring invalid writing symbol {}: {}", id, error)) loaded.put(id, SymbolDefinition.parse(json));
.ifPresent(definition -> loaded.put(id, definition))); } catch (IllegalArgumentException exception) {
Rivencraft.LOGGER.error("Ignoring invalid writing symbol {}: {}", id, exception.getMessage());
}
});
registries.lookupOrThrow(Registries.BIOME).listElements()
.map(holder -> holder.key().location())
.filter(id -> id.getNamespace().equals("minecraft"))
.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); symbols = Map.copyOf(loaded);
Rivencraft.LOGGER.info("Loaded {} writing symbols", loaded.size()); Rivencraft.LOGGER.info("Loaded {} writing symbols", loaded.size());
} }
@@ -1,47 +1,127 @@
package net.dnorberg.rivencraft.writing; package net.dnorberg.rivencraft.writing;
import com.mojang.serialization.Codec; import com.google.gson.JsonElement;
import com.mojang.serialization.DataResult; import com.google.gson.JsonObject;
import com.mojang.serialization.codecs.RecordCodecBuilder; import com.google.gson.JsonPrimitive;
import java.util.Objects; import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.regex.Pattern; import java.util.regex.Pattern;
import net.minecraft.resources.ResourceLocation; import net.minecraft.resources.ResourceLocation;
/** Server-loaded, non-executable display metadata for a writing symbol. */ /** Server-only symbol definition. Only display metadata crosses to clients. */
public record SymbolDefinition( public record SymbolDefinition(
int schemaVersion, int schemaVersion,
String nameTranslationKey, String nameTranslationKey,
String descriptionTranslationKey, String descriptionTranslationKey,
ResourceLocation category ResourceLocation category,
Optional<SymbolSemantics> semantics,
String poem
) { ) {
public static final int CURRENT_SCHEMA_VERSION = 1; public static final int CURRENT_SCHEMA_VERSION = 2;
private static final Pattern TRANSLATION_KEY = Pattern.compile("[a-z0-9_.-]+"); private static final Pattern TRANSLATION_KEY = Pattern.compile("[a-z0-9_.-]+");
private static final Codec<String> TRANSLATION_KEY_CODEC = Codec.STRING.comapFlatMap( private static final Set<String> V2_FIELDS = Set.of(
value -> TRANSLATION_KEY.matcher(value).matches() "schema_version", "name", "description", "category", "semantics", "poem");
? DataResult.success(value)
: DataResult.error(() -> "Invalid translation key: " + value),
value -> value
);
public static final Codec<SymbolDefinition> CODEC = RecordCodecBuilder.<SymbolDefinition>create(instance -> instance.group(
Codec.INT.fieldOf("schema_version").forGetter(SymbolDefinition::schemaVersion),
TRANSLATION_KEY_CODEC.fieldOf("name").forGetter(SymbolDefinition::nameTranslationKey),
TRANSLATION_KEY_CODEC.fieldOf("description").forGetter(SymbolDefinition::descriptionTranslationKey),
ResourceLocation.CODEC.fieldOf("category").forGetter(SymbolDefinition::category)
).apply(instance, SymbolDefinition::new)).flatXmap(SymbolDefinition::validate, SymbolDefinition::validate);
public SymbolDefinition { public SymbolDefinition {
Objects.requireNonNull(nameTranslationKey, "nameTranslationKey"); Objects.requireNonNull(nameTranslationKey, "nameTranslationKey");
Objects.requireNonNull(descriptionTranslationKey, "descriptionTranslationKey"); Objects.requireNonNull(descriptionTranslationKey, "descriptionTranslationKey");
Objects.requireNonNull(category, "category"); Objects.requireNonNull(category, "category");
semantics = Objects.requireNonNull(semantics, "semantics");
poem = Objects.requireNonNull(poem, "poem");
if (schemaVersion != 1 && schemaVersion != CURRENT_SCHEMA_VERSION) {
throw new IllegalArgumentException("Unsupported schema_version " + schemaVersion);
}
if (schemaVersion == 1 && semantics.isPresent()) {
throw new IllegalArgumentException("Schema v1 symbols cannot have semantics");
}
if (schemaVersion == CURRENT_SCHEMA_VERSION && semantics.isEmpty()) {
throw new IllegalArgumentException("Schema v2 symbols require semantics");
}
validateTranslationKey(nameTranslationKey, "name");
validateTranslationKey(descriptionTranslationKey, "description");
if (!poem.isEmpty() && (poem.length() > 96
|| !poem.matches("[A-Za-z]+(?: [A-Za-z]+){3}"))) {
throw new IllegalArgumentException("'poem' must contain exactly four alphabetic words");
}
}
/** v1 remains display-only; v2 has an exact field set and typed semantics. */
public static SymbolDefinition parse(JsonElement json) {
if (json == null || !json.isJsonObject()) {
throw new IllegalArgumentException("Symbol definition must be a JSON object");
}
JsonObject object = json.getAsJsonObject();
int version = requiredInteger(object, "schema_version");
if (version != 1 && version != CURRENT_SCHEMA_VERSION) {
throw new IllegalArgumentException("Unsupported schema_version " + version);
}
if (version == CURRENT_SCHEMA_VERSION) {
for (String field : object.keySet()) {
if (!V2_FIELDS.contains(field)) {
throw new IllegalArgumentException("Unknown symbol field '" + field + "'");
}
}
} else if (object.has("semantics")) {
throw new IllegalArgumentException("Schema v1 cannot declare semantics; use schema_version 2");
}
String name = requiredString(object, "name");
String description = requiredString(object, "description");
ResourceLocation category = requiredResourceLocation(object, "category",
version == CURRENT_SCHEMA_VERSION);
Optional<SymbolSemantics> semantics = version == CURRENT_SCHEMA_VERSION
? Optional.of(SymbolSemantics.parse(object.get("semantics")))
: Optional.empty();
String poem = object.has("poem") ? requiredString(object, "poem") : "";
return new SymbolDefinition(version, name, description, category, semantics, poem);
} }
public SymbolDisplayMetadata display(ResourceLocation id) { public SymbolDisplayMetadata display(ResourceLocation id) {
return new SymbolDisplayMetadata(id, nameTranslationKey, descriptionTranslationKey, category, true); return new SymbolDisplayMetadata(id, nameTranslationKey, descriptionTranslationKey, category, true, poem);
} }
private static DataResult<SymbolDefinition> validate(SymbolDefinition definition) { static String requiredString(JsonObject object, String field) {
return definition.schemaVersion == CURRENT_SCHEMA_VERSION JsonElement element = object.get(field);
? DataResult.success(definition) if (element == null || !element.isJsonPrimitive()
: DataResult.error(() -> "Unsupported symbol schema_version " + definition.schemaVersion); || !element.getAsJsonPrimitive().isString()) {
throw new IllegalArgumentException("'" + field + "' must be a string");
}
return element.getAsString();
}
static ResourceLocation requiredResourceLocation(JsonObject object, String field) {
return requiredResourceLocation(object, field, true);
}
private static ResourceLocation requiredResourceLocation(JsonObject object, String field, boolean canonical) {
String value = requiredString(object, field);
ResourceLocation id = ResourceLocation.tryParse(value);
if (id == null || (canonical && !id.toString().equals(value))) {
throw new IllegalArgumentException("'" + field + "' must be "
+ (canonical ? "a canonical namespaced ID" : "a resource location") + ": " + value);
}
return id;
}
private static int requiredInteger(JsonObject object, String field) {
JsonElement element = object.get(field);
if (element == null || !element.isJsonPrimitive()) {
throw new IllegalArgumentException("'" + field + "' must be an integer");
}
JsonPrimitive primitive = element.getAsJsonPrimitive();
if (!primitive.isNumber() || !primitive.getAsString().matches("-?\\d+")) {
throw new IllegalArgumentException("'" + field + "' must be an integer");
}
try {
return Integer.parseInt(primitive.getAsString());
} catch (NumberFormatException exception) {
throw new IllegalArgumentException("'" + field + "' is outside the integer range", exception);
}
}
private static void validateTranslationKey(String value, String field) {
if (!TRANSLATION_KEY.matcher(value).matches()) {
throw new IllegalArgumentException("Invalid '" + field + "' translation key: " + value);
}
} }
} }
@@ -14,14 +14,16 @@ public record SymbolDisplayMetadata(
String nameTranslationKey, String nameTranslationKey,
String descriptionTranslationKey, String descriptionTranslationKey,
ResourceLocation category, ResourceLocation category,
boolean resolved boolean resolved,
String poem
) { ) {
public static final Codec<SymbolDisplayMetadata> CODEC = RecordCodecBuilder.create(instance -> instance.group( public static final Codec<SymbolDisplayMetadata> CODEC = RecordCodecBuilder.create(instance -> instance.group(
ResourceLocation.CODEC.fieldOf("id").forGetter(SymbolDisplayMetadata::id), ResourceLocation.CODEC.fieldOf("id").forGetter(SymbolDisplayMetadata::id),
Codec.STRING.fieldOf("name").forGetter(SymbolDisplayMetadata::nameTranslationKey), Codec.STRING.fieldOf("name").forGetter(SymbolDisplayMetadata::nameTranslationKey),
Codec.STRING.fieldOf("description").forGetter(SymbolDisplayMetadata::descriptionTranslationKey), Codec.STRING.fieldOf("description").forGetter(SymbolDisplayMetadata::descriptionTranslationKey),
ResourceLocation.CODEC.fieldOf("category").forGetter(SymbolDisplayMetadata::category), ResourceLocation.CODEC.fieldOf("category").forGetter(SymbolDisplayMetadata::category),
Codec.BOOL.fieldOf("resolved").forGetter(SymbolDisplayMetadata::resolved) Codec.BOOL.fieldOf("resolved").forGetter(SymbolDisplayMetadata::resolved),
Codec.STRING.optionalFieldOf("poem", "").forGetter(SymbolDisplayMetadata::poem)
).apply(instance, SymbolDisplayMetadata::new)); ).apply(instance, SymbolDisplayMetadata::new));
public static final StreamCodec<ByteBuf, SymbolDisplayMetadata> STREAM_CODEC = StreamCodec.composite( public static final StreamCodec<ByteBuf, SymbolDisplayMetadata> STREAM_CODEC = StreamCodec.composite(
ResourceLocation.STREAM_CODEC, SymbolDisplayMetadata::id, ResourceLocation.STREAM_CODEC, SymbolDisplayMetadata::id,
@@ -29,6 +31,7 @@ public record SymbolDisplayMetadata(
ByteBufCodecs.STRING_UTF8, SymbolDisplayMetadata::descriptionTranslationKey, ByteBufCodecs.STRING_UTF8, SymbolDisplayMetadata::descriptionTranslationKey,
ResourceLocation.STREAM_CODEC, SymbolDisplayMetadata::category, ResourceLocation.STREAM_CODEC, SymbolDisplayMetadata::category,
ByteBufCodecs.BOOL, SymbolDisplayMetadata::resolved, ByteBufCodecs.BOOL, SymbolDisplayMetadata::resolved,
ByteBufCodecs.STRING_UTF8, SymbolDisplayMetadata::poem,
SymbolDisplayMetadata::new SymbolDisplayMetadata::new
); );
@@ -38,7 +41,8 @@ public record SymbolDisplayMetadata(
"symbol.rivencraft.unresolved", "symbol.rivencraft.unresolved",
"symbol.rivencraft.unresolved.description", "symbol.rivencraft.unresolved.description",
ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "unresolved"), ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "unresolved"),
false false,
""
); );
} }
} }
@@ -0,0 +1,30 @@
package net.dnorberg.rivencraft.writing;
/**
* Number components from Mystcraft Legacy's ModWords#constructNumber.
* Legacy registers 0–25; larger Rivencraft tab numbers use positional base 25.
*/
public final class SymbolNumerals {
private SymbolNumerals() {}
public static int[] digitsFor(int number) {
if (number < 0) throw new IllegalArgumentException("Numeral must be non-negative");
if (number < 25) return new int[] {number};
int count = 0;
for (int remaining = number; remaining > 0; remaining /= 25) count++;
int[] digits = new int[count];
for (int remaining = number, index = count - 1; index >= 0; index--, remaining /= 25)
digits[index] = remaining % 25;
return digits;
}
public static int[] componentsForDigit(int digit) {
if (digit < 0 || digit >= 25) throw new IllegalArgumentException("Numeral digit must be in [0, 24]");
if (digit == 0) return new int[] {1};
int fifths = digit / 5;
int remainder = digit % 5;
if (fifths == 0) return new int[] {55 + remainder};
if (remainder == 0) return new int[] {59 + fifths};
return new int[] {59 + fifths, 55 + remainder};
}
}
@@ -0,0 +1,26 @@
package net.dnorberg.rivencraft.writing;
import net.minecraft.resources.ResourceLocation;
/** Legacy poems for existing starter pages, including stacks saved before poem metadata existed. */
public final class SymbolPoems {
private SymbolPoems() {}
public static String builtIn(ResourceLocation id) {
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";
case "celestial/normal_time" -> "Transform Time System Balance";
case "feature/caves" -> "Terrain Transform Void Flow";
default -> "";
};
}
}
@@ -0,0 +1,122 @@
package net.dnorberg.rivencraft.writing;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonPrimitive;
import java.util.Arrays;
import java.util.Objects;
import java.util.Set;
import net.minecraft.resources.ResourceLocation;
/** Bounded grammar role and value, retained by the server catalog only. */
public record SymbolSemantics(Role role, Value value) {
public SymbolSemantics {
Objects.requireNonNull(role, "role");
Objects.requireNonNull(value, "value");
if (!role.accepts(value)) {
throw new IllegalArgumentException("Invalid semantics.value for role '" + role.id
+ "': " + value + "; expected " + role.expected());
}
}
public static SymbolSemantics parse(JsonElement json) {
if (json == null || !json.isJsonObject()) {
throw new IllegalArgumentException("'semantics' must be an object");
}
JsonObject object = json.getAsJsonObject();
for (String field : object.keySet()) {
if (!field.equals("role") && !field.equals("value")) {
throw new IllegalArgumentException("Unknown semantics field '" + field + "'");
}
}
String roleId = SymbolDefinition.requiredString(object, "role");
Role role = Arrays.stream(Role.values()).filter(candidate -> candidate.id.equals(roleId))
.findFirst().orElseThrow(() -> new IllegalArgumentException("Unknown semantic role '" + roleId + "'"));
JsonElement raw = object.get("value");
if (raw == null || !raw.isJsonPrimitive()) {
throw new IllegalArgumentException("'semantics.value' is required");
}
JsonPrimitive primitive = raw.getAsJsonPrimitive();
Value value;
if (role.kind == Kind.RESOURCE) {
value = new ResourceValue(SymbolDefinition.requiredResourceLocation(object, "value"));
} else if (role.kind == Kind.NUMBER) {
if (!primitive.isNumber()) {
throw new IllegalArgumentException("'semantics.value' for " + role.id + " must be a number");
}
value = new NumberValue(primitive.getAsDouble());
} else {
value = new ChoiceValue(SymbolDefinition.requiredString(object, "value"));
}
return new SymbolSemantics(role, value);
}
public sealed interface Value permits ResourceValue, ChoiceValue, NumberValue {}
public record ResourceValue(ResourceLocation id) implements Value {
public ResourceValue { Objects.requireNonNull(id, "id"); }
}
public record ChoiceValue(String id) implements Value {
public ChoiceValue { Objects.requireNonNull(id, "id"); }
}
public record NumberValue(double amount) implements Value {
public NumberValue {
if (!Double.isFinite(amount)) {
throw new IllegalArgumentException("Semantic numeric value must be finite");
}
}
}
private enum Kind { RESOURCE, CHOICE, NUMBER }
public enum Role {
TERRAIN("terrain", Kind.RESOURCE),
BIOME_CONTROLLER("biome_controller", Kind.CHOICE,
"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;
private final Kind kind;
private final Set<String> choices;
Role(String id, Kind kind, String... choices) {
this.id = id;
this.kind = kind;
this.choices = Set.of(choices);
}
public String id() { return id; }
private boolean accepts(Value value) {
if (kind == Kind.RESOURCE) return value instanceof ResourceValue;
if (kind == Kind.CHOICE) return value instanceof ChoiceValue choice && choices.contains(choice.id());
if (!(value instanceof NumberValue number)) return false;
return switch (this) {
case PERIOD_MODIFIER -> number.amount() >= 0.0 && number.amount() <= 2.0;
case ANGLE_MODIFIER, PHASE_MODIFIER -> number.amount() >= 0.0 && number.amount() < 360.0;
default -> false;
};
}
private String expected() {
return switch (kind) {
case RESOURCE -> "a canonical namespaced ID";
case CHOICE -> "one of " + choices.stream().sorted().toList();
case NUMBER -> this == PERIOD_MODIFIER ? "a finite number in [0, 2]"
: "a finite number in [0, 360) degrees";
};
}
}
}
@@ -2,9 +2,9 @@ package net.dnorberg.rivencraft.writing;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Comparator; import java.util.Comparator;
import java.util.HashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.TreeMap;
import net.dnorberg.rivencraft.block.entity.WritingDeskBlockEntity; import net.dnorberg.rivencraft.block.entity.WritingDeskBlockEntity;
import net.dnorberg.rivencraft.item.PageItem; import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.registry.ModDataComponents; import net.dnorberg.rivencraft.registry.ModDataComponents;
@@ -20,7 +20,7 @@ public final class WritingDeskCatalog {
private WritingDeskCatalog() {} private WritingDeskCatalog() {}
public static List<SymbolDisplayMetadata> available(WritingDeskBlockEntity desk) { public static List<SymbolDisplayMetadata> available(WritingDeskBlockEntity desk) {
Map<ResourceLocation, SymbolDisplayMetadata> unique = new TreeMap<>(); Map<ResourceLocation, SymbolDisplayMetadata> unique = new HashMap<>();
for (int slot = 0; slot < WritingDeskBlockEntity.COLLECTIONS; slot++) { for (int slot = 0; slot < WritingDeskBlockEntity.COLLECTIONS; slot++) {
ItemStack collection = desk.getItem(slot); ItemStack collection = desk.getItem(slot);
if (collection.is(ModItems.PAGE.get())) add(unique, collection); if (collection.is(ModItems.PAGE.get())) add(unique, collection);
@@ -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(); }
}
}
@@ -34,6 +34,18 @@
"screen.rivencraft.book_binder.previous_pages": "Scroll pages left (Left Arrow)", "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.next_pages": "Scroll pages right (Right Arrow)",
"screen.rivencraft.book_binder.select_hint": "Right-click page to select", "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.ink": "Ink: %s/%s",
"screen.rivencraft.writing_desk.search": "Search", "screen.rivencraft.writing_desk.search": "Search",
"screen.rivencraft.writing_desk.sort": "Sort pages by name (A–Z)", "screen.rivencraft.writing_desk.sort": "Sort pages by name (A–Z)",
@@ -42,6 +54,7 @@
"screen.rivencraft.writing_desk.all_categories": "All categories", "screen.rivencraft.writing_desk.all_categories": "All categories",
"screen.rivencraft.writing_desk.previous_tabs": "Previous four tabs (Page Up)", "screen.rivencraft.writing_desk.previous_tabs": "Previous four tabs (Page Up)",
"screen.rivencraft.writing_desk.next_tabs": "Next four tabs (Page Down)", "screen.rivencraft.writing_desk.next_tabs": "Next four tabs (Page Down)",
"screen.rivencraft.writing_desk.tab_symbol": "Tab %s",
"screen.rivencraft.writing_desk.no_symbols": "No available symbols", "screen.rivencraft.writing_desk.no_symbols": "No available symbols",
"item.rivencraft.ink_vial.remaining": "Ink: %s/%s", "item.rivencraft.ink_vial.remaining": "Ink: %s/%s",
"item.rivencraft.ink_vial.usage": "Use with paper in the other hand to prepare a Link Panel.", "item.rivencraft.ink_vial.usage": "Use with paper in the other hand to prepare a Link Panel.",
@@ -57,6 +70,7 @@
"message.rivencraft.descriptive_book.unwritten": "This Descriptive Book is unwritten", "message.rivencraft.descriptive_book.unwritten": "This Descriptive Book is unwritten",
"message.rivencraft.descriptive_book.created": "Created Age: %s", "message.rivencraft.descriptive_book.created": "Created Age: %s",
"message.rivencraft.descriptive_book.unavailable": "That Age is unavailable", "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.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_first": "Linked to %s — a Return Link was created",
"message.rivencraft.descriptive_book.linked": "Linked to %s", "message.rivencraft.descriptive_book.linked": "Linked to %s",
@@ -74,7 +88,6 @@
"screen.rivencraft.age.pages": "Pages", "screen.rivencraft.age.pages": "Pages",
"screen.rivencraft.age.details": "Details", "screen.rivencraft.age.details": "Details",
"screen.rivencraft.age.pages_count": "Writing %s/%s", "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.biomes": "Biomes: %s",
"screen.rivencraft.age.trait.lighting": "Lighting: %s", "screen.rivencraft.age.trait.lighting": "Lighting: %s",
"screen.rivencraft.age.trait.weather": "Weather: %s", "screen.rivencraft.age.trait.weather": "Weather: %s",
@@ -107,16 +120,112 @@
"symbol.rivencraft.unresolved.description": "Missing symbol: %s", "symbol.rivencraft.unresolved.description": "Missing symbol: %s",
"symbol.rivencraft.terrain.standard": "Standard Terrain", "symbol.rivencraft.terrain.standard": "Standard Terrain",
"symbol.rivencraft.terrain.standard.description": "A familiar continental terrain foundation.", "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": "Native Biomes",
"symbol.rivencraft.biome.native.description": "Use the terrain profile's native biome climate.", "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": "Normal Lighting",
"symbol.rivencraft.lighting.normal.description": "Use normal skylight and ambient brightness.", "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": "Normal Weather",
"symbol.rivencraft.weather.normal.description": "Use the normal weather cycle.", "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": "Normal Time",
"symbol.rivencraft.celestial.normal_time.description": "Use a normal-length celestial cycle.", "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": "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.standard": "Standard",
"generator.rivencraft.amplified": "Amplified", "generator.rivencraft.amplified": "Amplified",
"generator.rivencraft.island": "Island", "generator.rivencraft.island": "Island",
@@ -138,5 +247,15 @@
"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.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.", "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": "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.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"
} }
@@ -1,17 +1,13 @@
{ {
"parent": "minecraft:item/generated", "parent": "builtin/entity",
"textures": { "gui_light": "front",
"layer0": "rivencraft:item/page" "display": {
}, "ground": { "translation": [0, 2, 0], "scale": [0.5, 0.5, 0.5] },
"overrides": [ "head": { "rotation": [0, 180, 0], "translation": [0, 13, 7] },
{ "predicate": { "custom_model_data": 1 }, "model": "rivencraft:item/page_link_panel" }, "thirdperson_righthand": { "translation": [0, 3, 1], "scale": [0.55, 0.55, 0.55] },
{ "predicate": { "custom_model_data": 2 }, "model": "rivencraft:item/page_unresolved" }, "thirdperson_lefthand": { "translation": [0, 3, 1], "scale": [0.55, 0.55, 0.55] },
{ "predicate": { "custom_model_data": 3 }, "model": "rivencraft:item/page_symbol" }, "firstperson_righthand": { "rotation": [0, -90, 25], "translation": [1.13, 3.2, 1.13], "scale": [0.68, 0.68, 0.68] },
{ "predicate": { "custom_model_data": 100 }, "model": "rivencraft:item/page_symbol_terrain_standard" }, "firstperson_lefthand": { "rotation": [0, 90, -25], "translation": [1.13, 3.2, 1.13], "scale": [0.68, 0.68, 0.68] },
{ "predicate": { "custom_model_data": 101 }, "model": "rivencraft:item/page_symbol_biome_native" }, "fixed": { "rotation": [0, 180, 0] }
{ "predicate": { "custom_model_data": 102 }, "model": "rivencraft:item/page_symbol_lighting_normal" }, }
{ "predicate": { "custom_model_data": 103 }, "model": "rivencraft:item/page_symbol_weather_normal" },
{ "predicate": { "custom_model_data": 104 }, "model": "rivencraft:item/page_symbol_celestial_normal_time" },
{ "predicate": { "custom_model_data": 105 }, "model": "rivencraft:item/page_symbol_feature_caves" }
]
} }
@@ -1,4 +0,0 @@
{
"parent": "minecraft:item/generated",
"textures": { "layer0": "rivencraft:item/page_symbol_biome_native" }
}
@@ -1,4 +0,0 @@
{
"parent": "minecraft:item/generated",
"textures": { "layer0": "rivencraft:item/page_symbol_celestial_normal_time" }
}
@@ -1,4 +0,0 @@
{
"parent": "minecraft:item/generated",
"textures": { "layer0": "rivencraft:item/page_symbol_feature_caves" }
}
@@ -1,4 +0,0 @@
{
"parent": "minecraft:item/generated",
"textures": { "layer0": "rivencraft:item/page_symbol_lighting_normal" }
}
@@ -1,4 +0,0 @@
{
"parent": "minecraft:item/generated",
"textures": { "layer0": "rivencraft:item/page_symbol_terrain_standard" }
}
@@ -1,4 +0,0 @@
{
"parent": "minecraft:item/generated",
"textures": { "layer0": "rivencraft:item/page_symbol_weather_normal" }
}
Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

@@ -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"}
@@ -1,6 +1,8 @@
{ {
"schema_version": 1, "schema_version": 2,
"name": "symbol.rivencraft.biome.native", "name": "symbol.rivencraft.biome.native",
"description": "symbol.rivencraft.biome.native.description", "description": "symbol.rivencraft.biome.native.description",
"category": "rivencraft:biome" "category": "rivencraft:biome",
"semantics": { "role": "biome_controller", "value": "native" },
"poem": "Constraint Nature Tradition Sustain"
} }
@@ -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"}
@@ -1,6 +1,8 @@
{ {
"schema_version": 1, "schema_version": 2,
"name": "symbol.rivencraft.celestial.normal_time", "name": "symbol.rivencraft.celestial.normal_time",
"description": "symbol.rivencraft.celestial.normal_time.description", "description": "symbol.rivencraft.celestial.normal_time.description",
"category": "rivencraft:celestial" "category": "rivencraft:celestial",
"semantics": { "role": "celestial", "value": "normal_time" },
"poem": "Transform Time System Balance"
} }
@@ -1,6 +1,8 @@
{ {
"schema_version": 1, "schema_version": 2,
"name": "symbol.rivencraft.feature.caves", "name": "symbol.rivencraft.feature.caves",
"description": "symbol.rivencraft.feature.caves.description", "description": "symbol.rivencraft.feature.caves.description",
"category": "rivencraft:feature" "category": "rivencraft:feature",
"semantics": { "role": "feature", "value": "rivencraft:caves" },
"poem": "Terrain Transform Void Flow"
} }
Loaded 100 of 135 files, more files were not shown because too many files have changed in this diff. Show more