Compare commits

...
19 Commits
Author SHA1 Message Date
dnorberg b86e855907 Add Link Panel modifiers and legacy Ink Mixer presentation (#36)
Build / build (push) Canceled after 0s
2026-10-03 07:36:46 -04:00
dnorberg 6c3b4f1885 Apply authored feature and decoration pages to ages
Build / build (push) Canceled after 0s
2026-10-02 21:28:11 -04:00
dnorberg 84a1f32732 Organize creative pages and stabilize GameTests
Build / build (push) Canceled after 0s
2026-10-02 14:49:41 -04:00
dnorberg a7b2c24915 Apply authored Age environment symbols (#34)
Build / build (push) Canceled after 0s
2026-10-01 17:28:20 -04:00
dnorberg 050a9537e9 Apply authored biome distributions and expose biome pages (#33)
Build / build (push) Canceled after 0s
2026-10-01 16:29:01 -04:00
dnorberg e28079566b Implement terrain symbol generation profiles
Build / build (push) Canceled after 0s
2026-09-30 16:44:22 -04:00
dnorberg 28c2ca0db3 Persist authored Age generation plans (#31)
Build / build (push) Canceled after 0s
2026-09-30 16:17:25 -04:00
dnorberg 27abebe3aa Validate ordered Age writing and highlight Binder errors (#30)
Build / build (push) Canceled after 0s
2026-09-30 15:39:53 -04:00
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
dnorberg 8246640f49 Complete Milestone 4 writing acceptance and migration coverage (#26, #27)
Build / build (push) Canceled after 0s
2026-09-29 22:51:49 -04:00
dnorberg ba2faace15 Use Legacy Linking Book recipe and add page-turn audio
Build / build (push) Canceled after 0s
2026-09-29 22:37:45 -04:00
dnorberg 88355ee276 Add Ink Mixer and optional JEI writing guides
Build / build (push) Canceled after 0s
2026-09-29 10:35:29 -04:00
dnorberg 568490e625 Persist ordered book writing and restore Legacy book pages
Build / build (push) Canceled after 0s
2026-09-29 09:46:17 -04:00
dnorberg 85da1f047d Add Legacy-style Book Binder
Build / build (push) Canceled after 0s
2026-09-29 09:06:34 -04:00
dnorberg 6587a924e9 worked on getting writing desk model to match legacy
Build / build (push) Canceled after 0s
2026-09-25 08:27:41 -04:00
dnorberg a359ce7835 Refine Writing Desk collection and ink refill behavior
Build / build (push) Canceled after 0s
2026-09-25 06:07:44 -04:00
194 changed files with 8973 additions and 671 deletions

No files matched your search

+127
View File
@@ -0,0 +1,127 @@
Rivencraft Build Instructions
============================
These instructions apply when source code, models, textures, data, or other
resources have been changed.
Requirements
------------
- Java 21 JDK
- A working Gradle wrapper
- The project dependencies available in the Gradle cache, or network access
for Gradle to download them
The project targets Minecraft 1.21.1 and NeoForge 21.1.251.
1. Open the project directory
--------------------------------
cd /path/to/rivencraft
2. Check the changed files
--------------------------
Confirm that model, texture, and other resource files are inside
`src/main/resources`. Java source files belong under `src/main/java`.
For example, block models are normally stored under:
src/main/resources/assets/rivencraft/models/block/
Resource files placed under `src/main/resources` are automatically included in
the finished mod JAR by Gradle.
3. Update the version when appropriate
---------------------------------------
Rivencraft uses the version format `x.y.z.b`:
- `x`: major release
- `y`: milestone completion
- `z`: release slice
- `b`: bug fixes and additional work within that slice
Edit `mod_version` in `gradle.properties` before creating a new release. Do
not reuse a version that has already been published.
4. Build the mod
----------------
From the project directory, run:
./gradlew build --offline
If the required dependencies are not cached locally, remove `--offline`:
./gradlew build
On systems using mise-managed Java and Gradle, use:
mise exec -- ./gradlew build --offline
5. Run the automated tests
--------------------------
To build and run the GameTest suite:
./gradlew build runGameTestServer --offline
Or, with mise:
mise exec -- ./gradlew build runGameTestServer --offline
All required GameTests should pass before distributing a build.
GameTests use `build/gametest-run/world`, separate from the normal development
world. Gradle starts each default run with a fresh world and removes it after
every run, whether tests pass or fail. The GameTest server always uses seed `0`,
so retries regenerate a clean world with that seed. Logs and configuration are kept.
A caller-supplied `-PgameTestRunDir`
is never removed automatically.
To run the suite in a fresh temporary directory instead, use:
test_dir=$(mktemp -d /tmp/rivencraft-gametest.XXXXXX)
./gradlew runGameTestServer --offline -PgameTestRunDir="$test_dir"
With mise, prefix the second command with `mise exec --`.
6. Locate and inspect the JAR
-----------------------------
Build outputs are written to:
build/libs/
The filename uses the configured version, for example:
build/libs/rivencraft-0.3.6.9.jar
To verify that changed resource files are packaged:
unzip -l build/libs/rivencraft-VERSION.jar | rg 'models|textures|data'
Replace `VERSION` with the actual version number.
To create a checksum for distribution:
sha256sum build/libs/rivencraft-VERSION.jar
7. Stop the Gradle daemon when finished
----------------------------------------
This is optional, but useful after a long test run:
./gradlew --stop
Release checklist
-----------------
- Confirm the version was incremented when required.
- Confirm the build completed successfully.
- Confirm all required GameTests passed.
- Confirm changed resources are present in the JAR.
- Generate and record the SHA-256 checksum.
- Test the JAR in the target Minecraft 1.21.1 NeoForge instance.
- Publish the JAR only after client-side testing is complete.
+3
View File
@@ -16,6 +16,9 @@ The Writing Desk block texture is copied from Legacy's
assets/mystcraft/textures/entity/desk.png under the same license. assets/mystcraft/textures/entity/desk.png under the same license.
The Writing Desk GUI atlas is copied from Legacy's assets/mystcraft/gui/writingdesk.png The Writing Desk GUI atlas is copied from Legacy's assets/mystcraft/gui/writingdesk.png
under the same license; desk wood and inlay textures are cropped from desk.png. under the same license; desk wood and inlay textures are cropped from desk.png.
The Ink Mixer GUI atlas and block textures are copied from Legacy's
assets/mystcraft/gui/inkmixer.png and textures/blocks/inkmixer_*.png under
the same license. Rivencraft's block model is original and uses those textures.
The initial build layout is derived from the official NeoForge 1.21.1 The initial build layout is derived from the official NeoForge 1.21.1
ModDevGradle MDK: https://github.com/NeoForgeMDKs/MDK-1.21.1-ModDevGradle ModDevGradle MDK: https://github.com/NeoForgeMDKs/MDK-1.21.1-ModDevGradle
+88 -9
View File
@@ -4,8 +4,8 @@ Rivencraft is a clean, incremental port of the ideas and gameplay of
[Mystcraft Legacy](https://github.com/Mystcraft/Mystcraft-Legacy) to Minecraft [Mystcraft Legacy](https://github.com/Mystcraft/Mystcraft-Legacy) to Minecraft
1.21.1 on NeoForge. 1.21.1 on NeoForge.
The bootstrap, books/linking, and Ages milestones are complete. Milestone 4 is The bootstrap, books/linking, Ages, and writing-system milestones are complete.
building the writing system on a data-pack symbol catalog and persistent The writing system uses a data-pack symbol catalog and persistent
ordered-writing model. The project currently provides functional Linking Books ordered-writing model. The project currently provides functional Linking Books
and randomly seeded, persistent vanilla-like Ages created from page-free and randomly seeded, persistent vanilla-like Ages created from page-free
Descriptive Books. Instability and full symbol-to-world grammar interpretation Descriptive Books. Instability and full symbol-to-world grammar interpretation
@@ -19,36 +19,111 @@ hand and use the Ink Vial in the other to prepare a baseline Link Panel Page.
Each vial holds 16 ink units, and the default link-panel cost is two units. Each vial holds 16 ink units, and the default link-panel cost is two units.
The spent vial returns a glass bottle. Server owners can adjust the symbol-copy The spent vial returns a glass bottle. Server owners can adjust the symbol-copy
and link-panel costs in the `writing` section of `rivencraft-server.toml`. and link-panel costs in the `writing` section of `rivencraft-server.toml`.
The Ink Mixer now offers a Legacy-style station for producing Link Panels:
insert paper and Ink Vials, then take a Link Panel from the result slot. Each
vial fills its 16-unit basin and returns a glass bottle; no server tick is
needed. The earlier paper-in-one-hand method remains available. Ink modifier
ingredients and link properties are planned for Milestone 5.
The Writing Desk can copy a selected written page from its collection tabs. The Writing Desk can copy a selected written page from its collection tabs.
The Writing Desk is now craftable from planks, a glass bottle, and a feather. The Writing Desk is now craftable from planks, a glass bottle, and a feather.
It occupies two adjacent blocks, with one shared inventory; loaded paper and It occupies two adjacent blocks, with one shared inventory; loaded paper and
the selected page appear on its Legacy-inspired model. the selected page appear on its Legacy-inspired model.
Desks placed before 0.3.6.1 keep their old one-block footprint until broken Desks placed before 0.3.6.1 keep their old one-block footprint until broken
and placed again; leave an adjacent space when replacing one. and placed again; leave an adjacent space when replacing one.
Its four collection tabs, paper input, ink vial input, empty glass-bottle return, Its 88 collection tabs, paper input, ink vial input, empty glass-bottle return,
16-unit ink meter, and inventory persist 16-unit ink meter, and inventory persist
through world saves; breaking it drops stored contents. The desk screen is a through world saves; breaking it drops stored contents. The desk screen is a
functional foundation styled after Legacy's left tabs, central writing surface, functional foundation using Legacy's original desk and scrollbar textures.
and right inventory. Put vanilla paper in the Four tabs are visible at once; the controls above and below them move by four
(1–4, 5–8, through 85–88). Each viewer can browse a different group. Existing
four-tab desks retain their collections and supplies when upgraded.
With a notebook selected, pick up a Page from your inventory and click an empty
position on the left surface to store one page there. Clear search/filter/sort
and turn off `ALL` to place pages at specific positions; occupied positions are
never overwritten. A notebook tab exposes all 27 notebook positions (scroll to
reach the rest); a loose-page tab exposes only its one occupied position.
Empty tabs have no page storage until a notebook or page is put in the tab slot.
Click a page on the desk surface to select it for copying. Drag a page from one
notebook position to an empty position to move it, or onto another page to swap
their positions. This also works between notebooks shown in the `ALL` view.
Drag a page out of the panel to turn it back into an item. Drop it over a player
inventory slot or desk tab to place it there; a tab with a notebook adds it to
the first open position. Dropping elsewhere leaves the page on the cursor for
normal inventory placement. The source notebook or tab loses the page only after
a valid drop.
Put vanilla paper in the
upper-left slot and Ink Vials in the upper-right; a copy appears in the upper-left slot and Ink Vials in the upper-right; a copy appears in the
lower-left result slot when the selected page is valid. Taking it consumes one lower-left result slot when the selected page is valid. Taking it consumes one
paper and, by default, one ink. An empty meter consumes a vial to refill and paper and, by default, one ink. An available vial refills an empty ink meter
returns a vanilla glass bottle to the lower-right slot. The `AZ` control sorts when inserted or when copying uses its last ink, and returns a vanilla glass
bottle to the lower-right slot. Removing a bottle also retries a blocked refill.
Refilling waits if that slot is full or contains another item. The `AZ` control sorts
visible pages by name; `ALL` shows pages held across every desk tab. Search and visible pages by name; `ALL` shows pages held across every desk tab. Search and
category filtering narrow the view without granting new pages, and cross-tab category filtering narrow the view without granting new pages, and cross-tab
copy selection is checked by the server. copy selection is checked by the server.
Selecting a stored page on the desk surface shows its Legacy-proportioned Selecting a stored page on the desk surface shows its Legacy-proportioned
portrait preview and name above the player inventory. portrait preview and name above the player inventory.
## Book Binder
For a new survival Age: craft an Ink Vial, an Ink Mixer, a Writing Desk, and a Book Binder.
Put vanilla paper and an Ink Vial in the Ink Mixer to make a Link Panel
Page. Place leather (or an empty Notebook) and the Link Panel in the Book Binder,
enter an Age name, and take the finished Descriptive Book. Written symbol Pages
are optional; without them, the book creates a random Age. To duplicate a Page
you already own, store it in a Writing Desk tab, select it, supply paper and ink,
and take the copied Page from the output. A Notebook can hold and transfer a
larger ordered collection of Pages between desks and the binder.
With JEI installed, Rivencraft displays the Ink Mixer operation in its own
category and the hand-use, copying, binding, and Linking Book crafting flows in a Writing category.
The Link Panel and individual symbol Pages, including registered vanilla biome
pages, appear as separately searchable JEI ingredients.
Creative inventory separates Link Pages and each symbol category into their own
tabs, including distinct Biome and Biome Generation tabs. Blank Pages are hidden
from creative inventory and JEI.
JEI is optional; vanilla crafting
recipes and all writing interactions work without it. For a development client
with JEI, run `./gradlew runClient -PwithJei=true`.
Craft a Book Binder from three iron ingots and five planks. Put leather or an
empty Notebook in the left cover slot. Enter a title, then place a Link Panel
Page first in the horizontal page strip. Click a page in the strip with a
written Page on the cursor to insert it before that position; click it with an
empty cursor to take it out. The arrows or mouse wheel scroll through up to
27 written Pages. Clicking the strip with a filled Notebook imports its Pages
at that position and leaves the emptied Notebook on the cursor. The right slot
outputs a Descriptive Book once the title, cover, and Link Panel are present.
Inputs are consumed only when the result is taken.
The completed book receives its Age identity when assembled. With only a Link
Panel, it describes a randomly generated Age. Authored writing is compiled once
into a versioned, server-owned Age plan. The plan freezes the Age seed, resolved
symbol meanings, page order, and runtime profile, so later data-pack changes do
not reinterpret an existing Age. An authored terrain page selects its runtime
profile. Built-in pages cover Standard, Amplified, Cave, Island, Flat, and Void;
authored biome, environment, and supported feature pages also affect new Ages.
Further symbol effects are scheduled for later Milestone 5 slices. The
writing is also stored on the book; the Descriptive Book screen's turned pages
show ordered symbols and unresolved IDs. The Descriptive Book screen follows
Legacy's book spread: the title and Age details are on the left, the destination
preview is on the right, and clicks in the bottom corners turn pages. Ordered
symbol pages appear before the final blank spread; their pictograms await
Milestone 5. Link-panel-only books show their details in the enchantment-table
font.
## Linking Book ## Linking Book
Craft a Linking Book from a vanilla book and an ender pearl, then use it in the Craft an unwritten Linking Book from one Link Panel Page and one leather in any
air. An unbound book opens a screen where it can be named and bound to the two crafting-grid positions. An unbound book opens a screen where it can be named and bound to the
current location. A bound book opens its destination screen and travels when current location. A bound book opens its destination screen and travels when
its preview panel is clicked. The destination is stored on the item and its preview panel is clicked. The destination is stored on the item and
survives inventory and world saves. Travel only succeeds if the target survives inventory and world saves. Travel only succeeds if the target
dimension is loaded and a non-fluid, passable landing position can be found dimension is loaded and a non-fluid, passable landing position can be found
nearby. nearby.
The Linking Book uses the same Legacy page layout and bottom-corner page turns
as the Descriptive Book, but without the Descriptive Book's gold cover edges.
Both screens play Minecraft's book-page-turn sound when a page is turned.
Successful book travel plays Mystcraft Legacy's original linking sound at both Successful book travel plays Mystcraft Legacy's original linking sound at both
the departure and arrival locations. the departure and arrival locations.
@@ -124,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
+116 -7
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,7 +38,53 @@ 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 {
name = 'JaredsMaven'
url = 'https://maven.blamejared.com'
content {
includeGroup 'mezz.jei'
includeGroup 'net.mezzdev.config'
}
}
maven { url = 'https://maven.createmod.net' } maven { url = 'https://maven.createmod.net' }
maven { maven {
url = 'https://www.cursemaven.com' url = 'https://www.cursemaven.com'
@@ -78,7 +136,10 @@ neoForge {
// The gametest system is also enabled by default for other run configs under the /test command. // The gametest system is also enabled by default for other run configs under the /test command.
gameTestServer { gameTestServer {
type = "gameTestServer" type = "gameTestServer"
systemProperty 'neoforge.enabledGameTestNamespaces', project.mod_id // Keep generated test Ages separate from worlds used by the dev client/server.
gameDirectory = project.file(project.findProperty('gameTestRunDir')
?: layout.buildDirectory.dir('gametest-run').get().asFile)
systemProperty 'neoforge.enabledGameTestNamespaces', enabledGameTestNamespaces
} }
data { data {
@@ -116,6 +177,54 @@ neoForge {
} }
} }
// Vanilla's GameTestServer uses a fixed world seed of 0. Every default run
// regenerates its world; custom run directories are never managed here.
boolean customGameTestRunDir = providers.gradleProperty('gameTestRunDir').isPresent()
File dedicatedGameTestBuildDir = layout.buildDirectory.get().asFile
File dedicatedGameTestDir = layout.buildDirectory.dir('gametest-run').get().asFile
def prepareGameTestWorld = tasks.register('prepareGameTestWorld') {
onlyIf { !customGameTestRunDir }
doLast {
GameTestWorlds.clean(dedicatedGameTestBuildDir, dedicatedGameTestDir)
}
}
def finishGameTestWorld = tasks.register('finishGameTestWorld') {
onlyIf { !customGameTestRunDir }
doLast {
GameTestWorlds.clean(dedicatedGameTestBuildDir, dedicatedGameTestDir)
}
}
tasks.named('runGameTestServer').configure {
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'.
// This configuration should be used instead of 'runtimeOnly' to declare // This configuration should be used instead of 'runtimeOnly' to declare
// a dependency that will be present for runtime testing but that is // a dependency that will be present for runtime testing but that is
@@ -131,12 +240,12 @@ dependencies {
compileOnly "maven.modrinth:immersive-portals-neoforge:${immersive_portals_version}" compileOnly "maven.modrinth:immersive-portals-neoforge:${immersive_portals_version}"
implementation "curse.maven:dynamicdimension-ar-edition-1469680:${dynamic_dimensions_file_id}" implementation "curse.maven:dynamicdimension-ar-edition-1469680:${dynamic_dimensions_file_id}"
implementation "lol.bai:badpackets:neo-${badpackets_version}" implementation "lol.bai:badpackets:neo-${badpackets_version}"
// Example optional mod dependency with JEI // JEI integration is isolated in its plugin and absent from the published runtime dependencies.
// The JEI API is declared for compile time use, while the full JEI artifact is used at runtime compileOnly "mezz.jei:jei-${minecraft_version}-neoforge-api:${jei_version}"
// compileOnly "mezz.jei:jei-${mc_version}-common-api:${jei_version}" // Opt in to JEI for a dev client with -PwithJei=true.
// compileOnly "mezz.jei:jei-${mc_version}-neoforge-api:${jei_version}" if (providers.gradleProperty('withJei').map { it.toBoolean() }.orElse(false).get()) {
// We add the full version to localRuntime, not runtimeOnly, so that we do not publish a dependency on it localRuntime "mezz.jei:jei-${minecraft_version}-neoforge:${jei_version}"
// localRuntime "mezz.jei:jei-${mc_version}-neoforge:${jei_version}" }
// Example mod dependency using a mod jar from ./libs with a flat dir repository // Example mod dependency using a mod jar from ./libs with a flat dir repository
// This maps to ./libs/coolmod-${mc_version}-${coolmod_version}.jar // This maps to ./libs/coolmod-${mc_version}-${coolmod_version}.jar
Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 166 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 116 KiB

+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
+13 -3
View File
@@ -8,13 +8,23 @@ project's GNU LGPL v3 license. Rivencraft itself uses the same license.
| --- | --- | --- | --- | | --- | --- | --- | --- |
| `assets/rivencraft/textures/item/page.png` | `assets/mystcraft/textures/items/page_background.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only | | `assets/rivencraft/textures/item/page.png` | `assets/mystcraft/textures/items/page_background.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only |
| `assets/rivencraft/textures/gui/notebook_pages.png` | `assets/mystcraft/gui/bookui_pagel.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; Notebook draws the native 30×40 page at atlas coordinates `(156, 0)` | | `assets/rivencraft/textures/gui/notebook_pages.png` | `assets/mystcraft/gui/bookui_pagel.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; Notebook draws the native 30×40 page at atlas coordinates `(156, 0)` |
| `assets/rivencraft/textures/gui/bookui_cover.png` | `assets/mystcraft/gui/bookui_cover.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; shared book cover, with gold edges drawn only for Descriptive Books |
| `assets/rivencraft/textures/gui/bookui_pagel.png` | `assets/mystcraft/gui/bookui_pagel.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; turned left page |
| `assets/rivencraft/textures/gui/bookui_pager.png` | `assets/mystcraft/gui/bookui_pager.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; link-panel frame on the first right page |
| `assets/rivencraft/textures/gui/bookui_rpage_full.png` | `assets/mystcraft/gui/bookui_rpage_full.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; full right written page |
| `assets/rivencraft/textures/item/writing_desk.png` | `assets/mystcraft/textures/items/writingdesk.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only | | `assets/rivencraft/textures/item/writing_desk.png` | `assets/mystcraft/textures/items/writingdesk.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only |
| `assets/rivencraft/textures/block/writing_desk.png` | `assets/mystcraft/textures/entity/desk.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only | | `assets/rivencraft/textures/block/writing_desk.png` | `assets/mystcraft/textures/entity/desk.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only |
| `assets/rivencraft/textures/block/writing_desk_wood.png` and `writing_desk_inlay.png` | `assets/mystcraft/textures/entity/desk.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Cropped opaque wood and red inlay regions for the two-block model | | `assets/rivencraft/textures/gui/writing_desk_legacy.png` | `assets/mystcraft/gui/writingdesk.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; full desk panel, tabs, and cycling controls at original atlas coordinates |
| `assets/rivencraft/textures/gui/writing_desk_legacy.png` | `assets/mystcraft/gui/writingdesk.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; solid GUI backing sampled from Legacy atlas | | `assets/rivencraft/textures/gui/scrollbar.png` | `assets/mystcraft/gui/scrollbar.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; tiled track and normal/pressed thumb |
| `assets/rivencraft/textures/block/book_binder.png` | `assets/mystcraft/textures/entity/bookbinder/bookbinder.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; Book Binder model uses this body texture |
| `assets/rivencraft/textures/block/book_binder_press.png` | `assets/mystcraft/textures/entity/bookbinder/press_part.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; Book Binder model uses this press texture |
| `assets/rivencraft/textures/gui/book_binder_legacy.png` | `assets/mystcraft/gui/pagebinder.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; Book Binder GUI uses the original 176×181 panel |
| `assets/rivencraft/textures/gui/ink_mixer_legacy.png` | `assets/mystcraft/gui/inkmixer.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; Ink Mixer GUI uses the original 176×181 panel |
| `assets/rivencraft/textures/block/ink_mixer_top.png`, `ink_mixer_side.png`, `ink_mixer_bottom.png` | `assets/mystcraft/textures/blocks/inkmixer_top.png`, `inkmixer_side.png`, `inkmixer_bottom.png` | `9bc8ddc061845df0cd5ea47f4fdef773cff786ae` | Namespace/path rename only; Rivencraft supplies its own block model |
| `assets/rivencraft/textures/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`
+140
View File
@@ -0,0 +1,140 @@
# 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 Ink Mixer modifier check (Milestone 5, issue #36)
With optional JEI installed, search for the Ink Mixer category. It should show
the base paper/ink/vial operation and separate entries for Gunpowder, Mushroom
Stew, Experience Bottle, Ender Pearl, Feather, and Fire Charge,
with their property chances. Black Dye and Clay Ball should not appear: the
former had no working Legacy effect, while Generate Platform is redundant
with default Age arrival. Without JEI, Rivencraft should still
start and the mixer should work normally.
Put paper and an Ink Vial in the mixer. Hold Gunpowder on the cursor and
right-click the ink basin once; one Gunpowder should be consumed, and hovering
the basin should show a 20% Disarm chance. Black Dye, Clay Balls, and an
unrelated item such as Stone should remain untouched.
Closing and reopening the mixer should retain the chance. Taking a Link Panel
should consume one paper and the configured ink cost, clear the current
mixture, and possibly give a panel with Disarm on its tooltip. Repeat until
a property-bearing panel appears, craft it with leather, and confirm the
unwritten Linking Book preserves the property tooltip. After binding it,
link to another dimension; inventory items should drop at the departure point.
With twenty Ender Pearls added to a fresh mixture, both Disarm and Intra
Linking should show about 96.1%, and the basin should animate both property
colors. Taking a panel should reset all three percentages and clear the color
effect; a near-certain modifier should show the brighter outer animation.
Also bind a Descriptive Book with a Disarm panel and check the same drop behavior.
Bind a Descriptive Book with both Intra Linking and Maintain Momentum on its
panel: the assembled book should retain Maintain Momentum but omit Intra
Linking. For Linking Books, try an unmodified book whose destination is the
current dimension: it should refuse travel. A Linking Book with Intra Linking
should work in the same dimension. A Descriptive Book does not require or use
Intra Linking, even if an older book retained that flag.
Automatic Return Links should still appear according to the existing setting
and work from an Age back to the Overworld. A full player inventory or blocked glass-bottle slot
must not duplicate or consume materials for an output that cannot be taken.
Link Panels should not enter Notebooks (folders) or Writing Desk tabs, whether
clicked, shift-clicked, or dragged onto the page surface. An old Notebook or
Desk already holding a Link Panel should still let the player take it out,
but the Desk must not offer a copy of it. The Desk should continue to copy
ordinary symbol Pages; JEI should show that example instead of Link Panel copying.
## Manual Age unload/reload check
The automated suite does not unload a freshly generated Age. Minecraft can
queue point-of-interest block updates after generation; closing that Age's
region storage while a queued update is still pending can leave the dedicated
GameTest server waiting forever in `SectionStorage.readColumn`. Plan save/load,
terrain generation, and safe spawn remain automated; runtime unload/reload is
checked in a normal game session:
1. Back up the test world. Bind one Link-Panel-only Descriptive Book and one
Descriptive Book with a terrain page (for example, Island), using distinct
names. Bring a working way back to the Overworld.
2. Travel through each book, confirm the named Age and expected terrain, then
return to the Overworld. Close book screens and wait a few seconds.
3. With cheats enabled, run `/rivencraft age list` and record each Age's
`rivencraft:age/...` dimension ID. Run `/rivencraft age unload <dimension>`
for one Age at a time, then list again to confirm it is unloaded.
4. Reopen the same Descriptive Books and travel back. Confirm each book reaches
its original Age, the terrain and safe arrival remain intact, and no extra
Age entry was created. Save, restart the world, and repeat the book check.
## Manual feature-generation check (Milestone 5, issue #35)
The automated suite verifies feature pages, compiled and saved feature IDs,
vanilla registry mappings, unsupported combinations, and the runtime generator.
An automated scan across many newly generated chunks stalled the GameTest
server, so physical placement is handed to the player for in-game verification:
1. In a fresh world, bind a Descriptive Book with Link Panel, Standard Terrain,
Plains Biome, Single Biome, Caves, and Rocks pages in that order.
Missing weather/lighting/celestial branches may be seed-filled. Travel to
the Age and explore several fresh surface chunks: boulders made from one
seed-selected full-collision block should appear among the plains terrain.
Then explore underground in fresh
chunks; the Caves page should add a second cave-carving pass to Standard
terrain, not switch the Age to Cave terrain.
2. Make a second book with Flat Terrain and Caves. The Binder should mark the
Caves page unsupported and prevent assembly. Cave Terrain plus Caves should
be accepted; Cave Terrain plus Rocks should be rejected.
3. Return, save, and restart the world. Re-enter the first Age and explore
*new* chunks. The authored decorations should continue without rebinding.
Previously generated chunks are intentionally unchanged.
4. Title-derived terrain regression (with Create installed): with no Terrain Page, assemble Link Panel,
Glowstone, Rocks, Chocolate, Small Lakes in that order and name the Age
`glow`. The Binder should accept it and generate compatible surface terrain;
Glowstone should be the rock material and Chocolate should appear in authored
Small Lakes across fresh chunks. Ordinary vanilla lava lakes may still occur.
Repeat
with `gl` or `glo` to confirm names do not change page validity. An explicit
Flat or Cave Terrain Page with Rocks should still be rejected.
+30
View File
@@ -0,0 +1,30 @@
# Ink Mixer and Link Panel modifiers (Milestone 5, issue #36)
Legacy source: [`InkEffects`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/data/InkEffects.java), [`TileEntityInkMixer`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/tileentity/TileEntityInkMixer.java), and [`LinkPropertyAPI`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/api/java/com/xcompwiz/mystcraft/api/hook/LinkPropertyAPI.java).
Legacy does **not** use a conventional ingredient slot: the player clicks the ink basin with a carried item. Each accepted item is consumed immediately, changing the basin's property probabilities. A Link Panel is a virtual result; taking it consumes paper and ink, rolls each property independently using a saved next-seed, writes the selected flags to the Page, then resets that basin's mixture. The Link Panel passes those flags to a Linking Book made with leather. The preview must not roll or consume anything.
| Ingredient | Property | Chance per item |
| --- | --- | ---: |
| Gunpowder | Disarm | 20% |
| Mushroom Stew | Disarm | 5% |
| Clay Ball | Generate Platform | 25% |
| Experience Bottle | Intra Linking | 15% |
| Ender Pearl | Intra Linking + Disarm | 15% each |
| Feather | Maintain Momentum | 15% |
| Fire Charge | Disarm | 25% |
| Black dye | Empty effect key; ignored by Legacy's mixer | None in practice |
Legacy also has optional ore-dictionary dusts: brass, bronze, tin, iron, lead, silver, diamond, and gold. Their effect combinations are in `InkEffects.init()`. Forge's ore dictionary does not exist in NeoForge 1.21.1, so these should be mapped through item tags only when a suitable tag and item exist; none should become a hard dependency. The `Relative` and `Intra Linking Only` properties are registered but have no built-in ingredient. `Natural`, `External`, `Offensive`, `Op-TP`, and `Following` are internal link flags, not mixer ingredients.
For each additive, Legacy scales each existing probability by `1 - sum(additive chances)` and then adds the additive's probabilities. Properties are rolled independently on the final Page. The Legacy link effects are: Disarm drops carried inventory before travel; Generate Platform places a single arrival block if a drop exists; Maintain Momentum retains velocity; Intra Linking permits a same-dimension link.
Rivencraft deliberately diverges from Legacy's shared-probability dilution here: each supported modifier accumulates independently as `new = 1 - (1 - old) × (1 - item chance)^item count`. Twenty Ender Pearls therefore produce about 96.1% each for Disarm and Intra Linking, and a panel can receive both. Taking the panel resets every probability to zero. The GUI uses Legacy's empty-basin atlas sprite, fills the basin dark when ink is present, and projects its colored rotating D'ni effect over the ink (red Disarm, blue Momentum, green Intra); the effect intensifies as a modifier approaches certainty and disappears after output is taken.
Implementation requirements: keep the mixer server-authoritative; persist mixture probabilities and next-seed; show a deterministic virtual result; consume exact inputs once; prevent duplicate output on shift-click; preserve inputs when output cannot be taken; copy the Page's link properties into a Linking Book; apply supported properties only after destination validation; retain unmodified books' current safe-link behavior; and expose both base and modifier sequences to optional JEI. Tests should cover persistence, multiple additives, invalid items, full inventory/bottle output, and panel-to-book transfer.
## Rivencraft 0.4.7.x implementation scope
The built-in vanilla-item rows above are supported except black dye and clay balls. Legacy ignores black dye's empty effect key, so Rivencraft does not consume or advertise it in JEI. Clay Balls are omitted because Age arrival already builds a safe platform by default and a separate Generate Platform link modifier would be redundant. Right-clicking the Ink Mixer basin with a carried item adds one; left-clicking adds the carried stack. The mixture is persistent and its next panel is deterministic. The visual basin tooltip shows current probabilities. Only taking the virtual Link Panel consumes paper/ink and clears the mixture. The Link Panel's property component is copied to a Linking Book by the leather recipe or a Descriptive Book by the Binder. JEI's optional Ink Mixer category lists the base panel and each supported additive interaction with its per-property chance; Rivencraft does not require JEI to run.
Disarm and Maintain Momentum are applied by the server after confirming a safe destination. Disarm spawns each inventory stack as an item entity at the departure point, including for Descriptive Books. Intra Linking is required only for a Linking Book whose destination is in the player's current dimension; ordinary cross-dimensional Linking Books still work. The Binder treats an Intra Linking panel as an ordinary Link Panel and omits that flag from the resulting Descriptive Book, while retaining Disarm and Maintain Momentum. Automatic Return Links remain enabled under the existing configuration, as requested. The old Generate Platform bit remains readable on pre-0.4.7.1 test items but is neither rolled nor applied. Optional dust-tag mappings remain outside this built-in subset until their cross-mod tags and gameplay meaning are agreed.
+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.
+10 -4
View File
@@ -33,11 +33,14 @@ acceptance issue and all required implementation issues are complete.
lifecycle management, data-pack integration, and optional destination lifecycle management, data-pack integration, and optional destination
renderer compatibility. **Complete.** See renderer compatibility. **Complete.** See
[Milestone 3](https://gitea.tail180fb1.ts.net/dnorberg/rivencraft/milestone/8). [Milestone 3](https://gitea.tail180fb1.ts.net/dnorberg/rivencraft/milestone/8).
4. **Writing system** — pages, symbols, notebooks, desks, and book assembly. 4. **Writing system** — pages, notebooks, desks, book assembly, and the baseline
**In progress.** Ink Mixer for Link Panels. Symbol effects are deferred until Milestone 5.
**Complete.** See [Milestone 4](https://gitea.tail180fb1.ts.net/dnorberg/rivencraft/milestone/9)
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.
@@ -62,10 +65,13 @@ The writing system and Age grammar will build on the existing page-free Age
path. Page-free books remain a useful deterministic fallback and test fixture path. Page-free books remain a useful deterministic fallback and test fixture
after written symbol combinations become available. after written symbol combinations become available.
Milestone 4 begins with a versioned, data-pack-defined symbol catalog and an Milestone 4 delivered a versioned, data-pack-defined symbol catalog and an
immutable ordered-writing model. See [WRITING_DATA.md](WRITING_DATA.md). These immutable ordered-writing model. See [WRITING_DATA.md](WRITING_DATA.md). These
contracts preserve unknown symbol identifiers and store author intent; they do contracts preserve unknown symbol identifiers and store author intent; they do
not interpret symbols into Age generation, which remains Milestone 5 work. not interpret symbols into Age generation, which remains Milestone 5 work.
The Ink Mixer is included in Milestone 4 after book assembly; it
uses paper and Ink Vials to make baseline Link Panels. Adding modifier
ingredients and symbol-driven link properties belongs to Milestone 5.
## Provenance rules ## Provenance rules
+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.
+78 -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
@@ -40,6 +45,16 @@ a symbol reference or a baseline link-panel marker. `OrderedWriting` retains up
to 256 entries in exact player-authored order. All three contracts have both to 256 entries in exact player-authored order. All three contracts have both
persistent codecs and bounded network codecs. persistent codecs and bounded network codecs.
Assembled Descriptive Books store `OrderedWriting` schema version 1 alongside
their Age reference. Books assembled in 0.3.7.2 saved writing as a bare list;
that form still loads as version 1 without reordering or dropping unknown IDs.
Older page-free books without writing continue to work unchanged. Copying a
book copies its writing and Age reference; merely copying it never creates a
new Age. The Book Binder creates the Age when its finished output is taken.
The Descriptive Book screen can inspect the ordered pages by turning them from
the bottom corners and identifies unresolved IDs using server-provided symbol
metadata. Page-free books continue to use random Age 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
the original namespaced ID for diagnostics and later restoration. This is the original namespaced ID for diagnostics and later restoration. This is
@@ -53,11 +68,11 @@ unresolved symbol, and baseline link panel. Symbol and unresolved-symbol pages
retain their namespaced symbol reference; unresolved pages can be inspected and retain their namespaced symbol reference; unresolved pages can be inspected and
removed but are rejected as usable writing until their data pack returns. removed but are rejected as usable writing until their data pack returns.
Only server-side writing operations may create a known symbol Only server-side writing operations may create a known symbol page or link
page or link panel from vanilla paper. The shared `PageItem` creation and validation gates reject panel from vanilla paper. The shared `PageItem` creation and validation gates
new pages for identifiers absent from the server catalog. Later Writing Desk reject new pages for identifiers absent from the server catalog. The Writing
and Book Binder packets must call these gates rather than accepting page Desk refuses to copy an unresolved page, and the Book Binder keeps such a page
contents supplied by a client. removable but will not assemble a book from it until its symbol resolves again.
The item model uses server-assigned custom-model data derived from the symbol The item model uses server-assigned custom-model data derived from the symbol
identifier. Built-in pages reproduce Mystcraft Legacy's four-word poem identifier. Built-in pages reproduce Mystcraft Legacy's four-word poem
@@ -72,6 +87,30 @@ placement. The surface draws the native 30×40 portrait page region from
Legacy's book UI atlas; symbols are layered at a uniform scale, while the Legacy's book UI atlas; symbols are layered at a uniform scale, while the
square item models remain unchanged in inventories. square item models remain unchanged in inventories.
A Notebook holds 27 ordered positions. Its pages, names, gaps, and unresolved
IDs are saved on the item, so moving the Notebook between an inventory, Desk,
and Binder does not rearrange them. A loose Page in a Desk tab exposes just one
position; a Notebook exposes all 27. The Desk has 88 persistent collection
tabs, shown four at a time. Use the up/down tab controls to move by four, put
paper and Ink Vials in their input slots, select a stored page, and take the
copy from the virtual output. Taking it spends one paper and the configured
symbol-copy ink cost. The `AZ`, `ALL`, search, and category controls only change
which stored pages are displayed; the server rechecks the actual source before
copying. Moving a page within the Desk or dragging it into the inventory removes
the original only when the destination accepts it.
The Book Binder takes a leather or empty-Notebook cover, an Age title, one Link
Panel, and optionally up to 27 ordered written Pages. A filled Notebook can be
imported at a chosen strip position; the empty Notebook remains recoverable.
The preview result is virtual. Taking the completed Descriptive Book commits the
inputs once, creates its Age identity, and saves schema-versioned
`OrderedWriting` plus the Age reference on the book. Link-Panel-only books
create random Ages. Supported written pages change the corresponding Age
generation branch; missing branches use seeded defaults.
Inputs, title, and pending Age identity survive Binder save/load; breaking the
Binder returns stored inputs. The completed book retains both its writing and
Age identity through item save/load and copying.
## Ink and baseline link panels ## Ink and baseline link panels
An Ink Vial is crafted from two black dye, a glass bottle, and a water bucket. An Ink Vial is crafted from two black dye, a glass bottle, and a water bucket.
@@ -91,3 +130,32 @@ resolved page, then spends paper and ink only when that copy is taken. The
desk's 16-unit ink meter refills from an Ink Vial when needed and returns a desk's 16-unit ink meter refills from an Ink Vial when needed and returns a
vanilla glass bottle. Link-property modifiers are vanilla glass bottle. Link-property modifiers are
deferred beyond this baseline flow. deferred beyond this baseline flow.
The Ink Mixer is the station version of Link Panel preparation. Put paper and
Ink Vials in its inputs and take the Link Panel from its virtual output. Its
16-unit basin refills only when needed and only if the glass-bottle output has
space. The basin and inputs persist through save/load; breaking the Mixer
returns stored items. A Link Panel plus leather also crafts an unwritten
Linking Book. JEI, when installed, displays the Mixer operation and the
writing, binding, and Linking Book crafting flows; it is not required to play.
## Migration and validation
The 0.3.7.2 bare-list `OrderedWriting` form reads as schema version 1 without
changing entry order. Descriptive Books with no writing component keep their
existing Age behavior. Old eight-slot Desks migrate their four collections,
ink supply, paper, bottle return, and legacy output into the 88-tab layout;
saved inputs are never silently discarded. Missing symbol IDs survive page,
Notebook, Binder, and assembled-book persistence instead of being substituted
or erased.
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,
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
manual smoke test of loading an older world before updating a production save.
Milestone 4 stops at preserving author intent and offering a playable random
Age fallback. Milestone 5 will define symbol grammar and validation, translate
valid writing into actual Age generation, and introduce symbol and ink modifiers.
+21
View File
@@ -0,0 +1,21 @@
# Ordered Descriptive Book grammar (Milestone 5, issue #30)
`WritingGrammar` interprets the saved `OrderedWriting` on the server using only `SymbolCatalog`'s schema-v2 semantics. Client display metadata, page names, and supplied translations never determine an Age's meaning. The parser is pure: it returns immutable parsed entries and indexed diagnostics without changing a book or its pages.
New Binder writing has at most one Link Panel plus 27 symbol pages. The Link Panel must be first. A Link-Panel-only book, or an older book with no writing component, keeps the existing random Age path. Any authored supported symbol makes the book a partial or complete grammar. From 0.4.3.0, the server compiles it into a persistent Age plan before consuming Binder inputs or generating chunks.
The supported order follows the representable subset of the [Legacy grammar audit](LEGACY_AGE_GRAMMAR_AUDIT.md): terrain; zero or more biome pages; biome controller; weather; lighting; sky effects; zero or more period or phase modifiers; one celestial page; then zero or more distinct features, each optionally preceded by a compatible block-material page. Biome pages precede the controller that consumes them, and celestial modifiers precede the celestial page. Terrain, controller, weather, lighting, sky, and celestial are single-choice categories; identical repeats are duplicates and differing values conflict. Repeated modifiers are intentional. Biome pages may repeat, preserving author order and any future weighting; feature IDs may not repeat. Angle modifiers remain recognized in the schema but are rejected at binding until a sky renderer can apply sun tilt.
Missing terrain, controller, weather, lighting, celestial, or the controller's minimum biome count is an **incomplete** warning, not an error: the compiler retains seed-selected traits for missing branches. An omitted terrain page uses a seed-selected profile compatible with authored feature pages, so changing the Age name cannot accidentally select Flat, Void, or Cave terrain for Rocks or Lakes. If no profile can support the writing, binding still rejects it. The minimum biome count is zero for Native, one for Single, and two for Tiled/Grid and Tiny–Huge. Native cannot consume authored biome pages; Single accepts only one. Unknown IDs, schema-v1 display-only symbols, wrong ordering, misplaced modifiers, duplicates, conflicts, missing/extra Link Panels, and oversized writing are errors. The Binder disables output and exposes the first error on the result-slot tooltip. When that error belongs to a page, its thumbnail is tinted and outlined red, the strip scrolls to it, and hovering it shows the diagnostic. This maps the parser's compact entry position back through any empty page positions. Rejected inputs remain removable. Binding an unwritten Descriptive Book rechecks its server-owned writing and reports the first error without creating an Age. A terrain symbol whose profile is unavailable is also rejected before Binder inputs are consumed.
The plan stores the original writing order, the authoritative semantic value of each resolved symbol, the Age seed, and a copy of the selected runtime profile. An explicit terrain page overrides random terrain selection; an omitted terrain uses a seed-selected compatible profile. The built-in Standard, Amplified, Cave, Island, Flat, and Void terrain pages select their matching generation resources. Age loading uses the frozen runtime profile and does not need the original symbol definition or runtime-profile JSON, though its referenced noise, biome-preset, and dimension-type registry entries must remain available. Existing bound books without plans are not reinterpreted. Page-free and Link-Panel-only books keep the pre-existing random path. Biome and environment pages affect new Ages, and the supported feature subset below is compiled into the same frozen plan; instability remains Milestone 6 work.
## Supported feature pages (issue #35)
Feature pages come after the celestial section. Their order is retained in the plan and in decoration placement. The Caves page adds a second, Age-seeded vanilla cave-carving pass to Noise terrain, including Standard, Amplified, Island, and Cave terrain. It chooses the vanilla Overworld or Nether cave carver from the source biome. This is separate from the Milestone 7 issue about Cave **terrain** generation. Flat and Void terrain have no suitable solid noise body and reject Caves with a binder diagnostic.
Flowers, Trees, Huge Trees, Rocks, Surface Lakes, Deep Lakes, and Small Lakes add vanilla placed features after normal biome decoration. Huge Trees currently use vanilla old-growth spruce placement as a modern approximation of Legacy's huge-tree page; it is not the custom Legacy tree generator. Without a preceding material page, Rocks select a valid solid block and each lake page selects a valid source-fluid block from the registered pool. The selection is deterministic for an Age seed and feature ID, so all chunks in that Age use the same material across restarts with the same block registry. The page-specific feature preserves vanilla placement rules other than the biome-list filter, since an authored page deliberately adds it to the Age. Surface and Small Lakes use a more visible one-in-twelve-chunks attempt rate instead of vanilla lava lakes' one-in-two-hundred; Deep Lakes retain their underground placement. Vanilla biome lava lakes are separate and can still appear alongside authored fluid lakes. These decorations require surface Noise terrain; Cave, Flat, and Void reject them. Flowers and both tree pages require at least one surface Overworld biome and only run in compatible chunks; Nether, End, and tagged cave biomes do not receive surface vegetation. Ravines add a separate Age-seeded vanilla canyon-carving pass to Noise terrain. Unsupported feature IDs and missing vanilla registry entries produce diagnostics instead of becoming no-ops.
Material pages are generated for registered full-collision, non-fluid blocks and genuine source-fluid blocks, including eligible blocks supplied by other mods. Blocks with block entities are excluded. Waterlogged plants and coral are not fluid blocks and receive no pages. Valid source-fluid blocks appear only in the Fluid Pages creative tab; valid full-collision solids appear only in Block Pages. Both categories use the same saved material-page semantics. Put a Block Page immediately before Rocks to choose a rock material, or a Fluid Page immediately before Surface Lakes, Deep Lakes, or Small Lakes to choose a lake fluid. A material page left alone, placed before a different category, or attached to an incompatible feature is rejected. Both the feature and material ID are frozen in the saved plan, so future chunks retain their choice after restart. Existing chunks are not retroactively decorated. Custom structures, crystals, portals, and the Cave-terrain bug are outside this slice.
The Rivencraft symbol-page creative tabs read a generated index of bundled symbol definitions and group Pages by each definition's category, except biome-controller roles, which appear in a separate Biome Generation tab rather than the Biome tab. Adding another valid JSON symbol under `src/main/resources/data/rivencraft/rivencraft/symbols/` includes its page in the matching category tab on the next build; a new bundled category receives its own tab. Registry-derived Block and Fluid Pages have separate tabs and both appear in optional JEI. Link Pages have a separate tab. Blank Pages appear in neither the creative tabs nor JEI's ingredient list. The server catalog still decides whether a page is valid for writing. External server data-pack symbols are not included in this bundled index.
+2 -1
View File
@@ -22,6 +22,7 @@ neo_version=21.1.251
ponder_version=1.0.82 ponder_version=1.0.82
dynamic_dimensions_file_id=7707789 dynamic_dimensions_file_id=7707789
badpackets_version=0.8.2 badpackets_version=0.8.2
jei_version=19.57.0.449
# The loader version range can only use the major version of FML as bounds # The loader version range can only use the major version of FML as bounds
loader_version_range=[1,) loader_version_range=[1,)
@@ -35,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.3.6.2 mod_version=0.4.7.3
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.
@@ -5,10 +5,12 @@ import net.dnorberg.rivencraft.registry.ModCreativeTabs;
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.registry.ModMenus; import net.dnorberg.rivencraft.registry.ModMenus;
import net.dnorberg.rivencraft.registry.ModRecipeSerializers;
import net.dnorberg.rivencraft.registry.ModSounds; 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;
@@ -39,10 +41,12 @@ 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);
ModMenus.register(modEventBus); ModMenus.register(modEventBus);
ModRecipeSerializers.register(modEventBus);
ModSounds.register(modEventBus); ModSounds.register(modEventBus);
ModCreativeTabs.register(modEventBus); ModCreativeTabs.register(modEventBus);
NeoForge.EVENT_BUS.addListener(BookStandConversionHandler::onRightClickBlock); NeoForge.EVENT_BUS.addListener(BookStandConversionHandler::onRightClickBlock);
@@ -0,0 +1,66 @@
package net.dnorberg.rivencraft.block;
import com.mojang.serialization.MapCodec;
import net.dnorberg.rivencraft.block.entity.BookBinderBlockEntity;
import net.dnorberg.rivencraft.menu.BookBinderMenu;
import net.minecraft.core.BlockPos;
import net.minecraft.core.Direction;
import net.minecraft.network.chat.Component;
import net.minecraft.server.level.ServerPlayer;
import net.minecraft.world.Containers;
import net.minecraft.world.InteractionResult;
import net.minecraft.world.SimpleMenuProvider;
import net.minecraft.world.entity.player.Player;
import net.minecraft.world.item.context.BlockPlaceContext;
import net.minecraft.world.level.Level;
import net.minecraft.world.level.block.BaseEntityBlock;
import net.minecraft.world.level.block.RenderShape;
import net.minecraft.world.level.block.state.BlockState;
import net.minecraft.world.level.block.state.StateDefinition;
import net.minecraft.world.level.block.state.properties.BlockStateProperties;
import net.minecraft.world.level.block.state.properties.DirectionProperty;
import net.minecraft.world.level.block.entity.BlockEntity;
import net.minecraft.world.phys.BlockHitResult;
public final class BookBinderBlock extends BaseEntityBlock {
public static final MapCodec<BookBinderBlock> CODEC = simpleCodec(BookBinderBlock::new);
public static final DirectionProperty FACING = BlockStateProperties.HORIZONTAL_FACING;
public BookBinderBlock(Properties properties) {
super(properties);
registerDefaultState(stateDefinition.any().setValue(FACING, Direction.NORTH));
}
@Override public MapCodec<? extends BaseEntityBlock> codec() { return CODEC; }
@Override protected void createBlockStateDefinition(StateDefinition.Builder<net.minecraft.world.level.block.Block, BlockState> builder) {
builder.add(FACING);
}
@Override public BlockState getStateForPlacement(BlockPlaceContext context) {
Direction facing = context.getHorizontalDirection().getOpposite();
return defaultBlockState().setValue(FACING, facing);
}
@Override protected RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) {
return new BookBinderBlockEntity(pos, state);
}
@Override protected InteractionResult useWithoutItem(BlockState state, Level level, BlockPos pos,
Player player, BlockHitResult hit) {
if (!level.isClientSide && player instanceof ServerPlayer serverPlayer
&& level.getBlockEntity(pos) instanceof BookBinderBlockEntity binder) {
serverPlayer.openMenu(new SimpleMenuProvider(
(id, inventory, ignored) -> new BookBinderMenu(id, inventory, binder),
Component.translatable("container.rivencraft.book_binder")),
buffer -> buffer.writeBlockPos(pos));
}
return InteractionResult.sidedSuccess(level.isClientSide);
}
@Override protected void onRemove(BlockState state, Level level, BlockPos pos,
BlockState replacement, boolean moving) {
if (!state.is(replacement.getBlock()) && !level.isClientSide
&& level.getBlockEntity(pos) instanceof BookBinderBlockEntity binder) {
Containers.dropContents(level, pos, binder);
level.updateNeighbourForOutputSignal(pos, this);
}
super.onRemove(state, level, pos, replacement, moving);
}
}
@@ -0,0 +1,52 @@
package net.dnorberg.rivencraft.block;
import com.mojang.serialization.MapCodec;
import net.dnorberg.rivencraft.block.entity.InkMixerBlockEntity;
import net.dnorberg.rivencraft.menu.InkMixerMenu;
import net.minecraft.core.BlockPos;
import net.minecraft.network.chat.Component;
import net.minecraft.server.level.ServerPlayer;
import net.minecraft.world.Containers;
import net.minecraft.world.InteractionResult;
import net.minecraft.world.SimpleMenuProvider;
import net.minecraft.world.entity.player.Player;
import net.minecraft.world.level.Level;
import net.minecraft.world.level.block.BaseEntityBlock;
import net.minecraft.world.level.block.RenderShape;
import net.minecraft.world.level.block.entity.BlockEntity;
import net.minecraft.world.level.block.state.BlockState;
import net.minecraft.world.phys.BlockHitResult;
public final class InkMixerBlock extends BaseEntityBlock {
public static final MapCodec<InkMixerBlock> CODEC = simpleCodec(InkMixerBlock::new);
public InkMixerBlock(Properties properties) { super(properties); }
@Override protected MapCodec<? extends BaseEntityBlock> codec() { return CODEC; }
@Override protected RenderShape getRenderShape(BlockState state) { return RenderShape.MODEL; }
@Override public BlockEntity newBlockEntity(BlockPos pos, BlockState state) {
return new InkMixerBlockEntity(pos, state);
}
@Override protected InteractionResult useWithoutItem(BlockState state, Level level, BlockPos pos,
Player player, BlockHitResult hit) {
if (!level.isClientSide && player instanceof ServerPlayer serverPlayer
&& level.getBlockEntity(pos) instanceof InkMixerBlockEntity mixer) {
serverPlayer.openMenu(new SimpleMenuProvider(
(id, inventory, ignored) -> new InkMixerMenu(id, inventory, mixer),
Component.translatable("container.rivencraft.ink_mixer")),
buffer -> buffer.writeBlockPos(pos));
}
return InteractionResult.sidedSuccess(level.isClientSide);
}
@Override protected void onRemove(BlockState state, Level level, BlockPos pos,
BlockState replacement, boolean moving) {
if (!state.is(replacement.getBlock()) && !level.isClientSide
&& level.getBlockEntity(pos) instanceof InkMixerBlockEntity mixer) {
Containers.dropContents(level, pos, mixer);
level.updateNeighbourForOutputSignal(pos, this);
}
super.onRemove(state, level, pos, replacement, moving);
}
}
@@ -0,0 +1,368 @@
package net.dnorberg.rivencraft.block.entity;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import net.dnorberg.rivencraft.book.AgeReference;
import net.dnorberg.rivencraft.book.AgeRegistrySavedData;
import net.dnorberg.rivencraft.book.AgeGenerationPlan;
import net.dnorberg.rivencraft.book.AgeGenerationProfiles;
import net.dnorberg.rivencraft.book.AgeRuntimeProfiles;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.registry.ModBlockEntities;
import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.writing.NotebookContents;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.dnorberg.rivencraft.writing.WritingEntry;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.minecraft.core.BlockPos;
import net.minecraft.core.HolderLookup;
import net.minecraft.core.NonNullList;
import net.minecraft.core.registries.Registries;
import net.minecraft.resources.ResourceKey;
import net.dnorberg.rivencraft.book.AgeBiomeSelection;
import net.dnorberg.rivencraft.book.AgeFeatureSelection;
import net.minecraft.tags.BiomeTags;
import net.minecraft.core.component.DataComponents;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.network.chat.Component;
import net.minecraft.network.protocol.Packet;
import net.minecraft.network.protocol.game.ClientGamePacketListener;
import net.minecraft.network.protocol.game.ClientboundBlockEntityDataPacket;
import net.minecraft.world.Container;
import net.minecraft.world.ContainerHelper;
import net.minecraft.world.entity.player.Player;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items;
import net.minecraft.world.level.block.entity.BlockEntity;
import net.minecraft.world.level.block.state.BlockState;
import net.minecraft.server.level.ServerLevel;
/** Persistent inputs for a binder; the assembled output is never stored here. */
public final class BookBinderBlockEntity extends BlockEntity implements Container {
public static final int COVER = 0;
public static final int LINK_PANEL = 1;
public static final int NOTEBOOK = 2;
public static final int FIRST_PAGE = 3;
public static final int PAGE_COUNT = NotebookContents.MAX_PAGES;
public static final int SIZE = FIRST_PAGE + PAGE_COUNT;
public static final int MAX_TITLE_LENGTH = 32;
private NonNullList<ItemStack> items = NonNullList.withSize(SIZE, ItemStack.EMPTY);
private String title = "";
private UUID pendingAgeId;
public BookBinderBlockEntity(BlockPos pos, BlockState state) {
super(ModBlockEntities.BOOK_BINDER.get(), pos, state);
}
public String title() { return title; }
public void setTitle(String value) {
String normalized = value == null ? "" : value.strip();
if (normalized.length() > MAX_TITLE_LENGTH) normalized = normalized.substring(0, MAX_TITLE_LENGTH);
if (!normalized.equals(title)) {
title = normalized;
setChanged();
}
}
public static boolean validCover(ItemStack stack) {
return stack.is(Items.LEATHER) || stack.is(ModItems.NOTEBOOK.get())
&& stack.getOrDefault(ModDataComponents.NOTEBOOK_CONTENTS.get(), NotebookContents.EMPTY).pageCount() == 0;
}
private static boolean validPage(ItemStack stack) {
return stack.is(ModItems.PAGE.get()) && PageItem.content(stack).kind() != PageContent.Kind.LINK_PANEL;
}
@Override public int getContainerSize() { return SIZE; }
@Override public boolean isEmpty() { return items.stream().allMatch(ItemStack::isEmpty); }
@Override public ItemStack getItem(int slot) { return items.get(slot); }
@Override public ItemStack removeItem(int slot, int amount) {
ItemStack removed = ContainerHelper.removeItem(items, slot, amount);
if (!removed.isEmpty()) setChanged();
return removed;
}
@Override public ItemStack removeItemNoUpdate(int slot) { return ContainerHelper.takeItem(items, slot); }
@Override public void setItem(int slot, ItemStack stack) {
items.set(slot, stack);
if (stack.getCount() > getMaxStackSize()) stack.setCount(getMaxStackSize());
setChanged();
}
@Override public boolean canPlaceItem(int slot, ItemStack stack) {
return switch (slot) {
case COVER -> validCover(stack);
case LINK_PANEL -> stack.is(ModItems.PAGE.get())
&& PageItem.content(stack).kind() == PageContent.Kind.LINK_PANEL;
case NOTEBOOK -> stack.is(ModItems.NOTEBOOK.get());
default -> slot >= FIRST_PAGE && slot < SIZE && validPage(stack);
};
}
@Override public boolean stillValid(Player player) {
return level != null && level.isLoaded(worldPosition) && level.getBlockEntity(worldPosition) == this
&& player.distanceToSqr(worldPosition.getX() + 0.5, worldPosition.getY() + 0.5,
worldPosition.getZ() + 0.5) <= 64.0;
}
/** All checks precede any mutation so a failed assembly leaves every input intact. */
public boolean canAssemble() {
if (title.isBlank() || !validCover(items.get(COVER))
|| !canPlaceItem(LINK_PANEL, items.get(LINK_PANEL))
|| items.get(LINK_PANEL).getCount() != 1) return false;
for (int slot = FIRST_PAGE; slot < SIZE; slot++) {
ItemStack page = items.get(slot);
if (!page.isEmpty() && (!validPage(page) || !PageItem.isUsableWriting(page) || page.getCount() != 1
|| PageItem.content(page).kind() == PageContent.Kind.BLANK)) return false;
}
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() {
if (!canAssemble()) return ItemStack.EMPTY;
if (pendingAgeId == null) {
pendingAgeId = UUID.randomUUID();
setChanged();
}
ItemStack book = new ItemStack(ModItems.DESCRIPTIVE_BOOK.get());
book.set(ModDataComponents.AGE_REFERENCE.get(), new AgeReference(pendingAgeId, title));
book.set(ModDataComponents.BOOK_WRITING.get(), currentWriting());
if (items.get(LINK_PANEL).has(ModDataComponents.LINK_PROPERTIES.get())) {
var properties = items.get(LINK_PANEL).get(ModDataComponents.LINK_PROPERTIES.get())
.forDescriptiveBook();
if (properties.flags() != 0) book.set(ModDataComponents.LINK_PROPERTIES.get(), properties);
}
book.set(DataComponents.CUSTOM_NAME, Component.literal(title));
return book;
}
/** Called once, on the server, after the output can be delivered. */
public boolean consumeAssembly() {
if (!canAssemble()) return false;
if (pendingAgeId == null) pendingAgeId = UUID.randomUUID();
if (level instanceof ServerLevel serverLevel)
AgeRegistrySavedData.resolveOrCreate(serverLevel, new AgeReference(pendingAgeId, title), currentWriting());
items.get(COVER).shrink(1);
if (items.get(COVER).isEmpty()) items.set(COVER, ItemStack.EMPTY);
items.get(LINK_PANEL).shrink(1);
if (items.get(LINK_PANEL).isEmpty()) items.set(LINK_PANEL, ItemStack.EMPTY);
for (int slot = FIRST_PAGE; slot < SIZE; slot++) items.set(slot, ItemStack.EMPTY);
title = "";
pendingAgeId = null;
setChanged();
return true;
}
public int nextPageIndex() {
for (int index = PAGE_COUNT - 1; index >= 0; index--) {
if (!items.get(FIRST_PAGE + index).isEmpty()) return index + 1;
}
return 0;
}
/** Insert before a displayed page, shifting later pages as Legacy's strip does. */
public boolean insertPage(int index, ItemStack page) {
int end = nextPageIndex();
if (index < 0 || index > end || end >= PAGE_COUNT || page.getCount() != 1
|| !validPage(page)) return false;
for (int current = end; current > index; current--)
items.set(FIRST_PAGE + current, items.get(FIRST_PAGE + current - 1));
items.set(FIRST_PAGE + index, page.copy());
setChanged();
return true;
}
/** Take a page back to the cursor, closing the gap in the displayed order. */
public ItemStack takePage(int index) {
int end = nextPageIndex();
if (index < 0 || index >= end || items.get(FIRST_PAGE + index).isEmpty()) return ItemStack.EMPTY;
ItemStack removed = items.get(FIRST_PAGE + index);
for (int current = index; current < end - 1; current++)
items.set(FIRST_PAGE + current, items.get(FIRST_PAGE + current + 1));
items.set(FIRST_PAGE + end - 1, ItemStack.EMPTY);
setChanged();
return removed;
}
/** Move every Notebook page as one transaction, leaving its empty cover in the input slot. */
public boolean importNotebook() {
ItemStack notebook = items.get(NOTEBOOK);
ItemStack emptied = importNotebookFromStack(notebook, nextPageIndex());
if (emptied.isEmpty()) return false;
items.set(NOTEBOOK, emptied);
setChanged();
return true;
}
/** Import a Notebook from either its stored slot or the player's cursor. */
public ItemStack importNotebookFromStack(ItemStack notebook, int index) {
if (!notebook.is(ModItems.NOTEBOOK.get()) || notebook.getCount() != 1) return ItemStack.EMPTY;
List<ItemStack> pages = notebook.getOrDefault(ModDataComponents.NOTEBOOK_CONTENTS.get(), NotebookContents.EMPTY).pages();
if (pages.isEmpty()) return ItemStack.EMPTY;
int end = nextPageIndex();
if (index < 0 || index > end) return ItemStack.EMPTY;
ItemStack linkPanel = ItemStack.EMPTY;
List<ItemStack> writing = new ArrayList<>();
for (ItemStack page : pages) {
if (page.isEmpty()) continue;
if (!page.is(ModItems.PAGE.get()) || page.getCount() != 1) return ItemStack.EMPTY;
if (PageItem.content(page).kind() == PageContent.Kind.LINK_PANEL) {
if (!linkPanel.isEmpty() || !items.get(LINK_PANEL).isEmpty()) return ItemStack.EMPTY;
linkPanel = page;
} else if (validPage(page)) writing.add(page);
else return ItemStack.EMPTY;
}
if (end + writing.size() > PAGE_COUNT || writing.isEmpty() && linkPanel.isEmpty()) return ItemStack.EMPTY;
if (!linkPanel.isEmpty()) items.set(LINK_PANEL, linkPanel.copy());
for (int current = end - 1; current >= index; current--)
items.set(FIRST_PAGE + current + writing.size(), items.get(FIRST_PAGE + current));
for (ItemStack page : writing) items.set(FIRST_PAGE + index++, page.copy());
ItemStack emptyNotebook = notebook.copy();
emptyNotebook.set(ModDataComponents.NOTEBOOK_CONTENTS.get(), NotebookContents.EMPTY);
setChanged();
return emptyNotebook;
}
@Override public void clearContent() {
items = NonNullList.withSize(SIZE, ItemStack.EMPTY);
title = "";
pendingAgeId = null;
setChanged();
}
@Override protected void loadAdditional(CompoundTag tag, HolderLookup.Provider registries) {
super.loadAdditional(tag, registries);
items = NonNullList.withSize(SIZE, ItemStack.EMPTY);
ContainerHelper.loadAllItems(tag, items, registries);
title = tag.getString("Title");
pendingAgeId = tag.hasUUID("PendingAgeId") ? tag.getUUID("PendingAgeId") : null;
}
@Override protected void saveAdditional(CompoundTag tag, HolderLookup.Provider registries) {
super.saveAdditional(tag, registries);
ContainerHelper.saveAllItems(tag, items, registries);
tag.putString("Title", title);
if (pendingAgeId != null) tag.putUUID("PendingAgeId", pendingAgeId);
}
@Override public Packet<ClientGamePacketListener> getUpdatePacket() {
return ClientboundBlockEntityDataPacket.create(this);
}
@Override public CompoundTag getUpdateTag(HolderLookup.Provider registries) {
return saveWithoutMetadata(registries);
}
@Override public void setChanged() {
super.setChanged();
if (level != null && !level.isClientSide) {
level.sendBlockUpdated(worldPosition, getBlockState(), getBlockState(), 2);
}
}
}
@@ -0,0 +1,182 @@
package net.dnorberg.rivencraft.block.entity;
import java.util.Random;
import net.dnorberg.rivencraft.book.LinkProperties;
import net.dnorberg.rivencraft.item.InkVialItem;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.writing.InkVialExchange;
import net.dnorberg.rivencraft.writing.InkModifierIngredients;
import net.dnorberg.rivencraft.registry.ModBlockEntities;
import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.writing.WritingInkService;
import net.minecraft.core.BlockPos;
import net.minecraft.core.HolderLookup;
import net.minecraft.core.NonNullList;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.world.Container;
import net.minecraft.world.ContainerHelper;
import net.minecraft.world.entity.player.Player;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items;
import net.minecraft.world.level.Level;
import net.minecraft.world.level.block.entity.BlockEntity;
import net.minecraft.world.level.block.state.BlockState;
/** Server-owned Link Panel mixer with a persistent, Legacy-style additive mixture. */
public final class InkMixerBlockEntity extends BlockEntity implements Container {
public static final int INK = 0;
public static final int PAPER = 1;
public static final int BOTTLES = 2;
public static final int SIZE = 3;
private NonNullList<ItemStack> items = NonNullList.withSize(SIZE, ItemStack.EMPTY);
private int inkRemaining;
private long nextModifierSeed = new Random().nextLong();
private final double[] modifierChances = new double[3];
private static final int[] FLAGS = {LinkProperties.DISARM,
LinkProperties.MAINTAIN_MOMENTUM, LinkProperties.INTRA_LINKING};
private static final String[] CHANCE_KEYS = {"DisarmChance", "MomentumChance", "IntraLinkingChance"};
private static final int[] OLD_CHANCE_INDEX = {0, 2, 3};
public InkMixerBlockEntity(BlockPos pos, BlockState state) {
super(ModBlockEntities.INK_MIXER.get(), pos, state);
}
public int inkRemaining() { return inkRemaining; }
public int modifierChancePermille(int index) {
return Math.clamp((int) Math.round(modifierChances[index] * 1000), 0, 1000);
}
/** Infuses a carried ingredient into the current ink pool; only the server calls this. */
public boolean addModifier(ItemStack carried, int amount) {
InkModifierIngredients.Ingredient ingredient = InkModifierIngredients.find(carried);
if (ingredient == null || inkRemaining == 0 || amount <= 0 || carried.getCount() < amount)
return false;
for (InkModifierIngredients.Effect effect : ingredient.effects())
for (int index = 0; index < FLAGS.length; index++)
if (FLAGS[index] == effect.flag())
modifierChances[index] = 1.0 - (1.0 - modifierChances[index])
* Math.pow(1.0 - effect.chance(), amount);
carried.shrink(amount);
setChanged();
return true;
}
public ItemStack previewLinkPanel() {
if (!canCreateLinkPanel()) return ItemStack.EMPTY;
ItemStack panel = PageItem.createLinkPanelPage();
LinkProperties properties = rollProperties(nextModifierSeed).properties();
if (properties.flags() != 0) panel.set(ModDataComponents.LINK_PROPERTIES.get(), properties);
return panel;
}
private record Roll(LinkProperties properties, long nextSeed) {}
private Roll rollProperties(long seed) {
Random random = new Random(seed);
int selected = 0;
for (int index = 0; index < FLAGS.length; index++)
if (modifierChances[index] > 0 && random.nextDouble() < modifierChances[index])
selected |= FLAGS[index];
return new Roll(new LinkProperties(selected), random.nextLong());
}
@Override public int getContainerSize() { return SIZE; }
@Override public boolean isEmpty() { return items.stream().allMatch(ItemStack::isEmpty); }
@Override public ItemStack getItem(int slot) { return items.get(slot); }
@Override public ItemStack removeItem(int slot, int amount) {
ItemStack removed = ContainerHelper.removeItem(items, slot, amount);
if (!removed.isEmpty()) {
setChanged();
if (slot == BOTTLES) refillEmptyBasin();
}
return removed;
}
@Override public ItemStack removeItemNoUpdate(int slot) { return ContainerHelper.takeItem(items, slot); }
@Override public void setItem(int slot, ItemStack stack) {
items.set(slot, stack);
if (stack.getCount() > getMaxStackSize()) stack.setCount(getMaxStackSize());
setChanged();
if (slot == INK || slot == BOTTLES) refillEmptyBasin();
}
@Override public boolean canPlaceItem(int slot, ItemStack stack) {
return switch (slot) {
case INK -> stack.is(ModItems.INK_VIAL.get());
case PAPER -> stack.is(Items.PAPER);
default -> false;
};
}
@Override public boolean stillValid(Player player) {
return level != null && level.isLoaded(worldPosition) && level.getBlockEntity(worldPosition) == this
&& player.distanceToSqr(worldPosition.getX() + 0.5, worldPosition.getY() + 0.5,
worldPosition.getZ() + 0.5) <= 64.0;
}
/** No server tick: refill only when ink, bottle space, or consumption changes. */
private void refillEmptyBasin() {
if (level != null && !level.isClientSide && inkRemaining == 0) {
int addedInk = InkVialExchange.exchange(items, INK, BOTTLES);
if (addedInk > 0) {
inkRemaining = addedInk;
setChanged();
}
}
}
public boolean canCreateLinkPanel() {
if (!items.get(PAPER).is(Items.PAPER)) return false;
int cost = WritingInkService.linkPanelCost();
return InkVialExchange.canPay(items, INK, BOTTLES, inkRemaining, cost);
}
/** Commit inputs only when a virtual output is actually taken. */
public boolean consumeLinkPanelMaterials() {
if (!canCreateLinkPanel()) return false;
int cost = WritingInkService.linkPanelCost();
if (inkRemaining < cost) {
inkRemaining += InkVialExchange.exchange(items, INK, BOTTLES);
}
inkRemaining -= cost;
items.get(PAPER).shrink(1);
if (items.get(PAPER).isEmpty()) items.set(PAPER, ItemStack.EMPTY);
nextModifierSeed = rollProperties(nextModifierSeed).nextSeed();
java.util.Arrays.fill(modifierChances, 0);
setChanged();
if (inkRemaining == 0) refillEmptyBasin();
return true;
}
@Override public void setLevel(Level level) {
super.setLevel(level);
refillEmptyBasin();
}
@Override public void clearContent() {
items = NonNullList.withSize(SIZE, ItemStack.EMPTY);
inkRemaining = 0;
java.util.Arrays.fill(modifierChances, 0);
setChanged();
}
@Override protected void loadAdditional(CompoundTag tag, HolderLookup.Provider registries) {
super.loadAdditional(tag, registries);
items = NonNullList.withSize(SIZE, ItemStack.EMPTY);
ContainerHelper.loadAllItems(tag, items, registries);
inkRemaining = Math.clamp(tag.getInt("InkRemaining"), 0, InkVialItem.CAPACITY);
if (tag.contains("NextModifierSeed")) nextModifierSeed = tag.getLong("NextModifierSeed");
for (int index = 0; index < modifierChances.length; index++) {
double chance = tag.contains(CHANCE_KEYS[index]) ? tag.getDouble(CHANCE_KEYS[index])
: tag.getDouble("ModifierChance" + OLD_CHANCE_INDEX[index]);
modifierChances[index] = Math.clamp(chance, 0.0, 1.0);
}
refillEmptyBasin();
}
@Override protected void saveAdditional(CompoundTag tag, HolderLookup.Provider registries) {
super.saveAdditional(tag, registries);
ContainerHelper.saveAllItems(tag, items, registries);
tag.putInt("InkRemaining", inkRemaining);
tag.putLong("NextModifierSeed", nextModifierSeed);
for (int index = 0; index < modifierChances.length; index++)
tag.putDouble(CHANCE_KEYS[index], modifierChances[index]);
}
}
@@ -1,7 +1,12 @@
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.item.PageItem;
import net.dnorberg.rivencraft.writing.InkVialExchange;
import net.dnorberg.rivencraft.writing.WritingInkService; import net.dnorberg.rivencraft.writing.WritingInkService;
import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.NotebookContents;
import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.registry.ModBlockEntities; import net.dnorberg.rivencraft.registry.ModBlockEntities;
import net.dnorberg.rivencraft.registry.ModItems; import net.dnorberg.rivencraft.registry.ModItems;
import net.minecraft.core.BlockPos; import net.minecraft.core.BlockPos;
@@ -16,18 +21,19 @@ import net.minecraft.world.ContainerHelper;
import net.minecraft.world.entity.player.Player; import net.minecraft.world.entity.player.Player;
import net.minecraft.world.item.ItemStack; import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items; import net.minecraft.world.item.Items;
import net.minecraft.world.level.Level;
import net.minecraft.world.level.block.entity.BlockEntity; import net.minecraft.world.level.block.entity.BlockEntity;
import net.minecraft.world.level.block.state.BlockState; import net.minecraft.world.level.block.state.BlockState;
/** Four collection tabs, paper, ink vials and empty-vial return are owned by the block. */ /** Collection tabs, paper, ink vials and empty-vial return are owned by the block. */
public final class WritingDeskBlockEntity extends BlockEntity implements Container { public final class WritingDeskBlockEntity extends BlockEntity implements Container {
public static final int COLLECTIONS = 4; public static final int COLLECTIONS = 88;
public static final int INK = 4; public static final int INK = COLLECTIONS;
public static final int RETURN = 5; public static final int RETURN = INK + 1;
public static final int PAPER = 6; public static final int PAPER = INK + 2;
/** Unused by new desks; retained so old saves cannot silently lose slot contents. */ /** Unused by new desks; retained so old saves cannot silently lose slot contents. */
public static final int LEGACY_OUTPUT = 7; public static final int LEGACY_OUTPUT = INK + 3;
public static final int SIZE = 8; public static final int SIZE = INK + 4;
private NonNullList<ItemStack> items = NonNullList.withSize(SIZE, ItemStack.EMPTY); private NonNullList<ItemStack> items = NonNullList.withSize(SIZE, ItemStack.EMPTY);
private int activeCollection; private int activeCollection;
private int inkRemaining; private int inkRemaining;
@@ -62,6 +68,7 @@ public final class WritingDeskBlockEntity extends BlockEntity implements Contain
if (!removed.isEmpty()) { if (!removed.isEmpty()) {
if (slot < COLLECTIONS) displayPage = ItemStack.EMPTY; if (slot < COLLECTIONS) displayPage = ItemStack.EMPTY;
setChanged(); setChanged();
if (slot == RETURN) refillEmptyInkBar();
} }
return removed; return removed;
} }
@@ -71,6 +78,7 @@ public final class WritingDeskBlockEntity extends BlockEntity implements Contain
if (stack.getCount() > getMaxStackSize()) stack.setCount(getMaxStackSize()); if (stack.getCount() > getMaxStackSize()) stack.setCount(getMaxStackSize());
if (slot < COLLECTIONS) displayPage = ItemStack.EMPTY; if (slot < COLLECTIONS) displayPage = ItemStack.EMPTY;
setChanged(); setChanged();
if (slot == INK || slot == RETURN) refillEmptyInkBar();
} }
@Override public boolean stillValid(Player player) { @Override public boolean stillValid(Player player) {
return level != null && level.isLoaded(worldPosition) return level != null && level.isLoaded(worldPosition)
@@ -79,7 +87,11 @@ public final class WritingDeskBlockEntity extends BlockEntity implements Contain
worldPosition.getZ() + 0.5) <= 64.0; worldPosition.getZ() + 0.5) <= 64.0;
} }
@Override public boolean canPlaceItem(int slot, ItemStack stack) { @Override public boolean canPlaceItem(int slot, ItemStack stack) {
if (slot < COLLECTIONS) return stack.is(ModItems.NOTEBOOK.get()) || stack.is(ModItems.PAGE.get()); if (slot < COLLECTIONS) return stack.is(ModItems.NOTEBOOK.get())
&& stack.getOrDefault(ModDataComponents.NOTEBOOK_CONTENTS.get(), NotebookContents.EMPTY)
.pages().stream().noneMatch(page -> PageItem.content(page).kind() == PageContent.Kind.LINK_PANEL)
|| stack.is(ModItems.PAGE.get())
&& PageItem.content(stack).kind() != PageContent.Kind.LINK_PANEL;
return switch (slot) { return switch (slot) {
case INK -> stack.is(ModItems.INK_VIAL.get()); case INK -> stack.is(ModItems.INK_VIAL.get());
case RETURN -> false; case RETURN -> false;
@@ -89,38 +101,42 @@ public final class WritingDeskBlockEntity extends BlockEntity implements Contain
}; };
} }
/** Consume one vial only when the empty meter can return its glass bottle. */
private void refillEmptyInkBar() {
if (level != null && !level.isClientSide && inkRemaining == 0) {
int addedInk = InkVialExchange.exchange(items, INK, RETURN);
if (addedInk > 0) {
inkRemaining = addedInk;
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. */
public boolean canConsumeCopyMaterials() { public boolean canConsumeCopyMaterials() {
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);
ItemStack returned = items.get(RETURN);
return vial.is(ModItems.INK_VIAL.get()) && inkRemaining + InkVialItem.remaining(vial) >= cost
&& (returned.isEmpty() || returned.is(Items.GLASS_BOTTLE)
&& returned.getCount() < returned.getMaxStackSize());
} }
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);
setChanged(); setChanged();
if (inkRemaining == 0) refillEmptyInkBar();
return true; return true;
} }
@Override public void setLevel(Level level) {
super.setLevel(level);
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;
@@ -130,15 +146,25 @@ public final class WritingDeskBlockEntity extends BlockEntity implements Contain
super.loadAdditional(tag, registries); super.loadAdditional(tag, registries);
items = NonNullList.withSize(SIZE, ItemStack.EMPTY); items = NonNullList.withSize(SIZE, ItemStack.EMPTY);
ContainerHelper.loadAllItems(tag, items, registries); ContainerHelper.loadAllItems(tag, items, registries);
// Pre-88-tab desks stored materials in slots 4..7. Move them once;
// never interpret those stacks as newly added collection tabs.
if (tag.getInt("InventoryVersion") < 1) {
for (int i = 0; i < 4; i++) {
items.set(INK + i, items.get(4 + i));
items.set(4 + i, ItemStack.EMPTY);
}
}
activeCollection = Math.clamp(tag.getInt("ActiveCollection"), 0, COLLECTIONS - 1); activeCollection = Math.clamp(tag.getInt("ActiveCollection"), 0, COLLECTIONS - 1);
inkRemaining = Math.clamp(tag.getInt("InkRemaining"), 0, InkVialItem.CAPACITY); inkRemaining = Math.clamp(tag.getInt("InkRemaining"), 0, InkVialItem.CAPACITY);
displayPage = tag.contains("DisplayPage", CompoundTag.TAG_COMPOUND) displayPage = tag.contains("DisplayPage", CompoundTag.TAG_COMPOUND)
? ItemStack.parse(registries, tag.getCompound("DisplayPage")).orElse(ItemStack.EMPTY) ? ItemStack.parse(registries, tag.getCompound("DisplayPage")).orElse(ItemStack.EMPTY)
: ItemStack.EMPTY; : ItemStack.EMPTY;
refillEmptyInkBar();
} }
@Override protected void saveAdditional(CompoundTag tag, HolderLookup.Provider registries) { @Override protected void saveAdditional(CompoundTag tag, HolderLookup.Provider registries) {
super.saveAdditional(tag, registries); super.saveAdditional(tag, registries);
ContainerHelper.saveAllItems(tag, items, registries); ContainerHelper.saveAllItems(tag, items, registries);
tag.putInt("InventoryVersion", 1);
tag.putInt("ActiveCollection", activeCollection); tag.putInt("ActiveCollection", activeCollection);
tag.putInt("InkRemaining", inkRemaining); tag.putInt("InkRemaining", inkRemaining);
if (!displayPage.isEmpty()) tag.put("DisplayPage", displayPage.save(registries)); if (!displayPage.isEmpty()) tag.put("DisplayPage", displayPage.save(registries));
@@ -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,60 @@
package net.dnorberg.rivencraft.book;
import com.mojang.serialization.Codec;
import io.netty.buffer.ByteBuf;
import java.util.List;
import net.minecraft.ChatFormatting;
import net.minecraft.network.codec.ByteBufCodecs;
import net.minecraft.network.codec.StreamCodec;
import net.minecraft.network.chat.Component;
/** Flags written into a Link Panel and carried by books assembled from it. */
public record LinkProperties(int flags) {
public static final int DISARM = 1;
/** Retained only to read pre-0.4.7.1 test books; no longer generated or applied. */
public static final int GENERATE_PLATFORM = 2;
public static final int MAINTAIN_MOMENTUM = 4;
public static final int INTRA_LINKING = 8;
private static final int ALL_FLAGS = DISARM | GENERATE_PLATFORM | MAINTAIN_MOMENTUM | INTRA_LINKING;
public static final LinkProperties NONE = new LinkProperties(0);
public static final Codec<LinkProperties> CODEC = Codec.intRange(0, ALL_FLAGS).xmap(
LinkProperties::new, LinkProperties::flags);
public static final StreamCodec<ByteBuf, LinkProperties> STREAM_CODEC = StreamCodec.of(
(buffer, value) -> ByteBufCodecs.VAR_INT.encode(buffer, value.flags),
buffer -> new LinkProperties(ByteBufCodecs.VAR_INT.decode(buffer)));
public LinkProperties {
if ((flags & ~ALL_FLAGS) != 0 || flags < 0) {
throw new IllegalArgumentException("Unknown Link Panel flags: " + flags);
}
}
public boolean has(int flag) {
return (flags & flag) != 0;
}
/** Intra Linking only governs Linking Books; a Descriptive Book treats that panel as ordinary. */
public LinkProperties forDescriptiveBook() {
return new LinkProperties(flags & ~INTRA_LINKING);
}
public void appendTooltip(List<Component> lines) {
if (has(DISARM)) lines.add(propertyName("disarm"));
if (has(MAINTAIN_MOMENTUM)) lines.add(propertyName("maintain_momentum"));
if (has(INTRA_LINKING)) lines.add(propertyName("intra_linking"));
}
private static Component propertyName(String name) {
return Component.translatable("item.rivencraft.link_property." + name)
.withStyle(ChatFormatting.DARK_PURPLE);
}
public static Component name(int flag) {
return switch (flag) {
case DISARM -> propertyName("disarm");
case MAINTAIN_MOMENTUM -> propertyName("maintain_momentum");
case INTRA_LINKING -> propertyName("intra_linking");
default -> throw new IllegalArgumentException("Unknown link property flag: " + flag);
};
}
}
@@ -25,7 +25,11 @@ public final class LinkingService {
} }
public static LinkResult travel(ServerPlayer player, LinkTarget target) { public static LinkResult travel(ServerPlayer player, LinkTarget target) {
return travel(player, target, false); return travel(player, target, LinkProperties.NONE);
}
public static LinkResult travel(ServerPlayer player, LinkTarget target, LinkProperties properties) {
return travel(player, target, false, properties);
} }
public static Optional<Vec3> resolveDestination(ServerLevel level, BlockPos origin, boolean ageArrival) { public static Optional<Vec3> resolveDestination(ServerLevel level, BlockPos origin, boolean ageArrival) {
@@ -36,27 +40,36 @@ public final class LinkingService {
/** Travels to an Age-style destination, which must have solid footing. */ /** Travels to an Age-style destination, which must have solid footing. */
public static LinkResult travelWithFooting(ServerPlayer player, LinkTarget target) { public static LinkResult travelWithFooting(ServerPlayer player, LinkTarget target) {
return travelWithFooting(player, target, LinkProperties.NONE);
}
public static LinkResult travelWithFooting(ServerPlayer player, LinkTarget target, LinkProperties properties) {
ServerLevel destinationLevel = player.getServer().getLevel(target.location().dimension()); ServerLevel destinationLevel = player.getServer().getLevel(target.location().dimension());
if (destinationLevel == null) { if (destinationLevel == null) {
return LinkResult.MISSING_DIMENSION; return LinkResult.MISSING_DIMENSION;
} }
Optional<Vec3> destination = resolveDestination(destinationLevel, target.location().pos(), true); Optional<Vec3> destination = resolveDestination(destinationLevel, target.location().pos(), true);
if (destination.isEmpty()) { if (destination.isEmpty()) {
return LinkResult.NO_SAFE_DESTINATION; return LinkResult.NO_SAFE_DESTINATION;
} }
Vec3 position = destination.get(); Vec3 position = destination.get();
Vec3 momentum = player.getDeltaMovement();
if (properties.has(LinkProperties.DISARM)) dropInventoryAtSource(player);
teleport(player, destinationLevel, position, target); teleport(player, destinationLevel, position, target);
if (properties.has(LinkProperties.MAINTAIN_MOMENTUM)) player.setDeltaMovement(momentum);
player.resetFallDistance(); player.resetFallDistance();
return LinkResult.SUCCESS; return LinkResult.SUCCESS;
} }
private static LinkResult travel(ServerPlayer player, LinkTarget target, boolean requiresFooting) { private static LinkResult travel(ServerPlayer player, LinkTarget target, boolean requiresFooting,
LinkProperties properties) {
ServerLevel destinationLevel = player.getServer().getLevel(target.location().dimension()); ServerLevel destinationLevel = player.getServer().getLevel(target.location().dimension());
if (destinationLevel == null) { if (destinationLevel == null) {
return LinkResult.MISSING_DIMENSION; return LinkResult.MISSING_DIMENSION;
} }
if (destinationLevel == player.level() && !properties.has(LinkProperties.INTRA_LINKING))
return LinkResult.INTRA_LINKING_REQUIRED;
Optional<Vec3> destination = resolveDestination(destinationLevel, target.location().pos(), requiresFooting); Optional<Vec3> destination = resolveDestination(destinationLevel, target.location().pos(), requiresFooting);
if (destination.isEmpty()) { if (destination.isEmpty()) {
@@ -64,11 +77,26 @@ public final class LinkingService {
} }
Vec3 position = destination.get(); Vec3 position = destination.get();
Vec3 momentum = player.getDeltaMovement();
if (properties.has(LinkProperties.DISARM)) dropInventoryAtSource(player);
teleport(player, destinationLevel, position, target); teleport(player, destinationLevel, position, target);
if (properties.has(LinkProperties.MAINTAIN_MOMENTUM)) player.setDeltaMovement(momentum);
player.resetFallDistance(); player.resetFallDistance();
return LinkResult.SUCCESS; return LinkResult.SUCCESS;
} }
/** Drop each inventory stack as an item entity at the departure point. */
private static void dropInventoryAtSource(ServerPlayer player) {
var inventory = player.getInventory();
for (int slot = 0; slot < inventory.getContainerSize(); slot++) {
var stack = inventory.getItem(slot);
if (stack.isEmpty()) continue;
inventory.setItem(slot, net.minecraft.world.item.ItemStack.EMPTY);
player.drop(stack, false);
}
player.containerMenu.broadcastChanges();
}
private static void teleport( private static void teleport(
ServerPlayer player, ServerPlayer player,
ServerLevel destinationLevel, ServerLevel destinationLevel,
@@ -166,6 +194,7 @@ public final class LinkingService {
public enum LinkResult { public enum LinkResult {
SUCCESS, SUCCESS,
MISSING_DIMENSION, MISSING_DIMENSION,
INTRA_LINKING_REQUIRED,
NO_SAFE_DESTINATION NO_SAFE_DESTINATION
} }
} }
@@ -0,0 +1,354 @@
package net.dnorberg.rivencraft.book;
import com.google.gson.JsonParser;
import java.util.List;
import java.util.UUID;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolCatalog;
import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.dnorberg.rivencraft.writing.WritingEntry;
import net.dnorberg.rivencraft.item.PageItem;
import net.minecraft.core.BlockPos;
import net.minecraft.core.registries.Registries;
import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper;
import net.minecraft.resources.ResourceKey;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.level.block.Blocks;
import net.minecraft.world.level.dimension.BuiltinDimensionTypes;
import net.dnorberg.rivencraft.world.AgeFlatChunkGenerator;
import net.minecraft.world.level.levelgen.NoiseBasedChunkGenerator;
import net.minecraft.world.level.biome.Biomes;
import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
/** Issue #32: authored terrain must drive actual runtime generation and survive reload. */
@GameTestHolder("rivencraft_archive_linking")
@PrefixGameTestTemplate(false)
public final class TerrainWritingGameTests {
private TerrainWritingGameTests() {}
@GameTest(template = "empty")
public static void seedSelectedCavePreflightRejectsSurfaceBiome(GameTestHelper helper) {
String candidate = null;
for (int index = 0; index < 1000; index++) {
String name = "Cave preflight " + index;
if (AgeRegistrySavedData.previewGenerationProfile(helper.getLevel(), name)
.equals(AgeGenerationProfiles.CAVE)) {
candidate = name;
break;
}
}
helper.assertTrue(candidate != null, "A deterministic name must select Cave terrain");
OrderedWriting writing = new OrderedWriting(List.of(WritingEntry.linkPanel(),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/plains")))));
boolean rejected = false;
try {
AgeRegistrySavedData.validateNewWriting(helper.getLevel(), candidate, writing);
} catch (IllegalArgumentException exception) {
rejected = exception.getMessage().contains("not a cave or Nether biome");
}
helper.assertTrue(rejected, "The preflight must use the actual seed-selected terrain profile");
helper.succeed();
}
@GameTest(template = "empty", timeoutTicks = 600)
public static void caveBiomePagesControlGeneratedPool(GameTestHelper helper) {
var player = helper.makeMockServerPlayerInLevel();
helper.assertTrue(PageItem.bundledCreativeSymbols().contains("biome/desert"),
"Desert must remain in the bundled creative page index");
var creativePages = PageItem.creativeSymbolPages(helper.getLevel().registryAccess());
helper.assertTrue(creativePages.stream().anyMatch(page -> PageItem.content(page).symbol()
.map(symbol -> symbol.id().equals(ResourceLocation.parse("rivencraft:biome/desert")))
.orElse(false))
&& creativePages.stream().anyMatch(page -> PageItem.content(page).symbol()
.map(symbol -> symbol.id().equals(ResourceLocation.parse("rivencraft:biome/jungle")))
.orElse(false)),
"Both bundled and registry-generated biome pages must be available to creative and JEI");
var jungle = ResourceLocation.withDefaultNamespace("jungle");
helper.assertTrue(SymbolCatalog.isKnown(new SymbolReference(ResourceLocation.parse("rivencraft:biome/jungle")))
&& PageItem.isUsableWriting(PageItem.createCreativeBiomePage(jungle)),
"A generated Jungle page must be usable as server-authored writing");
helper.getLevel().registryAccess().lookupOrThrow(Registries.BIOME).listElements()
.map(holder -> holder.key().location())
.filter(id -> id.getNamespace().equals("minecraft"))
.forEach(id -> helper.assertTrue(SymbolCatalog.isKnown(new SymbolReference(
ResourceLocation.fromNamespaceAndPath("rivencraft", "biome/" + id.getPath()))),
"Every registered vanilla biome must have a usable symbol page: " + id));
var overworldPool = AgeBiomeSelection.eligible(helper.getLevel().registryAccess(),
AgeRuntimeProfiles.resolve(AgeGenerationProfiles.STANDARD));
helper.assertTrue(overworldPool.containsAll(List.of(Biomes.LUSH_CAVES.location(),
Biomes.DRIPSTONE_CAVES.location(), Biomes.DEEP_DARK.location())),
"Standard terrain must retain the vanilla Overworld underground cave biomes");
OrderedWriting standardCaveWriting = new OrderedWriting(List.of(WritingEntry.linkPanel(),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:terrain/standard"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/dripstone_caves"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/single")))));
helper.assertValueEqual(AgeGenerationPlan.compile(standardCaveWriting, 45L,
AgeGenerationProfiles.STANDARD, AgeTraits.select(45L), helper.getLevel().registryAccess())
.biomeSelection().biomes(), List.of(Biomes.DRIPSTONE_CAVES.location()),
"A standard Age must accept an explicitly written cave biome");
OrderedWriting writing = new OrderedWriting(List.of(
WritingEntry.linkPanel(),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:terrain/cave"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/lush_caves"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/nether_wastes"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/tiled")))));
var reference = new AgeReference(UUID.randomUUID(), "Written Cave Biomes");
var target = AgeDimensionService.resolve(player, reference, writing).orElseThrow();
var age = AgeRegistrySavedData.get(helper.getLevel()).find(reference.id()).orElseThrow();
var selection = age.plan().biomeSelection();
helper.assertValueEqual(selection.distribution(), AgeTraits.BiomeDistribution.TILED,
"The authored distribution must override the random trait");
helper.assertValueEqual(selection.biomes(), List.of(Biomes.LUSH_CAVES.location(), Biomes.NETHER_WASTES.location()),
"An authored cave pool must include only its selected cave and Nether biomes");
helper.assertValueEqual(AgeGenerationPlan.load(age.plan().save()).biomeSelection(), selection,
"Biome IDs, count and distribution must survive a plan save/reload");
helper.runAfterDelay(1, () -> {
var level = helper.getLevel().getServer().getLevel(target.location().dimension());
helper.assertTrue(level != null, "The cave Age must load");
helper.assertValueEqual(level.getChunkSource().getGenerator().getBiomeSource().possibleBiomes().size(), 2,
"The runtime generator must expose both authored biomes");
helper.succeed();
});
}
@GameTest(template = "empty")
public static void authoredBiomeMinimumAndRandomAgeRange(GameTestHelper helper) {
var registries = helper.getLevel().registryAccess();
var profile = AgeRuntimeProfiles.resolve(AgeGenerationProfiles.STANDARD);
OrderedWriting twoBiomeTiny = new OrderedWriting(List.of(
WritingEntry.linkPanel(),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/plains"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/desert"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/tiny")))));
var written = AgeBiomeSelection.compile(net.dnorberg.rivencraft.writing.WritingGrammar.parse(twoBiomeTiny),
AgeTraits.select(42L), profile, 42L, registries);
helper.assertValueEqual(written.biomes(), List.of(Biomes.PLAINS.location(), Biomes.DESERT.location()),
"Two authored Tiny biomes must not acquire a third random biome");
var biomeRegistry = registries.lookupOrThrow(Registries.BIOME);
var scaled = new net.dnorberg.rivencraft.world.ScaledBiomeSource(net.minecraft.core.HolderSet.direct(
biomeRegistry.getOrThrow(Biomes.PLAINS), biomeRegistry.getOrThrow(Biomes.DESERT)), 42L, 0);
helper.assertValueEqual(scaled.possibleBiomes().size(), 2,
"The Tiny runtime biome source must accept exactly two authored biomes");
OrderedWriting oneBiomeTiny = new OrderedWriting(List.of(
WritingEntry.linkPanel(),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/plains"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/tiny")))));
var partial = AgeBiomeSelection.compile(net.dnorberg.rivencraft.writing.WritingGrammar.parse(oneBiomeTiny),
AgeTraits.select(42L), profile, 42L, registries);
helper.assertValueEqual(partial.biomes().size(), 2,
"One authored Tiny biome must receive only the missing second biome");
helper.assertValueEqual(partial.biomes().getFirst(), Biomes.PLAINS.location(),
"Random completion must preserve the authored biome first");
var randomWriting = net.dnorberg.rivencraft.writing.WritingGrammar.parse(OrderedWriting.EMPTY);
var traits = new AgeTraits(AgeTraits.BiomeDistribution.TINY, AgeTraits.Lighting.NORMAL,
AgeTraits.Weather.NORMAL, 1.0D, 0.0F, 0.0F);
int availableBiomeCount = new java.util.LinkedHashSet<>(AgeBiomeSelection.eligible(registries, profile)).size();
java.util.Set<Integer> counts = new java.util.HashSet<>();
for (long seed = 0; seed < 64; seed++) {
var random = AgeBiomeSelection.compile(randomWriting, traits, profile, seed, registries);
helper.assertTrue(random.biomes().size() >= 2 && random.biomes().size() <= availableBiomeCount,
"Random Tiny ages must not exceed their available biome pool");
helper.assertValueEqual(random, AgeBiomeSelection.compile(randomWriting, traits, profile, seed, registries),
"The random count and chosen biomes must be deterministic for an Age seed");
counts.add(random.biomes().size());
}
helper.assertTrue(counts.size() > 1, "Random Ages must vary their biome count across seeds");
if (availableBiomeCount > 6) {
helper.assertTrue(counts.stream().anyMatch(count -> count > 6),
"The available biome pool, not the old fixed cap, must bound random Ages");
}
var tiledTraits = new AgeTraits(AgeTraits.BiomeDistribution.TILED, AgeTraits.Lighting.NORMAL,
AgeTraits.Weather.NORMAL, 1.0D, 0.0F, 0.0F);
if (availableBiomeCount > 4) {
boolean exceededOldCap = false;
for (long seed = 0; seed < 64; seed++) {
var random = AgeBiomeSelection.compile(randomWriting, tiledTraits, profile, seed, registries);
helper.assertTrue(random.biomes().size() >= 2 && random.biomes().size() <= availableBiomeCount,
"Random Tiled ages must not exceed their available biome pool");
exceededOldCap |= random.biomes().size() > 4;
}
helper.assertTrue(exceededOldCap, "Tiled Ages must also be able to exceed the old fixed cap");
}
var caveProfile = AgeRuntimeProfiles.resolve(AgeGenerationProfiles.CAVE);
int caveBiomeCount = new java.util.LinkedHashSet<>(AgeBiomeSelection.eligible(registries, caveProfile)).size();
for (long seed = 0; seed < 64; seed++) {
var random = AgeBiomeSelection.compile(randomWriting, traits, caveProfile, seed, registries);
helper.assertTrue(random.biomes().size() >= 2 && random.biomes().size() <= caveBiomeCount,
"Random Cave ages must use the cave biome pool as their upper bound");
}
helper.succeed();
}
@GameTest(template = "empty", timeoutTicks = 600)
public static void skyIslandAllowsExplicitEndBiome(GameTestHelper helper) {
var player = helper.makeMockServerPlayerInLevel();
OrderedWriting writing = new OrderedWriting(List.of(
WritingEntry.linkPanel(),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:terrain/island"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/the_end"))),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:biome/single")))));
var reference = new AgeReference(UUID.randomUUID(), "End Island Biome");
var target = AgeDimensionService.resolve(player, reference, writing).orElseThrow();
var age = AgeRegistrySavedData.get(helper.getLevel()).find(reference.id()).orElseThrow();
helper.assertValueEqual(age.plan().biomeSelection().biomes(), List.of(Biomes.THE_END.location()),
"A sky island may use an explicitly authored End biome");
helper.runAfterDelay(1, () -> {
var server = helper.getLevel().getServer();
var level = server.getLevel(target.location().dimension());
helper.assertTrue(level != null, "The island Age must load");
helper.assertTrue(level.getChunkSource().getGenerator().getBiomeSource().possibleBiomes().stream()
.allMatch(biome -> biome.is(Biomes.THE_END)),
"The runtime sky-island generator must use the End biome page");
helper.assertValueEqual(AgeGenerationPlan.load(age.plan().save()).biomeSelection(),
age.plan().biomeSelection(), "The authored End biome must survive a plan save/load round trip");
helper.succeed();
});
}
@GameTest(template = "empty", timeoutTicks = 600)
public static void writtenTerrainFamiliesGenerateSafely(GameTestHelper helper) {
var player = helper.makeMockServerPlayerInLevel();
checkWrittenTerrain(helper, player, AgeGenerationProfiles.all(), 0);
}
private static void checkWrittenTerrain(GameTestHelper helper,
net.minecraft.server.level.ServerPlayer player,
List<ResourceLocation> profiles, int index) {
if (index >= profiles.size()) {
helper.succeed();
return;
}
var server = helper.getLevel().getServer();
ResourceLocation profileId = profiles.get(index);
SymbolReference symbol = new SymbolReference(ResourceLocation.fromNamespaceAndPath(
"rivencraft", "terrain/" + profileId.getPath()));
var semantics = SymbolCatalog.find(symbol).orElseThrow().semantics().orElseThrow();
helper.assertValueEqual(semantics.role(), SymbolSemantics.Role.TERRAIN,
"A built-in terrain page must have terrain semantics");
helper.assertValueEqual(((SymbolSemantics.ResourceValue) semantics.value()).id(), profileId,
"A terrain page must point at its matching profile");
OrderedWriting writing = new OrderedWriting(List.of(
WritingEntry.linkPanel(), WritingEntry.symbol(symbol)));
AgeReference reference = new AgeReference(UUID.randomUUID(),
"Written " + profileId.getPath() + " " + UUID.randomUUID());
var target = AgeDimensionService.resolve(player, reference, writing).orElseThrow();
AgeDefinition age = AgeRegistrySavedData.get(helper.getLevel()).find(reference.id()).orElseThrow();
helper.assertValueEqual(age.generationProfile(), profileId,
"Written terrain must override the random profile chosen from the seed");
helper.assertValueEqual(age.plan().runtimeProfile(), AgeRuntimeProfiles.profiles().get(profileId),
"The selected noise and dimension-type resources must be frozen in the plan");
helper.runAfterDelay(1, () -> {
var level = server.getLevel(target.location().dimension());
helper.assertTrue(level != null, "The written Age must create a runtime dimension");
assertGenerator(helper, level, age.plan().runtimeProfile());
BlockPos spawn = target.location().pos();
helper.assertTrue(level.getBlockState(spawn.below()).is(Blocks.COBBLESTONE)
&& level.getBlockState(spawn).isAir()
&& level.getBlockState(spawn.above()).isAir(),
"Every written terrain family must retain a safe arrival platform");
helper.assertValueEqual(AgeGenerationPlan.load(age.plan().save()).runtimeProfile(),
age.plan().runtimeProfile(), "The written terrain profile must survive plan persistence");
helper.runAfterDelay(1, () -> checkWrittenTerrain(helper, player, profiles, index + 1));
});
}
@GameTest(template = "empty")
public static void missingRegistryResourcesRejectProfileAndPreserveAge(GameTestHelper helper) {
ResourceLocation missing = ResourceLocation.parse("rivencraft:missing_noise");
var json = JsonParser.parseString("""
{"schema_version":1,"terrain":"noise","noise_settings":"rivencraft:missing_noise",
"biome_preset":"minecraft:overworld","dimension_type":"minecraft:overworld"}
""");
boolean rejected = false;
try {
AgeRuntimeProfiles.parse(missing, json, helper.getLevel().registryAccess());
} catch (IllegalArgumentException exception) {
rejected = exception.getMessage().contains("noise_settings")
&& exception.getMessage().contains(missing.toString());
}
helper.assertTrue(rejected, "A profile with missing noise settings needs an actionable rejection");
long seed = 42L;
OrderedWriting writing = new OrderedWriting(List.of(WritingEntry.linkPanel(),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:terrain/standard")))));
AgeRuntimeProfile broken = new AgeRuntimeProfile(1, AgeRuntimeProfile.Terrain.NOISE,
missing, ResourceLocation.parse("minecraft:overworld"),
ResourceLocation.parse("minecraft:overworld"));
AgeGenerationPlan plan = new AgeGenerationPlan(1, seed, writing,
List.of(new AgeGenerationPlan.ResolvedSymbol(1,
writing.entries().get(1).symbol().orElseThrow(),
new SymbolSemantics(SymbolSemantics.Role.TERRAIN,
new SymbolSemantics.ResourceValue(AgeGenerationProfiles.STANDARD)))), broken);
AgeDefinition age = new AgeDefinition(UUID.randomUUID(), "Missing Resource", seed,
AgeGenerationProfiles.STANDARD, AgeDefinition.CURRENT_GENERATION_VERSION,
helper.getLevel().getGameTime(),
ResourceLocation.parse("rivencraft:gametest/missing_resource_" + UUID.randomUUID()),
null, AgeTraits.select(seed), plan);
helper.assertTrue(AgeDimensionService.ensureLoaded(helper.getLevel().getServer(), age) == null,
"A removed resource must not silently turn an authored Age into a different terrain");
helper.assertValueEqual(age.plan(), plan, "Failed loading must not mutate the saved plan");
helper.succeed();
}
@GameTest(template = "empty")
public static void dimensionTypeSnapshotKeepsNetherSkylightRules(GameTestHelper helper) {
var profile = AgeRuntimeProfiles.parse(ResourceLocation.parse("rivencraft:gametest_nether"),
JsonParser.parseString("""
{"schema_version":1,"terrain":"noise","noise_settings":"minecraft:nether",
"biome_preset":"minecraft:nether","dimension_type":"minecraft:the_nether"}
"""), helper.getLevel().registryAccess());
long seed = 99L;
OrderedWriting writing = new OrderedWriting(List.of(WritingEntry.linkPanel(),
WritingEntry.symbol(new SymbolReference(ResourceLocation.parse("rivencraft:feature/caves")))));
var parsed = net.dnorberg.rivencraft.writing.WritingGrammar.parse(writing);
AgeGenerationPlan plan = new AgeGenerationPlan(1, seed, writing,
parsed.symbols().stream().map(symbol -> new AgeGenerationPlan.ResolvedSymbol(
symbol.index(), symbol.reference(), symbol.semantics())).toList(), profile);
AgeDefinition age = new AgeDefinition(UUID.randomUUID(), "Nether Type Snapshot", seed,
ResourceLocation.parse("rivencraft:gametest_nether"), AgeDefinition.CURRENT_GENERATION_VERSION,
helper.getLevel().getGameTime(),
ResourceLocation.parse("rivencraft:gametest/nether_type_" + UUID.randomUUID()),
null, AgeTraits.LEGACY_DEFAULTS, plan);
var level = AgeDimensionService.ensureLoaded(helper.getLevel().getServer(), age);
helper.assertTrue(level != null, "A valid custom dimension-type snapshot must load");
helper.assertFalse(level.dimensionType().hasSkyLight(),
"Normal lighting must not add skylight to a Nether-style dimension type");
helper.assertValueEqual(level.dimensionType().effectsLocation(), BuiltinDimensionTypes.NETHER_EFFECTS,
"The authored profile's dimension effects must reach the runtime Age");
helper.succeed();
}
private static void assertGenerator(GameTestHelper helper, net.minecraft.server.level.ServerLevel level,
AgeRuntimeProfile profile) {
var generator = level.getChunkSource().getGenerator();
if (profile.terrain() == AgeRuntimeProfile.Terrain.NOISE) {
helper.assertTrue(generator instanceof NoiseBasedChunkGenerator,
"Noise terrain must use a noise-based chunk generator");
var expected = level.registryAccess().lookupOrThrow(Registries.NOISE_SETTINGS).getOrThrow(
ResourceKey.create(Registries.NOISE_SETTINGS, profile.noiseSettings())).value();
helper.assertValueEqual(((NoiseBasedChunkGenerator) generator).generatorSettings().value().noiseSettings(),
expected.noiseSettings(), "Written noise settings must be applied to the generator");
} else {
helper.assertTrue(generator instanceof AgeFlatChunkGenerator,
"Flat and Void terrain must use a flat-source generator");
if (profile.terrain() == AgeRuntimeProfile.Terrain.VOID) {
helper.assertTrue(generator.getBiomeSource().possibleBiomes().stream()
.allMatch(biome -> biome.is(net.minecraft.world.level.biome.Biomes.THE_VOID)),
"Void terrain must use the Void biome");
}
}
var expectedType = level.registryAccess().lookupOrThrow(Registries.DIMENSION_TYPE).getOrThrow(
ResourceKey.create(Registries.DIMENSION_TYPE, profile.dimensionType())).value();
helper.assertValueEqual(level.dimensionType().effectsLocation(), expectedType.effectsLocation(),
"The profile's dimension-type effects must be applied");
}
}
@@ -92,8 +92,8 @@ public final class ClientBookInteractionHandler {
return; return;
} }
minecraft.setScreen(payload.fromStand() minecraft.setScreen(payload.fromStand()
? new DescriptiveBookScreen(payload.source().pos(), payload.book(), payload.traits()) ? new DescriptiveBookScreen(payload.source().pos(), payload.book(), payload.traits(), payload.writingSymbols())
: new DescriptiveBookScreen(hand, payload.book(), payload.traits())); : new DescriptiveBookScreen(hand, payload.book(), payload.traits(), payload.writingSymbols()));
}); });
} }
} }
@@ -13,8 +13,14 @@ 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.InkMixerScreen;
import net.dnorberg.rivencraft.registry.ModMenus; import net.dnorberg.rivencraft.registry.ModMenus;
@EventBusSubscriber(modid = Rivencraft.MOD_ID, value = Dist.CLIENT) @EventBusSubscriber(modid = Rivencraft.MOD_ID, value = Dist.CLIENT)
@@ -32,6 +38,26 @@ public final class ClientEvents {
public static void registerScreens(RegisterMenuScreensEvent event) { public static void registerScreens(RegisterMenuScreensEvent event) {
event.register(ModMenus.NOTEBOOK.get(), NotebookScreen::new); event.register(ModMenus.NOTEBOOK.get(), NotebookScreen::new);
event.register(ModMenus.WRITING_DESK.get(), WritingDeskScreen::new); event.register(ModMenus.WRITING_DESK.get(), WritingDeskScreen::new);
event.register(ModMenus.BOOK_BINDER.get(), BookBinderScreen::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
@@ -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");
}
}
@@ -0,0 +1,258 @@
package net.dnorberg.rivencraft.client.screen;
import java.util.Locale;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.block.entity.BookBinderBlockEntity;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.menu.BookBinderMenu;
import net.dnorberg.rivencraft.network.SetBookBinderTitlePayload;
import net.minecraft.client.gui.GuiGraphics;
import net.minecraft.client.gui.components.EditBox;
import net.minecraft.client.gui.screens.inventory.AbstractContainerScreen;
import net.minecraft.network.chat.Component;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.entity.player.Inventory;
import net.minecraft.world.item.ItemStack;
import net.neoforged.neoforge.network.PacketDistributor;
import org.lwjgl.glfw.GLFW;
/** Legacy-sized binder: cover and result flank a scrolling strip of full page thumbnails. */
public final class BookBinderScreen extends AbstractContainerScreen<BookBinderMenu> {
private static final ResourceLocation BACKGROUND = ResourceLocation.fromNamespaceAndPath(
Rivencraft.MOD_ID, "textures/gui/book_binder_legacy.png");
private static final ResourceLocation PAGE_ATLAS = ResourceLocation.fromNamespaceAndPath(
Rivencraft.MOD_ID, "textures/gui/notebook_pages.png");
private static final int STRIP_X = 7;
private static final int STRIP_Y = 45;
private static final int STRIP_WIDTH = 162;
private static final int STRIP_HEIGHT = 40;
private static final int PAGE_WIDTH = 26;
private static final int PAGE_HEIGHT = 34;
private static final int PAGE_STEP = 28;
private static final int VISIBLE_PAGES = 5;
private EditBox titleInput;
private int firstVisible;
private int lastGrammarErrorStripIndex = -1;
private boolean stripClickPendingRelease;
public BookBinderScreen(BookBinderMenu menu, Inventory inventory, Component title) {
super(menu, inventory, title);
imageWidth = 176;
imageHeight = 181;
inventoryLabelX = 8;
inventoryLabelY = 87;
}
@Override public boolean isPauseScreen() { return false; }
@Override protected void init() {
super.init();
titleInput = new EditBox(font, leftPos + 9, topPos + 10, 112, 12,
Component.translatable("screen.rivencraft.book_binder.title"));
titleInput.setBordered(false);
titleInput.setTextColor(0xFFFFFFFF);
titleInput.setMaxLength(BookBinderBlockEntity.MAX_TITLE_LENGTH);
titleInput.setValue(menu.title());
titleInput.setHint(Component.translatable("screen.rivencraft.book_binder.title_hint"));
titleInput.setResponder(value -> PacketDistributor.sendToServer(
new SetBookBinderTitlePayload(menu.containerId, value)));
addRenderableWidget(titleInput);
}
@Override public void renderBackground(GuiGraphics graphics, int mouseX, int mouseY, float partialTick) {
renderBg(graphics, partialTick, mouseX, mouseY);
}
@Override protected void renderBg(GuiGraphics graphics, float partialTick, int mouseX, int mouseY) {
graphics.blit(BACKGROUND, leftPos, topPos, 0, 0, imageWidth, imageHeight, 256, 256);
if (menu.getSlot(BookBinderBlockEntity.LINK_PANEL).getItem().isEmpty()) {
float fade = (System.currentTimeMillis() % 4000L) / 2000F;
if (fade > 1F) fade = 2F - fade;
graphics.blit(BACKGROUND, leftPos + 27, topPos + 26,
18, 18, 176, 0, 30, 40, 256, 256);
graphics.setColor(1F, 0.3F, 0.3F, 0.8F * fade);
graphics.blit(BACKGROUND, leftPos + 27, topPos + 26,
18, 18, 176, 0, 30, 40, 256, 256);
graphics.setColor(1F, 1F, 1F, 1F);
}
graphics.fill(leftPos + 7, topPos + 9, leftPos + 123, topPos + 23, 0xFF000000);
graphics.renderOutline(leftPos + 7, topPos + 9, 116, 14,
titleInput == null || titleInput.getValue().isBlank() ? 0xFFFF3030 : 0xFFA0A0A0);
}
@Override protected void renderLabels(GuiGraphics graphics, int mouseX, int mouseY) {
graphics.drawString(font, playerInventoryTitle, inventoryLabelX, inventoryLabelY, 0xFF404040, false);
}
@Override public void render(GuiGraphics graphics, int mouseX, int mouseY, float partialTick) {
super.render(graphics, mouseX, mouseY, partialTick);
firstVisible = Math.min(firstVisible, maxFirstVisible());
int errorStripIndex = menu.grammarErrorStripIndex();
if (errorStripIndex != lastGrammarErrorStripIndex) {
if (errorStripIndex >= 0
&& (errorStripIndex < firstVisible || errorStripIndex >= firstVisible + VISIBLE_PAGES))
firstVisible = Math.clamp(errorStripIndex - VISIBLE_PAGES + 1, 0, maxFirstVisible());
lastGrammarErrorStripIndex = errorStripIndex;
}
graphics.enableScissor(leftPos + STRIP_X + 8, topPos + STRIP_Y,
leftPos + STRIP_X + STRIP_WIDTH - 8, topPos + STRIP_Y + STRIP_HEIGHT);
int count = visiblePageCount();
for (int visible = 0; visible < VISIBLE_PAGES; visible++) {
int index = firstVisible + visible;
if (index >= count) break;
drawPage(graphics, pageAtIndex(index), index,
leftPos + 16 + visible * PAGE_STEP, topPos + STRIP_Y + 3);
}
graphics.disableScissor();
drawScrollEnds(graphics);
Component grammarTooltip = menu.grammarError().map(code -> Component.translatable(
"screen.rivencraft.book_binder.grammar." + code.name().toLowerCase(Locale.ROOT),
errorStripIndex + 1)).orElse(null);
if (menu.getSlot(BookBinderMenu.RESULT).getItem().isEmpty()
&& mouseX >= leftPos + 152 && mouseX < leftPos + 168
&& mouseY >= topPos + 27 && mouseY < topPos + 43
&& grammarTooltip != null) {
graphics.renderTooltip(font, grammarTooltip, mouseX, mouseY);
return;
}
if (mouseY >= topPos + STRIP_Y && mouseY < topPos + STRIP_Y + STRIP_HEIGHT) {
if (firstVisible > 0 && mouseX >= leftPos + STRIP_X && mouseX < leftPos + STRIP_X + 8)
graphics.renderTooltip(font, Component.translatable("screen.rivencraft.book_binder.previous_pages"), mouseX, mouseY);
else if (firstVisible < maxFirstVisible() && mouseX >= leftPos + STRIP_X + STRIP_WIDTH - 8
&& mouseX < leftPos + STRIP_X + STRIP_WIDTH)
graphics.renderTooltip(font, Component.translatable("screen.rivencraft.book_binder.next_pages"), mouseX, mouseY);
}
if (pageAtIndex(0).isEmpty() && mouseX >= leftPos + 27 && mouseX < leftPos + 45
&& mouseY >= topPos + 26 && mouseY < topPos + 44) {
graphics.renderTooltip(font,
Component.translatable("screen.rivencraft.book_binder.missing_panel"), mouseX, mouseY);
return;
}
int hovered = pageIndexAt(mouseX, mouseY);
if (hovered >= 0 && hovered == errorStripIndex && grammarTooltip != null)
graphics.renderTooltip(font, grammarTooltip, mouseX, mouseY);
else if (hovered >= 0 && hovered < displayedPages() && !pageAtIndex(hovered).isEmpty())
graphics.renderTooltip(font, pageAtIndex(hovered), mouseX, mouseY);
else renderTooltip(graphics, mouseX, mouseY);
}
private ItemStack pageAtIndex(int index) {
return menu.getSlot(index == 0 ? BookBinderBlockEntity.LINK_PANEL
: BookBinderBlockEntity.FIRST_PAGE + index - 1).getItem();
}
private int displayedPages() {
for (int index = BookBinderBlockEntity.PAGE_COUNT; index >= 1; index--)
if (!pageAtIndex(index).isEmpty()) return index + 1;
return pageAtIndex(0).isEmpty() ? 0 : 1;
}
private int maxFirstVisible() {
return Math.max(0, visiblePageCount() - VISIBLE_PAGES);
}
private int visiblePageCount() {
return Math.min(BookBinderBlockEntity.PAGE_COUNT + 1,
displayedPages() + (menu.getCarried().isEmpty() ? 0 : 1));
}
private void drawPage(GuiGraphics graphics, ItemStack page, int index, int x, int y) {
graphics.blit(PAGE_ATLAS, x, y, PAGE_WIDTH, PAGE_HEIGHT, 156, 0, 30, 40, 256, 256);
if (page.isEmpty()) {
graphics.fill(x, y, x + PAGE_WIDTH, y + PAGE_HEIGHT, 0xAA000000);
return;
}
switch (PageItem.content(page).kind()) {
case BLANK -> { }
case LINK_PANEL -> graphics.fill(x + 5, y + 6, x + 22, y + 17, 0xFF000000);
case SYMBOL, UNRESOLVED_SYMBOL -> graphics.blit(NotebookScreen.symbolTexture(page),
x + 1, y + 5, 24, 24, 0, 0, 128, 128, 128, 128);
}
if (index == menu.grammarErrorStripIndex() && menu.grammarError().isPresent()) {
graphics.fill(x, y, x + PAGE_WIDTH, y + PAGE_HEIGHT, 0x55FF2020);
graphics.renderOutline(x, y, PAGE_WIDTH, PAGE_HEIGHT, 0xFFFF3030);
}
}
private void drawScrollEnds(GuiGraphics graphics) {
int x = leftPos + STRIP_X;
int y = topPos + STRIP_Y;
graphics.fill(x, y, x + 8, y + STRIP_HEIGHT,
firstVisible == 0 ? 0x33000000 : 0xAA000000);
graphics.fill(x + STRIP_WIDTH - 8, y, x + STRIP_WIDTH, y + STRIP_HEIGHT,
firstVisible >= maxFirstVisible() ? 0x33000000 : 0xAA000000);
}
private int pageIndexAt(double mouseX, double mouseY) {
int localX = (int) mouseX - leftPos;
int localY = (int) mouseY - topPos;
if (localX < STRIP_X + 8 || localX >= STRIP_X + STRIP_WIDTH - 8
|| localY < STRIP_Y || localY >= STRIP_Y + STRIP_HEIGHT) return -1;
int visible = (localX - 16) / PAGE_STEP;
if (visible < 0 || visible >= VISIBLE_PAGES) return -1;
return Math.min(firstVisible + visible, BookBinderBlockEntity.PAGE_COUNT);
}
@Override public boolean mouseClicked(double mouseX, double mouseY, int button) {
int localX = (int) mouseX - leftPos;
int localY = (int) mouseY - topPos;
if ((button == 0 || button == 1) && localY >= STRIP_Y && localY < STRIP_Y + STRIP_HEIGHT
&& localX >= STRIP_X && localX < STRIP_X + STRIP_WIDTH) {
stripClickPendingRelease = true;
if (localX < STRIP_X + 8) firstVisible = Math.max(0, firstVisible - 1);
else if (localX >= STRIP_X + STRIP_WIDTH - 8)
firstVisible = Math.min(maxFirstVisible(), firstVisible + 1);
else {
int index = pageIndexAt(mouseX, mouseY);
if (index >= 0 && index <= displayedPages()
&& (index < displayedPages() || !menu.getCarried().isEmpty()))
clickStrip(index);
}
return true;
}
return super.mouseClicked(mouseX, mouseY, button);
}
private void clickStrip(int index) {
if (minecraft != null && minecraft.gameMode != null)
minecraft.gameMode.handleInventoryButtonClick(menu.containerId,
BookBinderMenu.STRIP_CLICK_BASE + index);
}
@Override public boolean mouseReleased(double mouseX, double mouseY, int button) {
if (stripClickPendingRelease) {
stripClickPendingRelease = false;
return true;
}
return super.mouseReleased(mouseX, mouseY, button);
}
@Override public boolean mouseScrolled(double mouseX, double mouseY, double scrollX, double scrollY) {
if (mouseX >= leftPos + STRIP_X && mouseX < leftPos + STRIP_X + STRIP_WIDTH
&& mouseY >= topPos + STRIP_Y && mouseY < topPos + STRIP_Y + STRIP_HEIGHT) {
firstVisible = Math.clamp(firstVisible - (int) Math.signum(scrollY), 0, maxFirstVisible());
return true;
}
return super.mouseScrolled(mouseX, mouseY, scrollX, scrollY);
}
@Override public boolean keyPressed(int keyCode, int scanCode, int modifiers) {
if (titleInput != null && titleInput.isFocused()) {
if (keyCode == 256) {
setFocused(null);
titleInput.setFocused(false);
} else titleInput.keyPressed(keyCode, scanCode, modifiers);
return true;
}
if (keyCode == GLFW.GLFW_KEY_LEFT && firstVisible > 0) {
firstVisible--;
return true;
}
if (keyCode == GLFW.GLFW_KEY_RIGHT && firstVisible < maxFirstVisible()) {
firstVisible++;
return true;
}
return super.keyPressed(keyCode, scanCode, modifiers);
}
}
@@ -1,8 +1,11 @@
package net.dnorberg.rivencraft.client.screen; package net.dnorberg.rivencraft.client.screen;
import java.util.List;
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;
@@ -10,62 +13,77 @@ import net.dnorberg.rivencraft.network.RequestLinkPreviewPayload;
import net.dnorberg.rivencraft.network.LinkPreviewPayload; import net.dnorberg.rivencraft.network.LinkPreviewPayload;
import net.dnorberg.rivencraft.network.ReleaseLinkPreviewPayload; import net.dnorberg.rivencraft.network.ReleaseLinkPreviewPayload;
import net.dnorberg.rivencraft.registry.ModDataComponents; import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolDisplayMetadata;
import net.dnorberg.rivencraft.writing.WritingEntry;
import net.dnorberg.rivencraft.client.preview.DestinationPreviewRenderer; import net.dnorberg.rivencraft.client.preview.DestinationPreviewRenderer;
import net.dnorberg.rivencraft.client.preview.DestinationPreviewRenderers; import net.dnorberg.rivencraft.client.preview.DestinationPreviewRenderers;
import net.minecraft.core.BlockPos; import net.minecraft.core.BlockPos;
import net.minecraft.client.gui.GuiGraphics; import net.minecraft.client.gui.GuiGraphics;
import net.minecraft.client.gui.screens.Screen; import net.minecraft.client.gui.screens.Screen;
import net.minecraft.client.resources.sounds.SimpleSoundInstance;
import net.minecraft.client.gui.components.Button; import net.minecraft.client.gui.components.Button;
import net.minecraft.client.gui.components.EditBox; import net.minecraft.client.gui.components.EditBox;
import net.minecraft.client.gui.components.Tooltip;
import net.minecraft.network.chat.Component; import net.minecraft.network.chat.Component;
import net.minecraft.resources.ResourceLocation; import net.minecraft.resources.ResourceLocation;
import net.minecraft.sounds.SoundEvents;
import net.minecraft.util.FormattedCharSequence; import net.minecraft.util.FormattedCharSequence;
import net.minecraft.world.item.ItemStack; import net.minecraft.world.item.ItemStack;
import net.minecraft.world.InteractionHand; import net.minecraft.world.InteractionHand;
import net.neoforged.neoforge.network.PacketDistributor; import net.neoforged.neoforge.network.PacketDistributor;
import org.lwjgl.glfw.GLFW;
import org.jetbrains.annotations.Nullable; import org.jetbrains.annotations.Nullable;
import java.util.Locale;
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 ResourceLocation BOOK_TEXTURE = ResourceLocation.fromNamespaceAndPath( private static final int UNRESOLVED_TEXT_COLOR = 0xFF9B302C;
"rivencraft", "textures/gui/linking_book.png"
);
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 TEXTURE_WIDTH = 512; private static final int LINK_PANEL_X = 173;
private static final int TEXTURE_HEIGHT = 312; private static final int LINK_PANEL_Y = 20;
private static final int LINK_PANEL_X = 28; private static final int LINK_PANEL_WIDTH = 132;
private static final int LINK_PANEL_Y = 35; private static final int LINK_PANEL_HEIGHT = 83;
private static final int LINK_PANEL_WIDTH = 126;
private static final int LINK_PANEL_HEIGHT = 86;
private static final Component EXPLORE_ICON = Component.literal("👁"); private static final Component EXPLORE_ICON = Component.literal("👁");
private final AgeReference age; private final AgeReference age;
private final ResourceLocation generationProfile; private final ResourceLocation generationProfile;
private final AgeTraits traits; private final AgeTraits traits;
private final OrderedWriting writing;
private final List<SymbolDisplayMetadata> writingSymbols;
private final boolean pageFree;
private final InteractionHand hand; private final InteractionHand hand;
private final BlockPos bookStandPos; private final BlockPos bookStandPos;
private DestinationPreviewRenderer preview; private DestinationPreviewRenderer preview;
private EditBox titleInput; private EditBox titleInput;
private Button exploreButton; private Button exploreButton;
private Button createButton;
private Button cancelButton;
private int pageIndex;
private boolean movingToExploreOverlay; private boolean movingToExploreOverlay;
public DescriptiveBookScreen(InteractionHand hand, ItemStack book, @Nullable AgeTraits traits) { public DescriptiveBookScreen(InteractionHand hand, ItemStack book, @Nullable AgeTraits traits,
List<SymbolDisplayMetadata> writingSymbols) {
super(book.getHoverName()); super(book.getHoverName());
age = book.get(ModDataComponents.AGE_REFERENCE.get()); age = book.get(ModDataComponents.AGE_REFERENCE.get());
generationProfile = book.get(ModDataComponents.AGE_GENERATION_PROFILE.get()); generationProfile = book.get(ModDataComponents.AGE_GENERATION_PROFILE.get());
this.traits = traits; this.traits = traits;
writing = book.getOrDefault(ModDataComponents.BOOK_WRITING.get(), OrderedWriting.EMPTY);
this.writingSymbols = List.copyOf(writingSymbols);
pageFree = writing.entries().stream().noneMatch(entry -> entry.kind() == WritingEntry.Kind.SYMBOL);
this.hand = hand; this.hand = hand;
bookStandPos = null; bookStandPos = null;
} }
public DescriptiveBookScreen(BlockPos bookStandPos, ItemStack book, @Nullable AgeTraits traits) { public DescriptiveBookScreen(BlockPos bookStandPos, ItemStack book, @Nullable AgeTraits traits,
List<SymbolDisplayMetadata> writingSymbols) {
super(book.getHoverName()); super(book.getHoverName());
age = book.get(ModDataComponents.AGE_REFERENCE.get()); age = book.get(ModDataComponents.AGE_REFERENCE.get());
generationProfile = book.get(ModDataComponents.AGE_GENERATION_PROFILE.get()); generationProfile = book.get(ModDataComponents.AGE_GENERATION_PROFILE.get());
this.traits = traits; this.traits = traits;
writing = book.getOrDefault(ModDataComponents.BOOK_WRITING.get(), OrderedWriting.EMPTY);
this.writingSymbols = List.copyOf(writingSymbols);
pageFree = writing.entries().stream().noneMatch(entry -> entry.kind() == WritingEntry.Kind.SYMBOL);
hand = InteractionHand.MAIN_HAND; hand = InteractionHand.MAIN_HAND;
this.bookStandPos = bookStandPos.immutable(); this.bookStandPos = bookStandPos.immutable();
} }
@@ -75,19 +93,22 @@ public final class DescriptiveBookScreen extends Screen implements ExplorableBoo
int left = (width - BOOK_WIDTH) / 2; int left = (width - BOOK_WIDTH) / 2;
int top = (height - BOOK_HEIGHT) / 2; int top = (height - BOOK_HEIGHT) / 2;
if (age == null) { if (age == null) {
int rightPage = left + 177; int leftPage = left + 40;
titleInput = new EditBox(font, rightPage, top + 69, 124, 20, titleInput = new EditBox(font, leftPage, top + 69, 110, 20,
Component.translatable("screen.rivencraft.age.title")); Component.translatable("screen.rivencraft.age.title"));
titleInput.setMaxLength(ModNetworking.MAX_BOOK_TITLE_LENGTH); titleInput.setMaxLength(ModNetworking.MAX_BOOK_TITLE_LENGTH);
titleInput.setHint(Component.translatable("screen.rivencraft.age.title_hint")); titleInput.setHint(Component.translatable("screen.rivencraft.age.title_hint"));
addRenderableWidget(titleInput); addRenderableWidget(titleInput);
setInitialFocus(titleInput); setInitialFocus(titleInput);
addRenderableWidget(Button.builder(Component.translatable("screen.rivencraft.age.create"), button -> createAge()) createButton = addRenderableWidget(Button.builder(Component.translatable("screen.rivencraft.age.create"), button -> createAge())
.bounds(rightPage, top + 100, 59, 20) .bounds(leftPage, top + 100, 53, 20)
.build()); .build());
addRenderableWidget(Button.builder(Component.translatable("gui.cancel"), button -> onClose()) cancelButton = addRenderableWidget(Button.builder(Component.translatable("gui.cancel"), button -> onClose())
.bounds(rightPage + 65, top + 100, 59, 20) .bounds(leftPage + 57, top + 100, 53, 20)
.build()); .build());
titleInput.visible = pageIndex == 0;
createButton.visible = pageIndex == 0;
cancelButton.visible = pageIndex == 0;
} else { } else {
boolean requestPreview = preview == null; boolean requestPreview = preview == null;
if (requestPreview) { if (requestPreview) {
@@ -96,8 +117,10 @@ public final class DescriptiveBookScreen extends Screen implements ExplorableBoo
if (preview.supportsExploration()) { if (preview.supportsExploration()) {
exploreButton = addRenderableWidget(Button.builder( exploreButton = addRenderableWidget(Button.builder(
EXPLORE_ICON, button -> enterExploreOverlay()) EXPLORE_ICON, button -> enterExploreOverlay())
.bounds(left + 81, top + 145, 20, 20).build()); .bounds(left + 229, top + 145, 20, 20)
.tooltip(Tooltip.create(Component.translatable("screen.rivencraft.book.explore"))).build());
exploreButton.active = bookStandPos == null; exploreButton.active = bookStandPos == null;
exploreButton.visible = pageIndex == 0;
} }
if (requestPreview) { if (requestPreview) {
PacketDistributor.sendToServer(new RequestLinkPreviewPayload( PacketDistributor.sendToServer(new RequestLinkPreviewPayload(
@@ -132,50 +155,109 @@ public final class DescriptiveBookScreen extends Screen implements ExplorableBoo
public void render(GuiGraphics graphics, int mouseX, int mouseY, float partialTick) { public void render(GuiGraphics graphics, int mouseX, int mouseY, float partialTick) {
renderBook(graphics, partialTick); renderBook(graphics, partialTick);
super.render(graphics, mouseX, mouseY, partialTick); super.render(graphics, mouseX, mouseY, partialTick);
int left = (width - BOOK_WIDTH) / 2;
int top = (height - BOOK_HEIGHT) / 2;
if (mouseY >= top + 164 && mouseY < top + 195) {
if (pageIndex > 0 && mouseX >= left + 7 && mouseX < left + 35)
graphics.renderTooltip(font, Component.translatable("screen.rivencraft.book.previous_page"), mouseX, mouseY);
else if (pageIndex < pageCount() && mouseX >= left + 293 && mouseX < left + 320)
graphics.renderTooltip(font, Component.translatable("screen.rivencraft.book.next_page"), mouseX, mouseY);
}
} }
private void renderBook(GuiGraphics graphics, float partialTick) { private void renderBook(GuiGraphics graphics, float partialTick) {
int left = (width - BOOK_WIDTH) / 2; int left = (width - BOOK_WIDTH) / 2;
int top = (height - BOOK_HEIGHT) / 2; int top = (height - BOOK_HEIGHT) / 2;
graphics.blit(BOOK_TEXTURE, left, top, BOOK_WIDTH, BOOK_HEIGHT, 0, 0, LegacyBookArtwork.drawCover(graphics, left, top, true);
TEXTURE_WIDTH, TEXTURE_HEIGHT, TEXTURE_WIDTH, TEXTURE_HEIGHT);
if (pageIndex > 0) {
LegacyBookArtwork.drawLeftPage(graphics, left, top);
}
if (pageIndex == 0) {
if (age != null && preview != null) {
preview.render(graphics, left + LINK_PANEL_X, top + LINK_PANEL_Y,
LINK_PANEL_WIDTH, LINK_PANEL_HEIGHT, partialTick);
}
LegacyBookArtwork.drawPanelPage(graphics, left, top);
graphics.enableScissor(left + 38, top + 38, left + 154, top + 174);
renderFirstPageText(graphics, left, top);
graphics.disableScissor();
} else if (pageIndex < pageCount()) {
LegacyBookArtwork.drawFullPage(graphics, left, top);
renderWrittenPage(graphics, left, top);
}
String counter = pageIndex + "/" + pageCount();
graphics.drawString(font, counter, left + 165 - font.width(counter) / 2,
top + 185, 0xFF000000, false);
}
private int pageCount() {
// Older page-free Descriptive Books do not have a BOOK_WRITING component.
return Math.max(1, writing.entries().size());
}
private void renderFirstPageText(GuiGraphics graphics, int left, int top) {
int x = left + 40;
drawWrappedWithoutShadow(graphics, Component.translatable("screen.rivencraft.age.title"),
x, top + 40, 110);
if (age == null) { if (age == null) {
drawWrappedWithoutShadow(graphics, Component.translatable("screen.rivencraft.age.name_prompt"), drawWrappedWithoutShadow(graphics, Component.translatable("screen.rivencraft.age.name_prompt"),
left + 177, top + 45, 124); x, top + 52, 110);
} else { return;
preview.render(graphics, left + LINK_PANEL_X, top + LINK_PANEL_Y, LINK_PANEL_WIDTH, LINK_PANEL_HEIGHT, partialTick);
int detailsY = drawWrappedWithoutShadow(
graphics, Component.literal(age.name()), left + 177, top + 43, 124) + 3;
detailsY = Math.max(detailsY, top + 72);
if (generationProfile != null) {
Component profileName = generationProfile.getNamespace().equals("rivencraft")
? Component.translatable("generator.rivencraft." + generationProfile.getPath())
: Component.literal(generationProfile.toString());
detailsY = drawWrappedWithoutShadow(graphics,
Component.translatable("screen.rivencraft.age.generator", profileName),
left + 177, detailsY, 124) + 2;
}
if (traits != null) {
detailsY = drawTrait(graphics, "biomes", traitName("biome_distribution", traits.biomeDistribution()),
left + 177, detailsY);
detailsY = drawTrait(graphics, "lighting", traitName("lighting", traits.lighting()),
left + 177, detailsY);
detailsY = drawTrait(graphics, "weather", traitName("weather", traits.weather()),
left + 177, detailsY);
Component dayLength = traits.hasStoppedCelestialCycle()
? Component.translatable("trait.rivencraft.day_length.stopped")
: Component.literal(String.format(Locale.ROOT, "%.2fx", traits.celestialPeriod()));
detailsY = drawTrait(graphics, "day_length", dayLength, left + 177, detailsY);
detailsY = drawTrait(graphics, "celestial_angle",
Component.literal(String.format(Locale.ROOT, "%.0f°", traits.celestialAngle())),
left + 177, detailsY);
drawTrait(graphics, "celestial_phase",
Component.literal(String.format(Locale.ROOT, "%.0f%%", traits.celestialPhase() * 100.0F)),
left + 177, detailsY);
}
} }
int detailsY = drawWrappedWithoutShadow(graphics, Component.literal(age.name()),
x + 10, top + 52, 100) + 10;
if (generationProfile != null) {
Component profileName = generationProfile.getNamespace().equals("rivencraft")
? Component.translatable("generator.rivencraft." + generationProfile.getPath())
: Component.literal(generationProfile.toString());
detailsY = drawDescription(graphics,
Component.translatable("screen.rivencraft.age.generator", profileName),
x, detailsY, 110) + 2;
}
if (traits != null) {
detailsY = drawTrait(graphics, "biomes", traitName("biome_distribution", traits.biomeDistribution()), x, detailsY);
detailsY = drawTrait(graphics, "lighting", traitName("lighting", traits.lighting()), x, detailsY);
detailsY = drawTrait(graphics, "weather", traitName("weather", traits.weather()), x, detailsY);
Component dayLength = traits.hasStoppedCelestialCycle()
? Component.translatable("trait.rivencraft.day_length.stopped")
: Component.literal(String.format(Locale.ROOT, "%.2fx", traits.celestialPeriod()));
detailsY = drawTrait(graphics, "day_length", dayLength, x, detailsY);
detailsY = drawTrait(graphics, "celestial_angle",
Component.literal(String.format(Locale.ROOT, "%.0f°", traits.celestialAngle())), x, detailsY);
drawTrait(graphics, "celestial_phase",
Component.literal(String.format(Locale.ROOT, "%.0f%%", traits.celestialPhase() * 100.0F)), x, detailsY);
}
}
private void renderWrittenPage(GuiGraphics graphics, int left, int top) {
WritingEntry entry = writing.entries().get(pageIndex);
int x = left + 176;
if (entry.kind() == WritingEntry.Kind.LINK_PANEL) {
drawWrappedWithoutShadow(graphics, Component.translatable("item.rivencraft.page.link_panel"),
x, top + 39, 126);
return;
}
int symbolIndex = (int) writing.entries().subList(0, pageIndex + 1).stream()
.filter(candidate -> candidate.kind() == WritingEntry.Kind.SYMBOL).count() - 1;
SymbolDisplayMetadata display = symbolIndex < writingSymbols.size()
? writingSymbols.get(symbolIndex) : SymbolDisplayMetadata.unresolved(entry.symbol().orElseThrow());
int color = display.resolved() ? BOOK_TEXT_COLOR : UNRESOLVED_TEXT_COLOR;
drawWrappedWithoutShadow(graphics, Component.translatable(display.nameTranslationKey()),
x, top + 39, 126, color);
drawWrappedWithoutShadow(graphics, Component.literal(display.id().toString()),
x, top + 64, 126, color);
}
private void turnPage(int direction) {
int nextPage = Math.max(0, Math.min(pageCount(), pageIndex + direction));
if (nextPage == pageIndex) return;
pageIndex = nextPage;
minecraft.getSoundManager().play(SimpleSoundInstance.forUI(SoundEvents.BOOK_PAGE_TURN, 1.0F, 0.65F));
if (titleInput != null) titleInput.visible = pageIndex == 0;
if (createButton != null) createButton.visible = pageIndex == 0;
if (cancelButton != null) cancelButton.visible = pageIndex == 0;
if (exploreButton != null) exploreButton.visible = pageIndex == 0;
} }
@Override @Override
@@ -201,14 +283,25 @@ public final class DescriptiveBookScreen extends Screen implements ExplorableBoo
resetExploration(); resetExploration();
return true; return true;
} }
if (age != null && button == 0) { if (button == 0) {
int panelLeft = (width - BOOK_WIDTH) / 2 + LINK_PANEL_X; int left = (width - BOOK_WIDTH) / 2;
int panelTop = (height - BOOK_HEIGHT) / 2 + LINK_PANEL_Y; int top = (height - BOOK_HEIGHT) / 2;
if (mouseX >= panelLeft && mouseX < panelLeft + LINK_PANEL_WIDTH if (pageIndex == 0 && age != null
&& mouseY >= panelTop && mouseY < panelTop + LINK_PANEL_HEIGHT) { && mouseX >= left + LINK_PANEL_X && mouseX < left + LINK_PANEL_X + LINK_PANEL_WIDTH
&& mouseY >= top + LINK_PANEL_Y && mouseY < top + LINK_PANEL_Y + LINK_PANEL_HEIGHT) {
link(); link();
return true; return true;
} }
if (mouseY >= top + 164 && mouseY < top + 195) {
if (pageIndex > 0 && mouseX >= left + 7 && mouseX < left + 35) {
turnPage(-1);
return true;
}
if (pageIndex < pageCount() && mouseX >= left + 293 && mouseX < left + 320) {
turnPage(1);
return true;
}
}
} }
return super.mouseClicked(mouseX, mouseY, button); return super.mouseClicked(mouseX, mouseY, button);
} }
@@ -224,6 +317,10 @@ public final class DescriptiveBookScreen extends Screen implements ExplorableBoo
@Override @Override
public boolean keyPressed(int keyCode, int scanCode, int modifiers) { public boolean keyPressed(int keyCode, int scanCode, int modifiers) {
if (titleInput == null || !titleInput.isFocused()) {
if (keyCode == GLFW.GLFW_KEY_LEFT && pageIndex > 0) { turnPage(-1); return true; }
if (keyCode == GLFW.GLFW_KEY_RIGHT && pageIndex < pageCount()) { turnPage(1); return true; }
}
return preview != null && preview.keyPressed(keyCode, scanCode) return preview != null && preview.keyPressed(keyCode, scanCode)
|| super.keyPressed(keyCode, scanCode, modifiers); || super.keyPressed(keyCode, scanCode, modifiers);
} }
@@ -268,7 +365,7 @@ public final class DescriptiveBookScreen extends Screen implements ExplorableBoo
int top = (height - BOOK_HEIGHT) / 2; int top = (height - BOOK_HEIGHT) / 2;
graphics.drawCenteredString(font, graphics.drawCenteredString(font,
Component.translatable("screen.rivencraft.book.return_from_explore"), Component.translatable("screen.rivencraft.book.return_from_explore"),
left + 91, top + 154, BOOK_TEXT_COLOR); left + 239, top + 154, BOOK_TEXT_COLOR);
} }
@Override @Override
@@ -316,8 +413,14 @@ 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, 124) + 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) {
@@ -326,8 +429,12 @@ public final class DescriptiveBookScreen extends Screen implements ExplorableBoo
} }
private int drawWrappedWithoutShadow(GuiGraphics graphics, Component text, int x, int y, int maxWidth) { private int drawWrappedWithoutShadow(GuiGraphics graphics, Component text, int x, int y, int maxWidth) {
return drawWrappedWithoutShadow(graphics, text, x, y, maxWidth, BOOK_TEXT_COLOR);
}
private int drawWrappedWithoutShadow(GuiGraphics graphics, Component text, int x, int y, int maxWidth, int color) {
for (FormattedCharSequence line : font.split(text, maxWidth)) { for (FormattedCharSequence line : font.split(text, maxWidth)) {
graphics.drawString(font, line, x, y, BOOK_TEXT_COLOR, false); graphics.drawString(font, line, x, y, color, false);
y += font.lineHeight; y += font.lineHeight;
} }
return y; return y;
@@ -0,0 +1,161 @@
package net.dnorberg.rivencraft.client.screen;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.item.InkVialItem;
import net.dnorberg.rivencraft.menu.InkMixerMenu;
import net.minecraft.client.gui.GuiGraphics;
import net.minecraft.client.gui.screens.inventory.AbstractContainerScreen;
import net.minecraft.network.chat.Component;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.entity.player.Inventory;
import net.minecraft.world.inventory.ClickType;
/** Legacy Ink Mixer atlas with a server-synced, sixteen-use basin. */
public final class InkMixerScreen extends AbstractContainerScreen<InkMixerMenu> {
private static final ResourceLocation BACKGROUND = ResourceLocation.fromNamespaceAndPath(
Rivencraft.MOD_ID, "textures/gui/ink_mixer_legacy.png");
private static final int BASIN_X = 88;
private static final int BASIN_Y = 49;
private static final int BASIN_RADIUS = 30;
// Legacy's registered property colors: Disarm red, Momentum blue, Intra green.
private static final int[] PROPERTY_COLORS = {0xFFE84848, 0xFF5555FF, 0xFF55EF55};
private final int[] lastChances = new int[3];
private boolean basinClickPendingRelease;
private long lastAdditionTime;
public InkMixerScreen(InkMixerMenu menu, Inventory inventory, Component title) {
super(menu, inventory, title);
imageWidth = 176;
imageHeight = 181;
inventoryLabelY = 87;
}
@Override public boolean isPauseScreen() { return false; }
@Override public void renderBackground(GuiGraphics graphics, int mouseX, int mouseY, float partialTick) {
renderBg(graphics, partialTick, mouseX, mouseY);
}
@Override protected void renderBg(GuiGraphics graphics, float partialTick, int mouseX, int mouseY) {
// Legacy draws this inset behind the transparent center of the main atlas.
graphics.blit(BACKGROUND, leftPos + 54, topPos + 16, 179, 16, 66, 65, 256, 256);
if (menu.inkRemaining() > 0) {
// Ink is a full dark basin in Legacy, rather than a vertical meter.
graphics.fill(leftPos + 54, topPos + 16, leftPos + 120, topPos + 81, 0xFF101014);
renderPropertyGlyph(graphics);
}
graphics.blit(BACKGROUND, leftPos, topPos, 0, 0, imageWidth, imageHeight, 256, 256);
}
@Override protected void renderLabels(GuiGraphics graphics, int mouseX, int mouseY) {
graphics.drawString(font, playerInventoryTitle, inventoryLabelX, inventoryLabelY, 0x404040, false);
}
@Override public void render(GuiGraphics graphics, int mouseX, int mouseY, float partialTick) {
super.render(graphics, mouseX, mouseY, partialTick);
renderTooltip(graphics, mouseX, mouseY);
if (overBasin(mouseX, mouseY)) {
var lines = new java.util.ArrayList<Component>();
lines.add(Component.translatable("screen.rivencraft.ink_mixer.ink",
menu.inkRemaining(), InkVialItem.CAPACITY));
lines.add(Component.translatable("screen.rivencraft.ink_mixer.additive_hint"));
for (int index = 0; index < 3; index++) {
int chance = menu.modifierChancePermille(index);
if (chance > 0) lines.add(Component.translatable("screen.rivencraft.ink_mixer.chance",
switch (index) {
case 0 -> Component.translatable("item.rivencraft.link_property.disarm");
case 1 -> Component.translatable("item.rivencraft.link_property.maintain_momentum");
default -> Component.translatable("item.rivencraft.link_property.intra_linking");
}, chance / 10.0));
}
graphics.renderTooltip(font, lines, java.util.Optional.empty(), mouseX, mouseY);
}
}
@Override public boolean mouseClicked(double mouseX, double mouseY, int button) {
if ((button == 0 || button == 1) && overBasin(mouseX, mouseY)
&& !menu.getCarried().isEmpty()) {
slotClicked(menu.getSlot(InkMixerMenu.MODIFIER), InkMixerMenu.MODIFIER, button, ClickType.PICKUP);
basinClickPendingRelease = true;
return true;
}
return super.mouseClicked(mouseX, mouseY, button);
}
@Override public boolean mouseReleased(double mouseX, double mouseY, int button) {
if (basinClickPendingRelease) {
basinClickPendingRelease = false;
return true;
}
return super.mouseReleased(mouseX, mouseY, button);
}
private boolean overBasin(double mouseX, double mouseY) {
double x = mouseX - leftPos - BASIN_X;
double y = mouseY - topPos - BASIN_Y;
return x * x + y * y < BASIN_RADIUS * BASIN_RADIUS;
}
/** A GUI-scale projection of Legacy's colored, rotating D'ni ink effect. */
private void renderPropertyGlyph(GuiGraphics graphics) {
long now = System.currentTimeMillis();
int[] active = new int[3];
int count = 0;
int strongest = 0;
for (int index = 0; index < lastChances.length; index++) {
int chance = menu.modifierChancePermille(index);
if (chance > lastChances[index]) lastAdditionTime = now;
lastChances[index] = chance;
if (chance > 0) {
active[count++] = index;
strongest = Math.max(strongest, chance);
}
}
if (count == 0) {
lastAdditionTime = 0;
return;
}
double cycle = now / 1800.0;
int first = active[(int) cycle % count];
int second = active[((int) cycle + 1) % count];
double blend = (1.0 - Math.cos((cycle % 1.0) * Math.PI)) / 2.0;
int rgb = blendRgb(PROPERTY_COLORS[first], PROPERTY_COLORS[second], blend);
double pulse = Math.max(0.0, 1.0 - (now - lastAdditionTime) / 700.0);
int alpha = Math.clamp((int) (70 + strongest * 0.14 + pulse * 45), 0, 255);
int color = alpha << 24 | rgb;
int centerX = leftPos + BASIN_X;
int centerY = topPos + BASIN_Y;
double turn = now / 1200.0;
for (int spoke = 0; spoke < 4; spoke++) {
for (int step = 0; step <= 30; step++) {
double progress = step / 30.0;
double angle = turn + spoke * Math.PI / 2.0 + progress * 0.9;
double radius = 3.0 + progress * (15.0 + pulse * 3.0);
plot(graphics, centerX + Math.cos(angle) * radius,
centerY + Math.sin(angle) * radius, color);
}
}
for (int step = 0; step < 96; step++) {
double angle = step * Math.PI / 48.0 + turn * 0.3;
plot(graphics, centerX + Math.cos(angle) * 19.0,
centerY + Math.sin(angle) * 19.0, color);
if (strongest >= 990 && step % 2 == 0) {
plot(graphics, centerX + Math.cos(angle) * 23.0,
centerY + Math.sin(angle) * 23.0, color);
}
}
}
private static int blendRgb(int first, int second, double amount) {
int red = (int) (((first >> 16) & 0xFF) * (1.0 - amount)
+ ((second >> 16) & 0xFF) * amount);
int green = (int) (((first >> 8) & 0xFF) * (1.0 - amount)
+ ((second >> 8) & 0xFF) * amount);
int blue = (int) ((first & 0xFF) * (1.0 - amount) + (second & 0xFF) * amount);
return red << 16 | green << 8 | blue;
}
private static void plot(GuiGraphics graphics, double x, double y, int color) {
int pixelX = (int) Math.round(x);
int pixelY = (int) Math.round(y);
graphics.fill(pixelX, pixelY, pixelX + 1, pixelY + 1, color);
}
}
@@ -0,0 +1,48 @@
package net.dnorberg.rivencraft.client.screen;
import net.minecraft.client.gui.GuiGraphics;
import net.minecraft.resources.ResourceLocation;
/** Original Mystcraft Legacy book atlases and page composition (LGPL-3.0,
* copyright XCompWiz, revision 9bc8ddc061845df0cd5ea47f4fdef773cff786ae). */
final class LegacyBookArtwork {
private static final int ATLAS_SIZE = 256;
private static final ResourceLocation COVER = texture("bookui_cover.png");
private static final ResourceLocation LEFT_PAGE = texture("bookui_pagel.png");
private static final ResourceLocation RIGHT_PANEL = texture("bookui_pager.png");
private static final ResourceLocation RIGHT_FULL = texture("bookui_rpage_full.png");
private LegacyBookArtwork() {}
static void drawCover(GuiGraphics graphics, int left, int top, boolean gilded) {
blit(graphics, COVER, left, top + 7, 34, 192, 152, 0);
blit(graphics, COVER, left + 34, top + 7, 103, 192, 49, 0);
blit(graphics, COVER, left + 137, top + 7, 4, 192, 45, 0);
blit(graphics, COVER, left + 141, top + 7, 186, 192, 0, 0);
if (gilded) {
blit(graphics, COVER, left, top + 7, 34, 192, 186, 0);
blit(graphics, COVER, left + 293, top + 7, 34, 192, 186, 0);
}
}
static void drawLeftPage(GuiGraphics graphics, int left, int top) {
blit(graphics, LEFT_PAGE, left + 7, top, 156, 195, 0, 0);
}
static void drawPanelPage(GuiGraphics graphics, int left, int top) {
blit(graphics, RIGHT_PANEL, left + 163, top, 156, 195, 0, 0);
}
static void drawFullPage(GuiGraphics graphics, int left, int top) {
blit(graphics, RIGHT_FULL, left + 163, top, 156, 195, 0, 0);
}
private static ResourceLocation texture(String filename) {
return ResourceLocation.fromNamespaceAndPath("rivencraft", "textures/gui/" + filename);
}
private static void blit(GuiGraphics graphics, ResourceLocation texture, int x, int y,
int width, int height, int u, int v) {
graphics.blit(texture, x, y, width, height, u, v, width, height, ATLAS_SIZE, ATLAS_SIZE);
}
}
@@ -16,28 +16,28 @@ import net.dnorberg.rivencraft.item.LinkingBookItem;
import net.minecraft.client.gui.GuiGraphics; import net.minecraft.client.gui.GuiGraphics;
import net.minecraft.client.gui.components.Button; import net.minecraft.client.gui.components.Button;
import net.minecraft.client.gui.components.EditBox; import net.minecraft.client.gui.components.EditBox;
import net.minecraft.client.gui.components.Tooltip;
import net.minecraft.client.gui.screens.Screen; import net.minecraft.client.gui.screens.Screen;
import net.minecraft.client.resources.sounds.SimpleSoundInstance;
import net.minecraft.core.BlockPos; import net.minecraft.core.BlockPos;
import net.minecraft.core.component.DataComponents;
import net.minecraft.network.chat.Component; import net.minecraft.network.chat.Component;
import net.minecraft.resources.ResourceLocation; import net.minecraft.network.chat.contents.TranslatableContents;
import net.minecraft.sounds.SoundEvents;
import net.minecraft.util.FormattedCharSequence; import net.minecraft.util.FormattedCharSequence;
import net.minecraft.world.InteractionHand; import net.minecraft.world.InteractionHand;
import net.minecraft.world.item.ItemStack; import net.minecraft.world.item.ItemStack;
import net.neoforged.neoforge.network.PacketDistributor; import net.neoforged.neoforge.network.PacketDistributor;
import org.lwjgl.glfw.GLFW;
public final class LinkingBookScreen extends Screen implements ExplorableBookScreen { public final class LinkingBookScreen extends Screen implements ExplorableBookScreen {
private static final int BOOK_TEXT_COLOR = 0xFF3B281B; private static final int BOOK_TEXT_COLOR = 0xFF3B281B;
private static final ResourceLocation BOOK_TEXTURE = ResourceLocation.fromNamespaceAndPath(
"rivencraft", "textures/gui/linking_book.png"
);
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 TEXTURE_WIDTH = 512; private static final int PREVIEW_X = 173;
private static final int TEXTURE_HEIGHT = 312; private static final int PREVIEW_Y = 20;
private static final int PREVIEW_X = 28; private static final int PREVIEW_WIDTH = 132;
private static final int PREVIEW_Y = 35; private static final int PREVIEW_HEIGHT = 83;
private static final int PREVIEW_WIDTH = 126;
private static final int PREVIEW_HEIGHT = 86;
private static final Component EXPLORE_ICON = Component.literal("👁"); private static final Component EXPLORE_ICON = Component.literal("👁");
private final InteractionHand hand; private final InteractionHand hand;
@@ -47,6 +47,9 @@ public final class LinkingBookScreen extends Screen implements ExplorableBookScr
private DestinationPreviewRenderer preview; private DestinationPreviewRenderer preview;
private EditBox titleInput; private EditBox titleInput;
private Button exploreButton; private Button exploreButton;
private Button bindButton;
private Button cancelButton;
private int pageIndex;
private boolean movingToExploreOverlay; private boolean movingToExploreOverlay;
public LinkingBookScreen(InteractionHand hand, ItemStack book) { public LinkingBookScreen(InteractionHand hand, ItemStack book) {
@@ -70,19 +73,22 @@ public final class LinkingBookScreen extends Screen implements ExplorableBookScr
int left = (width - BOOK_WIDTH) / 2; int left = (width - BOOK_WIDTH) / 2;
int top = (height - BOOK_HEIGHT) / 2; int top = (height - BOOK_HEIGHT) / 2;
if (target == null) { if (target == null) {
int rightPage = left + 177; int leftPage = left + 40;
titleInput = new EditBox(font, rightPage, top + 69, 124, 20, titleInput = new EditBox(font, leftPage, top + 69, 110, 20,
Component.translatable("screen.rivencraft.book.title")); Component.translatable("screen.rivencraft.book.title"));
titleInput.setMaxLength(ModNetworking.MAX_BOOK_TITLE_LENGTH); titleInput.setMaxLength(ModNetworking.MAX_BOOK_TITLE_LENGTH);
titleInput.setHint(Component.translatable("screen.rivencraft.book.title_hint")); titleInput.setHint(Component.translatable("screen.rivencraft.book.title_hint"));
addRenderableWidget(titleInput); addRenderableWidget(titleInput);
setInitialFocus(titleInput); setInitialFocus(titleInput);
addRenderableWidget(Button.builder(Component.translatable("screen.rivencraft.book.bind"), button -> bind()) bindButton = addRenderableWidget(Button.builder(Component.translatable("screen.rivencraft.book.bind"), button -> bind())
.bounds(rightPage, top + 100, 59, 20) .bounds(leftPage, top + 100, 53, 20)
.build()); .build());
addRenderableWidget(Button.builder(Component.translatable("gui.cancel"), button -> onClose()) cancelButton = addRenderableWidget(Button.builder(Component.translatable("gui.cancel"), button -> onClose())
.bounds(rightPage + 65, top + 100, 59, 20) .bounds(leftPage + 57, top + 100, 53, 20)
.build()); .build());
titleInput.visible = pageIndex == 0;
bindButton.visible = pageIndex == 0;
cancelButton.visible = pageIndex == 0;
} else { } else {
boolean requestPreview = preview == null; boolean requestPreview = preview == null;
if (requestPreview) { if (requestPreview) {
@@ -91,8 +97,10 @@ public final class LinkingBookScreen extends Screen implements ExplorableBookScr
if (preview.supportsExploration()) { if (preview.supportsExploration()) {
exploreButton = addRenderableWidget(Button.builder( exploreButton = addRenderableWidget(Button.builder(
EXPLORE_ICON, button -> enterExploreOverlay()) EXPLORE_ICON, button -> enterExploreOverlay())
.bounds(left + 81, top + 145, 20, 20).build()); .bounds(left + 229, top + 145, 20, 20)
.tooltip(Tooltip.create(Component.translatable("screen.rivencraft.book.explore"))).build());
exploreButton.active = bookStandPos == null; exploreButton.active = bookStandPos == null;
exploreButton.visible = pageIndex == 0;
} }
if (requestPreview) { if (requestPreview) {
PacketDistributor.sendToServer(new RequestLinkPreviewPayload( PacketDistributor.sendToServer(new RequestLinkPreviewPayload(
@@ -128,33 +136,55 @@ public final class LinkingBookScreen extends Screen implements ExplorableBookScr
public void render(GuiGraphics graphics, int mouseX, int mouseY, float partialTick) { public void render(GuiGraphics graphics, int mouseX, int mouseY, float partialTick) {
renderBook(graphics, partialTick); renderBook(graphics, partialTick);
super.render(graphics, mouseX, mouseY, partialTick); super.render(graphics, mouseX, mouseY, partialTick);
int left = (width - BOOK_WIDTH) / 2;
int top = (height - BOOK_HEIGHT) / 2;
if (mouseY >= top + 164 && mouseY < top + 195) {
if (pageIndex > 0 && mouseX >= left + 7 && mouseX < left + 35)
graphics.renderTooltip(font, Component.translatable("screen.rivencraft.book.previous_page"), mouseX, mouseY);
else if (pageIndex == 0 && mouseX >= left + 293 && mouseX < left + 320)
graphics.renderTooltip(font, Component.translatable("screen.rivencraft.book.next_page"), mouseX, mouseY);
}
} }
private void renderBook(GuiGraphics graphics, float partialTick) { private void renderBook(GuiGraphics graphics, float partialTick) {
int left = (width - BOOK_WIDTH) / 2; int left = (width - BOOK_WIDTH) / 2;
int top = (height - BOOK_HEIGHT) / 2; int top = (height - BOOK_HEIGHT) / 2;
graphics.blit(BOOK_TEXTURE, left, top, BOOK_WIDTH, BOOK_HEIGHT, 0, 0, LegacyBookArtwork.drawCover(graphics, left, top, false);
TEXTURE_WIDTH, TEXTURE_HEIGHT, TEXTURE_WIDTH, TEXTURE_HEIGHT); if (pageIndex > 0) {
LegacyBookArtwork.drawLeftPage(graphics, left, top);
if (target == null) {
drawWrappedWithoutShadow(graphics, Component.translatable("screen.rivencraft.book.name_prompt"),
left + 177, top + 45, 124);
} else { } else {
int previewLeft = left + PREVIEW_X; if (target != null && preview != null) {
int previewTop = top + PREVIEW_Y; preview.render(graphics, left + PREVIEW_X, top + PREVIEW_Y,
preview.render(graphics, previewLeft, previewTop, PREVIEW_WIDTH, PREVIEW_HEIGHT, partialTick); PREVIEW_WIDTH, PREVIEW_HEIGHT, partialTick);
}
int rightCenter = left + 239; LegacyBookArtwork.drawPanelPage(graphics, left, top);
drawWrappedWithoutShadow(graphics, title, left + 177, top + 43, 124); graphics.enableScissor(left + 38, top + 38, left + 154, top + 174);
BlockPos pos = target.location().pos(); if (target == null) {
drawCenteredWithoutShadow(graphics, drawWrappedWithoutShadow(graphics, Component.translatable("screen.rivencraft.book.name_prompt"),
LinkingBookItem.destinationName(book, target), rightCenter, top + 76); left + 40, top + 43, 110);
drawCenteredWithoutShadow(graphics, } else {
Component.literal(pos.getX() + ", " + pos.getY() + ", " + pos.getZ()), rightCenter, top + 89); int x = left + 40;
drawCenteredWithoutShadow(graphics, Component customName = book.get(DataComponents.CUSTOM_NAME);
Component.translatable("screen.rivencraft.book.click_to_link"), rightCenter, top + 119); boolean returnLink = customName != null
&& customName.getContents() instanceof TranslatableContents translated
&& translated.getKey().equals("item.rivencraft.linking_book.return");
if (!returnLink) {
drawWrappedWithoutShadow(graphics, title, x, top + 40, 110);
}
int destinationY = returnLink ? top + 40 : top + 58;
drawWrappedWithoutShadow(graphics, LinkingBookItem.destinationName(book, target),
x + 10, destinationY, 100);
BlockPos pos = target.location().pos();
drawWrappedWithoutShadow(graphics,
Component.literal(pos.getX() + ", " + pos.getY() + ", " + pos.getZ()),
x, destinationY + 28, 110);
}
graphics.disableScissor();
} }
String counter = pageIndex + "/1";
graphics.drawString(font, counter, left + 165 - font.width(counter) / 2,
top + 185, 0xFF000000, false);
} }
@Override @Override
@@ -163,18 +193,39 @@ public final class LinkingBookScreen extends Screen implements ExplorableBookScr
resetExploration(); resetExploration();
return true; return true;
} }
if (target != null && button == 0) { if (button == 0) {
int left = (width - BOOK_WIDTH) / 2 + PREVIEW_X; int left = (width - BOOK_WIDTH) / 2;
int top = (height - BOOK_HEIGHT) / 2 + PREVIEW_Y; int top = (height - BOOK_HEIGHT) / 2;
if (mouseX >= left && mouseX < left + PREVIEW_WIDTH if (pageIndex == 0 && target != null
&& mouseY >= top && mouseY < top + PREVIEW_HEIGHT) { && mouseX >= left + PREVIEW_X && mouseX < left + PREVIEW_X + PREVIEW_WIDTH
&& mouseY >= top + PREVIEW_Y && mouseY < top + PREVIEW_Y + PREVIEW_HEIGHT) {
link(); link();
return true; return true;
} }
if (mouseY >= top + 164 && mouseY < top + 195) {
if (pageIndex > 0 && mouseX >= left + 7 && mouseX < left + 35) {
turnPage(0);
return true;
}
if (pageIndex == 0 && mouseX >= left + 293 && mouseX < left + 320) {
turnPage(1);
return true;
}
}
} }
return super.mouseClicked(mouseX, mouseY, button); return super.mouseClicked(mouseX, mouseY, button);
} }
private void turnPage(int page) {
if (pageIndex == page) return;
pageIndex = page;
minecraft.getSoundManager().play(SimpleSoundInstance.forUI(SoundEvents.BOOK_PAGE_TURN, 1.0F, 0.65F));
if (titleInput != null) titleInput.visible = pageIndex == 0;
if (bindButton != null) bindButton.visible = pageIndex == 0;
if (cancelButton != null) cancelButton.visible = pageIndex == 0;
if (exploreButton != null) exploreButton.visible = pageIndex == 0;
}
@Override @Override
public void removed() { public void removed() {
if (preview != null && !movingToExploreOverlay) { if (preview != null && !movingToExploreOverlay) {
@@ -197,6 +248,10 @@ public final class LinkingBookScreen extends Screen implements ExplorableBookScr
@Override @Override
public boolean keyPressed(int keyCode, int scanCode, int modifiers) { public boolean keyPressed(int keyCode, int scanCode, int modifiers) {
if (titleInput == null || !titleInput.isFocused()) {
if (keyCode == GLFW.GLFW_KEY_LEFT && pageIndex > 0) { turnPage(0); return true; }
if (keyCode == GLFW.GLFW_KEY_RIGHT && pageIndex == 0) { turnPage(1); return true; }
}
return preview != null && preview.keyPressed(keyCode, scanCode) return preview != null && preview.keyPressed(keyCode, scanCode)
|| super.keyPressed(keyCode, scanCode, modifiers); || super.keyPressed(keyCode, scanCode, modifiers);
} }
@@ -247,7 +302,7 @@ public final class LinkingBookScreen extends Screen implements ExplorableBookScr
int top = (height - BOOK_HEIGHT) / 2; int top = (height - BOOK_HEIGHT) / 2;
drawCenteredWithoutShadow(graphics, drawCenteredWithoutShadow(graphics,
Component.translatable("screen.rivencraft.book.return_from_explore"), Component.translatable("screen.rivencraft.book.return_from_explore"),
left + 91, top + 154); left + 239, top + 154);
} }
@Override @Override
@@ -3,8 +3,10 @@ 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.dnorberg.rivencraft.writing.PageContent;
import net.minecraft.client.gui.GuiGraphics; import net.minecraft.client.gui.GuiGraphics;
import net.minecraft.client.gui.components.Button; import net.minecraft.client.gui.components.Button;
import net.minecraft.client.gui.components.EditBox; import net.minecraft.client.gui.components.EditBox;
@@ -26,14 +28,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;
@@ -47,6 +41,8 @@ public final class NotebookScreen extends AbstractContainerScreen<NotebookMenu>
inventoryLabelY = 123; inventoryLabelY = 123;
} }
@Override public boolean isPauseScreen() { return false; }
@Override @Override
protected void init() { protected void init() {
super.init(); super.init();
@@ -120,7 +116,8 @@ public final class NotebookScreen extends AbstractContainerScreen<NotebookMenu>
if (index >= 0 && (button == 0 || button == 1)) { if (index >= 0 && (button == 0 || button == 1)) {
ItemStack page = menu.getSlot(index).getItem(); ItemStack page = menu.getSlot(index).getItem();
if ((!page.isEmpty() && !matchesSearch(page)) if ((!page.isEmpty() && !matchesSearch(page))
|| (page.isEmpty() && !menu.getCarried().is(ModItems.PAGE.get()))) { || (page.isEmpty() && (!menu.getCarried().is(ModItems.PAGE.get())
|| PageItem.content(menu.getCarried()).kind() == PageContent.Kind.LINK_PANEL))) {
return true; return true;
} }
setFocused(null); setFocused(null);
@@ -260,7 +257,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) {
@@ -272,23 +269,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,8 +5,11 @@ 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.writing.PageContent;
import net.dnorberg.rivencraft.menu.WritingDeskMenu; import net.dnorberg.rivencraft.menu.WritingDeskMenu;
import net.dnorberg.rivencraft.block.entity.WritingDeskBlockEntity;
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.NotebookContents; import net.dnorberg.rivencraft.writing.NotebookContents;
@@ -14,18 +17,23 @@ import net.dnorberg.rivencraft.writing.SymbolDisplayMetadata;
import net.minecraft.client.gui.GuiGraphics; import net.minecraft.client.gui.GuiGraphics;
import net.minecraft.client.gui.components.Button; import net.minecraft.client.gui.components.Button;
import net.minecraft.client.gui.components.EditBox; import net.minecraft.client.gui.components.EditBox;
import net.minecraft.client.gui.components.Tooltip;
import net.minecraft.client.gui.screens.inventory.AbstractContainerScreen; import net.minecraft.client.gui.screens.inventory.AbstractContainerScreen;
import net.minecraft.network.chat.Component; import net.minecraft.network.chat.Component;
import net.minecraft.resources.ResourceLocation; import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.entity.player.Inventory; import net.minecraft.world.entity.player.Inventory;
import net.minecraft.world.inventory.Slot;
import net.minecraft.world.item.ItemStack; import net.minecraft.world.item.ItemStack;
import org.lwjgl.glfw.GLFW;
/** Functional storage surface; full Legacy transcription controls are a later Milestone 4 slice. */ /** Legacy desk atlas layout, with four visible tabs out of the desk's 88 collections. */
public final class WritingDeskScreen extends AbstractContainerScreen<WritingDeskMenu> { public final class WritingDeskScreen extends AbstractContainerScreen<WritingDeskMenu> {
private static final ResourceLocation PAGE_ATLAS = ResourceLocation.fromNamespaceAndPath( private static final ResourceLocation PAGE_ATLAS = ResourceLocation.fromNamespaceAndPath(
Rivencraft.MOD_ID, "textures/gui/notebook_pages.png"); Rivencraft.MOD_ID, "textures/gui/notebook_pages.png");
private static final ResourceLocation LEGACY_DESK = ResourceLocation.fromNamespaceAndPath( private static final ResourceLocation LEGACY_DESK = ResourceLocation.fromNamespaceAndPath(
Rivencraft.MOD_ID, "textures/gui/writing_desk_legacy.png"); Rivencraft.MOD_ID, "textures/gui/writing_desk_legacy.png");
private static final ResourceLocation SCROLLBAR = ResourceLocation.fromNamespaceAndPath(
Rivencraft.MOD_ID, "textures/gui/scrollbar.png");
private int lastCollection = -1; private int lastCollection = -1;
private int selectedPage; private int selectedPage;
private int scrollRows; private int scrollRows;
@@ -39,20 +47,32 @@ public final class WritingDeskScreen extends AbstractContainerScreen<WritingDesk
private Button sortButton; private Button sortButton;
private boolean draggingScrollbar; private boolean draggingScrollbar;
private record DisplayPage(int collection, int index, ItemStack stack) {} private record DisplayPage(int collection, int index, ItemStack stack) {}
private DisplayPage pageDragSource;
private double pageDragStartX;
private double pageDragStartY;
private boolean draggingPage;
private boolean isPhysicalPageView() {
return !allMode && !sortAlphabetically && selectedCategory == null
&& (search == null || search.getValue().isBlank());
}
public WritingDeskScreen(WritingDeskMenu menu, Inventory inventory, Component title) { public WritingDeskScreen(WritingDeskMenu menu, Inventory inventory, Component title) {
super(menu, inventory, title); super(menu, inventory, title);
imageWidth = 398; imageWidth = 409;
imageHeight = 176; imageHeight = 186;
titleLabelX = 222; titleLabelX = 222;
} }
@Override public boolean isPauseScreen() { return false; }
@Override protected void init() { @Override protected void init() {
super.init(); super.init();
sortButton = addRenderableWidget(Button.builder(Component.literal("AZ"), button -> { sortButton = addRenderableWidget(Button.builder(Component.literal("AZ"), button -> {
sortAlphabetically = !sortAlphabetically; sortAlphabetically = !sortAlphabetically;
scrollRows = 0; scrollRows = 0;
}).bounds(leftPos + 58, topPos - 18, 20, 18).build()); }).bounds(leftPos + 58, topPos, 20, 18)
.tooltip(Tooltip.create(Component.translatable("screen.rivencraft.writing_desk.sort"))).build());
allButton = addRenderableWidget(Button.builder(Component.literal("ALL"), button -> { allButton = addRenderableWidget(Button.builder(Component.literal("ALL"), button -> {
allMode = !allMode; allMode = !allMode;
scrollRows = 0; scrollRows = 0;
@@ -60,10 +80,11 @@ public final class WritingDeskScreen extends AbstractContainerScreen<WritingDesk
selectedCollection = -1; selectedCollection = -1;
selectedPage = 0; selectedPage = 0;
if (minecraft != null && minecraft.gameMode != null) if (minecraft != null && minecraft.gameMode != null)
minecraft.gameMode.handleInventoryButtonClick(menu.containerId, menu.activeCollection()); minecraft.gameMode.handleInventoryButtonClick(menu.containerId, WritingDeskMenu.PAGE_BUTTON_BASE);
} }
}).bounds(leftPos + 80, topPos - 18, 28, 18).build()); }).bounds(leftPos + 80, topPos, 28, 18)
search = new EditBox(font, leftPos + 110, topPos - 18, 86, 18, .tooltip(Tooltip.create(Component.translatable("screen.rivencraft.writing_desk.all"))).build());
search = new EditBox(font, leftPos + 110, topPos, 101, 18,
Component.translatable("screen.rivencraft.writing_desk.search")); Component.translatable("screen.rivencraft.writing_desk.search"));
search.setMaxLength(64); search.setMaxLength(64);
search.setHint(Component.translatable("screen.rivencraft.writing_desk.search")); search.setHint(Component.translatable("screen.rivencraft.writing_desk.search"));
@@ -76,20 +97,22 @@ public final class WritingDeskScreen extends AbstractContainerScreen<WritingDesk
selectedCategory = next >= categories.size() ? null : categories.get(next); selectedCategory = next >= categories.size() ? null : categories.get(next);
categoryButton.setMessage(Component.literal(selectedCategory == null ? "C" : "C*")); categoryButton.setMessage(Component.literal(selectedCategory == null ? "C" : "C*"));
scrollRows = 0; scrollRows = 0;
}).bounds(leftPos + 198, topPos - 18, 18, 18).build()); }).bounds(leftPos + 213, topPos, 18, 18).build());
} }
private List<DisplayPage> filteredPages() { private List<DisplayPage> filteredPages() {
String query = search == null ? "" : search.getValue().trim().toLowerCase(Locale.ROOT); String query = search == null ? "" : search.getValue().trim().toLowerCase(Locale.ROOT);
List<DisplayPage> entries = new ArrayList<>(); List<DisplayPage> entries = new ArrayList<>();
int from = allMode ? 0 : menu.activeCollection(); int from = allMode ? 0 : menu.activeCollection();
int until = allMode ? 4 : from + 1; int until = allMode ? WritingDeskBlockEntity.COLLECTIONS : from + 1;
for (int collection = from; collection < until; collection++) { for (int collection = from; collection < until; collection++) {
List<ItemStack> pages = pages(collection); List<ItemStack> pages = pages(collection);
int last = -1; int last = -1;
for (int i = 0; i < pages.size(); i++) if (!pages.get(i).isEmpty()) last = i; for (int i = 0; i < pages.size(); i++) if (!pages.get(i).isEmpty()) last = i;
// A notebook has exactly its normal GUI capacity; a loose page has one position.
if (isPhysicalPageView()) last = menu.pageCapacity(collection) - 1;
for (int i = 0; i <= last; i++) { for (int i = 0; i <= last; i++) {
ItemStack page = pages.get(i); ItemStack page = i < pages.size() ? pages.get(i) : ItemStack.EMPTY;
if (page.isEmpty() && (allMode || sortAlphabetically || !query.isEmpty() || selectedCategory != null)) continue; if (page.isEmpty() && (allMode || sortAlphabetically || !query.isEmpty() || selectedCategory != null)) continue;
if (!page.isEmpty() && !query.isEmpty() if (!page.isEmpty() && !query.isEmpty()
&& !page.getHoverName().getString().toLowerCase(Locale.ROOT).contains(query) && !page.getHoverName().getString().toLowerCase(Locale.ROOT).contains(query)
@@ -118,47 +141,49 @@ public final class WritingDeskScreen extends AbstractContainerScreen<WritingDesk
@Override protected void renderBg(GuiGraphics graphics, float partialTick, int mouseX, int mouseY) { @Override protected void renderBg(GuiGraphics graphics, float partialTick, int mouseX, int mouseY) {
int x = leftPos; int x = leftPos;
int y = topPos; int y = topPos;
graphics.fill(x + 56, y + 14, x + 206, y + 168, 0xAA201B18); // Legacy GuiWritingDesk draws the entire 176x166 panel, not a stretched swatch.
graphics.blit(LEGACY_DESK, x, y + 5, 56, 9, 0, 166, 56, 9, 256, 256); graphics.blit(LEGACY_DESK, x + 233, y + 20, 0, 0, 176, 166);
graphics.blit(LEGACY_DESK, x, y + 166, 56, 9, 0, 215, 56, 9, 256, 256); drawTabControl(graphics, 20, 203, menu.firstVisibleTab() > 0);
graphics.blit(LEGACY_DESK, x + 218, y + 4, 178, 170, 64, 8, 16, 16, 256, 256);
for (int i = 0; i < 4; i++) { for (int i = 0; i < 4; i++) {
graphics.blit(LEGACY_DESK, x, y + 16 + i * 37, int tab = menu.firstVisibleTab() + i;
56, 36, 0, 166, 56, 54, 256, 256); int tabY = y + 29 + i * 37;
if (i == menu.activeCollection() && !allMode) if (tab == menu.activeCollection() && !allMode) graphics.setColor(0.5F, 0.5F, 1F, 1F);
graphics.fill(x + 2, y + 18 + i * 37, x + 54, y + 46 + i * 37, 0x885858CC); graphics.blit(LEGACY_DESK, x, tabY, 0, 166, 58, 37);
graphics.drawString(font, new String[]{"I", "II", "III", "IV"}[i], graphics.setColor(1F, 1F, 1F, 1F);
x + 8, y + 25 + i * 37, 0xFF181818, false); // Encode the visible one-based tab number with Legacy's numeric word glyph.
slotFrame(graphics, 36, 20 + i * 37); SymbolPageTextures.drawNumeral(graphics, tab + 1, x + 8, tabY + 3, 19);
ItemStack collection = menu.getSlot(tab).getItem();
if (!collection.isEmpty()) {
String name = collection.getHoverName().getString();
float scale = Math.min(1F, 50F / Math.max(1, font.width(name)));
graphics.pose().pushPose();
graphics.pose().translate(x + 4, tabY + 25, 0);
graphics.pose().scale(scale, scale, 1);
graphics.drawString(font, name, 0, 0, 0xFF404040, false);
graphics.pose().popPose();
}
} }
graphics.blit(LEGACY_DESK, x + 206, y + 14, 10, 130, 177, 0, 12, 166, 256, 256); drawTabControl(graphics, 177, 212, menu.firstVisibleTab() < WritingDeskBlockEntity.COLLECTIONS - 4);
// GuiElementVSlider: 4-pixel caps, repeated 22-pixel track, 12x15 thumb.
graphics.blit(SCROLLBAR, x + 213, y + 20, 0, 0, 20, 4, 32, 32);
for (int offset = 4; offset < 162; offset += 22)
graphics.blit(SCROLLBAR, x + 213, y + 20 + offset, 0, 4, 20, Math.min(22, 162 - offset), 32, 32);
graphics.blit(SCROLLBAR, x + 213, y + 182, 0, 26, 20, 4, 32, 32);
int totalRows = (filteredPages().size() + 4) / 5; int totalRows = (filteredPages().size() + 4) / 5;
int maxScroll = Math.max(0, totalRows - 3); int maxScroll = Math.max(0, totalRows - 4);
scrollRows = Math.clamp(scrollRows, 0, maxScroll); scrollRows = Math.clamp(scrollRows, 0, maxScroll);
int thumbHeight = Math.max(14, 126 * 3 / Math.max(3, totalRows)); int thumbY = y + 24 + (maxScroll == 0 ? 0 : scrollRows * 143 / maxScroll);
int thumbY = y + 16 + (maxScroll == 0 ? 0 : scrollRows * (126 - thumbHeight) / maxScroll); graphics.blit(SCROLLBAR, x + 217, thumbY, 20, draggingScrollbar ? 15 : 0, 12, 15, 32, 32);
graphics.fill(x + 207, thumbY, x + 215, thumbY + thumbHeight, 0xFFB7B7B7); graphics.fill(x + 365, y + 27, x + 381, y + 97, 0xFF303035);
graphics.renderOutline(x + 207, thumbY, 8, thumbHeight, 0xFF424242); graphics.fill(x + 366, y + 28, x + 380, y + 96, 0xFF6666AA);
slotFrame(graphics, 370, 9); int filled = 68 * menu.inkRemaining() / 16;
slotFrame(graphics, 228, 9); if (filled > 0) graphics.fill(x + 366, y + 96 - filled, x + 380, y + 96, 0xFF15151B);
slotFrame(graphics, 228, 57);
slotFrame(graphics, 370, 57);
graphics.fill(x + 350, y + 9, x + 364, y + 64, 0xFF303035);
graphics.fill(x + 352, y + 11, x + 362, y + 62, 0xFF15151B);
int filled = 51 * menu.inkRemaining() / 16;
if (filled > 0) graphics.fill(x + 352, y + 62 - filled, x + 362, y + 62, 0xFF6666AA);
graphics.renderOutline(x + 350, y + 9, 14, 55, 0xFF484848);
for (int row = 0; row < 3; row++) {
for (int column = 0; column < 9; column++) slotFrame(graphics, 224 + column * 18, 79 + row * 18);
}
for (int column = 0; column < 9; column++) slotFrame(graphics, 224 + column * 18, 137);
} }
private void slotFrame(GuiGraphics graphics, int x, int y) { private void drawTabControl(GuiGraphics graphics, int y, int textureY, boolean enabled) {
graphics.fill(leftPos + x - 1, topPos + y - 1, if (!enabled) graphics.setColor(0.4F, 0.4F, 0.4F, 1F);
leftPos + x + 17, topPos + y + 17, 0xFF4D4D4D); graphics.blit(LEGACY_DESK, leftPos, topPos + y, 0, textureY, 58, 9);
graphics.fill(leftPos + x, topPos + y, graphics.setColor(1F, 1F, 1F, 1F);
leftPos + x + 16, topPos + y + 16, 0xFF858585);
} }
@Override protected void renderLabels(GuiGraphics graphics, int mouseX, int mouseY) { @Override protected void renderLabels(GuiGraphics graphics, int mouseX, int mouseY) {
@@ -167,19 +192,42 @@ public final class WritingDeskScreen extends AbstractContainerScreen<WritingDesk
@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);
if (sortAlphabetically) graphics.renderOutline(leftPos + 58, topPos - 18, 20, 18, 0xFFFFD061); if (sortAlphabetically) graphics.renderOutline(leftPos + 58, topPos, 20, 18, 0xFFFFD061);
if (allMode) graphics.renderOutline(leftPos + 80, topPos - 18, 28, 18, 0xFFFFD061); if (allMode) graphics.renderOutline(leftPos + 80, topPos, 28, 18, 0xFFFFD061);
renderCollection(graphics); renderCollection(graphics);
if (draggingPage && pageDragSource != null) {
DisplayPage target = pageAtMouse(mouseX, mouseY);
if (target != null && canMovePage(pageDragSource, target)) {
int x = leftPos + 58 + ((int) mouseX - leftPos - 58) / 31 * 31;
int y = topPos + 20 + ((int) mouseY - topPos - 20) / 41 * 41;
graphics.renderOutline(x, y, 30, 40, 0xFF57D478);
}
graphics.renderItem(pageDragSource.stack(), mouseX - 8, mouseY - 8);
}
renderTooltip(graphics, mouseX, mouseY); renderTooltip(graphics, mouseX, mouseY);
if (mouseX >= leftPos + 350 && mouseX < leftPos + 364 if (mouseX >= leftPos + 365 && mouseX < leftPos + 381
&& mouseY >= topPos + 9 && mouseY < topPos + 64) { && mouseY >= topPos + 27 && mouseY < topPos + 97) {
graphics.renderTooltip(font, Component.translatable("screen.rivencraft.writing_desk.ink", graphics.renderTooltip(font, Component.translatable("screen.rivencraft.writing_desk.ink",
menu.inkRemaining(), 16), mouseX, mouseY); menu.inkRemaining(), 16), mouseX, mouseY);
} }
if (mouseX >= leftPos + 198 && mouseX < leftPos + 216 if (mouseX >= leftPos + 213 && mouseX < leftPos + 231
&& mouseY >= topPos - 18 && mouseY < topPos) { && mouseY >= topPos && mouseY < topPos + 18) {
graphics.renderTooltip(font, Component.literal(selectedCategory == null graphics.renderTooltip(font, Component.translatable("screen.rivencraft.writing_desk.category",
? "All categories" : selectedCategory.toString()), mouseX, mouseY); selectedCategory == null
? Component.translatable("screen.rivencraft.writing_desk.all_categories")
: Component.literal(selectedCategory.toString())), mouseX, mouseY);
}
if (mouseX >= leftPos && mouseX < leftPos + 58) {
int localY = mouseY - topPos;
if (localY >= 20 && localY < 29)
graphics.renderTooltip(font, Component.translatable("screen.rivencraft.writing_desk.previous_tabs"), mouseX, mouseY);
else if (localY >= 177 && localY < 186)
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);
}
} }
} }
@@ -200,13 +248,13 @@ public final class WritingDeskScreen extends AbstractContainerScreen<WritingDesk
selectedCollection = -1; selectedCollection = -1;
} }
List<DisplayPage> entries = filteredPages(); List<DisplayPage> entries = filteredPages();
for (int i = scrollRows * 5; i < entries.size() && i < scrollRows * 5 + 15; i++) { for (int i = scrollRows * 5; i < entries.size() && i < scrollRows * 5 + 20; i++) {
int column = i % 5; int column = i % 5;
int row = i / 5 - scrollRows; int row = i / 5 - scrollRows;
DisplayPage entry = entries.get(i); DisplayPage entry = entries.get(i);
ItemStack page = entry.stack(); ItemStack page = entry.stack();
int x = leftPos + 58 + column * 29; int x = leftPos + 58 + column * 31;
int y = topPos + 18 + row * 41; int y = topPos + 20 + row * 41;
drawPage(graphics, page, x, y); drawPage(graphics, page, x, y);
if (page.isEmpty()) graphics.fill(x, y, x + 30, y + 40, 0xB8000000); if (page.isEmpty()) graphics.fill(x, y, x + 30, y + 40, 0xB8000000);
int active = selectedCollection >= 0 ? selectedCollection : menu.activeCollection(); int active = selectedCollection >= 0 ? selectedCollection : menu.activeCollection();
@@ -217,10 +265,10 @@ public final class WritingDeskScreen extends AbstractContainerScreen<WritingDesk
List<ItemStack> source = pages(active); List<ItemStack> source = pages(active);
if (selectedPage >= source.size() || source.get(selectedPage).isEmpty()) return; if (selectedPage >= source.size() || source.get(selectedPage).isEmpty()) return;
ItemStack selected = source.get(selectedPage); ItemStack selected = source.get(selectedPage);
drawPage(graphics, selected, leftPos + 253, topPos + 10); drawPage(graphics, selected, leftPos + 265, topPos + 26);
String title = font.plainSubstrByWidth(selected.getHoverName().getString(), 84); String title = font.plainSubstrByWidth(selected.getHoverName().getString(), 95);
graphics.fill(leftPos + 251, topPos + 58, leftPos + 342, topPos + 73, 0xFF202020); graphics.fill(leftPos + 261, topPos + 81, leftPos + 360, topPos + 95, 0xFF202020);
graphics.drawString(font, title, leftPos + 254, topPos + 61, 0xFFE0E0E0, false); graphics.drawString(font, title, leftPos + 263, topPos + 84, 0xFFE0E0E0, false);
} }
private void drawPage(GuiGraphics graphics, ItemStack page, int x, int y) { private void drawPage(GuiGraphics graphics, ItemStack page, int x, int y) {
@@ -230,48 +278,122 @@ 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);
} }
} }
private DisplayPage pageAtMouse(double mouseX, double mouseY) {
int x = (int) Math.floor(mouseX - leftPos - 58);
int y = (int) Math.floor(mouseY - topPos - 20);
if (x < 0 || x >= 155 || y < 0 || y >= 164 || x % 31 >= 30 || y % 41 >= 40) return null;
int index = (y / 41 + scrollRows) * 5 + x / 31;
List<DisplayPage> entries = filteredPages();
return index < entries.size() ? entries.get(index) : null;
}
private boolean canMovePage(DisplayPage source, DisplayPage target) {
return !source.stack().isEmpty()
&& (menu.getSlot(source.collection()).getItem().is(ModItems.NOTEBOOK.get())
|| menu.getSlot(source.collection()).getItem().is(ModItems.PAGE.get()))
&& (menu.getSlot(target.collection()).getItem().is(ModItems.NOTEBOOK.get())
|| menu.getSlot(target.collection()).getItem().is(ModItems.PAGE.get()))
&& (source.collection() != target.collection() || source.index() != target.index());
}
private int extractTargetSlot(double mouseX, double mouseY) {
for (Slot slot : menu.slots) {
int index = slot.index;
if (index >= WritingDeskBlockEntity.COLLECTIONS && index <= WritingDeskMenu.COPY_RESULT) continue;
if (!slot.isActive() || !isHovering(slot.x, slot.y, 16, 16, mouseX, mouseY)) continue;
ItemStack held = pageDragSource.stack();
if (!slot.mayPlace(held)) return -1;
ItemStack current = slot.getItem();
if (current.isEmpty()) return index;
if (index < WritingDeskBlockEntity.COLLECTIONS && current.is(ModItems.NOTEBOOK.get())) {
List<ItemStack> pages = current.getOrDefault(
ModDataComponents.NOTEBOOK_CONTENTS.get(), NotebookContents.EMPTY).pages();
if (pages.size() < NotebookContents.MAX_PAGES || pages.stream().anyMatch(ItemStack::isEmpty))
return index;
} else if (index > WritingDeskMenu.COPY_RESULT && ItemStack.isSameItemSameComponents(current, held)
&& current.getCount() < slot.getMaxStackSize(held)) return index;
return -1;
}
return -1;
}
@Override public boolean mouseClicked(double mouseX, double mouseY, int button) { @Override public boolean mouseClicked(double mouseX, double mouseY, int button) {
if (button == 0) { if (button == 0) {
if (mouseX >= leftPos + 206 && mouseX < leftPos + 217 pageDragSource = null;
&& mouseY >= topPos + 14 && mouseY < topPos + 144) { draggingPage = false;
}
int surfaceX = (int) Math.floor(mouseX - leftPos - 58);
int surfaceY = (int) Math.floor(mouseY - topPos - 20);
if ((button == 0 || button == 1) && !menu.getCarried().isEmpty()
&& surfaceX >= 0 && surfaceX < 155 && surfaceY >= 0 && surfaceY < 164) {
if (menu.getCarried().is(ModItems.PAGE.get())
&& PageItem.content(menu.getCarried()).kind() != PageContent.Kind.LINK_PANEL
&& surfaceX % 31 < 30 && surfaceY % 41 < 40) {
int index = (surfaceY / 41 + scrollRows) * 5 + surfaceX / 31;
List<DisplayPage> entries = filteredPages();
// Only displayed positions are addressable. Filtering never turns
// empty screen space into additional storage for a loose-page tab.
int collection = index < entries.size() ? entries.get(index).collection() : menu.activeCollection();
int page = index < entries.size() ? entries.get(index).index() : index;
if (index < entries.size() && page < menu.pageCapacity(collection)
&& minecraft != null && minecraft.gameMode != null) {
minecraft.gameMode.handleInventoryButtonClick(menu.containerId,
WritingDeskMenu.PLACE_PAGE_BUTTON_BASE + collection * NotebookContents.MAX_PAGES + page);
}
}
return true;
}
if (button == 0) {
if (mouseX >= leftPos && mouseX < leftPos + 58) {
int y = (int) mouseY - topPos;
if (y >= 20 && y < 29 || y >= 177 && y < 186) {
if (minecraft != null && minecraft.gameMode != null)
minecraft.gameMode.handleInventoryButtonClick(menu.containerId,
y < 29 ? WritingDeskMenu.PREVIOUS_TABS : WritingDeskMenu.NEXT_TABS);
return true;
}
}
if (mouseX >= leftPos + 213 && mouseX < leftPos + 233
&& mouseY >= topPos + 20 && mouseY < topPos + 186) {
draggingScrollbar = true; draggingScrollbar = true;
setScrollFromMouse(mouseY); setScrollFromMouse(mouseY);
return true; return true;
} }
int x = (int) mouseX - leftPos - 58; int x = (int) Math.floor(mouseX - leftPos - 58);
int y = (int) mouseY - topPos - 18; int y = (int) Math.floor(mouseY - topPos - 20);
if (x >= 0 && x < 145 && y >= 0 && y < 123) { if (x >= 0 && x < 155 && y >= 0 && y < 164) {
int column = x / 29; DisplayPage entry = pageAtMouse(mouseX, mouseY);
int row = y / 41; if (entry != null && !entry.stack().isEmpty()) {
int index = (row + scrollRows) * 5 + column; selectedCollection = entry.collection();
List<DisplayPage> entries = filteredPages(); selectedPage = entry.index();
if (y % 41 < 40 && index < entries.size()) { if (menu.getCarried().isEmpty()) {
DisplayPage entry = entries.get(index); pageDragSource = entry;
if (!entry.stack().isEmpty()) { pageDragStartX = mouseX;
selectedCollection = entry.collection(); pageDragStartY = mouseY;
selectedPage = entry.index(); }
if (minecraft != null && minecraft.gameMode != null) { if (minecraft != null && minecraft.gameMode != null) {
int id = allMode ? 1000 + entry.collection() * NotebookContents.MAX_PAGES + entry.index() int id = WritingDeskMenu.ALL_PAGE_BUTTON_BASE
: 16 + entry.index(); + entry.collection() * NotebookContents.MAX_PAGES + entry.index();
minecraft.gameMode.handleInventoryButtonClick(menu.containerId, id); minecraft.gameMode.handleInventoryButtonClick(menu.containerId, id);
}
} }
} }
return true; return true;
} }
} }
if (button == 0 && mouseX >= leftPos && mouseX < leftPos + 35) { if (button == 0 && mouseX >= leftPos && mouseX < leftPos + 58) {
for (int i = 0; i < 4; i++) { for (int i = 0; i < 4; i++) {
int top = topPos + 16 + i * 37; int top = topPos + 29 + i * 37;
if (mouseY >= top && mouseY < top + 36) { boolean overSlot = mouseX >= leftPos + 36 && mouseX < leftPos + 54
&& mouseY >= top + 4 && mouseY < top + 22;
if (mouseY >= top && mouseY < top + 37 && !overSlot) {
allMode = false; allMode = false;
selectedCollection = -1; selectedCollection = -1;
if (minecraft != null && minecraft.gameMode != null) { if (minecraft != null && minecraft.gameMode != null) {
minecraft.gameMode.handleInventoryButtonClick(menu.containerId, i); minecraft.gameMode.handleInventoryButtonClick(menu.containerId, menu.firstVisibleTab() + i);
} }
return true; return true;
} }
@@ -281,10 +403,10 @@ public final class WritingDeskScreen extends AbstractContainerScreen<WritingDesk
} }
@Override public boolean mouseScrolled(double mouseX, double mouseY, double scrollX, double scrollY) { @Override public boolean mouseScrolled(double mouseX, double mouseY, double scrollX, double scrollY) {
if (mouseX >= leftPos + 58 && mouseX < leftPos + 217 if (mouseX >= leftPos + 58 && mouseX < leftPos + 233
&& mouseY >= topPos + 18 && mouseY < topPos + 141) { && mouseY >= topPos + 20 && mouseY < topPos + 186) {
int rows = (filteredPages().size() + 4) / 5; int rows = (filteredPages().size() + 4) / 5;
scrollRows = Math.clamp(scrollRows - (int) Math.signum(scrollY), 0, Math.max(0, rows - 3)); scrollRows = Math.clamp(scrollRows - (int) Math.signum(scrollY), 0, Math.max(0, rows - 4));
return true; return true;
} }
return super.mouseScrolled(mouseX, mouseY, scrollX, scrollY); return super.mouseScrolled(mouseX, mouseY, scrollX, scrollY);
@@ -292,11 +414,16 @@ public final class WritingDeskScreen extends AbstractContainerScreen<WritingDesk
private void setScrollFromMouse(double mouseY) { private void setScrollFromMouse(double mouseY) {
int rows = (filteredPages().size() + 4) / 5; int rows = (filteredPages().size() + 4) / 5;
int max = Math.max(0, rows - 3); int max = Math.max(0, rows - 4);
scrollRows = Math.clamp((int) Math.round((mouseY - topPos - 16) * max / 126.0), 0, max); scrollRows = Math.clamp((int) Math.round((mouseY - topPos - 31.5) * max / 143.0), 0, max);
} }
@Override public boolean mouseDragged(double mouseX, double mouseY, int button, double dragX, double dragY) { @Override public boolean mouseDragged(double mouseX, double mouseY, int button, double dragX, double dragY) {
if (button == 0 && pageDragSource != null) {
if (Math.abs(mouseX - pageDragStartX) >= 4 || Math.abs(mouseY - pageDragStartY) >= 4)
draggingPage = true;
return true;
}
if (button == 0 && draggingScrollbar) { if (button == 0 && draggingScrollbar) {
setScrollFromMouse(mouseY); setScrollFromMouse(mouseY);
return true; return true;
@@ -305,6 +432,27 @@ public final class WritingDeskScreen extends AbstractContainerScreen<WritingDesk
} }
@Override public boolean mouseReleased(double mouseX, double mouseY, int button) { @Override public boolean mouseReleased(double mouseX, double mouseY, int button) {
if (button == 0 && pageDragSource != null) {
if (draggingPage) {
DisplayPage target = pageAtMouse(mouseX, mouseY);
if (target != null && canMovePage(pageDragSource, target)
&& minecraft != null && minecraft.gameMode != null) {
selectedCollection = target.collection();
selectedPage = target.index();
minecraft.gameMode.handleInventoryButtonClick(menu.containerId,
WritingDeskMenu.movePageButtonId(pageDragSource.collection(), pageDragSource.index(),
target.collection(), target.index()));
} else if (target == null && minecraft != null && minecraft.gameMode != null) {
int targetSlot = extractTargetSlot(mouseX, mouseY);
minecraft.gameMode.handleInventoryButtonClick(menu.containerId,
WritingDeskMenu.extractPageButtonId(pageDragSource.collection(), pageDragSource.index(),
targetSlot));
}
}
pageDragSource = null;
draggingPage = false;
return true;
}
if (button == 0 && draggingScrollbar) { if (button == 0 && draggingScrollbar) {
draggingScrollbar = false; draggingScrollbar = false;
return true; return true;
@@ -322,6 +470,16 @@ public final class WritingDeskScreen extends AbstractContainerScreen<WritingDesk
} }
return true; return true;
} }
if (minecraft != null && minecraft.gameMode != null) {
if (keyCode == GLFW.GLFW_KEY_PAGE_UP) {
minecraft.gameMode.handleInventoryButtonClick(menu.containerId, WritingDeskMenu.PREVIOUS_TABS);
return true;
}
if (keyCode == GLFW.GLFW_KEY_PAGE_DOWN) {
minecraft.gameMode.handleInventoryButtonClick(menu.containerId, WritingDeskMenu.NEXT_TABS);
return true;
}
}
return super.keyPressed(keyCode, scanCode, modifiers); return super.keyPressed(keyCode, scanCode, modifiers);
} }
} }
@@ -0,0 +1,204 @@
package net.dnorberg.rivencraft.compat.jei;
import java.util.List;
import java.util.ArrayList;
import java.util.Set;
import java.util.stream.Collectors;
import mezz.jei.api.IModPlugin;
import mezz.jei.api.JeiPlugin;
import mezz.jei.api.constants.VanillaTypes;
import mezz.jei.api.gui.builder.IRecipeLayoutBuilder;
import mezz.jei.api.gui.ingredient.IRecipeSlotsView;
import mezz.jei.api.helpers.IGuiHelper;
import mezz.jei.api.recipe.IFocusGroup;
import mezz.jei.api.recipe.RecipeType;
import mezz.jei.api.recipe.category.AbstractRecipeCategory;
import mezz.jei.api.registration.IRecipeCatalystRegistration;
import mezz.jei.api.registration.IRecipeCategoryRegistration;
import mezz.jei.api.registration.IRecipeRegistration;
import mezz.jei.api.registration.ISubtypeRegistration;
import mezz.jei.api.registration.IExtraIngredientRegistration;
import mezz.jei.api.ingredients.subtypes.IIngredientSubtypeInterpreter;
import mezz.jei.api.ingredients.subtypes.UidContext;
import mezz.jei.api.runtime.IJeiRuntime;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.book.LinkProperties;
import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.writing.InkModifierIngredients;
import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.registry.ModItems;
import net.minecraft.client.Minecraft;
import net.minecraft.client.gui.GuiGraphics;
import net.minecraft.network.chat.Component;
import net.minecraft.network.chat.MutableComponent;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items;
/** Loaded by JEI's plugin scanner only when JEI is installed. No common mod class references this type. */
@JeiPlugin
public final class RivencraftJeiPlugin implements IModPlugin {
private static final RecipeType<WritingGuide> WRITING =
RecipeType.create(Rivencraft.MOD_ID, "writing", WritingGuide.class);
private static final RecipeType<InkMixerGuide> INK_MIXER =
RecipeType.create(Rivencraft.MOD_ID, "ink_mixer", InkMixerGuide.class);
@Override
public ResourceLocation getPluginUid() {
return ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "jei_writing");
}
@Override
public void registerItemSubtypes(ISubtypeRegistration registration) {
registration.registerSubtypeInterpreter(ModItems.PAGE.get(),
(IIngredientSubtypeInterpreter<ItemStack>) (stack, context) -> {
PageContent content = PageItem.content(stack);
return switch (content.kind()) {
case BLANK -> "blank";
case LINK_PANEL -> "link_panel:" + stack.getOrDefault(
ModDataComponents.LINK_PROPERTIES.get(), LinkProperties.NONE).flags();
case SYMBOL -> "symbol:" + content.symbol().orElseThrow().id();
case UNRESOLVED_SYMBOL -> "unresolved:" + content.symbol().orElseThrow().id();
};
});
}
@Override
public void registerExtraIngredients(IExtraIngredientRegistration registration) {
List<ItemStack> pages = new ArrayList<>();
pages.add(PageItem.createLinkPanelPage());
var connection = Minecraft.getInstance().getConnection();
if (connection != null) {
pages.addAll(PageItem.creativeSymbolPages(connection.registryAccess()));
} else {
PageItem.bundledCreativeSymbols().stream().map(PageItem::createBundledCreativePage)
.forEach(pages::add);
}
registration.addExtraItemStacks(pages);
}
@Override
public void onRuntimeAvailable(IJeiRuntime runtime) {
// JEI discovers the base Page item as a blank stack; only authored pages belong in its list.
runtime.getIngredientVisibility().hideIngredients(VanillaTypes.ITEM_STACK,
List.of(new ItemStack(ModItems.PAGE.get())), List.of(UidContext.Ingredient));
var connection = Minecraft.getInstance().getConnection();
if (connection == null) return;
Set<ResourceLocation> known = runtime.getIngredientManager().getAllItemStacks().stream()
.filter(stack -> stack.is(ModItems.PAGE.get()))
.map(PageItem::content)
.filter(content -> content.kind() == PageContent.Kind.SYMBOL)
.map(content -> content.symbol().orElseThrow().id())
.collect(Collectors.toSet());
List<ItemStack> missing = PageItem.creativeSymbolPages(connection.registryAccess()).stream()
.filter(stack -> !known.contains(PageItem.content(stack).symbol().orElseThrow().id()))
.toList();
if (!missing.isEmpty()) {
runtime.getIngredientManager().addIngredientsAtRuntime(VanillaTypes.ITEM_STACK, missing);
}
}
@Override
public void registerCategories(IRecipeCategoryRegistration registration) {
IGuiHelper guiHelper = registration.getJeiHelpers().getGuiHelper();
registration.addRecipeCategories(new WritingCategory(guiHelper), new InkMixerCategory(guiHelper));
}
@Override
public void registerRecipes(IRecipeRegistration registration) {
ItemStack panel = PageItem.createLinkPanelPage();
ItemStack symbolPage = PageItem.createSymbolPage(new SymbolReference(
ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "terrain/standard")));
registration.addRecipes(WRITING, List.of(
new WritingGuide(List.of(new ItemStack(Items.PAPER), new ItemStack(ModItems.INK_VIAL.get())),
panel, "jei.rivencraft.writing.link_panel_hand"),
new WritingGuide(List.of(symbolPage, new ItemStack(Items.PAPER), new ItemStack(ModItems.INK_VIAL.get())),
symbolPage, "jei.rivencraft.writing.copy"),
new WritingGuide(List.of(new ItemStack(Items.LEATHER), panel),
new ItemStack(ModItems.DESCRIPTIVE_BOOK.get()), "jei.rivencraft.writing.bind"),
new WritingGuide(List.of(panel, new ItemStack(Items.LEATHER)),
new ItemStack(ModItems.LINKING_BOOK.get()), "jei.rivencraft.writing.linking_book")
));
List<InkMixerGuide> mixerGuides = new ArrayList<>();
mixerGuides.add(new InkMixerGuide(panel, null));
InkModifierIngredients.builtIn().forEach(ingredient ->
mixerGuides.add(new InkMixerGuide(panel, ingredient)));
registration.addRecipes(INK_MIXER, mixerGuides);
}
@Override
public void registerRecipeCatalysts(IRecipeCatalystRegistration registration) {
registration.addRecipeCatalysts(WRITING, ModItems.INK_VIAL.get(),
ModItems.WRITING_DESK.get(), ModItems.BOOK_BINDER.get());
registration.addRecipeCatalysts(INK_MIXER, ModItems.INK_MIXER.get());
}
private record WritingGuide(List<ItemStack> inputs, ItemStack output, String instructionKey) {}
private record InkMixerGuide(ItemStack panel, InkModifierIngredients.Ingredient additive) {}
private static final class InkMixerCategory extends AbstractRecipeCategory<InkMixerGuide> {
InkMixerCategory(IGuiHelper guiHelper) {
super(INK_MIXER, Component.translatable("jei.rivencraft.ink_mixer"),
guiHelper.createDrawableIngredient(VanillaTypes.ITEM_STACK,
new ItemStack(ModItems.INK_MIXER.get())), 138, 80);
}
@Override
public void setRecipe(IRecipeLayoutBuilder builder, InkMixerGuide recipe, IFocusGroup focuses) {
builder.addInputSlot(2, 3).setStandardSlotBackground().addItemStack(new ItemStack(Items.PAPER));
builder.addInputSlot(23, 3).setStandardSlotBackground()
.addItemStack(new ItemStack(ModItems.INK_VIAL.get()));
if (recipe.additive() != null)
builder.addInputSlot(44, 3).setStandardSlotBackground()
.addItemStack(recipe.additive().item());
builder.addOutputSlot(112, 3).setOutputSlotBackground().addItemStack(recipe.panel());
builder.addOutputSlot(112, 46).setStandardSlotBackground()
.addItemStack(new ItemStack(Items.GLASS_BOTTLE));
}
@Override
public void draw(InkMixerGuide recipe, IRecipeSlotsView slots, GuiGraphics graphics,
double mouseX, double mouseY) {
Component instructions = recipe.additive() == null
? Component.translatable("jei.rivencraft.ink_mixer.usage")
: additiveInstructions(recipe.additive());
graphics.drawWordWrap(Minecraft.getInstance().font, instructions, 2, 27, 104, 0x404040);
}
private static Component additiveInstructions(InkModifierIngredients.Ingredient additive) {
MutableComponent effects = Component.empty();
for (InkModifierIngredients.Effect effect : additive.effects()) {
if (!effects.getSiblings().isEmpty()) effects.append(", ");
effects.append(Component.translatable("jei.rivencraft.ink_mixer.effect",
LinkProperties.name(effect.flag()), Math.round(effect.chance() * 100)));
}
return Component.translatable("jei.rivencraft.ink_mixer.additive", effects);
}
}
private static final class WritingCategory extends AbstractRecipeCategory<WritingGuide> {
WritingCategory(IGuiHelper guiHelper) {
super(WRITING, Component.translatable("jei.rivencraft.writing"),
guiHelper.createDrawableIngredient(VanillaTypes.ITEM_STACK,
new ItemStack(ModItems.WRITING_DESK.get())), 138, 80);
}
@Override
public void setRecipe(IRecipeLayoutBuilder builder, WritingGuide recipe, IFocusGroup focuses) {
for (int index = 0; index < recipe.inputs().size(); index++) {
builder.addInputSlot(2 + index * 21, 3).setStandardSlotBackground()
.addItemStack(recipe.inputs().get(index));
}
builder.addOutputSlot(112, 3).setOutputSlotBackground().addItemStack(recipe.output());
}
@Override
public void draw(WritingGuide recipe, IRecipeSlotsView slots, GuiGraphics graphics,
double mouseX, double mouseY) {
graphics.drawWordWrap(Minecraft.getInstance().font,
Component.translatable(recipe.instructionKey()), 2, 27, 134, 0x404040);
}
}
}
@@ -0,0 +1,385 @@
package net.dnorberg.rivencraft.gametest;
import java.util.List;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.block.entity.BookBinderBlockEntity;
import net.dnorberg.rivencraft.book.AgeReference;
import net.dnorberg.rivencraft.book.AgeDimensionService;
import net.dnorberg.rivencraft.book.AgeRegistrySavedData;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.menu.BookBinderMenu;
import net.dnorberg.rivencraft.registry.ModBlocks;
import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.writing.NotebookContents;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.writing.SymbolCatalog;
import net.dnorberg.rivencraft.writing.WritingEntry;
import net.minecraft.core.BlockPos;
import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.entity.item.ItemEntity;
import net.minecraft.world.inventory.ClickType;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items;
import net.minecraft.world.level.block.Blocks;
import net.minecraft.world.phys.AABB;
import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
@GameTestHolder("rivencraft_archive_binder")
@PrefixGameTestTemplate(false)
public final class BookBinderGameTests {
private BookBinderGameTests() {}
private static ItemStack terrainPage() {
return PageItem.createSymbolPage(new SymbolReference(
ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "terrain/standard")));
}
private static ItemStack weatherPage() {
return PageItem.createSymbolPage(new SymbolReference(
ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "weather/normal")));
}
private static BookBinderBlockEntity place(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.BOOK_BINDER.get().defaultBlockState(), 3);
return (BookBinderBlockEntity) helper.getLevel().getBlockEntity(pos);
}
@GameTest(template = "empty")
public static void binderInputsAndTitleSurviveSaveLoad(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper);
binder.setTitle("Ordered Age");
binder.setItem(BookBinderBlockEntity.COVER, new ItemStack(Items.LEATHER));
binder.setItem(BookBinderBlockEntity.LINK_PANEL, PageItem.createLinkPanelPage());
binder.setItem(BookBinderBlockEntity.FIRST_PAGE, terrainPage());
var saved = binder.saveWithoutMetadata(helper.getLevel().registryAccess());
var restored = new BookBinderBlockEntity(binder.getBlockPos(), binder.getBlockState());
restored.setLevel(helper.getLevel());
restored.loadWithComponents(saved, helper.getLevel().registryAccess());
helper.assertValueEqual(restored.title(), "Ordered Age", "Title must persist");
helper.assertTrue(restored.getItem(BookBinderBlockEntity.COVER).is(Items.LEATHER), "Cover must persist");
helper.assertTrue(restored.getItem(BookBinderBlockEntity.LINK_PANEL).is(ModItems.PAGE.get()),
"Link Panel must persist");
helper.assertTrue(ItemStack.matches(restored.getItem(BookBinderBlockEntity.FIRST_PAGE), terrainPage()),
"Ordered page must persist");
helper.assertTrue(restored.canAssemble(), "Restored binder must remain ready to assemble");
AgeReference beforeSave = binder.previewBook().get(ModDataComponents.AGE_REFERENCE.get());
var previewSaved = binder.saveWithoutMetadata(helper.getLevel().registryAccess());
restored.loadWithComponents(previewSaved, helper.getLevel().registryAccess());
helper.assertValueEqual(restored.previewBook().get(ModDataComponents.AGE_REFERENCE.get()), beforeSave,
"Pending Age identity must survive a world restart");
helper.succeed();
}
public static void missingSymbolPageSurvivesReloadButCannotBeAssembled(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper);
binder.setTitle("Recoverable Writing");
binder.setItem(BookBinderBlockEntity.COVER, new ItemStack(Items.LEATHER));
binder.setItem(BookBinderBlockEntity.LINK_PANEL, PageItem.createLinkPanelPage());
SymbolReference missing = new SymbolReference(ResourceLocation.parse("example:removed_symbol"));
binder.setItem(BookBinderBlockEntity.FIRST_PAGE, PageItem.createRecoveredPage(missing));
var saved = binder.saveWithoutMetadata(helper.getLevel().registryAccess());
var restored = new BookBinderBlockEntity(binder.getBlockPos(), binder.getBlockState());
restored.loadWithComponents(saved, helper.getLevel().registryAccess());
helper.assertValueEqual(PageItem.content(restored.getItem(BookBinderBlockEntity.FIRST_PAGE))
.symbol().orElseThrow(), missing, "Reload must preserve the removed data-pack symbol ID");
restored.getItem(BookBinderBlockEntity.FIRST_PAGE).set(ModDataComponents.PAGE_SYMBOL_DISPLAY.get(),
SymbolCatalog.display(new SymbolReference(ResourceLocation.parse("rivencraft:terrain/standard"))));
helper.assertFalse(restored.canAssemble(),
"Forged display metadata cannot make a missing symbol valid for a new Age");
helper.assertTrue(restored.getItem(BookBinderBlockEntity.FIRST_PAGE).is(ModItems.PAGE.get()),
"Rejected writing must remain recoverable as a Page");
helper.succeed();
}
@GameTest(template = "empty")
public static void conflictingGrammarKeepsBinderInputsRecoverable(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper);
binder.setTitle("Recoverable Duplicate");
binder.setItem(BookBinderBlockEntity.COVER, new ItemStack(Items.LEATHER));
binder.setItem(BookBinderBlockEntity.LINK_PANEL, PageItem.createLinkPanelPage());
binder.setItem(BookBinderBlockEntity.FIRST_PAGE, terrainPage());
binder.setItem(BookBinderBlockEntity.FIRST_PAGE + 5, terrainPage());
helper.assertFalse(binder.canAssemble(), "Duplicate terrain must not assemble a new Age");
int errorEntry = binder.writingGrammar().firstError().orElseThrow().index();
helper.assertValueEqual(errorEntry, 2, "Parser must identify the second authored symbol");
helper.assertValueEqual(binder.writingStripIndex(errorEntry), 6,
"A grammar error must highlight the correct strip page despite empty positions");
helper.assertFalse(binder.consumeAssembly(), "Rejected grammar must not consume binder inputs");
helper.assertTrue(binder.getItem(BookBinderBlockEntity.COVER).is(Items.LEATHER),
"Rejected grammar must leave the cover recoverable");
helper.assertTrue(binder.getItem(BookBinderBlockEntity.LINK_PANEL).is(ModItems.PAGE.get()),
"Rejected grammar must leave the Link Panel recoverable");
helper.assertTrue(binder.getItem(BookBinderBlockEntity.FIRST_PAGE + 5).is(ModItems.PAGE.get()),
"Rejected grammar must leave the duplicate page removable");
ItemStack removed = binder.takePage(5);
helper.assertTrue(removed.is(ModItems.PAGE.get()), "Player must be able to correct the duplicate page");
helper.assertTrue(binder.canAssemble(), "Corrected partial writing must become assemblable");
helper.succeed();
}
public static void assemblyIsAtomicAndRetainsPageOrder(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper);
binder.setTitle("A New Age");
binder.setItem(BookBinderBlockEntity.COVER, new ItemStack(Items.LEATHER));
binder.setItem(BookBinderBlockEntity.FIRST_PAGE, terrainPage());
binder.setItem(BookBinderBlockEntity.FIRST_PAGE + 1, weatherPage());
helper.assertFalse(binder.canAssemble(), "Missing Link Panel must prevent assembly");
helper.assertFalse(binder.consumeAssembly(), "Failure must consume nothing");
helper.assertTrue(binder.getItem(BookBinderBlockEntity.COVER).is(Items.LEATHER),
"Rejected assembly must preserve cover");
ItemStack flavoredPanel = PageItem.createLinkPanelPage();
flavoredPanel.set(ModDataComponents.LINK_PROPERTIES.get(),
new net.dnorberg.rivencraft.book.LinkProperties(
net.dnorberg.rivencraft.book.LinkProperties.DISARM
| net.dnorberg.rivencraft.book.LinkProperties.MAINTAIN_MOMENTUM
| net.dnorberg.rivencraft.book.LinkProperties.INTRA_LINKING));
var expectedProperties = flavoredPanel.get(ModDataComponents.LINK_PROPERTIES.get()).forDescriptiveBook();
binder.setItem(BookBinderBlockEntity.LINK_PANEL, flavoredPanel);
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(binder.getBlockPos().getX() + 0.5, binder.getBlockPos().getY() + 0.5,
binder.getBlockPos().getZ() + 0.5);
BookBinderMenu menu = new BookBinderMenu(1, player.getInventory(), binder);
menu.broadcastChanges();
helper.assertTrue(menu.getSlot(BookBinderMenu.RESULT).hasItem(), "Valid binder must show output");
menu.clicked(BookBinderMenu.RESULT, 0, ClickType.PICKUP, player);
ItemStack book = menu.getCarried();
helper.assertTrue(book.is(ModItems.DESCRIPTIVE_BOOK.get()), "Result must be a Descriptive Book");
helper.assertValueEqual(book.get(ModDataComponents.LINK_PROPERTIES.get()),
expectedProperties,
"Binder must retain Disarm and Momentum but omit Intra Linking");
AgeReference age = book.get(ModDataComponents.AGE_REFERENCE.get());
helper.assertTrue(age != null, "Assembled book must already be a written Age book");
OrderedWriting writing = book.get(ModDataComponents.BOOK_WRITING.get());
helper.assertTrue(writing != null, "Assembled book must keep its writing");
helper.assertValueEqual(writing.schemaVersion(), OrderedWriting.CURRENT_SCHEMA_VERSION,
"Assembled writing must use the current schema");
helper.assertValueEqual(writing.entries().size(), 3, "Link Panel and two pages must be present");
helper.assertValueEqual(writing.entries().get(0).kind(), WritingEntry.Kind.LINK_PANEL,
"Link Panel must be first");
helper.assertValueEqual(writing.entries().get(1).symbol().orElseThrow().id().toString(),
"rivencraft:terrain/standard", "Terrain page order must be preserved");
helper.assertValueEqual(writing.entries().get(2).symbol().orElseThrow().id().toString(),
"rivencraft:weather/normal", "Weather page order must be preserved");
helper.assertTrue(AgeRegistrySavedData.get(helper.getLevel()).find(age.id()).isPresent(),
"Taking the completed book must register its random Age definition");
ItemStack copy = book.copy();
helper.assertValueEqual(copy.get(ModDataComponents.BOOK_WRITING.get()), writing,
"A book copy must retain identical ordered writing");
helper.assertValueEqual(copy.get(ModDataComponents.AGE_REFERENCE.get()), age,
"A book copy must retain the same Age rather than assigning a new one");
var savedBook = (net.minecraft.nbt.CompoundTag) copy.saveOptional(helper.getLevel().registryAccess());
ItemStack restoredBook = ItemStack.parseOptional(helper.getLevel().registryAccess(), savedBook);
helper.assertValueEqual(restoredBook.get(ModDataComponents.BOOK_WRITING.get()), writing,
"Versioned ordered writing must survive full book save/load");
helper.assertTrue(binder.getItem(BookBinderBlockEntity.COVER).isEmpty(), "Cover must be consumed once");
helper.assertTrue(binder.getItem(BookBinderBlockEntity.LINK_PANEL).isEmpty(), "Link Panel must be consumed once");
helper.assertTrue(binder.getItem(BookBinderBlockEntity.FIRST_PAGE).isEmpty(), "Pages must be consumed once");
menu.broadcastChanges();
helper.assertTrue(menu.getSlot(BookBinderMenu.RESULT).getItem().isEmpty(), "No duplicate output may remain");
helper.succeed();
}
@GameTest(template = "empty")
public static void linkPanelOnlyCreatesCompletedRandomAgeBook(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper);
binder.setTitle("Random Binder Age");
binder.setItem(BookBinderBlockEntity.COVER, new ItemStack(Items.LEATHER));
binder.setItem(BookBinderBlockEntity.LINK_PANEL, PageItem.createLinkPanelPage());
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(binder.getBlockPos().getX() + 0.5, binder.getBlockPos().getY() + 0.5,
binder.getBlockPos().getZ() + 0.5);
BookBinderMenu menu = new BookBinderMenu(1, player.getInventory(), binder);
menu.clicked(BookBinderMenu.RESULT, 0, ClickType.PICKUP, player);
ItemStack book = menu.getCarried();
AgeReference age = book.get(ModDataComponents.AGE_REFERENCE.get());
helper.assertTrue(age != null, "Link-Panel-only output must be written, not unwritten");
helper.assertValueEqual(age.name(), "Random Binder Age", "The assigned title must name the Age");
helper.assertValueEqual(book.get(ModDataComponents.BOOK_WRITING.get()).entries().size(), 1,
"A random Age book must contain only its Link Panel when no symbols are supplied");
helper.assertTrue(AgeRegistrySavedData.get(helper.getLevel()).find(age.id()).isPresent(),
"Taking the book must register its random Age definition");
helper.assertTrue(AgeDimensionService.resolve(player, age).isPresent(),
"The completed book must resolve to a usable random Age");
helper.succeed();
}
@GameTest(template = "empty")
public static void notebookImportPreservesOrderAndRejectsOverflow(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper);
ItemStack notebook = new ItemStack(ModItems.NOTEBOOK.get());
notebook.set(ModDataComponents.NOTEBOOK_CONTENTS.get(), new NotebookContents(List.of(
PageItem.createLinkPanelPage(), terrainPage(), weatherPage())));
binder.setItem(BookBinderBlockEntity.NOTEBOOK, notebook);
helper.assertTrue(binder.importNotebook(), "Notebook pages must import together");
helper.assertTrue(binder.getItem(BookBinderBlockEntity.LINK_PANEL).is(ModItems.PAGE.get()),
"Imported Link Panel must use its dedicated slot");
helper.assertTrue(ItemStack.matches(binder.getItem(BookBinderBlockEntity.FIRST_PAGE), terrainPage()),
"First Notebook symbol must stay first");
helper.assertTrue(ItemStack.matches(binder.getItem(BookBinderBlockEntity.FIRST_PAGE + 1), weatherPage()),
"Second Notebook symbol must stay second");
helper.assertValueEqual(binder.getItem(BookBinderBlockEntity.NOTEBOOK)
.getOrDefault(ModDataComponents.NOTEBOOK_CONTENTS.get(), NotebookContents.EMPTY).pageCount(), 0,
"Empty Notebook cover must remain recoverable");
for (int slot = BookBinderBlockEntity.FIRST_PAGE + 2; slot < BookBinderBlockEntity.SIZE; slot++)
binder.setItem(slot, terrainPage());
ItemStack overflow = new ItemStack(ModItems.NOTEBOOK.get());
overflow.set(ModDataComponents.NOTEBOOK_CONTENTS.get(), new NotebookContents(List.of(weatherPage())));
binder.setItem(BookBinderBlockEntity.NOTEBOOK, overflow);
helper.assertFalse(binder.importNotebook(), "Full binder must reject Notebook import");
helper.assertValueEqual(binder.getItem(BookBinderBlockEntity.NOTEBOOK)
.getOrDefault(ModDataComponents.NOTEBOOK_CONTENTS.get(), NotebookContents.EMPTY).pageCount(), 1,
"Rejected import must preserve the Notebook page");
helper.succeed();
}
@GameTest(template = "empty")
public static void pageControlsAndBreakingPreserveStoredInputs(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper);
binder.setItem(BookBinderBlockEntity.COVER, new ItemStack(Items.LEATHER));
binder.setItem(BookBinderBlockEntity.LINK_PANEL, PageItem.createLinkPanelPage());
binder.setItem(BookBinderBlockEntity.FIRST_PAGE, terrainPage());
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(binder.getBlockPos().getX() + 0.5, binder.getBlockPos().getY() + 0.5,
binder.getBlockPos().getZ() + 0.5);
BookBinderMenu menu = new BookBinderMenu(1, player.getInventory(), binder);
helper.assertFalse(menu.clickMenuButton(player, BookBinderMenu.MOVE_PREVIOUS),
"Move without selection must be rejected");
helper.assertTrue(menu.clickMenuButton(player, BookBinderMenu.SELECT_BASE), "Page selection must succeed");
helper.assertTrue(menu.clickMenuButton(player, BookBinderMenu.MOVE_NEXT), "Page move must succeed");
helper.assertTrue(binder.getItem(BookBinderBlockEntity.FIRST_PAGE).isEmpty(), "Old position must be empty");
helper.assertTrue(ItemStack.matches(binder.getItem(BookBinderBlockEntity.FIRST_PAGE + 1), terrainPage()),
"Moved page must keep its data");
helper.assertFalse(menu.clickMenuButton(player, 999), "Unknown action must be rejected");
BlockPos pos = binder.getBlockPos();
helper.getLevel().setBlock(pos, Blocks.AIR.defaultBlockState(), 3);
helper.assertFalse(menu.stillValid(player), "Removed binder must invalidate the menu");
var drops = helper.getLevel().getEntitiesOfClass(ItemEntity.class, new AABB(pos).inflate(2));
int leather = drops.stream().filter(entity -> entity.getItem().is(Items.LEATHER))
.mapToInt(entity -> entity.getItem().getCount()).sum();
int pages = drops.stream().filter(entity -> entity.getItem().is(ModItems.PAGE.get()))
.mapToInt(entity -> entity.getItem().getCount()).sum();
helper.assertValueEqual(leather, 1, "Cover must drop once");
helper.assertValueEqual(pages, 2, "Link Panel and writing page must drop once each");
helper.succeed();
}
@GameTest(template = "empty")
public static void fullInventoryCannotConsumeBinderInputs(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper);
binder.setTitle("Full Inventory");
binder.setItem(BookBinderBlockEntity.COVER, new ItemStack(Items.LEATHER));
binder.setItem(BookBinderBlockEntity.LINK_PANEL, PageItem.createLinkPanelPage());
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(binder.getBlockPos().getX() + 0.5, binder.getBlockPos().getY() + 0.5,
binder.getBlockPos().getZ() + 0.5);
for (int slot = 0; slot < 36; slot++)
player.getInventory().setItem(slot, new ItemStack(Items.COBBLESTONE, 64));
BookBinderMenu menu = new BookBinderMenu(1, player.getInventory(), binder);
helper.assertTrue(menu.quickMoveStack(player, BookBinderMenu.RESULT).isEmpty(),
"Full inventory must reject output transfer");
helper.assertTrue(binder.getItem(BookBinderBlockEntity.COVER).is(Items.LEATHER),
"Rejected transfer must preserve cover");
helper.assertTrue(binder.getItem(BookBinderBlockEntity.LINK_PANEL).is(ModItems.PAGE.get()),
"Rejected transfer must preserve Link Panel");
helper.assertTrue(menu.getSlot(BookBinderMenu.RESULT).hasItem(),
"Result must remain available after inventory space is freed");
helper.assertFalse(menu.setTitle(player, "A title that is much too long for the binder slot"),
"Oversized title packet must be rejected");
helper.assertValueEqual(binder.title(), "Full Inventory", "Rejected title must preserve existing title");
helper.succeed();
}
public static void forgedBinderActionsAndReplayedOutputCannotDuplicateBook(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper);
binder.setTitle("Single Assembly");
binder.setItem(BookBinderBlockEntity.COVER, new ItemStack(Items.LEATHER));
binder.setItem(BookBinderBlockEntity.LINK_PANEL, PageItem.createLinkPanelPage());
var first = helper.makeMockServerPlayerInLevel();
var second = helper.makeMockServerPlayerInLevel();
for (var player : List.of(first, second)) player.moveTo(binder.getBlockPos().getX() + 0.5,
binder.getBlockPos().getY() + 0.5, binder.getBlockPos().getZ() + 0.5);
BookBinderMenu firstMenu = new BookBinderMenu(1, first.getInventory(), binder);
BookBinderMenu secondMenu = new BookBinderMenu(2, second.getInventory(), binder);
helper.assertFalse(firstMenu.clickMenuButton(first, BookBinderMenu.SELECT_BASE + BookBinderBlockEntity.PAGE_COUNT),
"A fabricated page selection must be rejected");
helper.assertFalse(firstMenu.clickMenuButton(first, BookBinderMenu.STRIP_CLICK_BASE
+ BookBinderBlockEntity.PAGE_COUNT + 1), "A fabricated strip address must be rejected");
helper.assertTrue(firstMenu.quickMoveStack(first, BookBinderMenu.RESULT).is(ModItems.DESCRIPTIVE_BOOK.get()),
"The first viewer must receive the single assembled book");
helper.assertTrue(secondMenu.quickMoveStack(second, BookBinderMenu.RESULT).isEmpty(),
"Another viewer must not take a stale result");
helper.assertTrue(firstMenu.quickMoveStack(first, BookBinderMenu.RESULT).isEmpty(),
"Replaying the output request must not create a second book");
int books = first.getInventory().items.stream().filter(stack -> stack.is(ModItems.DESCRIPTIVE_BOOK.get()))
.mapToInt(ItemStack::getCount).sum();
helper.assertValueEqual(books, 1, "Only one completed book may be emitted");
helper.assertTrue(binder.getItem(BookBinderBlockEntity.COVER).isEmpty(), "Cover must be consumed once");
helper.assertTrue(binder.getItem(BookBinderBlockEntity.LINK_PANEL).isEmpty(), "Panel must be consumed once");
helper.getLevel().setBlock(binder.getBlockPos(), Blocks.AIR.defaultBlockState(), 3);
helper.assertFalse(firstMenu.clickMenuButton(first, BookBinderMenu.IMPORT_NOTEBOOK),
"A stale binder menu must reject packets after block removal");
helper.succeed();
}
@GameTest(template = "empty")
public static void legacyStripInsertsAndRemovesPagesInOrder(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper);
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(binder.getBlockPos().getX() + 0.5, binder.getBlockPos().getY() + 0.5,
binder.getBlockPos().getZ() + 0.5);
BookBinderMenu menu = new BookBinderMenu(1, player.getInventory(), binder);
menu.setCarried(PageItem.createLinkPanelPage());
helper.assertTrue(menu.clickMenuButton(player, BookBinderMenu.STRIP_CLICK_BASE),
"The first thumbnail must accept a Link Panel");
helper.assertTrue(menu.getCarried().isEmpty(), "Inserted panel must leave the cursor");
menu.setCarried(terrainPage());
helper.assertTrue(menu.clickMenuButton(player, BookBinderMenu.STRIP_CLICK_BASE + 1),
"The strip must accept a written Page");
menu.setCarried(weatherPage());
helper.assertTrue(menu.clickMenuButton(player, BookBinderMenu.STRIP_CLICK_BASE + 1),
"Inserting before a Page must shift it right");
helper.assertTrue(ItemStack.matches(binder.getItem(BookBinderBlockEntity.FIRST_PAGE), weatherPage()),
"Inserted Page must be first");
helper.assertTrue(ItemStack.matches(binder.getItem(BookBinderBlockEntity.FIRST_PAGE + 1), terrainPage()),
"Existing Page must move right");
helper.assertTrue(menu.clickMenuButton(player, BookBinderMenu.STRIP_CLICK_BASE + 1),
"Clicking a thumbnail with an empty cursor must take the Page");
helper.assertTrue(ItemStack.matches(menu.getCarried(), weatherPage()),
"Removed Page must return to the cursor");
helper.assertTrue(ItemStack.matches(binder.getItem(BookBinderBlockEntity.FIRST_PAGE), terrainPage()),
"Removal must close the gap");
helper.assertFalse(menu.clickMenuButton(player, BookBinderMenu.STRIP_CLICK_BASE),
"A symbol Page must not replace the Link Panel");
helper.succeed();
}
@GameTest(template = "empty")
public static void legacyStripImportsNotebookAtClickedPosition(GameTestHelper helper) {
BookBinderBlockEntity binder = place(helper);
binder.setItem(BookBinderBlockEntity.LINK_PANEL, PageItem.createLinkPanelPage());
binder.setItem(BookBinderBlockEntity.FIRST_PAGE, terrainPage());
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(binder.getBlockPos().getX() + 0.5, binder.getBlockPos().getY() + 0.5,
binder.getBlockPos().getZ() + 0.5);
BookBinderMenu menu = new BookBinderMenu(1, player.getInventory(), binder);
ItemStack notebook = new ItemStack(ModItems.NOTEBOOK.get());
notebook.set(ModDataComponents.NOTEBOOK_CONTENTS.get(), new NotebookContents(List.of(weatherPage())));
menu.setCarried(notebook);
helper.assertTrue(menu.clickMenuButton(player, BookBinderMenu.STRIP_CLICK_BASE + 1),
"Notebook pages must import where clicked");
helper.assertValueEqual(menu.getCarried().getOrDefault(
ModDataComponents.NOTEBOOK_CONTENTS.get(), NotebookContents.EMPTY).pageCount(), 0,
"The empty Notebook must remain on the cursor");
helper.assertTrue(ItemStack.matches(binder.getItem(BookBinderBlockEntity.FIRST_PAGE), weatherPage()),
"Imported Page must occupy the clicked position");
helper.assertTrue(ItemStack.matches(binder.getItem(BookBinderBlockEntity.FIRST_PAGE + 1), terrainPage()),
"Existing Page must shift right");
helper.succeed();
}
}
@@ -0,0 +1,114 @@
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 mixerModifierTransaction(GameTestHelper helper) {
InkMixerGameTests.modifierClickPersistsPreviewAndConsumesOnce(helper);
}
@GameTest(template = "empty")
public static void linkingBookRecipe(GameTestHelper helper) {
LinkingBookRecipeGameTests.legacyRecipeRequiresExactlyLeatherAndLinkPanel(helper);
}
}
@@ -0,0 +1,174 @@
package net.dnorberg.rivencraft.gametest;
import net.dnorberg.rivencraft.block.entity.InkMixerBlockEntity;
import net.dnorberg.rivencraft.menu.InkMixerMenu;
import net.dnorberg.rivencraft.registry.ModBlocks;
import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.writing.WritingInkService;
import net.minecraft.core.BlockPos;
import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper;
import net.minecraft.world.inventory.ClickType;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items;
import net.minecraft.world.entity.item.ItemEntity;
import net.minecraft.world.level.block.Blocks;
import net.minecraft.world.phys.AABB;
import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
@GameTestHolder("rivencraft_archive_mixer")
@PrefixGameTestTemplate(false)
public final class InkMixerGameTests {
private InkMixerGameTests() {}
private static InkMixerBlockEntity place(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.INK_MIXER.get().defaultBlockState(), 3);
return (InkMixerBlockEntity) helper.getLevel().getBlockEntity(pos);
}
public static void modifierClickPersistsPreviewAndConsumesOnce(GameTestHelper helper) {
InkMixerBlockEntity mixer = place(helper);
mixer.setItem(InkMixerBlockEntity.PAPER, new ItemStack(Items.PAPER, 2));
mixer.setItem(InkMixerBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(mixer.getBlockPos().getX() + 0.5, mixer.getBlockPos().getY() + 0.5,
mixer.getBlockPos().getZ() + 0.5);
InkMixerMenu menu = new InkMixerMenu(1, player.getInventory(), mixer);
menu.setCarried(new ItemStack(Items.GUNPOWDER, 2));
menu.clicked(InkMixerMenu.MODIFIER, 1, ClickType.PICKUP, player);
helper.assertValueEqual(menu.getCarried().getCount(), 1, "Right click must consume one additive");
helper.assertValueEqual(mixer.modifierChancePermille(0), 200,
"Gunpowder must add Legacy's 20% Disarm chance");
menu.setCarried(new ItemStack(Items.STONE));
menu.clicked(InkMixerMenu.MODIFIER, 0, ClickType.PICKUP, player);
helper.assertValueEqual(menu.getCarried().getCount(), 1, "Invalid additive must remain carried");
helper.assertValueEqual(mixer.modifierChancePermille(0), 200,
"Invalid additive must not change the mixture");
ItemStack preview = mixer.previewLinkPanel();
var saved = mixer.saveWithoutMetadata(helper.getLevel().registryAccess());
var restored = new InkMixerBlockEntity(mixer.getBlockPos(), ModBlocks.INK_MIXER.get().defaultBlockState());
restored.loadWithComponents(saved, helper.getLevel().registryAccess());
helper.assertTrue(ItemStack.matches(preview, restored.previewLinkPanel()),
"Saving must retain the mixture and deterministic next-panel preview");
menu.setCarried(ItemStack.EMPTY);
menu.clicked(InkMixerMenu.RESULT, 0, ClickType.PICKUP, player);
helper.assertTrue(menu.getCarried().is(ModItems.PAGE.get()), "Taking result must give a panel");
helper.assertValueEqual(mixer.modifierChancePermille(0), 0,
"Mixture must be spent only when a panel is taken");
helper.assertValueEqual(mixer.getItem(InkMixerBlockEntity.PAPER).getCount(), 1,
"Taking the panel must consume exactly one paper");
helper.succeed();
}
@GameTest(template = "empty")
public static void enderPearlsRaiseBothPropertiesIndependentlyAndResetOnOutput(GameTestHelper helper) {
InkMixerBlockEntity mixer = place(helper);
mixer.setItem(InkMixerBlockEntity.PAPER, new ItemStack(Items.PAPER, 2));
mixer.setItem(InkMixerBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
ItemStack pearls = new ItemStack(Items.ENDER_PEARL, 20);
helper.assertTrue(mixer.addModifier(pearls, 20), "Ender Pearls must infuse the basin");
helper.assertTrue(pearls.isEmpty(), "Twenty pearls must be consumed exactly once");
helper.assertValueEqual(mixer.modifierChancePermille(0), 961,
"Disarm must approach 100% independently");
helper.assertValueEqual(mixer.modifierChancePermille(2), 961,
"Intra Linking must approach 100% independently");
helper.assertValueEqual(mixer.modifierChancePermille(1), 0,
"Ender Pearls must not add Momentum");
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(mixer.getBlockPos().getX() + 0.5, mixer.getBlockPos().getY() + 0.5,
mixer.getBlockPos().getZ() + 0.5);
InkMixerMenu menu = new InkMixerMenu(1, player.getInventory(), mixer);
menu.clicked(InkMixerMenu.RESULT, 0, ClickType.PICKUP, player);
helper.assertTrue(menu.getCarried().is(ModItems.PAGE.get()), "Taking output must yield one panel");
for (int index = 0; index < 3; index++)
helper.assertValueEqual(mixer.modifierChancePermille(index), 0,
"Every modifier chance must reset when output is taken");
helper.assertValueEqual(mixer.getItem(InkMixerBlockEntity.PAPER).getCount(), 1,
"Taking output must consume one paper");
helper.succeed();
}
public static void linkPanelRequiresTakingOutputAndPersistsInk(GameTestHelper helper) {
InkMixerBlockEntity mixer = place(helper);
mixer.setItem(InkMixerBlockEntity.PAPER, new ItemStack(Items.PAPER, 2));
mixer.setItem(InkMixerBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(mixer.getBlockPos().getX() + 0.5, mixer.getBlockPos().getY() + 0.5,
mixer.getBlockPos().getZ() + 0.5);
InkMixerMenu menu = new InkMixerMenu(1, player.getInventory(), mixer);
menu.broadcastChanges();
helper.assertTrue(menu.getSlot(InkMixerMenu.RESULT).getItem().is(ModItems.PAGE.get()),
"Paper and filled basin must preview a Link Panel");
helper.assertValueEqual(mixer.getItem(InkMixerBlockEntity.PAPER).getCount(), 2,
"Preview must not consume paper");
helper.assertValueEqual(mixer.inkRemaining(), 16, "Vial must fill the basin");
helper.assertTrue(mixer.getItem(InkMixerBlockEntity.BOTTLES).is(Items.GLASS_BOTTLE),
"Consumed vial must return a vanilla glass bottle");
menu.clicked(InkMixerMenu.RESULT, 0, ClickType.PICKUP, player);
helper.assertTrue(menu.getCarried().is(ModItems.PAGE.get()), "Taking result must give a Link Panel");
helper.assertValueEqual(mixer.getItem(InkMixerBlockEntity.PAPER).getCount(), 1,
"Taking result must use exactly one paper");
helper.assertValueEqual(mixer.inkRemaining(), 16 - WritingInkService.linkPanelCost(),
"Taking result must spend the configured ink cost");
var saved = mixer.saveWithoutMetadata(helper.getLevel().registryAccess());
var restored = new InkMixerBlockEntity(mixer.getBlockPos(), ModBlocks.INK_MIXER.get().defaultBlockState());
restored.loadWithComponents(saved, helper.getLevel().registryAccess());
helper.assertValueEqual(restored.inkRemaining(), mixer.inkRemaining(), "Ink basin must persist");
helper.assertValueEqual(restored.getItem(InkMixerBlockEntity.PAPER).getCount(), 1,
"Paper input must persist");
helper.succeed();
}
@GameTest(template = "empty")
public static void bottleCapacityBlocksAndThenPermitsRefill(GameTestHelper helper) {
InkMixerBlockEntity mixer = place(helper);
mixer.setItem(InkMixerBlockEntity.PAPER, new ItemStack(Items.PAPER));
mixer.setItem(InkMixerBlockEntity.BOTTLES, new ItemStack(Items.GLASS_BOTTLE, 64));
mixer.setItem(InkMixerBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
helper.assertValueEqual(mixer.inkRemaining(), 0, "Full bottle output must block refill");
helper.assertTrue(mixer.getItem(InkMixerBlockEntity.INK).is(ModItems.INK_VIAL.get()),
"Blocked refill must preserve vial");
helper.assertFalse(mixer.canCreateLinkPanel(), "Blocked refill must suppress output");
mixer.removeItem(InkMixerBlockEntity.BOTTLES, 1);
helper.assertValueEqual(mixer.inkRemaining(), 16, "Making bottle space must immediately refill");
helper.assertValueEqual(mixer.getItem(InkMixerBlockEntity.BOTTLES).getCount(), 64,
"One bottle must be returned after refill");
helper.assertTrue(mixer.canCreateLinkPanel(), "Refill must enable Link Panel output");
helper.succeed();
}
@GameTest(template = "empty")
public static void shiftClickNeedsInventorySpaceAndBreakingReturnsInputs(GameTestHelper helper) {
InkMixerBlockEntity mixer = place(helper);
mixer.setItem(InkMixerBlockEntity.PAPER, new ItemStack(Items.PAPER, 2));
mixer.setItem(InkMixerBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(mixer.getBlockPos().getX() + 0.5, mixer.getBlockPos().getY() + 0.5,
mixer.getBlockPos().getZ() + 0.5);
InkMixerMenu menu = new InkMixerMenu(1, player.getInventory(), mixer);
for (int slot = 0; slot < 36; slot++) player.getInventory().setItem(slot, new ItemStack(Items.STONE, 64));
helper.assertTrue(menu.quickMoveStack(player, InkMixerMenu.RESULT).isEmpty(),
"Full inventory must not consume mixer output");
helper.assertValueEqual(mixer.getItem(InkMixerBlockEntity.PAPER).getCount(), 2,
"Full inventory must preserve paper");
player.getInventory().setItem(0, ItemStack.EMPTY);
helper.assertTrue(menu.quickMoveStack(player, InkMixerMenu.RESULT).is(ModItems.PAGE.get()),
"Free inventory space must accept the Link Panel");
helper.assertValueEqual(mixer.getItem(InkMixerBlockEntity.PAPER).getCount(), 1,
"Shift-click must consume only one paper");
helper.getLevel().setBlock(mixer.getBlockPos(), Blocks.AIR.defaultBlockState(), 3);
helper.assertFalse(menu.stillValid(player), "Breaking the mixer must invalidate its menu");
var drops = helper.getLevel().getEntitiesOfClass(ItemEntity.class,
new AABB(mixer.getBlockPos()).inflate(2));
int paper = drops.stream().filter(entity -> entity.getItem().is(Items.PAPER))
.mapToInt(entity -> entity.getItem().getCount()).sum();
int bottles = drops.stream().filter(entity -> entity.getItem().is(Items.GLASS_BOTTLE))
.mapToInt(entity -> entity.getItem().getCount()).sum();
helper.assertValueEqual(paper, 1, "Breaking the mixer must return unused paper once");
helper.assertValueEqual(bottles, 1, "Breaking the mixer must return the consumed vial's bottle once");
helper.succeed();
}
}
@@ -0,0 +1,76 @@
package net.dnorberg.rivencraft.gametest;
import java.util.List;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.book.LinkProperties;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.writing.LinkingBookRecipe;
import net.minecraft.core.component.DataComponents;
import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper;
import net.minecraft.network.chat.Component;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items;
import net.minecraft.world.item.crafting.CraftingBookCategory;
import net.minecraft.world.item.crafting.CraftingInput;
import net.minecraft.world.item.crafting.RecipeType;
import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
@GameTestHolder("rivencraft_archive_recipe")
@PrefixGameTestTemplate(false)
public final class LinkingBookRecipeGameTests {
private LinkingBookRecipeGameTests() {}
public static void legacyRecipeRequiresExactlyLeatherAndLinkPanel(GameTestHelper helper) {
LinkingBookRecipe recipe = new LinkingBookRecipe(CraftingBookCategory.MISC);
ItemStack panel = PageItem.createLinkPanelPage();
CraftingInput valid = CraftingInput.of(2, 1, List.of(panel, new ItemStack(Items.LEATHER)));
helper.assertTrue(recipe.matches(valid, helper.getLevel()), "Link Panel and leather must match");
helper.assertTrue(recipe.matches(CraftingInput.of(2, 1,
List.of(new ItemStack(Items.LEATHER), panel)), helper.getLevel()),
"The Legacy recipe must be shapeless");
helper.assertFalse(recipe.matches(CraftingInput.of(2, 1,
List.of(new ItemStack(Items.BOOK), new ItemStack(Items.ENDER_PEARL))), helper.getLevel()),
"The old placeholder recipe must no longer match");
helper.assertFalse(recipe.matches(CraftingInput.of(2, 1,
List.of(new ItemStack(ModItems.PAGE.get()), new ItemStack(Items.LEATHER))), helper.getLevel()),
"A blank Page must not substitute for a Link Panel");
helper.assertFalse(recipe.matches(CraftingInput.of(3, 1,
List.of(panel, new ItemStack(Items.LEATHER), new ItemStack(Items.PAPER))), helper.getLevel()),
"An extra ingredient must invalidate the recipe");
helper.succeed();
}
@GameTest(template = "empty")
public static void outputIsUnwrittenAndRegisteredRecipeLoads(GameTestHelper helper) {
ItemStack panel = PageItem.createLinkPanelPage();
panel.set(DataComponents.CUSTOM_NAME, Component.literal("Home Panel"));
panel.set(ModDataComponents.LINK_PROPERTIES.get(),
new LinkProperties(LinkProperties.INTRA_LINKING | LinkProperties.MAINTAIN_MOMENTUM));
CraftingInput input = CraftingInput.of(2, 1, List.of(panel, new ItemStack(Items.LEATHER)));
var holder = helper.getLevel().getRecipeManager()
.getRecipeFor(RecipeType.CRAFTING, input, helper.getLevel()).orElseThrow();
helper.assertValueEqual(holder.id(), ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "linking_book"),
"The registered recipe must replace the old placeholder");
ItemStack result = holder.value().assemble(input, helper.getLevel().registryAccess());
helper.assertTrue(result.is(ModItems.LINKING_BOOK.get()), "Crafting must produce a Linking Book");
helper.assertValueEqual(result.getCount(), 1, "Crafting must produce one book");
helper.assertFalse(result.has(ModDataComponents.LINK_TARGET.get()), "The book must be unwritten/unbound");
helper.assertFalse(result.has(ModDataComponents.PAGE_CONTENT.get()), "Page identity must not leak onto the book");
helper.assertValueEqual(result.get(DataComponents.CUSTOM_NAME), Component.literal("Home Panel"),
"The panel's custom name must survive crafting");
helper.assertValueEqual(result.get(ModDataComponents.LINK_PROPERTIES.get()),
panel.get(ModDataComponents.LINK_PROPERTIES.get()),
"The panel's link properties must survive crafting");
ItemStack restored = ItemStack.parseOptional(helper.getLevel().registryAccess(),
(net.minecraft.nbt.CompoundTag) result.saveOptional(helper.getLevel().registryAccess()));
helper.assertValueEqual(restored.get(ModDataComponents.LINK_PROPERTIES.get()),
panel.get(ModDataComponents.LINK_PROPERTIES.get()),
"The crafted book's link properties must persist through save/load");
helper.succeed();
}
}
@@ -2,6 +2,8 @@ package net.dnorberg.rivencraft.gametest;
import net.dnorberg.rivencraft.Rivencraft; import net.dnorberg.rivencraft.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;
@@ -9,9 +11,11 @@ import net.dnorberg.rivencraft.book.AgeRegistrySavedData;
import net.dnorberg.rivencraft.book.AgeRuntimeProfile; import net.dnorberg.rivencraft.book.AgeRuntimeProfile;
import net.dnorberg.rivencraft.book.AgeRuntimeProfiles; import net.dnorberg.rivencraft.book.AgeRuntimeProfiles;
import net.dnorberg.rivencraft.book.LinkTarget; import net.dnorberg.rivencraft.book.LinkTarget;
import net.dnorberg.rivencraft.book.LinkProperties;
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 +38,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 +46,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 +130,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 +183,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 +314,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 +386,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 +491,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 +515,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 +538,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");
@@ -632,7 +579,8 @@ public final class LinkingGameTests {
ServerPlayer player = helper.makeMockServerPlayerInLevel(); ServerPlayer player = helper.makeMockServerPlayerInLevel();
LinkTarget target = new LinkTarget(GlobalPos.of(helper.getLevel().dimension(), destination), 90.0F, 15.0F); LinkTarget target = new LinkTarget(GlobalPos.of(helper.getLevel().dimension(), destination), 90.0F, 15.0F);
LinkingService.LinkResult result = LinkingService.travel(player, target); LinkingService.LinkResult result = LinkingService.travel(player, target,
new LinkProperties(LinkProperties.INTRA_LINKING));
helper.assertValueEqual(result, LinkingService.LinkResult.SUCCESS, helper.assertValueEqual(result, LinkingService.LinkResult.SUCCESS,
"A Linking Book must accept leaf blocks even without a floor"); "A Linking Book must accept leaf blocks even without a floor");
@@ -657,7 +605,8 @@ public final class LinkingGameTests {
ServerPlayer player = helper.makeMockServerPlayerInLevel(); ServerPlayer player = helper.makeMockServerPlayerInLevel();
LinkTarget target = new LinkTarget(GlobalPos.of(helper.getLevel().dimension(), absoluteOrigin), 0.0F, 0.0F); LinkTarget target = new LinkTarget(GlobalPos.of(helper.getLevel().dimension(), absoluteOrigin), 0.0F, 0.0F);
helper.assertValueEqual(LinkingService.travelWithFooting(player, target), LinkingService.LinkResult.SUCCESS, helper.assertValueEqual(LinkingService.travelWithFooting(player, target,
new LinkProperties(LinkProperties.INTRA_LINKING)), LinkingService.LinkResult.SUCCESS,
"Descriptive Book travel must find an alternate grounded arrival"); "Descriptive Book travel must find an alternate grounded arrival");
BlockPos landing = player.blockPosition(); BlockPos landing = player.blockPosition();
helper.assertTrue(helper.getLevel().getBlockState(landing.below()).isFaceSturdy( helper.assertTrue(helper.getLevel().getBlockState(landing.below()).isFaceSturdy(
@@ -666,7 +615,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(
@@ -679,8 +627,10 @@ public final class LinkingGameTests {
ServerPlayer player = helper.makeMockServerPlayerInLevel(); ServerPlayer player = helper.makeMockServerPlayerInLevel();
LinkTarget target = new LinkTarget(GlobalPos.of(helper.getLevel().dimension(), absoluteOrigin), 0.0F, 0.0F); LinkTarget target = new LinkTarget(GlobalPos.of(helper.getLevel().dimension(), absoluteOrigin), 0.0F, 0.0F);
helper.assertValueEqual(LinkingService.travel(player, target), LinkingService.LinkResult.NO_SAFE_DESTINATION, helper.assertValueEqual(LinkingService.travel(player, target,
new LinkProperties(LinkProperties.INTRA_LINKING)), LinkingService.LinkResult.NO_SAFE_DESTINATION,
"Linking must fail rather than placing a player inside a blocked destination"); "Linking must fail rather than placing a player inside a blocked destination");
helper.succeed(); helper.succeed();
} }
} }
@@ -1,12 +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 net.dnorberg.rivencraft.Rivencraft; import java.util.UUID;
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;
@@ -29,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() {
@@ -46,6 +53,8 @@ public final class WritingDataGameTests {
)); ));
var json = OrderedWriting.CODEC.encodeStart(JsonOps.INSTANCE, original).result().orElseThrow(); var json = OrderedWriting.CODEC.encodeStart(JsonOps.INSTANCE, original).result().orElseThrow();
helper.assertValueEqual(json.getAsJsonObject().get("schema_version").getAsInt(),
OrderedWriting.CURRENT_SCHEMA_VERSION, "Writing must save an explicit schema version");
OrderedWriting persistentCopy = OrderedWriting.CODEC.parse(JsonOps.INSTANCE, json).result().orElseThrow(); OrderedWriting persistentCopy = OrderedWriting.CODEC.parse(JsonOps.INSTANCE, json).result().orElseThrow();
helper.assertValueEqual(persistentCopy, original, helper.assertValueEqual(persistentCopy, original,
"Persistent writing codec must retain entry order and unknown symbol IDs"); "Persistent writing codec must retain entry order and unknown symbol IDs");
@@ -58,6 +67,27 @@ public final class WritingDataGameTests {
helper.succeed(); helper.succeed();
} }
public static void oldBareListWritingAndPageFreeBooksRemainReadable(GameTestHelper helper) {
OrderedWriting writing = new OrderedWriting(List.of(
WritingEntry.linkPanel(), WritingEntry.symbol(reference("example:removed_symbol"))));
var oldJson = WritingEntry.CODEC.listOf().encodeStart(JsonOps.INSTANCE, writing.entries())
.result().orElseThrow();
OrderedWriting migrated = OrderedWriting.CODEC.parse(JsonOps.INSTANCE, oldJson).result().orElseThrow();
helper.assertValueEqual(migrated, writing,
"0.3.7.2 bare-list writing must load into schema version 1 intact");
ItemStack oldPageFreeBook = new ItemStack(ModItems.DESCRIPTIVE_BOOK.get());
AgeReference originalAge = new AgeReference(UUID.randomUUID(), "Legacy Page-Free Age");
oldPageFreeBook.set(ModDataComponents.AGE_REFERENCE.get(), originalAge);
CompoundTag saved = (CompoundTag) oldPageFreeBook.saveOptional(helper.getLevel().registryAccess());
ItemStack restored = ItemStack.parseOptional(helper.getLevel().registryAccess(), saved);
helper.assertValueEqual(restored.get(ModDataComponents.AGE_REFERENCE.get()), originalAge,
"A page-free book must keep its existing Age identity");
helper.assertValueEqual(restored.getOrDefault(ModDataComponents.BOOK_WRITING.get(), OrderedWriting.EMPTY),
OrderedWriting.EMPTY, "Older page-free books must not require writing migration");
helper.succeed();
}
@GameTest(template = "empty") @GameTest(template = "empty")
public static void serverCatalogResolvesBuiltinsAndKeepsUnknownReferencesReadable(GameTestHelper helper) { public static void serverCatalogResolvesBuiltinsAndKeepsUnknownReferencesReadable(GameTestHelper helper) {
SymbolReference known = reference("rivencraft:terrain/standard"); SymbolReference known = reference("rivencraft:terrain/standard");
@@ -76,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");
@@ -100,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");
@@ -116,6 +235,10 @@ public final class WritingDataGameTests {
); );
ItemStack recovered = PageItem.createRecoveredPage(unknown); ItemStack recovered = PageItem.createRecoveredPage(unknown);
CompoundTag recoveredTag = (CompoundTag) recovered.saveOptional(helper.getLevel().registryAccess());
ItemStack restoredRecovered = ItemStack.parseOptional(helper.getLevel().registryAccess(), recoveredTag);
helper.assertValueEqual(PageItem.content(restoredRecovered).symbol().orElseThrow(), unknown,
"A missing symbol must survive a full Page item reload");
helper.assertFalse(PageItem.isUsableWriting(recovered), helper.assertFalse(PageItem.isUsableWriting(recovered),
"An unresolved page must remain recoverable without becoming valid writing"); "An unresolved page must remain recoverable without becoming valid writing");
try { try {
@@ -126,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,
@@ -165,6 +287,8 @@ public final class WritingDataGameTests {
helper.assertFalse(menu.getSlot(0).mayPlace(new ItemStack(Items.DIRT)), helper.assertFalse(menu.getSlot(0).mayPlace(new ItemStack(Items.DIRT)),
"Notebook slots must reject non-Page items"); "Notebook slots must reject non-Page items");
helper.assertFalse(menu.getSlot(0).mayPlace(PageItem.createLinkPanelPage()),
"Notebook slots must reject Link Panels");
menu.getSlot(0).set(first); menu.getSlot(0).set(first);
menu.getSlot(1).set(second); menu.getSlot(1).set(second);
helper.assertTrue(menu.clickMenuButton(player, NotebookMenu.MOVE_NEXT_BASE), helper.assertTrue(menu.clickMenuButton(player, NotebookMenu.MOVE_NEXT_BASE),
@@ -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() {}
@@ -61,10 +60,10 @@ public final class WritingDeskGameTests {
helper.getLevel().setBlock(pos, Blocks.AIR.defaultBlockState(), 3); helper.getLevel().setBlock(pos, Blocks.AIR.defaultBlockState(), 3);
var drops = helper.getLevel().getEntitiesOfClass(ItemEntity.class, new AABB(pos).inflate(2)); var drops = helper.getLevel().getEntitiesOfClass(ItemEntity.class, new AABB(pos).inflate(2));
int notebooks = drops.stream().filter(e -> e.getItem().is(ModItems.NOTEBOOK.get())).mapToInt(e -> e.getItem().getCount()).sum(); int notebooks = drops.stream().filter(e -> e.getItem().is(ModItems.NOTEBOOK.get())).mapToInt(e -> e.getItem().getCount()).sum();
int ink = drops.stream().filter(e -> e.getItem().is(ModItems.INK_VIAL.get())).mapToInt(e -> e.getItem().getCount()).sum(); int bottles = drops.stream().filter(e -> e.getItem().is(Items.GLASS_BOTTLE)).mapToInt(e -> e.getItem().getCount()).sum();
int pages = drops.stream().filter(e -> e.getItem().is(Items.PAPER)).mapToInt(e -> e.getItem().getCount()).sum(); int pages = drops.stream().filter(e -> e.getItem().is(Items.PAPER)).mapToInt(e -> e.getItem().getCount()).sum();
helper.assertValueEqual(notebooks, 1, "Notebook must drop exactly once"); helper.assertValueEqual(notebooks, 1, "Notebook must drop exactly once");
helper.assertValueEqual(ink, 1, "Ink must drop exactly once"); helper.assertValueEqual(bottles, 1, "Consumed vial must return one glass bottle on break");
helper.assertValueEqual(pages, 12, "Pages must drop without loss"); helper.assertValueEqual(pages, 12, "Pages must drop without loss");
helper.succeed(); helper.succeed();
} }
@@ -81,7 +80,7 @@ public final class WritingDeskGameTests {
helper.assertTrue(menu.stillValid(player), "Placed desk must keep its menu valid"); helper.assertTrue(menu.stillValid(player), "Placed desk must keep its menu valid");
helper.assertTrue(menu.clickMenuButton(player, 3), "Active collection control must accept a valid tab"); helper.assertTrue(menu.clickMenuButton(player, 3), "Active collection control must accept a valid tab");
helper.assertValueEqual(desk.activeCollection(), 3, "Selected tab must be stored on the desk"); helper.assertValueEqual(desk.activeCollection(), 3, "Selected tab must be stored on the desk");
menu.quickMoveStack(player, 9); menu.quickMoveStack(player, WritingDeskMenu.COPY_RESULT + 1);
helper.assertValueEqual(desk.getItem(WritingDeskBlockEntity.PAPER).getCount(), 12, "Shift-click must deposit all pages"); helper.assertValueEqual(desk.getItem(WritingDeskBlockEntity.PAPER).getCount(), 12, "Shift-click must deposit all pages");
helper.assertTrue(player.getInventory().getItem(9).isEmpty(), "Shift-click must consume player source stack"); helper.assertTrue(player.getInventory().getItem(9).isEmpty(), "Shift-click must consume player source stack");
menu.quickMoveStack(player, WritingDeskBlockEntity.PAPER); menu.quickMoveStack(player, WritingDeskBlockEntity.PAPER);
@@ -94,12 +93,11 @@ 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);
WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos); WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
ItemStack source = PageItem.createLinkPanelPage(); ItemStack source = terrainPage();
desk.setItem(0, source.copy()); desk.setItem(0, source.copy());
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER, 2)); desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER, 2));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get())); desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
@@ -111,12 +109,12 @@ public final class WritingDeskGameTests {
"A source page with paper and ink must preview one copy"); "A source page with paper and ink must preview one copy");
helper.assertValueEqual(desk.getItem(WritingDeskBlockEntity.PAPER).getCount(), 2, helper.assertValueEqual(desk.getItem(WritingDeskBlockEntity.PAPER).getCount(), 2,
"Previewing must not consume paper"); "Previewing must not consume paper");
helper.assertValueEqual(desk.inkRemaining(), 0, "Previewing must not consume ink"); helper.assertValueEqual(desk.inkRemaining(), 16, "Inserting a vial must fill the empty bar before copying");
menu.clicked(WritingDeskMenu.COPY_RESULT, 0, ClickType.PICKUP, player); menu.clicked(WritingDeskMenu.COPY_RESULT, 0, ClickType.PICKUP, player);
helper.assertTrue(menu.getCarried().is(ModItems.PAGE.get()), "Taking result must give the copied page"); helper.assertTrue(menu.getCarried().is(ModItems.PAGE.get()), "Taking result must give the copied page");
helper.assertValueEqual(desk.getItem(WritingDeskBlockEntity.PAPER).getCount(), 1, helper.assertValueEqual(desk.getItem(WritingDeskBlockEntity.PAPER).getCount(), 1,
"Taking a copy must consume one paper"); "Taking a copy must consume one paper");
helper.assertValueEqual(desk.inkRemaining(), 15, "First copy must refill to 16 and consume one ink"); helper.assertValueEqual(desk.inkRemaining(), 15, "First copy must consume one ink");
helper.assertTrue(desk.getItem(WritingDeskBlockEntity.INK).isEmpty(), "Refill must consume one vial"); helper.assertTrue(desk.getItem(WritingDeskBlockEntity.INK).isEmpty(), "Refill must consume one vial");
helper.assertTrue(desk.getItem(WritingDeskBlockEntity.RETURN).is(Items.GLASS_BOTTLE), helper.assertTrue(desk.getItem(WritingDeskBlockEntity.RETURN).is(Items.GLASS_BOTTLE),
"Refill must return a vanilla glass bottle"); "Refill must return a vanilla glass bottle");
@@ -135,15 +133,57 @@ public final class WritingDeskGameTests {
helper.succeed(); helper.succeed();
} }
@GameTest(template = "empty")
public static void emptyDeskInkBarRefillsWithoutCopying(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get(), 2));
helper.assertValueEqual(desk.inkRemaining(), 16, "Inserting a vial must refill immediately");
helper.assertValueEqual(desk.getItem(WritingDeskBlockEntity.INK).getCount(), 1,
"Refill must consume exactly one vial");
helper.assertTrue(desk.getItem(WritingDeskBlockEntity.RETURN).is(Items.GLASS_BOTTLE),
"Refill must put a vanilla glass bottle in the return slot");
helper.runAfterDelay(2, () -> {
helper.assertValueEqual(desk.inkRemaining(), 16, "Full bar must not refill again");
helper.assertValueEqual(desk.getItem(WritingDeskBlockEntity.INK).getCount(), 1,
"Full bar must leave the second vial untouched");
helper.assertValueEqual(desk.getItem(WritingDeskBlockEntity.RETURN).getCount(), 1,
"Full bar must not create another bottle");
helper.succeed();
});
}
@GameTest(template = "empty")
public static void emptyDeskInkBarWaitsForBottleSpace(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
desk.setItem(WritingDeskBlockEntity.RETURN, new ItemStack(Items.GLASS_BOTTLE, 64));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
helper.assertValueEqual(desk.inkRemaining(), 0, "Full bottle slot must block automatic refill");
helper.assertTrue(desk.getItem(WritingDeskBlockEntity.INK).is(ModItems.INK_VIAL.get()),
"Blocked refill must preserve the vial");
helper.assertValueEqual(desk.getItem(WritingDeskBlockEntity.RETURN).getCount(), 64,
"Blocked refill must preserve the bottle stack");
desk.removeItem(WritingDeskBlockEntity.RETURN, 1);
helper.assertValueEqual(desk.inkRemaining(), 16, "Removing a bottle must immediately permit refill");
helper.assertTrue(desk.getItem(WritingDeskBlockEntity.INK).isEmpty(),
"Refill must consume the waiting vial");
helper.assertValueEqual(desk.getItem(WritingDeskBlockEntity.RETURN).getCount(), 64,
"Refill must return one glass bottle to the available space");
helper.succeed();
}
@GameTest(template = "empty") @GameTest(template = "empty")
public static void shiftClickCopiesOnlyWhenResourcesAndBottleSpaceExist(GameTestHelper helper) { public static void shiftClickCopiesOnlyWhenResourcesAndBottleSpaceExist(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);
WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos); WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
desk.setItem(0, PageItem.createLinkPanelPage()); desk.setItem(0, terrainPage());
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER, 2)); desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER, 2));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
desk.setItem(WritingDeskBlockEntity.RETURN, new ItemStack(Items.GLASS_BOTTLE, 64)); desk.setItem(WritingDeskBlockEntity.RETURN, new ItemStack(Items.GLASS_BOTTLE, 64));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
var player = helper.makeMockServerPlayerInLevel(); var player = helper.makeMockServerPlayerInLevel();
player.moveTo(pos.getX() + 0.5, pos.getY() + 0.5, pos.getZ() + 0.5); player.moveTo(pos.getX() + 0.5, pos.getY() + 0.5, pos.getZ() + 0.5);
WritingDeskMenu menu = new WritingDeskMenu(1, player.getInventory(), desk); WritingDeskMenu menu = new WritingDeskMenu(1, player.getInventory(), desk);
@@ -170,7 +210,7 @@ public final class WritingDeskGameTests {
WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos); WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
ItemStack notebook = new ItemStack(ModItems.NOTEBOOK.get()); ItemStack notebook = new ItemStack(ModItems.NOTEBOOK.get());
notebook.set(ModDataComponents.NOTEBOOK_CONTENTS.get(), notebook.set(ModDataComponents.NOTEBOOK_CONTENTS.get(),
new NotebookContents(List.of(ItemStack.EMPTY, PageItem.createLinkPanelPage()))); new NotebookContents(List.of(ItemStack.EMPTY, terrainPage())));
desk.setItem(0, notebook); desk.setItem(0, notebook);
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER)); desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get())); desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
@@ -180,7 +220,7 @@ public final class WritingDeskGameTests {
menu.broadcastChanges(); menu.broadcastChanges();
helper.assertTrue(menu.getSlot(WritingDeskMenu.COPY_RESULT).getItem().isEmpty(), helper.assertTrue(menu.getSlot(WritingDeskMenu.COPY_RESULT).getItem().isEmpty(),
"An empty selected position must not create a copy"); "An empty selected position must not create a copy");
helper.assertTrue(menu.clickMenuButton(player, 17), "Second page selection must be accepted"); helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.PAGE_BUTTON_BASE + 1), "Second page selection must be accepted");
menu.broadcastChanges(); menu.broadcastChanges();
helper.assertTrue(menu.getSlot(WritingDeskMenu.COPY_RESULT).getItem().is(ModItems.PAGE.get()), helper.assertTrue(menu.getSlot(WritingDeskMenu.COPY_RESULT).getItem().is(ModItems.PAGE.get()),
"Selecting the populated page must show a copy"); "Selecting the populated page must show a copy");
@@ -192,7 +232,7 @@ public final class WritingDeskGameTests {
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);
WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos); WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
desk.setItem(0, PageItem.createLinkPanelPage()); desk.setItem(0, terrainPage());
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER)); desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get())); desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
var first = helper.makeMockServerPlayerInLevel(); var first = helper.makeMockServerPlayerInLevel();
@@ -207,11 +247,39 @@ public final class WritingDeskGameTests {
"First viewer should take the last available copy"); "First viewer should take the last available copy");
helper.assertTrue(secondMenu.quickMoveStack(second, WritingDeskMenu.COPY_RESULT).isEmpty(), helper.assertTrue(secondMenu.quickMoveStack(second, WritingDeskMenu.COPY_RESULT).isEmpty(),
"Second viewer must not copy the already-consumed paper"); "Second viewer must not copy the already-consumed paper");
helper.assertTrue(firstMenu.quickMoveStack(first, WritingDeskMenu.COPY_RESULT).isEmpty(),
"Replaying the first viewer's output request must not make another page");
helper.assertTrue(desk.getItem(WritingDeskBlockEntity.PAPER).isEmpty(), helper.assertTrue(desk.getItem(WritingDeskBlockEntity.PAPER).isEmpty(),
"Shared desk must spend paper only once"); "Shared desk must spend paper only once");
helper.succeed(); helper.succeed();
} }
public static void forgedDeskSelectionsAndStaleMenuCannotCopy(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
desk.setItem(0, terrainPage());
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(pos.getX() + 0.5, pos.getY() + 0.5, pos.getZ() + 0.5);
WritingDeskMenu menu = new WritingDeskMenu(1, player.getInventory(), desk);
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.CATALOG_BUTTON_BASE + 999),
"A fabricated catalog index must be rejected");
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.ALL_PAGE_BUTTON_BASE + 27),
"A fabricated page address must be rejected");
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.extractPageButtonId(0, 0,
WritingDeskBlockEntity.PAPER)), "A page cannot be extracted into a material slot");
helper.assertValueEqual(desk.getItem(WritingDeskBlockEntity.PAPER).getCount(), 1,
"Forged actions must not spend paper");
helper.assertTrue(desk.getItem(0).is(ModItems.PAGE.get()), "Forged actions must not remove the source");
helper.getLevel().setBlock(pos, Blocks.AIR.defaultBlockState(), 3);
helper.assertFalse(menu.clickMenuButton(player, 0), "A stale menu must reject selection packets");
helper.assertTrue(menu.quickMoveStack(player, WritingDeskMenu.COPY_RESULT).isEmpty(),
"A stale menu must reject output packets");
helper.succeed();
}
@GameTest(template = "empty") @GameTest(template = "empty")
public static void catalogAggregatesKnownSymbolsAcrossCollections(GameTestHelper helper) { public static void catalogAggregatesKnownSymbolsAcrossCollections(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1)); BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
@@ -230,8 +298,8 @@ public final class WritingDeskGameTests {
var player = helper.makeMockServerPlayerInLevel(); var player = helper.makeMockServerPlayerInLevel();
player.moveTo(pos.getX() + 0.5, pos.getY() + 0.5, pos.getZ() + 0.5); player.moveTo(pos.getX() + 0.5, pos.getY() + 0.5, pos.getZ() + 0.5);
WritingDeskMenu menu = new WritingDeskMenu(1, player.getInventory(), desk); WritingDeskMenu menu = new WritingDeskMenu(1, player.getInventory(), desk);
helper.assertFalse(menu.clickMenuButton(player, 101), "Out-of-range catalog index must be rejected"); helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.CATALOG_BUTTON_BASE + 1), "Out-of-range catalog index must be rejected");
helper.assertTrue(menu.clickMenuButton(player, 100), "Known catalog symbol must be selectable"); helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.CATALOG_BUTTON_BASE), "Known catalog symbol must be selectable");
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER)); desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get())); desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
menu.broadcastChanges(); menu.broadcastChanges();
@@ -251,7 +319,7 @@ public final class WritingDeskGameTests {
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);
WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos); WritingDeskBlockEntity desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
desk.setItem(0, PageItem.createLinkPanelPage()); desk.setItem(0, terrainPage());
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER)); desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get())); desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
var player = helper.makeMockServerPlayerInLevel(); var player = helper.makeMockServerPlayerInLevel();
@@ -262,13 +330,12 @@ public final class WritingDeskGameTests {
"Full inventory must reject shift-click copy"); "Full inventory must reject shift-click copy");
helper.assertValueEqual(desk.getItem(WritingDeskBlockEntity.PAPER).getCount(), 1, helper.assertValueEqual(desk.getItem(WritingDeskBlockEntity.PAPER).getCount(), 1,
"Rejected copy must preserve paper"); "Rejected copy must preserve paper");
helper.assertValueEqual(desk.inkRemaining(), 0, "Rejected copy must preserve ink meter"); helper.assertValueEqual(desk.inkRemaining(), 16, "Rejected copy must preserve the filled ink meter");
helper.assertTrue(desk.getItem(WritingDeskBlockEntity.INK).is(ModItems.INK_VIAL.get()), helper.assertTrue(desk.getItem(WritingDeskBlockEntity.INK).isEmpty(),
"Rejected copy must preserve ink vial"); "The vial should already have refilled the empty meter");
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();
@@ -340,9 +407,9 @@ public final class WritingDeskGameTests {
var player = helper.makeMockServerPlayerInLevel(); var player = helper.makeMockServerPlayerInLevel();
player.moveTo(pos.getX() + 0.5, pos.getY() + 0.5, pos.getZ() + 0.5); player.moveTo(pos.getX() + 0.5, pos.getY() + 0.5, pos.getZ() + 0.5);
WritingDeskMenu menu = new WritingDeskMenu(1, player.getInventory(), desk); WritingDeskMenu menu = new WritingDeskMenu(1, player.getInventory(), desk);
helper.assertFalse(menu.clickMenuButton(player, 1000 + 2 * NotebookContents.MAX_PAGES), helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.ALL_PAGE_BUTTON_BASE + 2 * NotebookContents.MAX_PAGES),
"ALL view must reject empty cross-tab positions"); "ALL view must reject empty cross-tab positions");
helper.assertTrue(menu.clickMenuButton(player, 1000 + NotebookContents.MAX_PAGES + 1), helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.ALL_PAGE_BUTTON_BASE + NotebookContents.MAX_PAGES + 1),
"ALL view must accept the populated second tab page"); "ALL view must accept the populated second tab page");
helper.assertTrue(ItemStack.matches(menu.getSlot(WritingDeskMenu.COPY_RESULT).getItem(), second), helper.assertTrue(ItemStack.matches(menu.getSlot(WritingDeskMenu.COPY_RESULT).getItem(), second),
"Copy preview must match the physical page selected from the other tab"); "Copy preview must match the physical page selected from the other tab");
@@ -350,4 +417,272 @@ public final class WritingDeskGameTests {
"Selecting from ALL must not silently change the active tab"); "Selecting from ALL must not silently change the active tab");
helper.succeed(); helper.succeed();
} }
@GameTest(template = "empty")
public static void tabGroupsCycleByFourAndProtectHiddenSlots(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
var desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(pos.getX() + 0.5, pos.getY() + 0.5, pos.getZ() + 0.5);
var menu = new WritingDeskMenu(1, player.getInventory(), desk);
var otherViewer = new WritingDeskMenu(2, player.getInventory(), desk);
menu.clickMenuButton(player, WritingDeskMenu.PREVIOUS_TABS);
helper.assertValueEqual(menu.firstVisibleTab(), 0, "Previous must stop at tabs 1-4");
menu.clickMenuButton(player, WritingDeskMenu.NEXT_TABS);
helper.assertValueEqual(menu.firstVisibleTab(), 4, "Next must show tabs 5-8");
helper.assertValueEqual(otherViewer.firstVisibleTab(), 0, "Cycling must not move another viewer's slots");
helper.assertFalse(menu.getSlot(0).isActive(), "Earlier tab slots must be hidden");
helper.assertTrue(menu.getSlot(4).isActive(), "New group's slots must be interactive");
desk.setItem(0, new ItemStack(ModItems.NOTEBOOK.get()));
menu.clicked(0, 0, ClickType.PICKUP, player);
helper.assertTrue(menu.getCarried().isEmpty(), "Hidden slot clicks must not take items");
helper.assertTrue(menu.quickMoveStack(player, 0).isEmpty(), "Hidden shift-click must be rejected");
player.getInventory().setItem(9, new ItemStack(ModItems.NOTEBOOK.get()));
menu.quickMoveStack(player, WritingDeskMenu.COPY_RESULT + 1);
helper.assertTrue(desk.getItem(4).is(ModItems.NOTEBOOK.get()), "Shift-click must use the visible group");
for (int i = 0; i < 30; i++) menu.clickMenuButton(player, WritingDeskMenu.NEXT_TABS);
helper.assertValueEqual(menu.firstVisibleTab(), 84, "Last group must be tabs 85-88");
helper.assertTrue(menu.clickMenuButton(player, 87), "Tab 88 must be selectable without page-ID collisions");
helper.assertValueEqual(desk.activeCollection(), 87, "Tab 88 must become active");
helper.assertFalse(menu.clickMenuButton(player, 88), "Tab 89 must not exist");
desk.setItem(87, terrainPage());
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.ALL_PAGE_BUTTON_BASE + 87 * NotebookContents.MAX_PAGES),
"ALL must select a physical page from tab 88");
helper.assertTrue(menu.quickMoveStack(player, WritingDeskMenu.COPY_RESULT).is(ModItems.PAGE.get()),
"Tab 88's page must be copyable");
menu.clickMenuButton(player, WritingDeskMenu.PREVIOUS_TABS);
helper.assertValueEqual(menu.firstVisibleTab(), 80, "Previous must move back four tabs");
helper.succeed();
}
public static void oldDeskInventoryMigratesAndAll88TabsPersist(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
var registries = helper.getLevel().registryAccess();
var oldItems = net.minecraft.core.NonNullList.withSize(8, ItemStack.EMPTY);
oldItems.set(0, new ItemStack(ModItems.NOTEBOOK.get()));
oldItems.set(3, PageItem.createLinkPanelPage());
oldItems.set(4, new ItemStack(ModItems.INK_VIAL.get(), 2));
oldItems.set(5, new ItemStack(Items.GLASS_BOTTLE, 3));
oldItems.set(6, new ItemStack(Items.PAPER, 12));
oldItems.set(7, PageItem.createLinkPanelPage());
var oldTag = new net.minecraft.nbt.CompoundTag();
net.minecraft.world.ContainerHelper.saveAllItems(oldTag, oldItems, registries);
oldTag.putInt("InkRemaining", 7);
oldTag.putInt("ActiveCollection", 3);
var desk = new WritingDeskBlockEntity(pos, ModBlocks.WRITING_DESK.get().defaultBlockState());
desk.loadWithComponents(oldTag, registries);
for (int i = 0; i < 4; i++) {
helper.assertTrue(ItemStack.matches(desk.getItem(i), oldItems.get(i)), "Original tab must survive migration");
helper.assertTrue(ItemStack.matches(desk.getItem(WritingDeskBlockEntity.INK + i), oldItems.get(4 + i)),
"Original supplies and legacy output must survive migration");
helper.assertTrue(desk.getItem(4 + i).isEmpty(), "Supplies must not be duplicated into new tabs");
}
helper.assertValueEqual(desk.inkRemaining(), 7, "Migration must preserve ink meter");
helper.assertValueEqual(desk.activeCollection(), 3, "Migration must preserve active tab");
for (int i = 0; i < WritingDeskBlockEntity.COLLECTIONS; i++) desk.setItem(i, PageItem.createLinkPanelPage());
desk.setActiveCollection(87);
var restored = new WritingDeskBlockEntity(pos, ModBlocks.WRITING_DESK.get().defaultBlockState());
restored.loadWithComponents(desk.saveWithoutMetadata(registries), registries);
for (int i = 0; i < WritingDeskBlockEntity.COLLECTIONS; i++)
helper.assertTrue(restored.getItem(i).is(ModItems.PAGE.get()), "All 88 tab contents must survive save/load");
helper.assertValueEqual(restored.activeCollection(), 87, "Tab 88 selection must survive save/load");
helper.assertValueEqual(restored.getItem(WritingDeskBlockEntity.PAPER).getCount(), 12, "Reload must not repeat migration");
helper.succeed();
}
@GameTest(template = "empty")
public static void surfacePlacesCarriedPagesWithoutLossOrOverwrite(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
var desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
desk.setItem(87, new ItemStack(ModItems.NOTEBOOK.get()));
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(pos.getX() + 0.5, pos.getY() + 0.5, pos.getZ() + 0.5);
var menu = new WritingDeskMenu(1, player.getInventory(), desk);
ItemStack held = terrainPage().copyWithCount(3);
ItemStack expectedPage = held.copyWithCount(1);
player.getInventory().setItem(9, held);
menu.clicked(WritingDeskMenu.COPY_RESULT + 1, 0, ClickType.PICKUP, player);
int lastPosition = WritingDeskMenu.PLACE_PAGE_BUTTON_BASE + 87 * NotebookContents.MAX_PAGES + 26;
helper.assertTrue(menu.clickMenuButton(player, lastPosition), "Surface must place into final notebook position");
helper.assertValueEqual(menu.getCarried().getCount(), 2, "Placing must consume exactly one held page");
var pages = desk.getItem(87).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pages();
helper.assertValueEqual(pages.size(), 27, "Placement must preserve addressed position");
helper.assertTrue(pages.get(0).isEmpty() && pages.get(25).isEmpty(), "Placement must preserve preceding gaps");
helper.assertTrue(ItemStack.matches(pages.get(26), expectedPage), "Stored page must preserve components");
helper.assertFalse(menu.clickMenuButton(player, lastPosition), "Occupied position must not be overwritten");
helper.assertValueEqual(menu.getCarried().getCount(), 2, "Rejected placement must preserve cursor");
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.PLACE_PAGE_BUTTON_BASE + 88 * NotebookContents.MAX_PAGES),
"Out-of-range placement must be rejected");
helper.assertValueEqual(menu.pageCapacity(87), NotebookContents.MAX_PAGES, "Notebook tab must expose normal notebook capacity");
helper.assertValueEqual(menu.pageCapacity(0), 0, "Empty tab has no page storage");
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.PLACE_PAGE_BUTTON_BASE), "Empty tab must require a collection first");
desk.setItem(0, terrainPage());
helper.assertValueEqual(menu.pageCapacity(0), 1, "Loose page tab must expose exactly one position");
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.PLACE_PAGE_BUTTON_BASE), "Loose page must not be replaced");
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.PLACE_PAGE_BUTTON_BASE + 1), "Loose page tab must not grow extra positions");
helper.assertValueEqual(menu.getCarried().getCount(), 2, "Rejected placements must preserve cursor");
helper.assertTrue(menu.clickMenuButton(player, lastPosition - 1), "A second empty notebook position must accept a page");
helper.assertTrue(menu.clickMenuButton(player, lastPosition - 2), "A third empty notebook position must accept the last page");
helper.assertTrue(menu.getCarried().isEmpty(), "Final placement must clear cursor");
menu.setCarried(new ItemStack(Items.DIAMOND));
helper.assertFalse(menu.clickMenuButton(player, lastPosition - 3), "Non-page items must be rejected");
helper.assertTrue(menu.getCarried().is(Items.DIAMOND), "Rejected item must remain held");
var restored = new WritingDeskBlockEntity(pos, ModBlocks.WRITING_DESK.get().defaultBlockState());
restored.loadWithComponents(desk.saveWithoutMetadata(helper.getLevel().registryAccess()), helper.getLevel().registryAccess());
helper.assertValueEqual(restored.getItem(87).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pageCount(), 3,
"Placed pages must persist in the notebook");
helper.succeed();
}
@GameTest(template = "empty")
public static void deskSurfaceDragMovesAndSwapsNotebookPages(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
var desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
ItemStack movingPage = terrainPage();
ItemStack terrain = terrainPage();
ItemStack firstBook = new ItemStack(ModItems.NOTEBOOK.get());
firstBook.set(ModDataComponents.NOTEBOOK_CONTENTS.get(), new NotebookContents(List.of(movingPage, terrain)));
desk.setItem(0, firstBook);
desk.setItem(1, new ItemStack(ModItems.NOTEBOOK.get()));
desk.setItem(2, terrainPage());
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(pos.getX() + 0.5, pos.getY() + 0.5, pos.getZ() + 0.5);
var menu = new WritingDeskMenu(1, player.getInventory(), desk);
int moveToEmpty = WritingDeskMenu.movePageButtonId(0, 0, 0, 26);
helper.assertTrue(menu.clickMenuButton(player, moveToEmpty), "Drag must move to a distant empty notebook position");
var pages = desk.getItem(0).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pages();
helper.assertTrue(pages.get(0).isEmpty(), "Moving must clear the source position");
helper.assertTrue(ItemStack.matches(pages.get(26), movingPage), "Moving must preserve page components");
helper.assertValueEqual(desk.getItem(0).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pageCount(), 2,
"Moving must preserve total page count");
helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.movePageButtonId(0, 26, 0, 1)),
"Drag onto an occupied position must swap pages");
pages = desk.getItem(0).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pages();
helper.assertTrue(ItemStack.matches(pages.get(1), movingPage) && ItemStack.matches(pages.get(26), terrain),
"Swap must preserve both pages");
helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.movePageButtonId(0, 1, 1, 5)),
"Drag into another notebook must work");
var otherPages = desk.getItem(1).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pages();
helper.assertTrue(ItemStack.matches(otherPages.get(5), movingPage)
&& desk.getItem(0).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pages().get(1).isEmpty(),
"Cross notebook move must have one destination and no old source");
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.movePageButtonId(0, 1, 1, 6)),
"Dragging an empty source must be rejected");
helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.movePageButtonId(2, 0, 1, 6)),
"A loose page should move into a notebook position");
helper.assertTrue(desk.getItem(2).isEmpty()
&& desk.getItem(1).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pages().get(6).is(ModItems.PAGE.get()),
"Moving a loose page must empty its tab without losing the item");
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.movePageButtonId(1, 5, 1, 5)),
"A no-op drag must be rejected");
menu.setCarried(new ItemStack(Items.DIAMOND));
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.movePageButtonId(1, 5, 1, 6)),
"Held inventory items must not be moved by a panel drag");
helper.assertTrue(ItemStack.matches(desk.getItem(1).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pages().get(5), movingPage),
"Rejected drags must leave notebook data intact");
helper.succeed();
}
@GameTest(template = "empty")
public static void deskSurfaceDragExtractsPagesToInventoryAndTabs(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
var desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
ItemStack page = terrainPage();
ItemStack source = new ItemStack(ModItems.NOTEBOOK.get());
source.set(ModDataComponents.NOTEBOOK_CONTENTS.get(),
new NotebookContents(List.of(page, page, page, page, page, page)));
desk.setItem(0, source);
ItemStack otherBook = new ItemStack(ModItems.NOTEBOOK.get());
ItemStack terrain = PageItem.createSymbolPage(new SymbolReference(
ResourceLocation.parse("rivencraft:terrain/standard")));
otherBook.set(ModDataComponents.NOTEBOOK_CONTENTS.get(), new NotebookContents(List.of(terrain)));
desk.setItem(2, otherBook);
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(pos.getX() + 0.5, pos.getY() + 0.5, pos.getZ() + 0.5);
player.getInventory().setItem(10, page.copyWithCount(2));
var menu = new WritingDeskMenu(1, player.getInventory(), desk);
int inventoryStart = WritingDeskMenu.COPY_RESULT + 1;
helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.extractPageButtonId(0, 0, -1)),
"Dropping away from a slot must return the page to the cursor");
helper.assertTrue(ItemStack.matches(menu.getCarried(), page), "Cursor must hold the original page item");
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.extractPageButtonId(0, 1, inventoryStart)),
"Extraction must not replace an occupied cursor");
menu.setCarried(ItemStack.EMPTY);
helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.extractPageButtonId(0, 1, inventoryStart)),
"Dropping on player inventory must transfer a page");
helper.assertTrue(ItemStack.matches(player.getInventory().getItem(9), page),
"Transferred page must retain its components");
helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.extractPageButtonId(0, 2, 1)),
"Dropping on an empty tab must store a loose page");
helper.assertTrue(ItemStack.matches(desk.getItem(1), page), "Tab must hold the extracted page");
helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.extractPageButtonId(0, 3, 2)),
"Dropping on a notebook tab must insert the page");
var otherPages = desk.getItem(2).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pages();
helper.assertTrue(ItemStack.matches(otherPages.get(0), terrain)
&& ItemStack.matches(otherPages.get(1), page), "Notebook drop must preserve existing pages");
helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.extractPageButtonId(0, 4, inventoryStart + 1)),
"Dropping on a matching inventory stack must merge one page");
helper.assertValueEqual(player.getInventory().getItem(10).getCount(), 3, "Merge must add exactly one page");
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.extractPageButtonId(0, 5, 1)),
"Occupied loose-page tabs must reject a drop");
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.extractPageButtonId(0, 5, WritingDeskBlockEntity.INK)),
"Ink slot must not accept an extracted page");
helper.assertValueEqual(desk.getItem(0).get(ModDataComponents.NOTEBOOK_CONTENTS.get()).pageCount(), 1,
"Rejected drops must leave the remaining source page in the notebook");
helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.extractPageButtonId(1, 0, -1)),
"A loose page shown on the panel must be draggable back to the cursor");
helper.assertTrue(desk.getItem(1).isEmpty() && ItemStack.matches(menu.getCarried(), page),
"Extracting a loose page must empty its tab and return the same item");
helper.succeed();
}
@GameTest(template = "empty")
public static void linkPanelsCannotBeStoredOrCopiedButOldPanelsCanBeRecovered(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.WRITING_DESK.get().defaultBlockState(), 3);
var desk = (WritingDeskBlockEntity) helper.getLevel().getBlockEntity(pos);
ItemStack panel = PageItem.createLinkPanelPage();
ItemStack oldNotebook = new ItemStack(ModItems.NOTEBOOK.get());
oldNotebook.set(ModDataComponents.NOTEBOOK_CONTENTS.get(), new NotebookContents(List.of(panel)));
helper.assertFalse(desk.canPlaceItem(0, panel), "Desk tab must reject a Link Panel");
helper.assertFalse(desk.canPlaceItem(0, oldNotebook),
"Desk tab must reject a Notebook containing an old Link Panel");
// A preexisting desk is loaded without discarding its contents.
desk.setItem(0, panel.copy());
desk.setItem(1, new ItemStack(ModItems.NOTEBOOK.get()));
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(pos.getX() + 0.5, pos.getY() + 0.5, pos.getZ() + 0.5);
var menu = new WritingDeskMenu(1, player.getInventory(), desk);
menu.broadcastChanges();
helper.assertTrue(menu.getSlot(WritingDeskMenu.COPY_RESULT).getItem().isEmpty(),
"Existing Link Panels must not produce a Desk copy");
helper.assertTrue(menu.quickMoveStack(player, WritingDeskMenu.COPY_RESULT).isEmpty(),
"Shift-click must not bypass the Link Panel copy rule");
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.movePageButtonId(0, 0, 1, 0)),
"An old Link Panel must not move into a Notebook");
menu.setCarried(panel.copy());
helper.assertFalse(menu.clickMenuButton(player, WritingDeskMenu.PLACE_PAGE_BUTTON_BASE
+ NotebookContents.MAX_PAGES), "A carried Link Panel must not enter a Notebook");
menu.setCarried(ItemStack.EMPTY);
helper.assertTrue(menu.clickMenuButton(player, WritingDeskMenu.extractPageButtonId(0, 0, -1)),
"A stored legacy Link Panel must remain recoverable to the cursor");
helper.assertTrue(ItemStack.matches(menu.getCarried(), panel),
"Recovery must preserve the original Link Panel");
helper.succeed();
}
private static ItemStack terrainPage() {
return PageItem.createSymbolPage(new SymbolReference(
ResourceLocation.parse("rivencraft:terrain/standard")));
}
} }
@@ -0,0 +1,143 @@
package net.dnorberg.rivencraft.gametest;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolCatalog;
import net.dnorberg.rivencraft.writing.SymbolDefinition;
import net.dnorberg.rivencraft.writing.SymbolReference;
import net.dnorberg.rivencraft.writing.SymbolSemantics;
import net.dnorberg.rivencraft.writing.WritingEntry;
import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper;
import net.minecraft.resources.ResourceLocation;
import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
/** Issue #30: parsing must not mutate writing or trust client display metadata. */
@GameTestHolder("rivencraft_archive_grammar")
@PrefixGameTestTemplate(false)
public final class WritingGrammarGameTests {
private WritingGrammarGameTests() {}
@GameTest(template = "empty")
public static void orderedGrammarAcceptsPartialWritingAndDiagnosesInvalidSequences(GameTestHelper helper) {
SymbolReference terrain = ref("rivencraft:terrain/standard");
SymbolReference nativeBiomes = ref("rivencraft:biome/native");
SymbolReference weather = ref("rivencraft:weather/normal");
SymbolReference lighting = ref("rivencraft:lighting/normal");
SymbolReference celestial = ref("rivencraft:celestial/normal_time");
SymbolReference caves = ref("rivencraft:feature/caves");
SymbolReference plains = ref("test:biome/plains");
SymbolReference forest = ref("test:biome/forest");
SymbolReference single = ref("test:controller/single");
SymbolReference alternateTerrain = ref("test:terrain/alternate");
SymbolReference periodHalf = ref("test:period/half");
SymbolReference periodFull = ref("test:period/full");
SymbolReference displayOnly = ref("test:display_only");
Map<SymbolReference, SymbolDefinition> definitions = Map.of(
plains, definition(SymbolSemantics.Role.BIOME,
new SymbolSemantics.ResourceValue(ResourceLocation.parse("minecraft:plains"))),
forest, definition(SymbolSemantics.Role.BIOME,
new SymbolSemantics.ResourceValue(ResourceLocation.parse("minecraft:forest"))),
single, definition(SymbolSemantics.Role.BIOME_CONTROLLER,
new SymbolSemantics.ChoiceValue("single")),
alternateTerrain, definition(SymbolSemantics.Role.TERRAIN,
new SymbolSemantics.ResourceValue(ResourceLocation.parse("test:alternate"))),
periodHalf, definition(SymbolSemantics.Role.PERIOD_MODIFIER,
new SymbolSemantics.NumberValue(0.5)),
periodFull, definition(SymbolSemantics.Role.PERIOD_MODIFIER,
new SymbolSemantics.NumberValue(1.0)),
displayOnly, new SymbolDefinition(1, "symbol.test", "symbol.test.description",
ResourceLocation.parse("test:display"), Optional.empty(), ""));
java.util.function.Function<SymbolReference, Optional<SymbolDefinition>> resolver = reference ->
Optional.ofNullable(definitions.get(reference)).or(() -> SymbolCatalog.find(reference));
helper.assertTrue(parse(resolver, WritingEntry.linkPanel()).randomFallback(),
"Link-Panel-only writing must retain the random Age path");
helper.assertTrue(WritingGrammar.parse(OrderedWriting.EMPTY, resolver).randomFallback(),
"Old page-free books must retain the random Age path");
OrderedWriting partial = writing(WritingEntry.linkPanel(), WritingEntry.symbol(terrain));
WritingGrammar.Result incomplete = WritingGrammar.parse(partial, resolver);
helper.assertTrue(incomplete.canCreate() && !incomplete.randomFallback(),
"Partial authored writing must remain valid, without pretending it is page-free");
helper.assertTrue(incomplete.diagnostics().stream().anyMatch(d -> d.code() == WritingGrammar.Code.INCOMPLETE),
"Missing branches must be reported for deterministic completion");
helper.assertValueEqual(partial.entries().size(), 2, "Parsing must not rewrite saved page order");
WritingGrammar.Result complete = parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(terrain),
WritingEntry.symbol(plains), WritingEntry.symbol(single), WritingEntry.symbol(weather),
WritingEntry.symbol(lighting), WritingEntry.symbol(periodHalf), WritingEntry.symbol(celestial),
WritingEntry.symbol(caves));
helper.assertTrue(complete.canCreate(), "Legacy-ordered categories and prefix modifiers must parse");
helper.assertValueEqual(complete.symbols().size(), 8, "Parsed symbols must preserve every authored page");
helper.assertValueEqual(complete.symbols().get(1).reference(), plains,
"A biome page must precede the controller that consumes it");
helper.assertValueEqual(WritingGrammar.parse(writing(WritingEntry.linkPanel(), WritingEntry.symbol(terrain),
WritingEntry.symbol(plains), WritingEntry.symbol(single), WritingEntry.symbol(weather),
WritingEntry.symbol(lighting), WritingEntry.symbol(periodHalf), WritingEntry.symbol(celestial),
WritingEntry.symbol(caves)), resolver), complete,
"Identical ordered writing and server definitions must parse deterministically");
WritingGrammar.Result repeatedModifiers = parse(resolver, WritingEntry.linkPanel(),
WritingEntry.symbol(periodHalf), WritingEntry.symbol(periodFull), WritingEntry.symbol(celestial));
helper.assertTrue(repeatedModifiers.canCreate(), "Repeated period modifiers must remain legal");
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(terrain),
WritingEntry.symbol(terrain)), WritingGrammar.Code.DUPLICATE);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(terrain),
WritingEntry.symbol(alternateTerrain)), WritingGrammar.Code.CONFLICT);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(weather),
WritingEntry.symbol(terrain)), WritingGrammar.Code.OUT_OF_ORDER);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(celestial),
WritingEntry.symbol(periodHalf)), WritingGrammar.Code.MISPLACED_MODIFIER);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(nativeBiomes),
WritingEntry.symbol(plains)), WritingGrammar.Code.OUT_OF_ORDER);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(plains),
WritingEntry.symbol(nativeBiomes)), WritingGrammar.Code.CONFLICT);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(plains),
WritingEntry.symbol(forest), WritingEntry.symbol(single)), WritingGrammar.Code.CONFLICT);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(caves),
WritingEntry.symbol(caves)), WritingGrammar.Code.DUPLICATE);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(ref("test:missing"))),
WritingGrammar.Code.UNRESOLVED);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.symbol(displayOnly)),
WritingGrammar.Code.UNSUPPORTED);
assertCode(helper, parse(resolver, WritingEntry.symbol(terrain)), WritingGrammar.Code.MISSING_PANEL);
assertCode(helper, parse(resolver, WritingEntry.linkPanel(), WritingEntry.linkPanel()),
WritingGrammar.Code.DUPLICATE_PANEL);
List<WritingEntry> oversized = new ArrayList<>();
for (int index = 0; index <= WritingGrammar.MAX_NEW_ENTRIES; index++)
oversized.add(WritingEntry.linkPanel());
assertCode(helper, WritingGrammar.parse(new OrderedWriting(oversized), resolver), WritingGrammar.Code.TOO_MANY);
helper.succeed();
}
private static SymbolReference ref(String id) {
return new SymbolReference(ResourceLocation.parse(id));
}
private static SymbolDefinition definition(SymbolSemantics.Role role, SymbolSemantics.Value value) {
return new SymbolDefinition(2, "symbol.test", "symbol.test.description",
ResourceLocation.parse("test:" + role.id()), Optional.of(new SymbolSemantics(role, value)), "");
}
private static OrderedWriting writing(WritingEntry... entries) {
return new OrderedWriting(List.of(entries));
}
private static WritingGrammar.Result parse(
java.util.function.Function<SymbolReference, Optional<SymbolDefinition>> resolver,
WritingEntry... entries) {
return WritingGrammar.parse(writing(entries), resolver);
}
private static void assertCode(GameTestHelper helper, WritingGrammar.Result result, WritingGrammar.Code code) {
helper.assertFalse(result.canCreate(), "Writing with " + code + " must not create a new Age");
helper.assertTrue(result.diagnostics().stream().anyMatch(diagnostic -> diagnostic.code() == code),
"Writing must report " + code + " rather than silently dropping a page");
}
}
@@ -4,6 +4,7 @@ import java.util.List;
import net.dnorberg.rivencraft.book.AgeReference; import net.dnorberg.rivencraft.book.AgeReference;
import net.dnorberg.rivencraft.book.AgeVisitSavedData; import net.dnorberg.rivencraft.book.AgeVisitSavedData;
import net.dnorberg.rivencraft.book.LinkTarget; import net.dnorberg.rivencraft.book.LinkTarget;
import net.dnorberg.rivencraft.book.LinkProperties;
import net.dnorberg.rivencraft.book.LinkingService; import net.dnorberg.rivencraft.book.LinkingService;
import net.dnorberg.rivencraft.book.AgeDimensionService; import net.dnorberg.rivencraft.book.AgeDimensionService;
import net.dnorberg.rivencraft.config.RivencraftConfig; import net.dnorberg.rivencraft.config.RivencraftConfig;
@@ -54,7 +55,9 @@ public final class DescriptiveBookItem extends Item {
ServerLevel sourceLevel = player.serverLevel(); ServerLevel sourceLevel = player.serverLevel();
var sourcePosition = player.blockPosition(); var sourcePosition = player.blockPosition();
LinkingService.LinkResult result = LinkingService.travelWithFooting(player, ageTarget); LinkProperties properties = stack.getOrDefault(ModDataComponents.LINK_PROPERTIES.get(), LinkProperties.NONE)
.forDescriptiveBook();
LinkingService.LinkResult result = LinkingService.travelWithFooting(player, ageTarget, properties);
if (result != LinkingService.LinkResult.SUCCESS) { if (result != LinkingService.LinkResult.SUCCESS) {
player.displayClientMessage(Component.translatable("message.rivencraft.descriptive_book.unsafe"), true); player.displayClientMessage(Component.translatable("message.rivencraft.descriptive_book.unsafe"), true);
return false; return false;
@@ -109,5 +112,7 @@ public final class DescriptiveBookItem extends Item {
? Component.translatable("item.rivencraft.descriptive_book.unwritten") ? Component.translatable("item.rivencraft.descriptive_book.unwritten")
: Component.translatable("item.rivencraft.descriptive_book.age", age.name()); : Component.translatable("item.rivencraft.descriptive_book.age", age.name());
tooltipComponents.add(status.withStyle(ChatFormatting.GRAY)); tooltipComponents.add(status.withStyle(ChatFormatting.GRAY));
stack.getOrDefault(ModDataComponents.LINK_PROPERTIES.get(), LinkProperties.NONE)
.forDescriptiveBook().appendTooltip(tooltipComponents);
} }
} }
@@ -4,6 +4,7 @@ import java.util.List;
import net.dnorberg.rivencraft.book.LinkTarget; import net.dnorberg.rivencraft.book.LinkTarget;
import net.dnorberg.rivencraft.book.AgeRegistrySavedData; import net.dnorberg.rivencraft.book.AgeRegistrySavedData;
import net.dnorberg.rivencraft.book.LinkingService; import net.dnorberg.rivencraft.book.LinkingService;
import net.dnorberg.rivencraft.book.LinkProperties;
import net.dnorberg.rivencraft.registry.ModDataComponents; import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.registry.ModSounds; import net.dnorberg.rivencraft.registry.ModSounds;
import net.minecraft.ChatFormatting; import net.minecraft.ChatFormatting;
@@ -49,7 +50,8 @@ public final class LinkingBookItem extends Item {
Level sourceLevel = player.level(); Level sourceLevel = player.level();
BlockPos sourcePosition = player.blockPosition(); BlockPos sourcePosition = player.blockPosition();
LinkingService.LinkResult result = LinkingService.travel(player, target); LinkProperties properties = stack.getOrDefault(ModDataComponents.LINK_PROPERTIES.get(), LinkProperties.NONE);
LinkingService.LinkResult result = LinkingService.travel(player, target, properties);
if (result == LinkingService.LinkResult.SUCCESS) { if (result == LinkingService.LinkResult.SUCCESS) {
sourceLevel.playSound(null, sourcePosition, ModSounds.LINK.get(), SoundSource.PLAYERS, sourceLevel.playSound(null, sourcePosition, ModSounds.LINK.get(), SoundSource.PLAYERS,
0.8F, sourceLevel.random.nextFloat() * 0.2F + 0.9F); 0.8F, sourceLevel.random.nextFloat() * 0.2F + 0.9F);
@@ -65,9 +67,11 @@ public final class LinkingBookItem extends Item {
return InteractionResultHolder.success(stack); return InteractionResultHolder.success(stack);
} }
String errorKey = result == LinkingService.LinkResult.MISSING_DIMENSION String errorKey = switch (result) {
? "message.rivencraft.linking_book.missing_dimension" case MISSING_DIMENSION -> "message.rivencraft.linking_book.missing_dimension";
: "message.rivencraft.linking_book.unsafe"; case INTRA_LINKING_REQUIRED -> "message.rivencraft.linking_book.intra_required";
default -> "message.rivencraft.linking_book.unsafe";
};
player.displayClientMessage(Component.translatable(errorKey), true); player.displayClientMessage(Component.translatable(errorKey), true);
return InteractionResultHolder.fail(stack); return InteractionResultHolder.fail(stack);
} }
@@ -85,9 +89,11 @@ public final class LinkingBookItem extends Item {
TooltipFlag tooltipFlag TooltipFlag tooltipFlag
) { ) {
LinkTarget target = stack.get(ModDataComponents.LINK_TARGET.get()); LinkTarget target = stack.get(ModDataComponents.LINK_TARGET.get());
LinkProperties properties = stack.getOrDefault(ModDataComponents.LINK_PROPERTIES.get(), LinkProperties.NONE);
if (target == null) { if (target == null) {
tooltipComponents.add(Component.translatable("item.rivencraft.linking_book.unbound") tooltipComponents.add(Component.translatable("item.rivencraft.linking_book.unbound")
.withStyle(ChatFormatting.GRAY)); .withStyle(ChatFormatting.GRAY));
properties.appendTooltip(tooltipComponents);
return; return;
} }
@@ -101,6 +107,7 @@ public final class LinkingBookItem extends Item {
position.getZ() position.getZ()
) )
.withStyle(ChatFormatting.GRAY)); .withStyle(ChatFormatting.GRAY));
properties.appendTooltip(tooltipComponents);
} }
public static String destinationName(ServerLevel level) { public static String destinationName(ServerLevel level) {
@@ -1,22 +1,45 @@
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.book.LinkProperties;
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);
} }
@@ -28,6 +51,127 @@ public final class PageItem extends Item {
return create(PageContent.symbol(reference)); return create(PageContent.symbol(reference));
} }
public static List<String> bundledCreativeSymbols() {
return List.copyOf(CREATIVE_SYMBOLS.keySet());
}
/** Bundled categories become separate creative tabs without a Java page list. */
public static List<ResourceLocation> bundledCreativeCategories() {
LinkedHashSet<ResourceLocation> categories = CREATIVE_SYMBOLS.values().stream()
.map(CreativeSymbol::creativeCategory)
.collect(java.util.stream.Collectors.toCollection(LinkedHashSet::new));
categories.add(BlockSymbolPages.CATEGORY);
categories.add(BlockSymbolPages.FLUID_CATEGORY);
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"));
}
return CREATIVE_SYMBOLS.entrySet().stream()
.filter(entry -> entry.getValue().creativeCategory().equals(category))
.findFirst()
.map(entry -> createBundledCreativePage(entry.getKey()))
.orElseThrow(() -> new IllegalArgumentException("No bundled pages for category " + category));
}
/** Exact symbol-page variants offered in the creative tab and to optional ingredient viewers. */
public static List<ItemStack> creativeSymbolPages(HolderLookup.Provider registries) {
List<ItemStack> pages = creativeBundledAndBiomePages(registries);
BlockSymbolPages.availableBlocks().forEach(id -> pages.add(createCreativeBlockPage(id)));
return List.copyOf(pages);
}
private static List<ItemStack> creativeBundledAndBiomePages(HolderLookup.Provider registries) {
List<ItemStack> pages = new ArrayList<>();
CREATIVE_SYMBOLS.keySet().forEach(id -> pages.add(createBundledCreativePage(id)));
Set<String> bundled = CREATIVE_SYMBOLS.keySet();
registries.lookupOrThrow(Registries.BIOME).listElements()
.map(holder -> holder.key().location())
.filter(id -> 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));
page.set(ModDataComponents.PAGE_SYMBOL_DISPLAY.get(), metadata);
return page;
}
public static ItemStack createCreativeBiomePage(net.minecraft.resources.ResourceLocation biomeId) {
var symbolId = BiomeSymbolPages.symbolId(biomeId);
ItemStack page = create(PageContent.symbol(new SymbolReference(symbolId)));
page.set(ModDataComponents.PAGE_SYMBOL_DISPLAY.get(), BiomeSymbolPages.definition(biomeId).display(symbolId));
return page;
}
public static ItemStack createCreativeBlockPage(ResourceLocation blockId) {
var symbolId = BlockSymbolPages.symbolId(blockId);
ItemStack page = create(PageContent.symbol(new SymbolReference(symbolId)));
page.set(ModDataComponents.PAGE_SYMBOL_DISPLAY.get(), BlockSymbolPages.definition(blockId).display(symbolId));
return page;
}
private static Map<String, CreativeSymbol> loadCreativeSymbols() {
String resource = "/assets/rivencraft/creative_symbol_pages.json";
try (var stream = PageItem.class.getResourceAsStream(resource)) {
if (stream == null) {
throw new IllegalStateException("Missing generated creative symbol index " + resource);
}
var json = JsonParser.parseReader(new InputStreamReader(stream, StandardCharsets.UTF_8))
.getAsJsonObject();
Map<String, CreativeSymbol> symbols = new LinkedHashMap<>();
json.entrySet().forEach(entry -> {
var id = net.minecraft.resources.ResourceLocation.parse(entry.getKey());
if (!id.getNamespace().equals(Rivencraft.MOD_ID)) {
throw new IllegalStateException("Creative symbol is not a Rivencraft page: " + id);
}
SymbolDefinition definition = SymbolDefinition.parse(entry.getValue());
ResourceLocation creativeCategory = definition.semantics()
.filter(semantics -> semantics.role() == SymbolSemantics.Role.BIOME_CONTROLLER)
.map(ignored -> BIOME_GENERATION_CATEGORY)
.orElse(definition.category());
symbols.put(id.getPath(), new CreativeSymbol(definition.display(id), creativeCategory));
});
return Collections.unmodifiableMap(symbols);
} catch (java.io.IOException exception) {
throw new IllegalStateException("Could not read generated creative symbol index " + resource, exception);
}
}
public static ItemStack createLinkPanelPage() { public static ItemStack createLinkPanelPage() {
return create(PageContent.LINK_PANEL); return create(PageContent.LINK_PANEL);
} }
@@ -80,6 +224,8 @@ public final class PageItem extends Item {
if (content.kind() == PageContent.Kind.LINK_PANEL) { if (content.kind() == PageContent.Kind.LINK_PANEL) {
tooltipComponents.add(Component.translatable("item.rivencraft.page.link_panel.description") tooltipComponents.add(Component.translatable("item.rivencraft.page.link_panel.description")
.withStyle(ChatFormatting.GRAY)); .withStyle(ChatFormatting.GRAY));
stack.getOrDefault(ModDataComponents.LINK_PROPERTIES.get(), LinkProperties.NONE)
.appendTooltip(tooltipComponents);
return; return;
} }
SymbolReference reference = content.symbol().orElseThrow(); SymbolReference reference = content.symbol().orElseThrow();
@@ -100,7 +246,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()));
@@ -111,25 +256,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;
};
};
}
} }
@@ -0,0 +1,248 @@
package net.dnorberg.rivencraft.menu;
import java.util.Optional;
import net.dnorberg.rivencraft.block.entity.BookBinderBlockEntity;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.registry.ModMenus;
import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.world.Container;
import net.minecraft.world.SimpleContainer;
import net.minecraft.world.entity.player.Inventory;
import net.minecraft.world.entity.player.Player;
import net.minecraft.world.inventory.AbstractContainerMenu;
import net.minecraft.world.inventory.ClickType;
import net.minecraft.world.inventory.DataSlot;
import net.minecraft.world.inventory.Slot;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items;
/** Fixed, ordered binder slots and a server-owned virtual result. */
public final class BookBinderMenu extends AbstractContainerMenu {
public static final int RESULT = BookBinderBlockEntity.SIZE;
public static final int SELECT_BASE = 100;
public static final int MOVE_PREVIOUS = 200;
public static final int MOVE_NEXT = 201;
public static final int IMPORT_NOTEBOOK = 202;
public static final int STRIP_CLICK_BASE = 300;
private static final int PLAYER_START = RESULT + 1;
private final BookBinderBlockEntity binder;
private final Container inputs;
private final SimpleContainer result = new SimpleContainer(1);
private final boolean clientSide;
private int selectedPage = -1;
private int grammarErrorCode = -1;
private int grammarErrorStripIndex = -1;
public BookBinderMenu(int id, Inventory inventory, RegistryFriendlyByteBuf data) {
this(id, inventory, inventory.player.level().getBlockEntity(data.readBlockPos())
instanceof BookBinderBlockEntity found ? found : null);
}
public BookBinderMenu(int id, Inventory inventory, BookBinderBlockEntity binder) {
super(ModMenus.BOOK_BINDER.get(), id);
this.binder = binder;
inputs = binder == null ? new SimpleContainer(BookBinderBlockEntity.SIZE) : binder;
clientSide = inventory.player.level().isClientSide;
addDataSlot(new DataSlot() {
@Override public int get() { return selectedPage; }
@Override public void set(int value) { selectedPage = value; }
});
addDataSlot(new DataSlot() {
@Override public int get() {
return clientSide || binder == null ? grammarErrorCode : binder.writingGrammar().firstError()
.map(error -> error.code().ordinal()).orElse(-1);
}
@Override public void set(int value) { grammarErrorCode = value; }
});
addDataSlot(new DataSlot() {
@Override public int get() {
return clientSide || binder == null ? grammarErrorStripIndex : binder.writingGrammar().firstError()
.map(error -> binder.writingStripIndex(error.index())).orElse(-1);
}
@Override public void set(int value) { grammarErrorStripIndex = value; }
});
addSlot(new BinderSlot(BookBinderBlockEntity.COVER, 8, 27, 64));
addSlot(new BinderSlot(BookBinderBlockEntity.LINK_PANEL, -1000, -1000, 1));
addSlot(new BinderSlot(BookBinderBlockEntity.NOTEBOOK, -1000, -1000, 1));
for (int page = 0; page < BookBinderBlockEntity.PAGE_COUNT; page++) {
addSlot(new BinderSlot(BookBinderBlockEntity.FIRST_PAGE + page, -1000, -1000, 1));
}
addSlot(new ResultSlot(result, 0, 152, 27));
for (int row = 0; row < 3; row++) {
for (int column = 0; column < 9; column++) {
addSlot(new Slot(inventory, column + row * 9 + 9, 8 + column * 18, 99 + row * 18));
}
}
for (int column = 0; column < 9; column++) {
addSlot(new Slot(inventory, column, 8 + column * 18, 157));
}
refreshResult();
}
public int selectedPage() { return selectedPage; }
public Optional<WritingGrammar.Code> grammarError() {
WritingGrammar.Code[] codes = WritingGrammar.Code.values();
return grammarErrorCode >= 0 && grammarErrorCode < codes.length
? Optional.of(codes[grammarErrorCode]) : Optional.empty();
}
public int grammarErrorStripIndex() { return grammarErrorStripIndex; }
public String title() { return binder == null ? "" : binder.title(); }
public boolean setTitle(Player player, String title) {
if (clientSide || !stillValid(player) || title == null
|| title.length() > BookBinderBlockEntity.MAX_TITLE_LENGTH) return false;
binder.setTitle(title);
refreshResult();
broadcastChanges();
return true;
}
@Override public boolean stillValid(Player player) {
return binder != null && binder.stillValid(player);
}
@Override public boolean clickMenuButton(Player player, int id) {
if (clientSide || !stillValid(player)) return false;
if (id >= STRIP_CLICK_BASE && id <= STRIP_CLICK_BASE + BookBinderBlockEntity.PAGE_COUNT) {
if (!clickStrip(id - STRIP_CLICK_BASE)) return false;
} else if (id >= SELECT_BASE && id < SELECT_BASE + BookBinderBlockEntity.PAGE_COUNT) {
selectedPage = id - SELECT_BASE;
} else if (id == MOVE_PREVIOUS || id == MOVE_NEXT) {
int target = selectedPage + (id == MOVE_PREVIOUS ? -1 : 1);
if (selectedPage < 0 || target < 0 || target >= BookBinderBlockEntity.PAGE_COUNT
|| binder.getItem(BookBinderBlockEntity.FIRST_PAGE + selectedPage).isEmpty()
|| !getCarried().isEmpty()) return false;
int fromSlot = BookBinderBlockEntity.FIRST_PAGE + selectedPage;
int toSlot = BookBinderBlockEntity.FIRST_PAGE + target;
ItemStack from = binder.getItem(fromSlot);
ItemStack to = binder.getItem(toSlot);
binder.setItem(fromSlot, to);
binder.setItem(toSlot, from);
selectedPage = target;
} else if (id == IMPORT_NOTEBOOK) {
if (!binder.importNotebook()) return false;
} else return false;
refreshResult();
broadcastChanges();
return true;
}
private boolean clickStrip(int index) {
ItemStack carried = getCarried();
if (carried.is(ModItems.NOTEBOOK.get())) {
ItemStack emptied = binder.importNotebookFromStack(carried, Math.min(index == 0 ? 0 : index - 1,
binder.nextPageIndex()));
if (emptied.isEmpty()) return false;
setCarried(emptied);
return true;
}
if (!carried.isEmpty()) {
if (index == 0) {
if (!binder.getItem(BookBinderBlockEntity.LINK_PANEL).isEmpty()
|| !binder.canPlaceItem(BookBinderBlockEntity.LINK_PANEL, carried)) return false;
binder.setItem(BookBinderBlockEntity.LINK_PANEL, carried.copyWithCount(1));
} else if (!binder.insertPage(index - 1, carried.copyWithCount(1))) return false;
ItemStack remainder = carried.copy();
remainder.shrink(1);
setCarried(remainder);
return true;
}
ItemStack removed;
if (index == 0) {
removed = binder.removeItem(BookBinderBlockEntity.LINK_PANEL, 1);
} else {
removed = binder.takePage(index - 1);
}
if (removed.isEmpty()) return false;
setCarried(removed);
return true;
}
@Override public ItemStack quickMoveStack(Player player, int index) {
if (!stillValid(player) || index < 0 || index >= slots.size()) return ItemStack.EMPTY;
if (index == RESULT) {
refreshResult();
if (!binder.canAssemble()) return ItemStack.EMPTY;
ItemStack book = binder.previewBook();
ItemStack remainder = book.copy();
if (!moveItemStackTo(remainder, PLAYER_START, slots.size(), true) || !remainder.isEmpty()) {
return ItemStack.EMPTY;
}
binder.consumeAssembly();
refreshResult();
return book;
}
Slot sourceSlot = slots.get(index);
if (!sourceSlot.hasItem()) return ItemStack.EMPTY;
ItemStack source = sourceSlot.getItem();
ItemStack original = source.copy();
boolean moved;
if (index < RESULT) {
moved = moveItemStackTo(source, PLAYER_START, slots.size(), true);
} else if (source.is(Items.LEATHER) || BookBinderBlockEntity.validCover(source)) {
moved = moveItemStackTo(source, BookBinderBlockEntity.COVER, BookBinderBlockEntity.COVER + 1, false);
} else if (source.is(ModItems.NOTEBOOK.get())) {
ItemStack emptied = binder.importNotebookFromStack(source, binder.nextPageIndex());
if (emptied.isEmpty()) return ItemStack.EMPTY;
sourceSlot.setByPlayer(emptied);
refreshResult();
return original;
} else if (source.is(ModItems.PAGE.get())
&& PageItem.content(source).kind() == PageContent.Kind.LINK_PANEL) {
moved = moveItemStackTo(source, BookBinderBlockEntity.LINK_PANEL,
BookBinderBlockEntity.LINK_PANEL + 1, false);
} else if (source.is(ModItems.PAGE.get())) {
moved = moveItemStackTo(source, BookBinderBlockEntity.FIRST_PAGE, RESULT, false);
} else moved = false;
if (!moved) return ItemStack.EMPTY;
if (source.isEmpty()) sourceSlot.setByPlayer(ItemStack.EMPTY);
else sourceSlot.setChanged();
refreshResult();
return original;
}
@Override public void clicked(int slotId, int button, ClickType clickType, Player player) {
if (!stillValid(player)) {
player.closeContainer();
return;
}
refreshResult();
super.clicked(slotId, button, clickType, player);
}
@Override public void broadcastChanges() {
refreshResult();
super.broadcastChanges();
}
private void refreshResult() {
if (clientSide) return;
ItemStack preview = binder == null ? ItemStack.EMPTY : binder.previewBook();
if (!ItemStack.matches(result.getItem(0), preview)) result.setItem(0, preview);
}
private final class BinderSlot extends Slot {
private final int capacity;
private BinderSlot(int index, int x, int y, int capacity) {
super(inputs, index, x, y);
this.capacity = capacity;
}
@Override public boolean mayPlace(ItemStack stack) { return inputs.canPlaceItem(getContainerSlot(), stack); }
@Override public int getMaxStackSize() { return capacity; }
}
private final class ResultSlot extends Slot {
private ResultSlot(Container container, int index, int x, int y) { super(container, index, x, y); }
@Override public boolean mayPlace(ItemStack stack) { return false; }
@Override public boolean mayPickup(Player player) {
return clientSide ? hasItem() : stillValid(player) && binder.canAssemble();
}
@Override public void onTake(Player player, ItemStack stack) {
if (!clientSide && binder.consumeAssembly()) refreshResult();
super.onTake(player, stack);
}
}
}
@@ -0,0 +1,155 @@
package net.dnorberg.rivencraft.menu;
import net.dnorberg.rivencraft.block.entity.InkMixerBlockEntity;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.registry.ModMenus;
import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.world.Container;
import net.minecraft.world.SimpleContainer;
import net.minecraft.world.entity.player.Inventory;
import net.minecraft.world.entity.player.Player;
import net.minecraft.world.inventory.AbstractContainerMenu;
import net.minecraft.world.inventory.ClickType;
import net.minecraft.world.inventory.DataSlot;
import net.minecraft.world.inventory.Slot;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items;
/** Server-owned virtual output; taking it spends paper and the configured ink cost once. */
public final class InkMixerMenu extends AbstractContainerMenu {
public static final int MODIFIER = InkMixerBlockEntity.SIZE;
public static final int RESULT = MODIFIER + 1;
private static final int PLAYER_START = RESULT + 1;
private final InkMixerBlockEntity mixer;
private final Container inputs;
private final SimpleContainer result = new SimpleContainer(1);
private final boolean clientSide;
private int inkRemaining;
private final int[] modifierChances = new int[3];
public InkMixerMenu(int id, Inventory inventory, RegistryFriendlyByteBuf data) {
this(id, inventory, inventory.player.level().getBlockEntity(data.readBlockPos())
instanceof InkMixerBlockEntity found ? found : null);
}
public InkMixerMenu(int id, Inventory inventory, InkMixerBlockEntity mixer) {
super(ModMenus.INK_MIXER.get(), id);
this.mixer = mixer;
inputs = mixer == null ? new SimpleContainer(InkMixerBlockEntity.SIZE) : mixer;
clientSide = inventory.player.level().isClientSide;
addDataSlot(new DataSlot() {
@Override public int get() { return clientSide ? inkRemaining : mixer.inkRemaining(); }
@Override public void set(int value) { inkRemaining = value; }
});
for (int index = 0; index < modifierChances.length; index++) {
final int chanceIndex = index;
addDataSlot(new DataSlot() {
@Override public int get() {
return clientSide ? modifierChances[chanceIndex] : mixer.modifierChancePermille(chanceIndex);
}
@Override public void set(int value) { modifierChances[chanceIndex] = value; }
});
}
addSlot(new MixerSlot(InkMixerBlockEntity.INK, 8, 27));
addSlot(new MixerSlot(InkMixerBlockEntity.PAPER, 8, 48));
addSlot(new MixerSlot(InkMixerBlockEntity.BOTTLES, 152, 27));
addSlot(new ModifierSlot(79, 40));
addSlot(new ResultSlot(152, 48));
for (int row = 0; row < 3; row++)
for (int column = 0; column < 9; column++)
addSlot(new Slot(inventory, column + row * 9 + 9, 8 + column * 18, 99 + row * 18));
for (int column = 0; column < 9; column++)
addSlot(new Slot(inventory, column, 8 + column * 18, 157));
refreshResult();
}
public int inkRemaining() { return inkRemaining; }
public int modifierChancePermille(int index) { return modifierChances[index]; }
@Override public void clicked(int slotId, int button, ClickType clickType, Player player) {
if (slotId == MODIFIER) {
if (!clientSide && stillValid(player) && clickType == ClickType.PICKUP
&& (button == 0 || button == 1)) {
ItemStack carried = getCarried();
int amount = button == 1 ? 1 : carried.getCount();
if (mixer.addModifier(carried, amount)) {
setCarried(carried);
refreshResult();
broadcastChanges();
}
}
return;
}
super.clicked(slotId, button, clickType, player);
}
@Override public boolean stillValid(Player player) {
return mixer != null && mixer.stillValid(player);
}
@Override public void broadcastChanges() {
refreshResult();
super.broadcastChanges();
}
private void refreshResult() {
if (clientSide) return;
ItemStack preview = mixer == null ? ItemStack.EMPTY : mixer.previewLinkPanel();
if (!ItemStack.matches(result.getItem(0), preview)) result.setItem(0, preview);
}
@Override public ItemStack quickMoveStack(Player player, int index) {
if (!stillValid(player) || index < 0 || index >= slots.size()) return ItemStack.EMPTY;
if (index == RESULT) {
refreshResult();
if (!mixer.canCreateLinkPanel()) return ItemStack.EMPTY;
ItemStack output = result.getItem(0).copy();
ItemStack remainder = output.copy();
if (!moveItemStackTo(remainder, PLAYER_START, slots.size(), true) || !remainder.isEmpty())
return ItemStack.EMPTY;
if (!mixer.consumeLinkPanelMaterials()) return ItemStack.EMPTY;
refreshResult();
return output;
}
Slot slot = slots.get(index);
if (!slot.hasItem()) return ItemStack.EMPTY;
ItemStack source = slot.getItem();
ItemStack original = source.copy();
boolean moved;
if (index < MODIFIER) moved = moveItemStackTo(source, PLAYER_START, slots.size(), true);
else if (source.is(ModItems.INK_VIAL.get()))
moved = moveItemStackTo(source, InkMixerBlockEntity.INK, InkMixerBlockEntity.INK + 1, false);
else if (source.is(Items.PAPER))
moved = moveItemStackTo(source, InkMixerBlockEntity.PAPER, InkMixerBlockEntity.PAPER + 1, false);
else moved = false;
if (!moved) return ItemStack.EMPTY;
if (source.isEmpty()) slot.setByPlayer(ItemStack.EMPTY);
else slot.setChanged();
refreshResult();
return original;
}
private final class MixerSlot extends Slot {
MixerSlot(int index, int x, int y) { super(inputs, index, x, y); }
@Override public boolean mayPlace(ItemStack stack) { return inputs.canPlaceItem(getContainerSlot(), stack); }
}
private static final class ModifierSlot extends Slot {
ModifierSlot(int x, int y) { super(new SimpleContainer(1), 0, x, y); }
@Override public boolean mayPlace(ItemStack stack) { return false; }
@Override public boolean mayPickup(Player player) { return false; }
}
private final class ResultSlot extends Slot {
ResultSlot(int x, int y) { super(result, 0, x, y); }
@Override public boolean mayPlace(ItemStack stack) { return false; }
@Override public boolean mayPickup(Player player) {
return clientSide ? hasItem() : stillValid(player) && mixer.canCreateLinkPanel();
}
@Override public void onTake(Player player, ItemStack stack) {
if (!clientSide && mixer.consumeLinkPanelMaterials()) refreshResult();
super.onTake(player, stack);
}
}
}
@@ -5,6 +5,8 @@ import net.dnorberg.rivencraft.registry.ModDataComponents;
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.NotebookContents; import net.dnorberg.rivencraft.writing.NotebookContents;
import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.item.PageItem;
import net.minecraft.core.NonNullList; import net.minecraft.core.NonNullList;
import net.minecraft.network.RegistryFriendlyByteBuf; import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.world.Container; import net.minecraft.world.Container;
@@ -82,6 +84,7 @@ public final class NotebookMenu extends AbstractContainerMenu {
} }
} else { } else {
if (!source.is(ModItems.PAGE.get()) if (!source.is(ModItems.PAGE.get())
|| PageItem.content(source).kind() == PageContent.Kind.LINK_PANEL
|| !moveItemStackTo(source, 0, PLAYER_INVENTORY_START, false)) { || !moveItemStackTo(source, 0, PLAYER_INVENTORY_START, false)) {
return ItemStack.EMPTY; return ItemStack.EMPTY;
} }
@@ -135,7 +138,10 @@ public final class NotebookMenu extends AbstractContainerMenu {
super(container, slot, x, y); super(container, slot, x, y);
} }
@Override public boolean mayPlace(ItemStack stack) { return stack.is(ModItems.PAGE.get()); } @Override public boolean mayPlace(ItemStack stack) {
return stack.is(ModItems.PAGE.get())
&& PageItem.content(stack).kind() != PageContent.Kind.LINK_PANEL;
}
@Override public int getMaxStackSize() { return 1; } @Override public int getMaxStackSize() { return 1; }
} }
@@ -29,13 +29,25 @@ import net.minecraft.world.item.Items;
public final class WritingDeskMenu extends AbstractContainerMenu { public final class WritingDeskMenu extends AbstractContainerMenu {
public static final int COPY_RESULT = WritingDeskBlockEntity.SIZE; public static final int COPY_RESULT = WritingDeskBlockEntity.SIZE;
public static final int VISIBLE_TABS = 4;
public static final int PREVIOUS_TABS = 90;
public static final int NEXT_TABS = 91;
public static final int PAGE_BUTTON_BASE = 128;
public static final int CATALOG_BUTTON_BASE = 512;
public static final int ALL_PAGE_BUTTON_BASE = 32768;
public static final int PLACE_PAGE_BUTTON_BASE = 65536;
private static final int PAGE_ADDRESS_COUNT = WritingDeskBlockEntity.COLLECTIONS * NotebookContents.MAX_PAGES;
public static final int MOVE_PAGE_BUTTON_BASE = PLACE_PAGE_BUTTON_BASE + PAGE_ADDRESS_COUNT;
private static final int PLAYER_START = COPY_RESULT + 1; private static final int PLAYER_START = COPY_RESULT + 1;
private static final int EXTRACT_TARGET_COUNT = PLAYER_START + 36 + 1;
public static final int EXTRACT_PAGE_BUTTON_BASE = MOVE_PAGE_BUTTON_BASE + PAGE_ADDRESS_COUNT * PAGE_ADDRESS_COUNT;
private final Container desk; private final Container desk;
private final WritingDeskBlockEntity blockEntity; private final WritingDeskBlockEntity blockEntity;
private final SimpleContainer result = new SimpleContainer(1); private final SimpleContainer result = new SimpleContainer(1);
private final boolean clientSide; private final boolean clientSide;
private int syncedActiveCollection; private int syncedActiveCollection;
private int syncedInkRemaining; private int syncedInkRemaining;
private int firstVisibleTab;
private int selectedPage; private int selectedPage;
private int selectedCollection = -1; private int selectedCollection = -1;
private ResourceLocation selectedSymbol; private ResourceLocation selectedSymbol;
@@ -55,6 +67,11 @@ public final class WritingDeskMenu extends AbstractContainerMenu {
this.clientSide = inventory.player.level().isClientSide; this.clientSide = inventory.player.level().isClientSide;
this.serverViewer = inventory.player instanceof ServerPlayer serverPlayer ? serverPlayer : null; this.serverViewer = inventory.player instanceof ServerPlayer serverPlayer ? serverPlayer : null;
if (blockEntity != null && !clientSide) catalog = WritingDeskCatalog.available(blockEntity); if (blockEntity != null && !clientSide) catalog = WritingDeskCatalog.available(blockEntity);
firstVisibleTab = blockEntity == null ? 0 : blockEntity.activeCollection() / VISIBLE_TABS * VISIBLE_TABS;
addDataSlot(new DataSlot() {
@Override public int get() { return firstVisibleTab; }
@Override public void set(int value) { firstVisibleTab = value; }
});
addDataSlot(new DataSlot() { addDataSlot(new DataSlot() {
@Override public int get() { return WritingDeskMenu.this.blockEntity == null @Override public int get() { return WritingDeskMenu.this.blockEntity == null
? syncedActiveCollection : WritingDeskMenu.this.blockEntity.activeCollection(); } ? syncedActiveCollection : WritingDeskMenu.this.blockEntity.activeCollection(); }
@@ -66,62 +83,226 @@ public final class WritingDeskMenu extends AbstractContainerMenu {
@Override public void set(int value) { syncedInkRemaining = value; } @Override public void set(int value) { syncedInkRemaining = value; }
}); });
for (int i = 0; i < WritingDeskBlockEntity.COLLECTIONS; i++) { for (int i = 0; i < WritingDeskBlockEntity.COLLECTIONS; i++) {
addSlot(new DeskSlot(desk, i, 36, 20 + i * 37, 1)); addSlot(new DeskSlot(desk, i, 37, 34 + (i % VISIBLE_TABS) * 37, 1));
} }
addSlot(new DeskSlot(desk, WritingDeskBlockEntity.INK, 370, 9, 16)); addSlot(new DeskSlot(desk, WritingDeskBlockEntity.INK, 385, 28, 16));
addSlot(new DeskSlot(desk, WritingDeskBlockEntity.RETURN, 370, 57, 64)); addSlot(new DeskSlot(desk, WritingDeskBlockEntity.RETURN, 385, 80, 64));
addSlot(new DeskSlot(desk, WritingDeskBlockEntity.PAPER, 228, 9, 64)); addSlot(new DeskSlot(desk, WritingDeskBlockEntity.PAPER, 241, 28, 64));
addSlot(new DeskSlot(desk, WritingDeskBlockEntity.LEGACY_OUTPUT, -1000, -1000, 64)); addSlot(new DeskSlot(desk, WritingDeskBlockEntity.LEGACY_OUTPUT, -1000, -1000, 64));
addSlot(new CopySlot(result, 0, 228, 57)); addSlot(new CopySlot(result, 0, 241, 80));
for (int row = 0; row < 3; row++) { for (int row = 0; row < 3; row++) {
for (int column = 0; column < 9; column++) { for (int column = 0; column < 9; column++) {
addSlot(new Slot(inventory, column + row * 9 + 9, 224 + column * 18, 79 + row * 18)); addSlot(new Slot(inventory, column + row * 9 + 9, 241 + column * 18, 104 + row * 18));
} }
} }
for (int column = 0; column < 9; column++) { for (int column = 0; column < 9; column++) {
addSlot(new Slot(inventory, column, 224 + column * 18, 137)); addSlot(new Slot(inventory, column, 241 + column * 18, 162));
} }
} }
public int activeCollection() { return syncedActiveCollection; } public int activeCollection() { return syncedActiveCollection; }
public int firstVisibleTab() { return firstVisibleTab; }
public int inkRemaining() { return syncedInkRemaining; } public int inkRemaining() { return syncedInkRemaining; }
public int pageCapacity(int collectionIndex) {
if (collectionIndex < 0 || collectionIndex >= WritingDeskBlockEntity.COLLECTIONS) return 0;
ItemStack collection = desk.getItem(collectionIndex);
return collection.is(ModItems.NOTEBOOK.get()) ? NotebookContents.MAX_PAGES
: collection.is(ModItems.PAGE.get()) ? 1 : 0;
}
public List<SymbolDisplayMetadata> catalog() { return catalog; } public List<SymbolDisplayMetadata> catalog() { return catalog; }
public void setCatalog(List<SymbolDisplayMetadata> symbols) { catalog = List.copyOf(symbols); } public void setCatalog(List<SymbolDisplayMetadata> symbols) { catalog = List.copyOf(symbols); }
public static int movePageButtonId(int sourceCollection, int sourcePage, int targetCollection, int targetPage) {
int source = sourceCollection * NotebookContents.MAX_PAGES + sourcePage;
int target = targetCollection * NotebookContents.MAX_PAGES + targetPage;
return MOVE_PAGE_BUTTON_BASE + source * PAGE_ADDRESS_COUNT + target;
}
/** targetSlot is -1 for the cursor, otherwise a visible player or desk-tab slot. */
public static int extractPageButtonId(int sourceCollection, int sourcePage, int targetSlot) {
int source = sourceCollection * NotebookContents.MAX_PAGES + sourcePage;
return EXTRACT_PAGE_BUTTON_BASE + source * EXTRACT_TARGET_COUNT + targetSlot + 1;
}
@Override public boolean clickMenuButton(Player player, int id) { @Override public boolean clickMenuButton(Player player, int id) {
if (blockEntity == null || !stillValid(player)) return false; if (blockEntity == null || !stillValid(player)) return false;
if (id >= 0 && id < WritingDeskBlockEntity.COLLECTIONS) { if (id == PREVIOUS_TABS || id == NEXT_TABS) {
firstVisibleTab = Math.clamp(firstVisibleTab + (id == NEXT_TABS ? VISIBLE_TABS : -VISIBLE_TABS),
0, WritingDeskBlockEntity.COLLECTIONS - VISIBLE_TABS);
return true;
} else if (id >= 0 && id < WritingDeskBlockEntity.COLLECTIONS) {
if (id < firstVisibleTab || id >= firstVisibleTab + VISIBLE_TABS) return false;
blockEntity.setActiveCollection(id); blockEntity.setActiveCollection(id);
selectedPage = 0; selectedPage = 0;
selectedCollection = -1; selectedCollection = -1;
selectedSymbol = null; selectedSymbol = null;
} else if (id >= 16 && id < 16 + NotebookContents.MAX_PAGES) { } else if (id >= EXTRACT_PAGE_BUTTON_BASE
selectedPage = id - 16; && id < EXTRACT_PAGE_BUTTON_BASE + PAGE_ADDRESS_COUNT * EXTRACT_TARGET_COUNT) {
int offset = id - EXTRACT_PAGE_BUTTON_BASE;
int source = offset / EXTRACT_TARGET_COUNT;
int targetSlot = offset % EXTRACT_TARGET_COUNT - 1;
if (!extractPage(source / NotebookContents.MAX_PAGES, source % NotebookContents.MAX_PAGES,
targetSlot)) return false;
} else if (id >= MOVE_PAGE_BUTTON_BASE && id < MOVE_PAGE_BUTTON_BASE + PAGE_ADDRESS_COUNT * PAGE_ADDRESS_COUNT) {
int offset = id - MOVE_PAGE_BUTTON_BASE;
int source = offset / PAGE_ADDRESS_COUNT;
int target = offset % PAGE_ADDRESS_COUNT;
if (!movePage(source / NotebookContents.MAX_PAGES, source % NotebookContents.MAX_PAGES,
target / NotebookContents.MAX_PAGES, target % NotebookContents.MAX_PAGES)) return false;
} else if (id >= PLACE_PAGE_BUTTON_BASE
&& id < PLACE_PAGE_BUTTON_BASE + WritingDeskBlockEntity.COLLECTIONS * NotebookContents.MAX_PAGES) {
int offset = id - PLACE_PAGE_BUTTON_BASE;
if (!placeCarriedPage(offset / NotebookContents.MAX_PAGES, offset % NotebookContents.MAX_PAGES)) return false;
} else if (id >= PAGE_BUTTON_BASE && id < PAGE_BUTTON_BASE + NotebookContents.MAX_PAGES) {
selectedPage = id - PAGE_BUTTON_BASE;
selectedCollection = -1; selectedCollection = -1;
selectedSymbol = null; selectedSymbol = null;
} else if (id >= 1000 && id < 1000 + WritingDeskBlockEntity.COLLECTIONS * NotebookContents.MAX_PAGES) { } else if (id >= ALL_PAGE_BUTTON_BASE && id < ALL_PAGE_BUTTON_BASE + WritingDeskBlockEntity.COLLECTIONS * NotebookContents.MAX_PAGES) {
int offset = id - 1000; int offset = id - ALL_PAGE_BUTTON_BASE;
int collection = offset / NotebookContents.MAX_PAGES; int collection = offset / NotebookContents.MAX_PAGES;
int page = offset % NotebookContents.MAX_PAGES; int page = offset % NotebookContents.MAX_PAGES;
if (pageAt(collection, page).isEmpty()) return false; if (pageAt(collection, page).isEmpty()) return false;
selectedCollection = collection; selectedCollection = collection;
selectedPage = page; selectedPage = page;
selectedSymbol = null; selectedSymbol = null;
} else if (id >= 100 && id < 100 + 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 - 100).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;
} }
private boolean placeCarriedPage(int collectionIndex, int pageIndex) {
// Resolve the actual storage position on the server, never a filtered list index.
ItemStack carried = getCarried();
if (clientSide || !storablePage(carried)) return false;
ItemStack collection = desk.getItem(collectionIndex);
if (collection.is(ModItems.NOTEBOOK.get())) {
var pages = new java.util.ArrayList<>(collection.getOrDefault(
ModDataComponents.NOTEBOOK_CONTENTS.get(), NotebookContents.EMPTY).pages());
while (pages.size() <= pageIndex) pages.add(ItemStack.EMPTY);
if (!pages.get(pageIndex).isEmpty()) return false;
pages.set(pageIndex, carried.copyWithCount(1));
ItemStack updated = collection.copy();
updated.set(ModDataComponents.NOTEBOOK_CONTENTS.get(), new NotebookContents(pages));
desk.setItem(collectionIndex, updated);
} else return false;
carried.shrink(1);
setCarried(carried.isEmpty() ? ItemStack.EMPTY : carried);
selectedCollection = collectionIndex;
selectedPage = pageIndex;
selectedSymbol = null;
refreshCatalog();
broadcastChanges();
return true;
}
private boolean movePage(int sourceCollection, int sourcePage, int targetCollection, int targetPage) {
if (!getCarried().isEmpty() || sourceCollection == targetCollection && sourcePage == targetPage) return false;
ItemStack sourceBook = desk.getItem(sourceCollection);
ItemStack targetBook = desk.getItem(targetCollection);
boolean sourceNotebook = sourceBook.is(ModItems.NOTEBOOK.get());
boolean targetNotebook = targetBook.is(ModItems.NOTEBOOK.get());
if ((!sourceNotebook && (!sourceBook.is(ModItems.PAGE.get()) || sourcePage != 0))
|| (!targetNotebook && (!targetBook.is(ModItems.PAGE.get()) || targetPage != 0))) return false;
var sourcePages = sourceNotebook ? new java.util.ArrayList<>(sourceBook.getOrDefault(
ModDataComponents.NOTEBOOK_CONTENTS.get(), NotebookContents.EMPTY).pages()) : null;
if (sourceNotebook && (sourcePage >= sourcePages.size() || sourcePages.get(sourcePage).isEmpty())) return false;
ItemStack moving = sourceNotebook ? sourcePages.get(sourcePage) : sourceBook;
if (moving.getCount() != 1) return false;
if (!storablePage(moving)) return false;
if (!targetNotebook && targetBook.getCount() != 1) return false;
var targetPages = targetNotebook ? sourceCollection == targetCollection ? sourcePages
: new java.util.ArrayList<>(targetBook.getOrDefault(
ModDataComponents.NOTEBOOK_CONTENTS.get(), NotebookContents.EMPTY).pages()) : null;
if (targetNotebook) while (targetPages.size() <= targetPage) targetPages.add(ItemStack.EMPTY);
ItemStack displaced = targetNotebook ? targetPages.get(targetPage) : targetBook;
if (!displaced.isEmpty() && !storablePage(displaced)) return false;
if (targetNotebook) targetPages.set(targetPage, moving);
if (sourceNotebook) {
sourcePages.set(sourcePage, displaced);
ItemStack updatedSource = sourceBook.copy();
updatedSource.set(ModDataComponents.NOTEBOOK_CONTENTS.get(), new NotebookContents(sourcePages));
desk.setItem(sourceCollection, updatedSource);
} else desk.setItem(sourceCollection, displaced.isEmpty() ? ItemStack.EMPTY : displaced.copyWithCount(1));
if (targetNotebook && sourceCollection != targetCollection) {
ItemStack updatedTarget = targetBook.copy();
updatedTarget.set(ModDataComponents.NOTEBOOK_CONTENTS.get(), new NotebookContents(targetPages));
desk.setItem(targetCollection, updatedTarget);
} else if (!targetNotebook) desk.setItem(targetCollection, moving.copyWithCount(1));
selectedCollection = targetCollection;
selectedPage = targetPage;
selectedSymbol = null;
refreshCatalog();
broadcastChanges();
return true;
}
private boolean extractPage(int sourceCollection, int sourcePage, int targetSlot) {
if (!getCarried().isEmpty() || targetSlot < -1 || targetSlot >= slots.size()) return false;
ItemStack sourceBook = desk.getItem(sourceCollection);
boolean sourceNotebook = sourceBook.is(ModItems.NOTEBOOK.get());
if (!sourceNotebook && (!sourceBook.is(ModItems.PAGE.get()) || sourcePage != 0)) return false;
var sourcePages = sourceNotebook ? new java.util.ArrayList<>(sourceBook.getOrDefault(
ModDataComponents.NOTEBOOK_CONTENTS.get(), NotebookContents.EMPTY).pages()) : null;
if (sourceNotebook && (sourcePage >= sourcePages.size() || sourcePages.get(sourcePage).isEmpty())) return false;
ItemStack moving = sourceNotebook ? sourcePages.get(sourcePage).copyWithCount(1) : sourceBook.copyWithCount(1);
if (!sourceNotebook && sourceBook.getCount() != 1) return false;
if (targetSlot == -1) {
setCarried(moving);
} else {
if (targetSlot >= WritingDeskBlockEntity.COLLECTIONS && targetSlot < PLAYER_START) return false;
if (targetSlot < WritingDeskBlockEntity.COLLECTIONS && !storablePage(moving)) return false;
Slot target = slots.get(targetSlot);
if (!target.isActive() || !target.mayPlace(moving)) return false;
ItemStack current = target.getItem();
if (targetSlot < WritingDeskBlockEntity.COLLECTIONS && current.is(ModItems.NOTEBOOK.get())) {
var targetPages = targetSlot == sourceCollection ? sourcePages
: new java.util.ArrayList<>(current.getOrDefault(
ModDataComponents.NOTEBOOK_CONTENTS.get(), NotebookContents.EMPTY).pages());
int position = -1;
for (int i = 0; i < NotebookContents.MAX_PAGES; i++) {
if (i >= targetPages.size() || targetPages.get(i).isEmpty()) {
position = i;
break;
}
}
if (position < 0) return false;
while (targetPages.size() <= position) targetPages.add(ItemStack.EMPTY);
targetPages.set(position, moving);
if (targetSlot != sourceCollection) {
ItemStack updatedTarget = current.copy();
updatedTarget.set(ModDataComponents.NOTEBOOK_CONTENTS.get(), new NotebookContents(targetPages));
target.setByPlayer(updatedTarget);
}
} else if (current.isEmpty()) {
target.setByPlayer(moving);
} else if (targetSlot >= PLAYER_START && ItemStack.isSameItemSameComponents(current, moving)
&& current.getCount() < target.getMaxStackSize(moving)) {
target.setByPlayer(current.copyWithCount(current.getCount() + 1));
} else return false;
}
if (sourceNotebook) {
sourcePages.set(sourcePage, ItemStack.EMPTY);
ItemStack updatedSource = sourceBook.copy();
updatedSource.set(ModDataComponents.NOTEBOOK_CONTENTS.get(), new NotebookContents(sourcePages));
desk.setItem(sourceCollection, updatedSource);
} else desk.setItem(sourceCollection, ItemStack.EMPTY);
selectedCollection = sourceCollection;
selectedPage = sourcePage;
selectedSymbol = null;
refreshCatalog();
broadcastChanges();
return true;
}
@Override public boolean stillValid(Player player) { @Override public boolean stillValid(Player player) {
return blockEntity != null && blockEntity.stillValid(player); return blockEntity != null && blockEntity.stillValid(player);
} }
@@ -141,6 +322,7 @@ public final class WritingDeskMenu extends AbstractContainerMenu {
return copy; return copy;
} }
Slot slot = slots.get(index); Slot slot = slots.get(index);
if (!slot.isActive()) return ItemStack.EMPTY;
if (!slot.hasItem()) return ItemStack.EMPTY; if (!slot.hasItem()) return ItemStack.EMPTY;
ItemStack moving = slot.getItem(); ItemStack moving = slot.getItem();
ItemStack original = moving.copy(); ItemStack original = moving.copy();
@@ -155,15 +337,21 @@ public final class WritingDeskMenu extends AbstractContainerMenu {
} }
private boolean moveIntoDesk(ItemStack moving) { private boolean moveIntoDesk(ItemStack moving) {
if (moving.is(ModItems.INK_VIAL.get())) return moveItemStackTo(moving, 4, 5, false); if (moving.is(ModItems.INK_VIAL.get())) return moveItemStackTo(moving,
if (moving.is(ModItems.NOTEBOOK.get())) return moveItemStackTo(moving, 0, 4, false); WritingDeskBlockEntity.INK, WritingDeskBlockEntity.INK + 1, false);
if (moving.is(ModItems.NOTEBOOK.get())) return moveItemStackTo(moving, firstVisibleTab, firstVisibleTab + VISIBLE_TABS, false);
if (moving.is(Items.PAPER)) if (moving.is(Items.PAPER))
return moveItemStackTo(moving, WritingDeskBlockEntity.PAPER, return moveItemStackTo(moving, WritingDeskBlockEntity.PAPER,
WritingDeskBlockEntity.PAPER + 1, false); WritingDeskBlockEntity.PAPER + 1, false);
if (moving.is(ModItems.PAGE.get())) return moveItemStackTo(moving, 0, 4, false); if (storablePage(moving)) return moveItemStackTo(moving, firstVisibleTab, firstVisibleTab + VISIBLE_TABS, false);
return false; return false;
} }
private static boolean storablePage(ItemStack stack) {
return stack.is(ModItems.PAGE.get())
&& PageItem.content(stack).kind() != PageContent.Kind.LINK_PANEL;
}
private ItemStack selectedSource() { private ItemStack selectedSource() {
if (selectedSymbol != null) { if (selectedSymbol != null) {
SymbolReference reference = new SymbolReference(selectedSymbol); SymbolReference reference = new SymbolReference(selectedSymbol);
@@ -195,6 +383,7 @@ public final class WritingDeskMenu extends AbstractContainerMenu {
ItemStack source = selectedSource(); ItemStack source = selectedSource();
return blockEntity != null && source.is(ModItems.PAGE.get()) return blockEntity != null && source.is(ModItems.PAGE.get())
&& PageItem.content(source).kind() != PageContent.Kind.BLANK && PageItem.content(source).kind() != PageContent.Kind.BLANK
&& PageItem.content(source).kind() != PageContent.Kind.LINK_PANEL
&& PageItem.isUsableWriting(source) && blockEntity.canConsumeCopyMaterials(); && PageItem.isUsableWriting(source) && blockEntity.canConsumeCopyMaterials();
} }
@@ -207,7 +396,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) {
@@ -230,6 +423,7 @@ public final class WritingDeskMenu extends AbstractContainerMenu {
} }
refreshCatalog(); refreshCatalog();
refreshOutput(); refreshOutput();
if (slotId >= 0 && slotId < slots.size() && !slots.get(slotId).isActive()) return;
super.clicked(slotId, button, clickType, player); super.clicked(slotId, button, clickType, player);
} }
@@ -245,13 +439,19 @@ public final class WritingDeskMenu extends AbstractContainerMenu {
} }
} }
private static final class DeskSlot extends Slot { private final class DeskSlot extends Slot {
private final int limit; private final int limit;
private DeskSlot(Container container, int index, int x, int y, int limit) { private DeskSlot(Container container, int index, int x, int y, int limit) {
super(container, index, x, y); super(container, index, x, y);
this.limit = limit; this.limit = limit;
} }
@Override public boolean mayPlace(ItemStack stack) { return container.canPlaceItem(getContainerSlot(), stack); } @Override public boolean isActive() {
int slot = getContainerSlot();
return slot >= WritingDeskBlockEntity.COLLECTIONS
|| slot >= firstVisibleTab && slot < firstVisibleTab + VISIBLE_TABS;
}
@Override public boolean mayPickup(Player player) { return isActive(); }
@Override public boolean mayPlace(ItemStack stack) { return isActive() && container.canPlaceItem(getContainerSlot(), stack); }
@Override public int getMaxStackSize() { return limit; } @Override public int getMaxStackSize() { return limit; }
} }
} }
@@ -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;
@@ -13,8 +16,14 @@ import net.dnorberg.rivencraft.client.ClientWritingDeskCatalog;
import net.dnorberg.rivencraft.event.AgeCelestialAngleSync; import net.dnorberg.rivencraft.event.AgeCelestialAngleSync;
import net.dnorberg.rivencraft.item.DescriptiveBookItem; import net.dnorberg.rivencraft.item.DescriptiveBookItem;
import net.dnorberg.rivencraft.item.LinkingBookItem; import net.dnorberg.rivencraft.item.LinkingBookItem;
import net.dnorberg.rivencraft.menu.BookBinderMenu;
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.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolCatalog;
import net.dnorberg.rivencraft.writing.SymbolDisplayMetadata;
import net.dnorberg.rivencraft.writing.WritingEntry;
import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.minecraft.core.component.DataComponents; import net.minecraft.core.component.DataComponents;
import net.minecraft.core.BlockPos; import net.minecraft.core.BlockPos;
import net.minecraft.core.GlobalPos; import net.minecraft.core.GlobalPos;
@@ -49,7 +58,7 @@ public final class ModNetworking {
} }
public static void register(RegisterPayloadHandlersEvent event) { public static void register(RegisterPayloadHandlersEvent event) {
PayloadRegistrar registrar = event.registrar("10"); PayloadRegistrar registrar = event.registrar("13");
registrar.playToServer(RequestDescriptiveBookScreenPayload.TYPE, RequestDescriptiveBookScreenPayload.STREAM_CODEC, registrar.playToServer(RequestDescriptiveBookScreenPayload.TYPE, RequestDescriptiveBookScreenPayload.STREAM_CODEC,
ModNetworking::requestDescriptiveBookScreen); ModNetworking::requestDescriptiveBookScreen);
registrar.playToClient(OpenDescriptiveBookScreenPayload.TYPE, OpenDescriptiveBookScreenPayload.STREAM_CODEC, registrar.playToClient(OpenDescriptiveBookScreenPayload.TYPE, OpenDescriptiveBookScreenPayload.STREAM_CODEC,
@@ -71,6 +80,16 @@ public final class ModNetworking {
ClientAgeCelestialAngles::handle); ClientAgeCelestialAngles::handle);
registrar.playToClient(WritingDeskCatalogPayload.TYPE, WritingDeskCatalogPayload.STREAM_CODEC, registrar.playToClient(WritingDeskCatalogPayload.TYPE, WritingDeskCatalogPayload.STREAM_CODEC,
ClientWritingDeskCatalog::handle); ClientWritingDeskCatalog::handle);
registrar.playToServer(SetBookBinderTitlePayload.TYPE, SetBookBinderTitlePayload.STREAM_CODEC,
ModNetworking::setBookBinderTitle);
}
private static void setBookBinderTitle(SetBookBinderTitlePayload payload, IPayloadContext context) {
if (context.player() instanceof ServerPlayer player
&& player.containerMenu instanceof BookBinderMenu menu
&& menu.containerId == payload.containerId()) {
menu.setTitle(player, payload.title());
}
} }
private static void requestDescriptiveBookScreen(RequestDescriptiveBookScreenPayload payload, IPayloadContext context) { private static void requestDescriptiveBookScreen(RequestDescriptiveBookScreenPayload payload, IPayloadContext context) {
@@ -92,10 +111,17 @@ public final class ModNetworking {
// Requests run on the same server thread as Age creation. A request queued // Requests run on the same server thread as Age creation. A request queued
// during generation can only open the finished book, never a stale client copy. // during generation can only open the finished book, never a stale client copy.
player.inventoryMenu.broadcastChanges(); player.inventoryMenu.broadcastChanges();
List<SymbolDisplayMetadata> writingSymbols = access.stack()
.getOrDefault(ModDataComponents.BOOK_WRITING.get(), OrderedWriting.EMPTY).entries().stream()
.filter(entry -> entry.kind() == WritingEntry.Kind.SYMBOL)
.map(entry -> SymbolCatalog.display(entry.symbol().orElseThrow()))
.toList();
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())); 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) {
@@ -113,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;
} }
@@ -271,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) {
@@ -1,7 +1,11 @@
package net.dnorberg.rivencraft.network; package net.dnorberg.rivencraft.network;
import java.util.ArrayList;
import java.util.List;
import net.dnorberg.rivencraft.Rivencraft; import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.book.AgeTraits; import net.dnorberg.rivencraft.book.AgeTraits;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolDisplayMetadata;
import net.minecraft.core.GlobalPos; import net.minecraft.core.GlobalPos;
import net.minecraft.network.RegistryFriendlyByteBuf; import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.network.codec.StreamCodec; import net.minecraft.network.codec.StreamCodec;
@@ -16,7 +20,8 @@ public record OpenDescriptiveBookScreenPayload(
boolean offhand, boolean offhand,
GlobalPos source, GlobalPos source,
ItemStack book, ItemStack book,
@Nullable AgeTraits traits @Nullable AgeTraits traits,
List<SymbolDisplayMetadata> writingSymbols
) )
implements CustomPacketPayload { implements CustomPacketPayload {
public static final Type<OpenDescriptiveBookScreenPayload> TYPE = new Type<>( public static final Type<OpenDescriptiveBookScreenPayload> TYPE = new Type<>(
@@ -40,6 +45,11 @@ public record OpenDescriptiveBookScreenPayload(
buffer.writeFloat(traits.celestialAngle()); buffer.writeFloat(traits.celestialAngle());
buffer.writeFloat(traits.celestialPhase()); buffer.writeFloat(traits.celestialPhase());
} }
if (payload.writingSymbols().size() > OrderedWriting.MAX_ENTRIES) {
throw new IllegalArgumentException("Too many book symbol displays");
}
buffer.writeVarInt(payload.writingSymbols().size());
payload.writingSymbols().forEach(symbol -> SymbolDisplayMetadata.STREAM_CODEC.encode(buffer, symbol));
} }
private static OpenDescriptiveBookScreenPayload decode(RegistryFriendlyByteBuf buffer) { private static OpenDescriptiveBookScreenPayload decode(RegistryFriendlyByteBuf buffer) {
@@ -57,7 +67,16 @@ public record OpenDescriptiveBookScreenPayload(
buffer.readFloat() buffer.readFloat()
) )
: null; : null;
return new OpenDescriptiveBookScreenPayload(fromStand, offhand, source, book, traits); int count = buffer.readVarInt();
if (count < 0 || count > OrderedWriting.MAX_ENTRIES) {
throw new IllegalArgumentException("Invalid book symbol display count " + count);
}
List<SymbolDisplayMetadata> writingSymbols = new ArrayList<>(count);
for (int index = 0; index < count; index++) {
writingSymbols.add(SymbolDisplayMetadata.STREAM_CODEC.decode(buffer));
}
return new OpenDescriptiveBookScreenPayload(fromStand, offhand, source, book, traits,
List.copyOf(writingSymbols));
} }
@Override @Override
@@ -0,0 +1,19 @@
package net.dnorberg.rivencraft.network;
import net.dnorberg.rivencraft.Rivencraft;
import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.network.codec.ByteBufCodecs;
import net.minecraft.network.codec.StreamCodec;
import net.minecraft.network.protocol.common.custom.CustomPacketPayload;
import net.minecraft.resources.ResourceLocation;
public record SetBookBinderTitlePayload(int containerId, String title) implements CustomPacketPayload {
public static final Type<SetBookBinderTitlePayload> TYPE = new Type<>(
ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "set_book_binder_title"));
public static final StreamCodec<RegistryFriendlyByteBuf, SetBookBinderTitlePayload> STREAM_CODEC =
StreamCodec.composite(ByteBufCodecs.VAR_INT, SetBookBinderTitlePayload::containerId,
ByteBufCodecs.STRING_UTF8, SetBookBinderTitlePayload::title,
SetBookBinderTitlePayload::new);
@Override public Type<? extends CustomPacketPayload> type() { return TYPE; }
}
@@ -2,7 +2,9 @@ package net.dnorberg.rivencraft.registry;
import net.dnorberg.rivencraft.Rivencraft; import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.block.entity.BookStandBlockEntity; import net.dnorberg.rivencraft.block.entity.BookStandBlockEntity;
import net.dnorberg.rivencraft.block.entity.BookBinderBlockEntity;
import net.dnorberg.rivencraft.block.entity.WritingDeskBlockEntity; import net.dnorberg.rivencraft.block.entity.WritingDeskBlockEntity;
import net.dnorberg.rivencraft.block.entity.InkMixerBlockEntity;
import net.minecraft.core.registries.Registries; import net.minecraft.core.registries.Registries;
import net.minecraft.world.level.block.entity.BlockEntityType; import net.minecraft.world.level.block.entity.BlockEntityType;
import net.neoforged.bus.api.IEventBus; import net.neoforged.bus.api.IEventBus;
@@ -20,6 +22,12 @@ public final class ModBlockEntities {
public static final DeferredHolder<BlockEntityType<?>, BlockEntityType<WritingDeskBlockEntity>> WRITING_DESK = public static final DeferredHolder<BlockEntityType<?>, BlockEntityType<WritingDeskBlockEntity>> WRITING_DESK =
BLOCK_ENTITIES.register("writing_desk", () -> BlockEntityType.Builder BLOCK_ENTITIES.register("writing_desk", () -> BlockEntityType.Builder
.of(WritingDeskBlockEntity::new, ModBlocks.WRITING_DESK.get()).build(null)); .of(WritingDeskBlockEntity::new, ModBlocks.WRITING_DESK.get()).build(null));
public static final DeferredHolder<BlockEntityType<?>, BlockEntityType<BookBinderBlockEntity>> BOOK_BINDER =
BLOCK_ENTITIES.register("book_binder", () -> BlockEntityType.Builder
.of(BookBinderBlockEntity::new, ModBlocks.BOOK_BINDER.get()).build(null));
public static final DeferredHolder<BlockEntityType<?>, BlockEntityType<InkMixerBlockEntity>> INK_MIXER =
BLOCK_ENTITIES.register("ink_mixer", () -> BlockEntityType.Builder
.of(InkMixerBlockEntity::new, ModBlocks.INK_MIXER.get()).build(null));
private ModBlockEntities() { private ModBlockEntities() {
} }
@@ -2,7 +2,9 @@ package net.dnorberg.rivencraft.registry;
import net.dnorberg.rivencraft.Rivencraft; import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.block.BookStandBlock; import net.dnorberg.rivencraft.block.BookStandBlock;
import net.dnorberg.rivencraft.block.BookBinderBlock;
import net.dnorberg.rivencraft.block.WritingDeskBlock; import net.dnorberg.rivencraft.block.WritingDeskBlock;
import net.dnorberg.rivencraft.block.InkMixerBlock;
import net.minecraft.world.level.block.Blocks; import net.minecraft.world.level.block.Blocks;
import net.minecraft.world.level.block.state.BlockBehaviour; import net.minecraft.world.level.block.state.BlockBehaviour;
import net.neoforged.bus.api.IEventBus; import net.neoforged.bus.api.IEventBus;
@@ -21,6 +23,14 @@ public final class ModBlocks {
"writing_desk", WritingDeskBlock::new, "writing_desk", WritingDeskBlock::new,
BlockBehaviour.Properties.ofFullCopy(Blocks.CRAFTING_TABLE).noOcclusion() BlockBehaviour.Properties.ofFullCopy(Blocks.CRAFTING_TABLE).noOcclusion()
); );
public static final DeferredBlock<BookBinderBlock> BOOK_BINDER = BLOCKS.registerBlock(
"book_binder", BookBinderBlock::new,
BlockBehaviour.Properties.ofFullCopy(Blocks.CRAFTING_TABLE).noOcclusion()
);
public static final DeferredBlock<InkMixerBlock> INK_MIXER = BLOCKS.registerBlock(
"ink_mixer", InkMixerBlock::new,
BlockBehaviour.Properties.ofFullCopy(Blocks.CRAFTING_TABLE).noOcclusion()
);
private ModBlocks() { private ModBlocks() {
} }
@@ -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;
@@ -23,18 +29,44 @@ public final class ModCreativeTabs {
output.accept(ModItems.NOTEBOOK.get()); output.accept(ModItems.NOTEBOOK.get());
output.accept(ModItems.INK_VIAL.get()); output.accept(ModItems.INK_VIAL.get());
output.accept(ModItems.WRITING_DESK.get()); output.accept(ModItems.WRITING_DESK.get());
output.accept(ModItems.INK_MIXER.get());
output.accept(ModItems.BOOK_BINDER.get());
}) })
.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(PageItem.createLinkPanelPage());
})
.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() {
} }
@@ -2,9 +2,11 @@ package net.dnorberg.rivencraft.registry;
import net.dnorberg.rivencraft.Rivencraft; import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.book.LinkTarget; import net.dnorberg.rivencraft.book.LinkTarget;
import net.dnorberg.rivencraft.book.LinkProperties;
import net.dnorberg.rivencraft.book.AgeReference; import net.dnorberg.rivencraft.book.AgeReference;
import net.dnorberg.rivencraft.writing.PageContent; import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.NotebookContents; import net.dnorberg.rivencraft.writing.NotebookContents;
import net.dnorberg.rivencraft.writing.OrderedWriting;
import net.dnorberg.rivencraft.writing.SymbolDisplayMetadata; import net.dnorberg.rivencraft.writing.SymbolDisplayMetadata;
import com.mojang.serialization.Codec; import com.mojang.serialization.Codec;
import net.minecraft.core.component.DataComponentType; import net.minecraft.core.component.DataComponentType;
@@ -25,6 +27,12 @@ public final class ModDataComponents {
.networkSynchronized(LinkTarget.STREAM_CODEC) .networkSynchronized(LinkTarget.STREAM_CODEC)
.cacheEncoding() .cacheEncoding()
.build()); .build());
public static final DeferredHolder<DataComponentType<?>, DataComponentType<LinkProperties>> LINK_PROPERTIES =
DATA_COMPONENTS.register("link_properties", () -> DataComponentType.<LinkProperties>builder()
.persistent(LinkProperties.CODEC)
.networkSynchronized(LinkProperties.STREAM_CODEC)
.cacheEncoding()
.build());
public static final DeferredHolder<DataComponentType<?>, DataComponentType<AgeReference>> AGE_REFERENCE = public static final DeferredHolder<DataComponentType<?>, DataComponentType<AgeReference>> AGE_REFERENCE =
DATA_COMPONENTS.register("age_reference", () -> DataComponentType.<AgeReference>builder() DATA_COMPONENTS.register("age_reference", () -> DataComponentType.<AgeReference>builder()
.persistent(AgeReference.CODEC) .persistent(AgeReference.CODEC)
@@ -61,6 +69,12 @@ public final class ModDataComponents {
.networkSynchronized(NotebookContents.STREAM_CODEC) .networkSynchronized(NotebookContents.STREAM_CODEC)
.cacheEncoding() .cacheEncoding()
.build()); .build());
public static final DeferredHolder<DataComponentType<?>, DataComponentType<OrderedWriting>> BOOK_WRITING =
DATA_COMPONENTS.register("book_writing", () -> DataComponentType.<OrderedWriting>builder()
.persistent(OrderedWriting.CODEC)
.networkSynchronized(OrderedWriting.STREAM_CODEC)
.cacheEncoding()
.build());
public static final DeferredHolder<DataComponentType<?>, DataComponentType<Integer>> INK_REMAINING = public static final DeferredHolder<DataComponentType<?>, DataComponentType<Integer>> INK_REMAINING =
DATA_COMPONENTS.register("ink_remaining", () -> DataComponentType.<Integer>builder() DATA_COMPONENTS.register("ink_remaining", () -> DataComponentType.<Integer>builder()
.persistent(Codec.intRange(0, 16)) .persistent(Codec.intRange(0, 16))
@@ -41,6 +41,8 @@ public final class ModItems {
new Item.Properties().stacksTo(16) new Item.Properties().stacksTo(16)
); );
public static final DeferredItem<BlockItem> WRITING_DESK = ITEMS.registerSimpleBlockItem(ModBlocks.WRITING_DESK); public static final DeferredItem<BlockItem> WRITING_DESK = ITEMS.registerSimpleBlockItem(ModBlocks.WRITING_DESK);
public static final DeferredItem<BlockItem> BOOK_BINDER = ITEMS.registerSimpleBlockItem(ModBlocks.BOOK_BINDER);
public static final DeferredItem<BlockItem> INK_MIXER = ITEMS.registerSimpleBlockItem(ModBlocks.INK_MIXER);
private ModItems() { private ModItems() {
} }
@@ -3,6 +3,8 @@ package net.dnorberg.rivencraft.registry;
import net.dnorberg.rivencraft.Rivencraft; import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.menu.NotebookMenu; import net.dnorberg.rivencraft.menu.NotebookMenu;
import net.dnorberg.rivencraft.menu.WritingDeskMenu; import net.dnorberg.rivencraft.menu.WritingDeskMenu;
import net.dnorberg.rivencraft.menu.BookBinderMenu;
import net.dnorberg.rivencraft.menu.InkMixerMenu;
import net.minecraft.core.registries.Registries; import net.minecraft.core.registries.Registries;
import net.minecraft.world.inventory.MenuType; import net.minecraft.world.inventory.MenuType;
import net.neoforged.bus.api.IEventBus; import net.neoforged.bus.api.IEventBus;
@@ -18,6 +20,10 @@ public final class ModMenus {
MENUS.register("notebook", () -> IMenuTypeExtension.create(NotebookMenu::new)); MENUS.register("notebook", () -> IMenuTypeExtension.create(NotebookMenu::new));
public static final DeferredHolder<MenuType<?>, MenuType<WritingDeskMenu>> WRITING_DESK = public static final DeferredHolder<MenuType<?>, MenuType<WritingDeskMenu>> WRITING_DESK =
MENUS.register("writing_desk", () -> IMenuTypeExtension.create(WritingDeskMenu::new)); MENUS.register("writing_desk", () -> IMenuTypeExtension.create(WritingDeskMenu::new));
public static final DeferredHolder<MenuType<?>, MenuType<BookBinderMenu>> BOOK_BINDER =
MENUS.register("book_binder", () -> IMenuTypeExtension.create(BookBinderMenu::new));
public static final DeferredHolder<MenuType<?>, MenuType<InkMixerMenu>> INK_MIXER =
MENUS.register("ink_mixer", () -> IMenuTypeExtension.create(InkMixerMenu::new));
private ModMenus() { private ModMenus() {
} }
@@ -0,0 +1,24 @@
package net.dnorberg.rivencraft.registry;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.writing.LinkingBookRecipe;
import net.minecraft.core.registries.Registries;
import net.minecraft.world.item.crafting.RecipeSerializer;
import net.minecraft.world.item.crafting.SimpleCraftingRecipeSerializer;
import net.neoforged.bus.api.IEventBus;
import net.neoforged.neoforge.registries.DeferredHolder;
import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModRecipeSerializers {
private static final DeferredRegister<RecipeSerializer<?>> SERIALIZERS =
DeferredRegister.create(Registries.RECIPE_SERIALIZER, Rivencraft.MOD_ID);
public static final DeferredHolder<RecipeSerializer<?>, RecipeSerializer<LinkingBookRecipe>> LINKING_BOOK =
SERIALIZERS.register("linking_book", () -> new SimpleCraftingRecipeSerializer<>(LinkingBookRecipe::new));
private ModRecipeSerializers() {}
public static void register(IEventBus modEventBus) {
SERIALIZERS.register(modEventBus);
}
}
@@ -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,33 @@
package net.dnorberg.rivencraft.writing;
import java.util.List;
import net.dnorberg.rivencraft.book.LinkProperties;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items;
/** Built-in Legacy ink additives. Optional mod dusts will be mapped through tags separately. */
public final class InkModifierIngredients {
public record Effect(int flag, double chance) {}
public record Ingredient(ItemStack item, List<Effect> effects) {}
private static final List<Ingredient> BUILT_IN = List.of(
new Ingredient(new ItemStack(Items.GUNPOWDER), List.of(new Effect(LinkProperties.DISARM, 0.20))),
new Ingredient(new ItemStack(Items.MUSHROOM_STEW), List.of(new Effect(LinkProperties.DISARM, 0.05))),
new Ingredient(new ItemStack(Items.EXPERIENCE_BOTTLE), List.of(new Effect(LinkProperties.INTRA_LINKING, 0.15))),
new Ingredient(new ItemStack(Items.ENDER_PEARL), List.of(
new Effect(LinkProperties.INTRA_LINKING, 0.15),
new Effect(LinkProperties.DISARM, 0.15))),
new Ingredient(new ItemStack(Items.FEATHER), List.of(new Effect(LinkProperties.MAINTAIN_MOMENTUM, 0.15))),
new Ingredient(new ItemStack(Items.FIRE_CHARGE), List.of(new Effect(LinkProperties.DISARM, 0.25)))
);
private InkModifierIngredients() {}
public static List<Ingredient> builtIn() {
return BUILT_IN;
}
public static Ingredient find(ItemStack stack) {
return BUILT_IN.stream().filter(ingredient -> stack.is(ingredient.item().getItem())).findFirst().orElse(null);
}
}
@@ -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);
}
}
@@ -0,0 +1,83 @@
package net.dnorberg.rivencraft.writing;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.registry.ModDataComponents;
import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.registry.ModRecipeSerializers;
import net.minecraft.core.HolderLookup;
import net.minecraft.core.NonNullList;
import net.minecraft.core.component.DataComponents;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items;
import net.minecraft.world.item.crafting.CraftingBookCategory;
import net.minecraft.world.item.crafting.CraftingInput;
import net.minecraft.world.item.crafting.CustomRecipe;
import net.minecraft.world.item.crafting.Ingredient;
import net.minecraft.world.item.crafting.RecipeSerializer;
import net.minecraft.world.level.Level;
import net.neoforged.neoforge.common.crafting.DataComponentIngredient;
/** Legacy's shapeless leather + Link Panel recipe, adapted to page components. */
public final class LinkingBookRecipe extends CustomRecipe {
public LinkingBookRecipe(CraftingBookCategory category) {
super(category);
}
private static ItemStack findPanel(CraftingInput input) {
if (input.ingredientCount() != 2) return ItemStack.EMPTY;
ItemStack panel = ItemStack.EMPTY;
boolean leather = false;
for (ItemStack stack : input.items()) {
if (stack.isEmpty()) continue;
if (stack.is(ModItems.PAGE.get()) && PageItem.content(stack).kind() == PageContent.Kind.LINK_PANEL
&& panel.isEmpty()) {
panel = stack;
} else if (stack.is(Items.LEATHER) && !leather) {
leather = true;
} else {
return ItemStack.EMPTY;
}
}
return leather ? panel : ItemStack.EMPTY;
}
@Override
public boolean matches(CraftingInput input, Level level) {
return !findPanel(input).isEmpty();
}
@Override
public ItemStack assemble(CraftingInput input, HolderLookup.Provider registries) {
ItemStack panel = findPanel(input);
if (panel.isEmpty()) return ItemStack.EMPTY;
ItemStack book = new ItemStack(ModItems.LINKING_BOOK.get());
// Copy book-relevant panel data, never the Page identity component.
if (panel.has(DataComponents.CUSTOM_NAME)) {
book.set(DataComponents.CUSTOM_NAME, panel.get(DataComponents.CUSTOM_NAME));
}
if (panel.has(ModDataComponents.LINK_PROPERTIES.get())) {
book.set(ModDataComponents.LINK_PROPERTIES.get(), panel.get(ModDataComponents.LINK_PROPERTIES.get()));
}
return book;
}
@Override
public boolean canCraftInDimensions(int width, int height) {
return width * height >= 2;
}
@Override
public NonNullList<Ingredient> getIngredients() {
NonNullList<Ingredient> ingredients = NonNullList.create();
ingredients.add(DataComponentIngredient.of(false,
net.dnorberg.rivencraft.registry.ModDataComponents.PAGE_CONTENT.get(),
PageContent.LINK_PANEL, ModItems.PAGE.get()));
ingredients.add(Ingredient.of(Items.LEATHER));
return ingredients;
}
@Override
public RecipeSerializer<?> getSerializer() {
return ModRecipeSerializers.LINKING_BOOK.get();
}
}
@@ -2,6 +2,7 @@ package net.dnorberg.rivencraft.writing;
import com.mojang.serialization.Codec; import com.mojang.serialization.Codec;
import com.mojang.serialization.DataResult; import com.mojang.serialization.DataResult;
import com.mojang.serialization.codecs.RecordCodecBuilder;
import io.netty.buffer.ByteBuf; import io.netty.buffer.ByteBuf;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
@@ -10,30 +11,50 @@ import net.minecraft.network.codec.ByteBufCodecs;
import net.minecraft.network.codec.StreamCodec; import net.minecraft.network.codec.StreamCodec;
/** Immutable ordered writing shared by pages, notebooks, desks, and books. */ /** Immutable ordered writing shared by pages, notebooks, desks, and books. */
public record OrderedWriting(List<WritingEntry> entries) { public record OrderedWriting(int schemaVersion, List<WritingEntry> entries) {
public static final int CURRENT_SCHEMA_VERSION = 1;
public static final int MAX_ENTRIES = 256; public static final int MAX_ENTRIES = 256;
public static final OrderedWriting EMPTY = new OrderedWriting(List.of()); public static final OrderedWriting EMPTY = new OrderedWriting(List.of());
public static final Codec<OrderedWriting> CODEC = WritingEntry.CODEC.listOf() private static final Codec<List<WritingEntry>> ENTRIES_CODEC = WritingEntry.CODEC.listOf()
.validate(entries -> entries.size() <= MAX_ENTRIES .validate(entries -> entries.size() <= MAX_ENTRIES
? DataResult.success(entries) ? DataResult.success(entries)
: DataResult.error(() -> "Writing exceeds " + MAX_ENTRIES + " entries")) : DataResult.error(() -> "Writing exceeds " + MAX_ENTRIES + " entries"));
.xmap(OrderedWriting::new, OrderedWriting::entries); private static final Codec<OrderedWriting> VERSIONED_CODEC = RecordCodecBuilder.create(instance -> instance.group(
Codec.intRange(CURRENT_SCHEMA_VERSION, CURRENT_SCHEMA_VERSION)
.fieldOf("schema_version").forGetter(OrderedWriting::schemaVersion),
ENTRIES_CODEC.fieldOf("entries").forGetter(OrderedWriting::entries)
).apply(instance, OrderedWriting::new));
// 0.3.7.2 stored BOOK_WRITING as a bare list. Decode it without changing its order.
public static final Codec<OrderedWriting> CODEC = Codec.withAlternative(
VERSIONED_CODEC, ENTRIES_CODEC.xmap(OrderedWriting::new, OrderedWriting::entries));
public static final StreamCodec<ByteBuf, OrderedWriting> STREAM_CODEC = StreamCodec.of( public static final StreamCodec<ByteBuf, OrderedWriting> STREAM_CODEC = StreamCodec.of(
OrderedWriting::encode, OrderedWriting::decode); OrderedWriting::encode, OrderedWriting::decode);
public OrderedWriting { public OrderedWriting {
if (schemaVersion != CURRENT_SCHEMA_VERSION) {
throw new IllegalArgumentException("Unsupported writing schema version " + schemaVersion);
}
entries = List.copyOf(Objects.requireNonNull(entries, "entries")); entries = List.copyOf(Objects.requireNonNull(entries, "entries"));
if (entries.size() > MAX_ENTRIES) { if (entries.size() > MAX_ENTRIES) {
throw new IllegalArgumentException("Writing exceeds " + MAX_ENTRIES + " entries"); throw new IllegalArgumentException("Writing exceeds " + MAX_ENTRIES + " entries");
} }
} }
public OrderedWriting(List<WritingEntry> entries) {
this(CURRENT_SCHEMA_VERSION, entries);
}
private static void encode(ByteBuf buffer, OrderedWriting writing) { private static void encode(ByteBuf buffer, OrderedWriting writing) {
ByteBufCodecs.VAR_INT.encode(buffer, writing.schemaVersion);
ByteBufCodecs.VAR_INT.encode(buffer, writing.entries.size()); ByteBufCodecs.VAR_INT.encode(buffer, writing.entries.size());
writing.entries.forEach(entry -> WritingEntry.STREAM_CODEC.encode(buffer, entry)); writing.entries.forEach(entry -> WritingEntry.STREAM_CODEC.encode(buffer, entry));
} }
private static OrderedWriting decode(ByteBuf buffer) { private static OrderedWriting decode(ByteBuf buffer) {
int schemaVersion = ByteBufCodecs.VAR_INT.decode(buffer);
if (schemaVersion != CURRENT_SCHEMA_VERSION) {
throw new IllegalArgumentException("Unsupported writing schema version " + schemaVersion);
}
int size = ByteBufCodecs.VAR_INT.decode(buffer); int size = ByteBufCodecs.VAR_INT.decode(buffer);
if (size < 0 || size > MAX_ENTRIES) { if (size < 0 || size > MAX_ENTRIES) {
throw new IllegalArgumentException("Invalid writing entry count " + size); throw new IllegalArgumentException("Invalid writing entry count " + size);
@@ -42,6 +63,6 @@ public record OrderedWriting(List<WritingEntry> entries) {
for (int index = 0; index < size; index++) { for (int index = 0; index < size; index++) {
entries.add(WritingEntry.STREAM_CODEC.decode(buffer)); entries.add(WritingEntry.STREAM_CODEC.decode(buffer));
} }
return new OrderedWriting(entries); return new OrderedWriting(schemaVersion, entries);
} }
} }
@@ -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(); }
}
}
@@ -0,0 +1,8 @@
{
"variants": {
"facing=north": {"model":"rivencraft:block/book_binder"},
"facing=east": {"model":"rivencraft:block/book_binder","y":90},
"facing=south": {"model":"rivencraft:block/book_binder","y":180},
"facing=west": {"model":"rivencraft:block/book_binder","y":270}
}
}
@@ -0,0 +1,5 @@
{
"variants": {
"": { "model": "rivencraft:block/ink_mixer" }
}
}
@@ -10,7 +10,10 @@
"item.rivencraft.page.blank": "Blank Page", "item.rivencraft.page.blank": "Blank Page",
"item.rivencraft.page.blank.description": "Ready for writing at a Writing Desk.", "item.rivencraft.page.blank.description": "Ready for writing at a Writing Desk.",
"item.rivencraft.page.link_panel": "Link Panel Page", "item.rivencraft.page.link_panel": "Link Panel Page",
"item.rivencraft.page.link_panel.description": "The baseline panel required to assemble a Descriptive Book.", "item.rivencraft.page.link_panel.description": "A Link Panel for assembling books.",
"item.rivencraft.link_property.disarm": "Disarm",
"item.rivencraft.link_property.maintain_momentum": "Maintain Momentum",
"item.rivencraft.link_property.intra_linking": "Intra Linking",
"item.rivencraft.page.unresolved": "Unresolved Symbol Page", "item.rivencraft.page.unresolved": "Unresolved Symbol Page",
"item.rivencraft.notebook": "Notebook", "item.rivencraft.notebook": "Notebook",
"item.rivencraft.notebook.pages": "Pages: %s/%s", "item.rivencraft.notebook.pages": "Pages: %s/%s",
@@ -18,8 +21,45 @@
"item.rivencraft.ink_vial": "Ink Vial", "item.rivencraft.ink_vial": "Ink Vial",
"block.rivencraft.writing_desk": "Writing Desk", "block.rivencraft.writing_desk": "Writing Desk",
"container.rivencraft.writing_desk": "Writing Desk", "container.rivencraft.writing_desk": "Writing Desk",
"block.rivencraft.book_binder": "Book Binder",
"container.rivencraft.book_binder": "Book Binder",
"block.rivencraft.ink_mixer": "Ink Mixer",
"container.rivencraft.ink_mixer": "Ink Mixer",
"screen.rivencraft.ink_mixer.ink": "Ink: %s/%s",
"screen.rivencraft.ink_mixer.additive_hint": "Click the basin with an additive; right-click adds one.",
"screen.rivencraft.ink_mixer.chance": "%s: %s%%",
"screen.rivencraft.book_binder.title": "Book title",
"screen.rivencraft.book_binder.title_hint": "Name the book",
"screen.rivencraft.book_binder.missing_panel": "Link Panel required as the first page",
"screen.rivencraft.book_binder.cover": "Cover · Link Panel · Notebook",
"screen.rivencraft.book_binder.import": "Import Notebook",
"screen.rivencraft.book_binder.import.tooltip": "Move all Notebook pages into the binder in order",
"screen.rivencraft.book_binder.move_previous": "Move selected page left",
"screen.rivencraft.book_binder.move_next": "Move selected page right",
"screen.rivencraft.book_binder.previous_pages": "Scroll pages left (Left Arrow)",
"screen.rivencraft.book_binder.next_pages": "Scroll pages right (Right Arrow)",
"screen.rivencraft.book_binder.select_hint": "Right-click page to select",
"screen.rivencraft.book_binder.grammar.too_many": "Too many pages for a new Age; remove excess pages",
"screen.rivencraft.book_binder.grammar.missing_panel": "Add a Link Panel as the first page",
"screen.rivencraft.book_binder.grammar.panel_order": "Page %s: move the Link Panel to the first position",
"screen.rivencraft.book_binder.grammar.duplicate_panel": "Page %s: remove the extra Link Panel",
"screen.rivencraft.book_binder.grammar.unresolved": "Page %s: missing symbol definition; restore its data pack or remove it",
"screen.rivencraft.book_binder.grammar.unsupported": "Page %s: this symbol needs semantic schema v2; update its data pack or remove it",
"screen.rivencraft.book_binder.grammar.unsupported_profile": "Page %s: its Age profile is unavailable; restore the data pack or remove this page",
"screen.rivencraft.book_binder.grammar.unsupported_environment": "Page %s: this weather or sky effect is not supported yet",
"screen.rivencraft.book_binder.grammar.duplicate": "Page %s: remove the duplicate symbol",
"screen.rivencraft.book_binder.grammar.conflict": "Page %s: replace the conflicting symbol",
"screen.rivencraft.book_binder.grammar.out_of_order": "Page %s: move this symbol before later categories",
"screen.rivencraft.book_binder.grammar.misplaced_modifier": "Page %s: move this modifier before its celestial page",
"screen.rivencraft.writing_desk.ink": "Ink: %s/%s", "screen.rivencraft.writing_desk.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.all": "Show pages from all tabs",
"screen.rivencraft.writing_desk.category": "Cycle page category: %s",
"screen.rivencraft.writing_desk.all_categories": "All categories",
"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.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.",
@@ -32,9 +72,11 @@
"message.rivencraft.linking_book.linked": "Linked", "message.rivencraft.linking_book.linked": "Linked",
"message.rivencraft.linking_book.missing_dimension": "That dimension is unavailable", "message.rivencraft.linking_book.missing_dimension": "That dimension is unavailable",
"message.rivencraft.linking_book.unsafe": "No safe destination was found near the link", "message.rivencraft.linking_book.unsafe": "No safe destination was found near the link",
"message.rivencraft.linking_book.intra_required": "This book needs an Intra Linking panel for same-dimension travel",
"message.rivencraft.descriptive_book.unwritten": "This Descriptive Book is unwritten", "message.rivencraft.descriptive_book.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",
@@ -49,6 +91,9 @@
"screen.rivencraft.age.name_prompt": "Name this Age before writing the Descriptive Book", "screen.rivencraft.age.name_prompt": "Name this Age before writing the Descriptive Book",
"screen.rivencraft.age.create": "Create", "screen.rivencraft.age.create": "Create",
"screen.rivencraft.age.generator": "Terrain: %s", "screen.rivencraft.age.generator": "Terrain: %s",
"screen.rivencraft.age.pages": "Pages",
"screen.rivencraft.age.details": "Details",
"screen.rivencraft.age.pages_count": "Writing %s/%s",
"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",
@@ -81,16 +126,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",
@@ -99,10 +240,30 @@
"generator.rivencraft.void": "Void", "generator.rivencraft.void": "Void",
"generator.rivencraft.random_vanilla": "Standard", "generator.rivencraft.random_vanilla": "Standard",
"screen.rivencraft.book.preview_pending": "Loading destination...", "screen.rivencraft.book.preview_pending": "Loading destination...",
"screen.rivencraft.book.click_to_link": "Click the panel to link",
"screen.rivencraft.book.explore": "Explore", "screen.rivencraft.book.explore": "Explore",
"screen.rivencraft.book.exploring": "Exploring", "screen.rivencraft.book.exploring": "Exploring",
"screen.rivencraft.book.return_from_explore": "Right-click to return", "screen.rivencraft.book.return_from_explore": "Right-click to return",
"screen.rivencraft.book.previous_page": "Previous page (Left Arrow)",
"screen.rivencraft.book.next_page": "Next page (Right Arrow)",
"jei.rivencraft.writing": "Rivencraft Writing",
"jei.rivencraft.writing.link_panel_hand": "Hold paper and an Ink Vial in opposite hands; use the vial to make a Link Panel.",
"jei.rivencraft.ink_mixer": "Ink Mixer",
"jei.rivencraft.ink_mixer.usage": "Paper + ink makes a Link Panel. One vial fills 16 ink; each panel uses the configured ink cost. The empty vial returns as a glass bottle.",
"jei.rivencraft.ink_mixer.additive": "Click this additive into the ink basin: %s. Effects roll when the panel is taken.",
"jei.rivencraft.ink_mixer.effect": "%s %s%%",
"jei.rivencraft.writing.copy": "At a Writing Desk, select a stored Page, add paper and ink, then take the copy. The source Page stays.",
"jei.rivencraft.writing.bind": "At a Book Binder, name the Age and add a cover plus Link Panel. Optional symbol Pages follow the panel.",
"jei.rivencraft.writing.linking_book": "Craft one Link Panel Page with leather to make an unwritten Linking Book. Open it to name and bind it.",
"itemGroup.rivencraft": "Rivencraft", "itemGroup.rivencraft": "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"
} }
@@ -0,0 +1,61 @@
{
"parent": "minecraft:block/block",
"textures": {
"particle": "rivencraft:block/book_binder",
"body": "rivencraft:block/book_binder",
"press": "rivencraft:block/book_binder_press"
},
"elements": [
{
"from": [0, 0, 0], "to": [16, 10, 16],
"faces": {
"north": {"texture":"#body","uv":[0,4,4,6.5]},
"east": {"texture":"#body","uv":[4,4,8,6.5]},
"south": {"texture":"#body","uv":[8,4,12,6.5]},
"west": {"texture":"#body","uv":[12,4,16,6.5]},
"up": {"texture":"#body","uv":[4,0,8,4]},
"down": {"texture":"#body","uv":[8,0,12,4]}
}
},
{
"from": [0, 10, 1], "to": [3, 14, 15],
"faces": {
"north": {"texture":"#press","uv":[0,4,1.5,6]},
"east": {"texture":"#press","uv":[0,0,7,2]},
"south": {"texture":"#press","uv":[2,4,3.5,6]},
"west": {"texture":"#press","uv":[0,2,7,4]},
"up": {"texture":"#press","uv":[7,0,8.5,6]},
"down": {"texture":"#press","uv":[8.5,0,10,7]}
}
},
{
"from": [13, 10, 1], "to": [16, 14, 15],
"faces": {
"north": {"texture":"#press","uv":[0,4,1.5,6]},
"east": {"texture":"#press","uv":[0,0,7,2]},
"south": {"texture":"#press","uv":[2,4,3.5,6]},
"west": {"texture":"#press","uv":[0,2,7,4]},
"up": {"texture":"#press","uv":[7,0,8.5,6]},
"down": {"texture":"#press","uv":[8.5,0,10,7]}
}
},
{
"from": [3, 11, 3], "to": [13, 12, 4],
"faces": {
"north": {"texture":"#press","uv":[1,15.5,6,16]},
"south": {"texture":"#press","uv":[7,15.5,12,16]},
"up": {"texture":"#press","uv":[0.5,15,5.5,15.5]},
"down": {"texture":"#press","uv":[5.5,15,10.5,15.5]}
}
},
{
"from": [3, 11, 12], "to": [13, 12, 13],
"faces": {
"north": {"texture":"#press","uv":[1,15.5,6,16]},
"south": {"texture":"#press","uv":[7,15.5,12,16]},
"up": {"texture":"#press","uv":[0.5,15,5.5,15.5]},
"down": {"texture":"#press","uv":[5.5,15,10.5,15.5]}
}
}
]
}
Loaded 100 of 194 files, more files were not shown because too many files have changed in this diff. Show more