Compare commits

...
4 Commits
Author SHA1 Message Date
dnorberg d0af75239a Match Legacy handheld book drops with model entity (#85)
Build / build (push) Canceled after 0s
2026-10-19 16:41:07 -04:00
dnorberg 2e5d6e0427 Adopt NeoForge 21.1.264 after compatibility testing
Build / build (push) Canceled after 0s
2026-10-19 05:37:46 -04:00
dnorberg 54c10cca6c Default automatic Return Links to disabled and review compatibility
Build / build (push) Canceled after 0s
2026-10-19 05:21:00 -04:00
dnorberg c39ebd78ba Add Milestone 7 progression advancements
Build / build (push) Canceled after 0s
2026-10-19 04:57:15 -04:00
41 changed files with 935 additions and 26 deletions

No files matched your search

+2 -2
View File
@@ -198,7 +198,7 @@ Linking creates a bound Return Link to the exact source position and orientation
according to the configured Return Link policy. according to the configured Return Link policy.
Server owners can set `descriptive_books.return_link_mode` in Rivencraft's Server owners can set `descriptive_books.return_link_mode` in Rivencraft's
server config to `ON_CREATION` (default), `ALWAYS`, or `DISABLED`. server config to `DISABLED` (default), `ON_CREATION`, or `ALWAYS`.
Age creation, persistence, lifecycle commands, configuration, backups, and Age creation, persistence, lifecycle commands, configuration, backups, and
administrator recovery are documented in [docs/AGES.md](docs/AGES.md). administrator recovery are documented in [docs/AGES.md](docs/AGES.md).
Data-pack runtime profiles are documented in Data-pack runtime profiles are documented in
@@ -208,7 +208,7 @@ Data-pack runtime profiles are documented in
- A Java 21 JDK - A Java 21 JDK
- Minecraft 1.21.1 - Minecraft 1.21.1
- NeoForge 21.1.251 or newer in the 21.1 line - NeoForge 21.1.264 or newer in the 21.1 line
- Dynamic Dimensions AR Edition 0.9.1 and Bad Packets 0.8.2 (client and server) - Dynamic Dimensions AR Edition 0.9.1 and Bad Packets 0.8.2 (client and server)
Create is optional. When installed, Rivencraft uses its Ponder renderer for Create is optional. When installed, Rivencraft uses its Ponder renderer for
+2
View File
@@ -132,6 +132,8 @@ neoForge {
server { server {
server() server()
// Keep dedicated compatibility runs away from the normal dev world.
gameDirectory = project.file(project.findProperty('serverRunDir') ?: 'run')
programArgument '--nogui' programArgument '--nogui'
systemProperty 'neoforge.enabledGameTestNamespaces', project.mod_id systemProperty 'neoforge.enabledGameTestNamespaces', project.mod_id
} }
Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 140 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 124 KiB

+2 -3
View File
@@ -69,10 +69,9 @@ definition.
Rivencraft writes gameplay settings to the world/server configuration managed Rivencraft writes gameplay settings to the world/server configuration managed
by NeoForge. `descriptive_books.return_link_mode` accepts: by NeoForge. `descriptive_books.return_link_mode` accepts:
- `ON_CREATION` (default): create one Return Link the first time a player - `DISABLED` (default): never create Return Links automatically.
enters each Age. - `ON_CREATION`: create one Return Link the first time a player enters each Age.
- `ALWAYS`: create a Return Link after every successful Descriptive Book trip. - `ALWAYS`: create a Return Link after every successful Descriptive Book trip.
- `DISABLED`: never create Return Links automatically.
Each client has a separate `rivencraft-client.toml`. Its `book_preview.mode` Each client has a separate `rivencraft-client.toml`. Its `book_preview.mode`
setting accepts `AUTO`, `IMMERSIVE_PORTALS`, `PONDER`, or `LEGACY`. This changes setting accepts `AUTO`, `IMMERSIVE_PORTALS`, `PONDER`, or `LEGACY`. This changes
+1 -1
View File
@@ -46,7 +46,7 @@ For a manual check, create a fresh surface Age and run `/rivencraft library near
Issue #75's comment calls this a despawning drop. The code differs subtly: [`EntityLinkbook`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/entity/EntityLinkbook.java#L190-L224) explicitly cannot despawn, but takes one starvation damage every 10,000 ticks and damage while wet. It can eventually be destroyed if left unattended; a vanilla item entity's fixed five-minute timeout is not parity. A modern equivalent should retain the visible book and avoid silently deleting its Age identity at that timeout. Issue #75's comment calls this a despawning drop. The code differs subtly: [`EntityLinkbook`](https://github.com/Mystcraft/Mystcraft-Legacy/blob/9bc8ddc061845df0cd5ea47f4fdef773cff786ae/src/main/java/com/xcompwiz/mystcraft/entity/EntityLinkbook.java#L190-L224) explicitly cannot despawn, but takes one starvation damage every 10,000 ticks and damage while wet. It can eventually be destroyed if left unattended; a vanilla item entity's fixed five-minute timeout is not parity. A modern equivalent should retain the visible book and avoid silently deleting its Age identity at that timeout.
Legacy's travel path creates no automatic Return Link. Rivencraft currently defaults to `ON_CREATION` via `DescriptiveBookItem` and `descriptive_books.return_link_mode`. Per #75's comment, change the **new-config default** to `DISABLED` while retaining `ON_CREATION` and `ALWAYS` as opt-ins. Existing saved server configs must keep their explicit value. Handheld-book drop and Return Link default are tracked in [#85](https://truenas-scale.tail180fb1.ts.net:8443/dnorberg/rivencraft/issues/85), not portal-frame logic. Legacy's travel path creates no automatic Return Link. Rivencraft now defaults to `DISABLED` in new server configs while retaining `ON_CREATION` and `ALWAYS` as opt-ins. Existing saved server configs keep their explicit value. Issue #85 adds the active-book drop only to hand-held Linking and Descriptive Book travel. On a successful link, the exact active stack becomes a dedicated `DroppedBookEntity` at the departure point, rendered with the same open `BookModel` and textures as the book stand; a rejected link restores it to the original hand. Stand and portal use leave their books in place. The entity has unlimited vanilla lifetime and loses one of its five item-health points every 10,000 loaded ticks, plus one per wet tick, matching Legacy's slow/wet decay. Unlike Legacy's custom entity, the modern book is picked up by ordinary contact, not sneaking with an empty hand, and remains subject to ordinary item hazards. Following is not yet a Rivencraft modifier, so no Following exception is exposed or silently simulated. Both hands can activate a book, whereas Legacy's explicit stack removal tested only its selected main-hand slot.
## Crafting, sounds, and progression ## Crafting, sounds, and progression
+40
View File
@@ -0,0 +1,40 @@
# Milestone 7 advancements and discovery (#81)
Rivencraft's advancement tab follows the visible progression in Mystcraft
Legacy's `assets/mystcraft/advancements/`: Page, unwritten Linking Book,
Writing Desk writing, Age Book, and safe Age travel. Titles such as *The Ending
Has Not Yet Been Written*, *D'ni Ink*, and *The Art of Writing* reference Myst
without requiring any assets from that game. The Legacy hidden Quinn trigger
has no established Rivencraft action and is deliberately omitted.
`root`, `page`, and `linking_book` use vanilla server-side tick/inventory
criteria. `link_panel`, `copy_page`, `bind_age`, `open_portal`, and `enter_age`
use an impossible criterion awarded only after the server commits the
corresponding action. The Age-travel award requires a successful book or portal
link ending in a registered Rivencraft Age. Opening a book GUI, rendering a
destination preview, viewing a recipe, or merely loading an Age cannot award
it. Progress is stored by Minecraft per player and survives world restarts.
Vanilla recipe-book unlock advancements now cover the Writing Desk, Ink Mixer,
Book Binder, and Notebook, in addition to the existing Ink Vial, Crystal
Block, and Book Receptacle unlocks. The component-sensitive Linking Book
crafting recipe remains a special recipe: its Link Panel requirement and the
Writing Desk/Ink Mixer/Book Binder processes are explained by Rivencraft's
optional JEI integration. No recipe or advancement requires JEI, Create, or
Immersive Portals to be installed.
Manual Survival check: collect a Page and Linking Book; use the Ink Mixer to
take a Link Panel; copy a Page at the Writing Desk; bind a Descriptive Book;
enter its Age; activate a Crystal Portal. Confirm each advancement appears
only after the completed action, not from an output preview or GUI opening.
Repeat the actions with two players to confirm only the actor receives each
award. Restart an existing save and confirm completed progress remains, then
complete one previously unearned milestone. With JEI absent, the vanilla
recipe book should still reveal standard crafting recipes as their ingredients
are discovered; with JEI installed, the special writing guides should appear.
The automated Book Binder output-award scenario stalls in the GameTest storage
runner, so it is intentionally omitted under the project test policy. For its
manual check, open a ready Binder, observe that merely previewing the finished
book does not award *A Book of Ages*, then take the book and confirm the award.
Repeat by shift-clicking the result in a fresh Binder.
+53
View File
@@ -0,0 +1,53 @@
# Milestone 7 compatibility review (#82)
Reviewed 2026-10-19 for Minecraft 1.21.1. The project now compiles against
NeoForge 21.1.264 and advertises that as its minimum. The official
[NeoForge Maven metadata](https://maven.neoforged.net/releases/net/neoforged/neoforge/maven-metadata.xml)
lists 21.1.264 as the newest 21.1 release. Its
[changelog](https://maven.neoforged.net/releases/net/neoforged/neoforge/21.1.264/neoforge-21.1.264-changelog.txt)
includes received split-packet size checks (21.1.260), network setup payload
direction/decoding limits (21.1.261), ad-hoc channel identifier limits
(21.1.262), and an initial attachment-sync fix (21.1.264). Those are concrete
reasons to evaluate an upgrade, but do not by themselves prove Rivencraft and
its optional integrations work on that loader.
**Decision: adopt 21.1.264 beginning with 0.6.6.2.** An override build
succeeded, but its GameTest server repeated its storage-progress display
without producing test results. That run was stopped; it is neither a pass nor
evidence of a NeoForge defect. The player subsequently passed an in-game
singleplayer test on 21.1.264 with the optional stack, then passed a dedicated
server test including Immersive Portals travel to a Rivencraft Age. The
dedicated server also reached the ready state with only the required mods
before the full optional stack was installed. Both modes used Rivencraft
0.6.6.1. The earlier 21.1.251 baseline passed 70 required GameTests for
release V0.6.6.0.
| Dependency | Project baseline | Newest checked 1.21.1 release | Follow-up |
| --- | --- | --- | --- |
| Dynamic Dimensions AR Edition (required) | 0.9.1 | 0.9.1 | No newer release found on [CurseForge](https://www.curseforge.com/minecraft/mc-mods/dynamicdimension-ar-edition/files/all). |
| Bad Packets (required) | neo-0.8.2 | neo-0.8.2 | No newer matching [Modrinth](https://modrinth.com/mod/badpackets/versions) release found. |
| JEI (optional) | 19.57.0.449 | 19.64.0.455 | Separate update issue; verify recipe categories and GUI discovery. |
| Create (optional) | 6.0.10 | 6.0.10 | No newer matching [Modrinth](https://modrinth.com/mod/create/versions) release found. Its jar bundles Ponder 1.0.82. |
| Ponder (bundled with Create) | 1.0.82 | 1.0.87 library artifact | [Maven](https://maven.createmod.net/net/createmod/ponder/ponder-neoforge/maven-metadata.xml) has a newer artifact, but Create 6.0.10 still bundles 1.0.82. Do not treat this as a separately installed Create update. |
| Immersive Portals (optional) | 6.0.7 | 6.0.7 | No newer matching [Modrinth](https://modrinth.com/mod/immersive-portals-neoforge/versions) release found. |
| TerraBlender (optional) | 4.1.0.8 | 4.1.0.8 | No newer matching [Modrinth](https://modrinth.com/mod/terrablender/versions) release found. |
| Serene Seasons (optional) | 10.1.0.8 compile target | 10.1.0.9 | Separate update issue; the user's Prism instance already contains 10.1.0.9, but that is not a recorded compatibility pass. |
| GlitchCore (Serene dependency) | 2.1.0.2 | 2.1.0.2 | No newer matching [Modrinth](https://modrinth.com/mod/glitchcore/versions) release found. |
| Biomes O' Plenty (TerraBlender test addon) | 21.1.0.14 in user's Prism instance | 21.1.0.14 | No newer matching [Modrinth](https://modrinth.com/mod/biomes-o-plenty/versions) release found. |
The Modrinth version comparisons above were filtered to **NeoForge and
Minecraft 1.21.1** on 2026-10-19. Create's bundled Ponder version was read
from `META-INF/jarjar/metadata.json` in `create-1.21.1-6.0.10.jar`; the
separate library-artifact comparison came from Create's Maven. Dynamic
Dimensions was checked on CurseForge. Versions for other Minecraft lines and
similarly named mods were excluded.
The full dedicated test stack contained Create/Ponder, Immersive Portals, JEI,
TerraBlender with Biomes O' Plenty, and Serene Seasons with GlitchCore. The
server loaded a new `rivencraft:age/test`, and its shutdown log confirms that
all Overworld, Nether, End, and Age chunks were saved. The player explicitly
approved 21.1.264 after that test. This does not independently certify every
optional combination, the LEGACY preview fallback on a client without Create
and Immersive Portals, or a full restart/rejoin cycle; keep those in the
regression checklist. Serene's GameTest mock-player network limitation still
requires real-client checks for seasonal behavior.
+1 -1
View File
@@ -45,7 +45,7 @@ being captured in the preview.
## Supported combinations and upstream limits ## Supported combinations and upstream limits
The compatibility baseline is Minecraft 1.21.1, NeoForge 21.1.251, Create The compatibility baseline is Minecraft 1.21.1, NeoForge 21.1.264, Create
6.0.10, and Immersive Portals 6.0.7. Core Age generation and the `LEGACY` 6.0.10, and Immersive Portals 6.0.7. Core Age generation and the `LEGACY`
backend run without Create or Immersive Portals; the headless GameTest server backend run without Create or Immersive Portals; the headless GameTest server
uses that dependency-free path. uses that dependency-free path.
+2 -2
View File
@@ -18,7 +18,7 @@ minecraft_version=1.21.1
# as they do not follow standard versioning conventions. # as they do not follow standard versioning conventions.
minecraft_version_range=[1.21.1] minecraft_version_range=[1.21.1]
# The Neo version must agree with the Minecraft version to get a valid artifact # The Neo version must agree with the Minecraft version to get a valid artifact
neo_version=21.1.251 neo_version=21.1.264
ponder_version=1.0.82 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
@@ -36,7 +36,7 @@ mod_name=Rivencraft
# The license of the mod. Review your options at https://choosealicense.com/. All Rights Reserved is the default. # The license of the mod. Review your options at https://choosealicense.com/. All Rights Reserved is the default.
mod_license=LGPL-3.0-or-later mod_license=LGPL-3.0-or-later
# The mod version. Rivencraft uses the x.y.z.b policy documented in README.md. # The mod version. Rivencraft uses the x.y.z.b policy documented in README.md.
mod_version=0.6.5.2 mod_version=0.6.6.6
immersive_portals_version=6.0.7 immersive_portals_version=6.0.7
terrablender_version=4.1.0.8 terrablender_version=4.1.0.8
serene_seasons_version_id=B6nTjh4b serene_seasons_version_id=B6nTjh4b
@@ -54,6 +54,7 @@ public final class Rivencraft {
ModBiomeSources.register(modEventBus); ModBiomeSources.register(modEventBus);
ModChunkGenerators.register(modEventBus); ModChunkGenerators.register(modEventBus);
ModBlocks.register(modEventBus); ModBlocks.register(modEventBus);
net.dnorberg.rivencraft.registry.ModEntities.register(modEventBus);
ModBlockEntities.register(modEventBus); ModBlockEntities.register(modEventBus);
ModItems.register(modEventBus); ModItems.register(modEventBus);
ModMenus.register(modEventBus); ModMenus.register(modEventBus);
@@ -0,0 +1,30 @@
package net.dnorberg.rivencraft.advancement;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.book.AgeRegistrySavedData;
import net.minecraft.resources.ResourceLocation;
import net.minecraft.server.level.ServerPlayer;
/** Awards action-only progression after the server has committed the action. */
public final class ProgressionAdvancements {
public static final String LINK_PANEL = "link_panel";
public static final String COPY_PAGE = "copy_page";
public static final String BIND_AGE = "bind_age";
public static final String OPEN_PORTAL = "open_portal";
public static final String ENTER_AGE = "enter_age";
private ProgressionAdvancements() {}
public static void award(ServerPlayer player, String path) {
var advancement = player.getServer().getAdvancements().get(
ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, "progression/" + path));
if (advancement != null) player.getAdvancements().award(advancement, "completed");
}
public static void awardAgeTravel(ServerPlayer player) {
if (AgeRegistrySavedData.get(player.serverLevel()).findByDimension(
player.serverLevel().dimension().location()).isPresent()) {
award(player, ENTER_AGE);
}
}
}
@@ -1,5 +1,6 @@
package net.dnorberg.rivencraft.block; package net.dnorberg.rivencraft.block;
import net.dnorberg.rivencraft.advancement.ProgressionAdvancements;
import com.mojang.serialization.MapCodec; import com.mojang.serialization.MapCodec;
import net.dnorberg.rivencraft.block.entity.BookReceptacleBlockEntity; import net.dnorberg.rivencraft.block.entity.BookReceptacleBlockEntity;
import net.dnorberg.rivencraft.portal.CrystalPortalNetwork; import net.dnorberg.rivencraft.portal.CrystalPortalNetwork;
@@ -117,6 +118,8 @@ public final class BookReceptacleBlock extends BaseEntityBlock {
server, pos, plan, destination)); server, pos, plan, destination));
} }
level.playSound(null, pos, SoundEvents.ENCHANTMENT_TABLE_USE, SoundSource.BLOCKS, 1, 1); level.playSound(null, pos, SoundEvents.ENCHANTMENT_TABLE_USE, SoundSource.BLOCKS, 1, 1);
if (player instanceof ServerPlayer serverPlayer)
ProgressionAdvancements.award(serverPlayer, ProgressionAdvancements.OPEN_PORTAL);
return ItemInteractionResult.SUCCESS; return ItemInteractionResult.SUCCESS;
} }
@@ -0,0 +1,127 @@
package net.dnorberg.rivencraft.book;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.entity.DroppedBookEntity;
import net.dnorberg.rivencraft.registry.ModEntities;
import net.dnorberg.rivencraft.registry.ModItems;
import net.minecraft.core.BlockPos;
import net.minecraft.core.GlobalPos;
import net.minecraft.gametest.framework.GameTest;
import net.minecraft.gametest.framework.GameTestHelper;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.world.InteractionHand;
import net.minecraft.world.entity.item.ItemEntity;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items;
import net.minecraft.world.level.block.Blocks;
import net.minecraft.world.phys.AABB;
import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
@GameTestHolder(Rivencraft.MOD_ID)
@PrefixGameTestTemplate(false)
public final class HandheldBookTravelGameTests {
private HandheldBookTravelGameTests() {
}
@GameTest(template = "empty")
public static void successfulHandheldTravelLeavesOnlyActiveBookAtOrigin(GameTestHelper helper) {
var player = helper.makeMockServerPlayerInLevel();
ItemStack book = new ItemStack(ModItems.LINKING_BOOK.get());
player.setItemInHand(InteractionHand.MAIN_HAND, book);
player.getInventory().setItem(1, new ItemStack(Items.DIAMOND));
var source = player.position();
BlockPos destination = helper.absolutePos(new BlockPos(2, 1, 2));
helper.getLevel().setBlock(destination, Blocks.AIR.defaultBlockState(), 2);
helper.getLevel().setBlock(destination.above(), Blocks.AIR.defaultBlockState(), 2);
LinkTarget target = new LinkTarget(GlobalPos.of(helper.getLevel().dimension(), destination), 0, 0);
helper.assertValueEqual(LinkingService.travelHandheld(player, InteractionHand.MAIN_HAND, book, target,
new LinkProperties(LinkProperties.INTRA_LINKING), false), LinkingService.LinkResult.SUCCESS,
"A valid intra-dimensional handheld link must succeed");
helper.assertTrue(player.getMainHandItem().isEmpty(), "Only the active book must leave the hand");
helper.assertTrue(player.getInventory().getItem(1).is(Items.DIAMOND),
"An unrelated inventory item must remain with the player");
var drops = helper.getLevel().getEntitiesOfClass(DroppedBookEntity.class, new AABB(source, source).inflate(2.0),
entity -> entity.getItem().is(ModItems.LINKING_BOOK.get()));
helper.assertValueEqual(drops.size(), 1, "Exactly one recoverable book must remain at the departure point");
helper.assertTrue(drops.getFirst().getItem() == book,
"The model-rendered entity must retain the exact active book stack");
helper.assertTrue(drops.getFirst().copy() instanceof DroppedBookEntity,
"The pickup-animation copy must keep the custom renderer's entity type");
helper.succeed();
}
@GameTest(template = "empty")
public static void rejectedHandheldTravelKeepsBook(GameTestHelper helper) {
var player = helper.makeMockServerPlayerInLevel();
ItemStack book = new ItemStack(ModItems.LINKING_BOOK.get());
player.setItemInHand(InteractionHand.OFF_HAND, book);
LinkTarget target = new LinkTarget(GlobalPos.of(helper.getLevel().dimension(), player.blockPosition()), 0, 0);
helper.assertValueEqual(LinkingService.travelHandheld(player, InteractionHand.OFF_HAND, book, target,
LinkProperties.NONE, false), LinkingService.LinkResult.INTRA_LINKING_REQUIRED,
"A same-dimension link without Intra Linking must be rejected");
helper.assertTrue(player.getOffhandItem() == book, "The exact rejected book must be restored to its hand");
helper.assertTrue(helper.getLevel().getEntitiesOfClass(ItemEntity.class,
new AABB(player.position(), player.position()).inflate(2.0),
entity -> entity.getItem().is(ModItems.LINKING_BOOK.get())).isEmpty(),
"A rejected link must not leave a second copy at the origin");
helper.succeed();
}
@GameTest(template = "empty")
public static void disarmDropsOtherInventoryWithoutDuplicatingActiveBook(GameTestHelper helper) {
var player = helper.makeMockServerPlayerInLevel();
ItemStack book = new ItemStack(ModItems.LINKING_BOOK.get());
player.setItemInHand(InteractionHand.MAIN_HAND, book);
player.getInventory().setItem(1, new ItemStack(Items.DIAMOND));
var source = player.position();
BlockPos destination = helper.absolutePos(new BlockPos(2, 1, 2));
helper.getLevel().setBlock(destination, Blocks.AIR.defaultBlockState(), 2);
helper.getLevel().setBlock(destination.above(), Blocks.AIR.defaultBlockState(), 2);
LinkTarget target = new LinkTarget(GlobalPos.of(helper.getLevel().dimension(), destination), 0, 0);
helper.assertValueEqual(LinkingService.travelHandheld(player, InteractionHand.MAIN_HAND, book, target,
new LinkProperties(LinkProperties.INTRA_LINKING | LinkProperties.DISARM), false),
LinkingService.LinkResult.SUCCESS, "Disarm must not block handheld travel");
var drops = helper.getLevel().getEntitiesOfClass(ItemEntity.class, new AABB(source, source).inflate(2.0));
helper.assertValueEqual(drops.stream().filter(entity -> entity instanceof DroppedBookEntity).count(),
1L, "Disarm must not create a second copy of the active book");
helper.assertValueEqual(drops.stream().filter(entity -> entity.getItem().is(Items.DIAMOND)).count(),
1L, "Disarm must still drop unrelated inventory items");
helper.succeed();
}
@GameTest(template = "empty")
public static void originBookUsesSlowDecayWithoutVanillaDespawn(GameTestHelper helper) {
DroppedBookEntity book = new DroppedBookEntity(helper.getLevel(),
net.minecraft.world.phys.Vec3.ZERO, new ItemStack(ModItems.LINKING_BOOK.get()));
CompoundTag seeded = new CompoundTag();
book.saveWithoutId(seeded);
seeded.putInt("BookDecayTicks", 9_999);
book.readAdditionalSaveData(seeded);
book.tick();
CompoundTag saved = new CompoundTag();
book.saveWithoutId(saved);
helper.assertValueEqual(saved.getShort("Age"), (short)-32_768,
"The dropped book must not expire after vanilla's five minutes");
helper.assertValueEqual(saved.getShort("Health"), (short)4,
"A dropped book must lose one item-health point after 10,000 loaded ticks");
helper.assertValueEqual(saved.getInt("BookDecayTicks"), 0,
"Slow decay must reset its interval and persist across a restart");
DroppedBookEntity restored = new DroppedBookEntity(ModEntities.DROPPED_BOOK.get(), helper.getLevel());
restored.readAdditionalSaveData(saved);
CompoundTag resaved = new CompoundTag();
restored.saveWithoutId(resaved);
helper.assertTrue(restored.getItem().is(ModItems.LINKING_BOOK.get()),
"The custom book entity must retain its book on reload");
helper.assertValueEqual(resaved.getShort("Age"), (short)-32_768,
"The custom book must remain non-despawning after reload");
helper.assertValueEqual(resaved.getShort("Health"), (short)4,
"Decay damage must persist after reload");
helper.assertTrue(restored.copy().getItem().is(ModItems.LINKING_BOOK.get()),
"A pickup-animation copy must retain the book data after reload");
helper.succeed();
}
}
@@ -5,10 +5,13 @@ import java.util.Optional;
import java.util.stream.IntStream; import java.util.stream.IntStream;
import java.util.stream.Stream; import java.util.stream.Stream;
import net.dnorberg.rivencraft.compat.ImmersivePortalsChunkLoaders; import net.dnorberg.rivencraft.compat.ImmersivePortalsChunkLoaders;
import net.dnorberg.rivencraft.entity.DroppedBookEntity;
import net.minecraft.core.BlockPos; import net.minecraft.core.BlockPos;
import net.minecraft.core.Direction; import net.minecraft.core.Direction;
import net.minecraft.server.level.ServerLevel; import net.minecraft.server.level.ServerLevel;
import net.minecraft.server.level.ServerPlayer; import net.minecraft.server.level.ServerPlayer;
import net.minecraft.world.InteractionHand;
import net.minecraft.world.item.ItemStack;
import net.minecraft.tags.BlockTags; import net.minecraft.tags.BlockTags;
import net.minecraft.world.level.border.WorldBorder; import net.minecraft.world.level.border.WorldBorder;
import net.minecraft.world.level.levelgen.Heightmap; import net.minecraft.world.level.levelgen.Heightmap;
@@ -32,6 +35,36 @@ public final class LinkingService {
return travel(player, target, false, properties, false); return travel(player, target, false, properties, false);
} }
/** Removes only the active handheld book after a successful link, leaving it at the departure point. */
public static LinkResult travelHandheld(ServerPlayer player, InteractionHand hand, ItemStack activeBook,
LinkTarget target, LinkProperties properties, boolean requiresFooting) {
if (player.getItemInHand(hand) != activeBook || activeBook.isEmpty()) {
return LinkResult.NO_SAFE_DESTINATION;
}
ServerLevel sourceLevel = player.serverLevel();
Vec3 sourcePosition = player.position();
player.setItemInHand(hand, ItemStack.EMPTY);
boolean dropped = false;
try {
LinkResult result = requiresFooting
? travelWithFooting(player, target, properties)
: travel(player, target, properties);
if (result != LinkResult.SUCCESS) return result;
DroppedBookEntity book = new DroppedBookEntity(sourceLevel, sourcePosition, activeBook);
dropped = sourceLevel.addFreshEntity(book);
return result;
} finally {
// Failed validation or a rejected entity spawn must never eat the book.
if (!dropped) {
if (player.getItemInHand(hand).isEmpty()) player.setItemInHand(hand, activeBook);
else if (!player.getInventory().add(activeBook)) player.drop(activeBook, false);
}
player.containerMenu.broadcastChanges();
}
}
/** Portal travel uses the vanilla transfer if its destination is not yet loaded. */ /** Portal travel uses the vanilla transfer if its destination is not yet loaded. */
public static LinkResult travelPortal(ServerPlayer player, LinkTarget target, LinkProperties properties) { public static LinkResult travelPortal(ServerPlayer player, LinkTarget target, LinkProperties properties) {
return travel(player, target, false, properties, true); return travel(player, target, false, properties, true);
@@ -5,6 +5,7 @@ import net.dnorberg.rivencraft.registry.ModBlockEntities;
import net.dnorberg.rivencraft.registry.ModBlocks; import net.dnorberg.rivencraft.registry.ModBlocks;
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.ModEntities;
import net.minecraft.client.renderer.item.ItemProperties; import net.minecraft.client.renderer.item.ItemProperties;
import net.minecraft.client.renderer.ItemBlockRenderTypes; import net.minecraft.client.renderer.ItemBlockRenderTypes;
import net.minecraft.client.renderer.RenderType; import net.minecraft.client.renderer.RenderType;
@@ -34,6 +35,7 @@ public final class ClientEvents {
@SubscribeEvent @SubscribeEvent
public static void registerRenderers(EntityRenderersEvent.RegisterRenderers event) { public static void registerRenderers(EntityRenderersEvent.RegisterRenderers event) {
event.registerEntityRenderer(ModEntities.DROPPED_BOOK.get(), DroppedBookRenderer::new);
event.registerBlockEntityRenderer(ModBlockEntities.BOOK_STAND.get(), BookStandRenderer::new); event.registerBlockEntityRenderer(ModBlockEntities.BOOK_STAND.get(), BookStandRenderer::new);
event.registerBlockEntityRenderer(ModBlockEntities.WRITING_DESK.get(), WritingDeskRenderer::new); event.registerBlockEntityRenderer(ModBlockEntities.WRITING_DESK.get(), WritingDeskRenderer::new);
event.registerBlockEntityRenderer(ModBlockEntities.STAR_FISSURE.get(), StarFissureRenderer::new); event.registerBlockEntityRenderer(ModBlockEntities.STAR_FISSURE.get(), StarFissureRenderer::new);
@@ -0,0 +1,51 @@
package net.dnorberg.rivencraft.client;
import com.mojang.blaze3d.vertex.PoseStack;
import com.mojang.blaze3d.vertex.VertexConsumer;
import com.mojang.math.Axis;
import net.dnorberg.rivencraft.entity.DroppedBookEntity;
import net.dnorberg.rivencraft.registry.ModItems;
import net.minecraft.client.model.BookModel;
import net.minecraft.client.model.geom.ModelLayers;
import net.minecraft.client.renderer.MultiBufferSource;
import net.minecraft.client.renderer.RenderType;
import net.minecraft.client.renderer.entity.EntityRenderer;
import net.minecraft.client.renderer.entity.EntityRendererProvider;
import net.minecraft.resources.ResourceLocation;
/** Renders the same open book model and textures as Rivencraft's book stands. */
public final class DroppedBookRenderer extends EntityRenderer<DroppedBookEntity> {
private static final ResourceLocation LINKING_TEXTURE = ResourceLocation.fromNamespaceAndPath(
"rivencraft", "textures/entity/linking_book.png");
private static final ResourceLocation DESCRIPTIVE_TEXTURE = ResourceLocation.fromNamespaceAndPath(
"rivencraft", "textures/entity/descriptive_book.png");
private final BookModel model;
public DroppedBookRenderer(EntityRendererProvider.Context context) {
super(context);
model = new BookModel(context.bakeLayer(ModelLayers.BOOK));
shadowRadius = 0.25F;
}
@Override
public void render(DroppedBookEntity entity, float yaw, float partialTick, PoseStack poseStack,
MultiBufferSource buffers, int packedLight) {
poseStack.pushPose();
poseStack.translate(0.0F, 0.0625F, 0.0F);
poseStack.mulPose(Axis.YP.rotationDegrees(yaw + 90.0F));
// The opened model's covers rotate toward the YZ plane. As in Legacy's
// dropped-book renderer, a Z-axis quarter-turn lays the pages skyward.
poseStack.mulPose(Axis.ZP.rotationDegrees(90.0F));
poseStack.scale(0.8F, 0.8F, 0.8F);
model.setupAnim(0.0F, 0.0F, 0.0F, 1.2F);
VertexConsumer vertices = buffers.getBuffer(RenderType.entitySolid(getTextureLocation(entity)));
model.render(poseStack, vertices, packedLight, net.minecraft.client.renderer.texture.OverlayTexture.NO_OVERLAY, -1);
poseStack.popPose();
super.render(entity, yaw, partialTick, poseStack, buffers, packedLight);
}
@Override
public ResourceLocation getTextureLocation(DroppedBookEntity entity) {
return entity.getItem().is(ModItems.DESCRIPTIVE_BOOK.get()) ? DESCRIPTIVE_TEXTURE : LINKING_TEXTURE;
}
}
@@ -75,7 +75,7 @@ public final class RivencraftConfig {
"Controls automatic Return Link creation for Descriptive Book travel.", "Controls automatic Return Link creation for Descriptive Book travel.",
"ON_CREATION creates one link when an Age is first reached; ALWAYS creates one on every arrival; DISABLED creates none." "ON_CREATION creates one link when an Age is first reached; ALWAYS creates one on every arrival; DISABLED creates none."
) )
.defineEnum("return_link_mode", ReturnLinkMode.ON_CREATION); .defineEnum("return_link_mode", ReturnLinkMode.DISABLED);
builder.pop(); builder.pop();
builder.push("libraries"); builder.push("libraries");
LIBRARY_LOOT_MODE = builder.comment( LIBRARY_LOOT_MODE = builder.comment(
@@ -0,0 +1,62 @@
package net.dnorberg.rivencraft.entity;
import net.dnorberg.rivencraft.registry.ModEntities;
import net.minecraft.nbt.CompoundTag;
import net.minecraft.world.entity.EntityType;
import net.minecraft.world.entity.item.ItemEntity;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.level.Level;
import net.minecraft.world.phys.Vec3;
/** A recoverable, model-rendered book left behind by handheld linking. */
public final class DroppedBookEntity extends ItemEntity {
private static final String DECAY_TICKS_TAG = "BookDecayTicks";
private static final int SLOW_DECAY_INTERVAL = 10_000;
private int decayTicks;
public DroppedBookEntity(EntityType<DroppedBookEntity> type, Level level) {
super(type, level);
}
public DroppedBookEntity(Level level, Vec3 position, ItemStack stack) {
this(ModEntities.DROPPED_BOOK.get(), level);
setPos(position.x, position.y + 0.25, position.z);
setDeltaMovement(Vec3.ZERO);
setItem(stack);
setUnlimitedLifetime();
setPickUpDelay(20);
}
/** Vanilla's pickup particle calls ItemEntity.copy() and renders the returned entity. */
@Override
public DroppedBookEntity copy() {
DroppedBookEntity copy = new DroppedBookEntity(ModEntities.DROPPED_BOOK.get(), level());
copy.copyPosition(this);
copy.setItem(getItem().copy());
copy.setUnlimitedLifetime();
return copy;
}
@Override
public void tick() {
super.tick();
if (level().isClientSide || isRemoved()) return;
if (++decayTicks >= SLOW_DECAY_INTERVAL) {
decayTicks = 0;
hurt(damageSources().starve(), 1.0F);
}
if (!isRemoved() && isInWaterOrRain()) hurt(damageSources().drown(), 1.0F);
}
@Override
public void addAdditionalSaveData(CompoundTag tag) {
super.addAdditionalSaveData(tag);
tag.putInt(DECAY_TICKS_TAG, decayTicks);
}
@Override
public void readAdditionalSaveData(CompoundTag tag) {
super.readAdditionalSaveData(tag);
decayTicks = Math.max(0, Math.min(tag.getInt(DECAY_TICKS_TAG), SLOW_DECAY_INTERVAL - 1));
}
}
@@ -0,0 +1,122 @@
package net.dnorberg.rivencraft.gametest;
import java.util.List;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.advancement.ProgressionAdvancements;
import net.dnorberg.rivencraft.block.entity.InkMixerBlockEntity;
import net.dnorberg.rivencraft.block.entity.WritingDeskBlockEntity;
import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.menu.InkMixerMenu;
import net.dnorberg.rivencraft.menu.WritingDeskMenu;
import net.dnorberg.rivencraft.registry.ModBlocks;
import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.writing.SymbolReference;
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.server.level.ServerPlayer;
import net.minecraft.world.inventory.ClickType;
import net.minecraft.world.item.ItemStack;
import net.minecraft.world.item.Items;
import net.neoforged.neoforge.gametest.GameTestHolder;
import net.neoforged.neoforge.gametest.PrefixGameTestTemplate;
@GameTestHolder(Rivencraft.MOD_ID)
@PrefixGameTestTemplate(false)
public final class Milestone7AdvancementGameTests {
private Milestone7AdvancementGameTests() {}
@GameTest(template = "empty")
public static void progressionAndRecipeUnlocksLoad(GameTestHelper helper) {
var registry = helper.getLevel().getServer().getAdvancements();
for (String path : List.of("root", "page", "linking_book", "link_panel",
"copy_page", "bind_age", "enter_age", "open_portal")) {
helper.assertTrue(registry.get(id("progression/" + path)) != null,
"Progression advancement must load: " + path);
}
for (String path : List.of("book_binder", "book_receptacle", "crystal_block",
"ink_mixer", "ink_vial", "notebook", "writing_desk")) {
helper.assertTrue(registry.get(id("recipes/misc/" + path)) != null,
"Recipe-book unlock must load: " + path);
}
var player = helper.makeMockServerPlayerInLevel();
for (String path : List.of("book_binder", "ink_mixer", "notebook", "writing_desk")) {
player.getAdvancements().award(registry.get(id("recipes/misc/" + path)), "has_material");
helper.assertTrue(player.getRecipeBook().contains(id(path)),
"Discovering the material must unlock the " + path + " recipe");
}
helper.succeed();
}
@GameTest(template = "empty")
public static void actionAwardsAreServerOwnedAndPerPlayer(GameTestHelper helper) {
var first = helper.makeMockServerPlayerInLevel();
var second = helper.makeMockServerPlayerInLevel();
var advancement = helper.getLevel().getServer().getAdvancements().get(id("progression/copy_page"));
helper.assertFalse(first.getAdvancements().getOrStartProgress(advancement).isDone(),
"Opening a menu or preview must not award a copied Page");
helper.assertFalse(second.getAdvancements().getOrStartProgress(advancement).isDone(),
"Another player must not inherit the advancement");
ProgressionAdvancements.awardAgeTravel(first);
var travel = helper.getLevel().getServer().getAdvancements().get(id("progression/enter_age"));
helper.assertFalse(first.getAdvancements().getOrStartProgress(travel).isDone(),
"Overworld travel or a preview must not count as entering an Age");
ProgressionAdvancements.award(first, ProgressionAdvancements.COPY_PAGE);
helper.assertTrue(first.getAdvancements().getOrStartProgress(advancement).isDone(),
"The server must award the player who completed the action");
helper.assertFalse(second.getAdvancements().getOrStartProgress(advancement).isDone(),
"Advancement progress must remain per-player in multiplayer");
helper.succeed();
}
@GameTest(template = "empty")
public static void mixerPreviewDoesNotAwardButTakingPanelDoes(GameTestHelper helper) {
BlockPos pos = helper.absolutePos(new BlockPos(1, 1, 1));
helper.getLevel().setBlock(pos, ModBlocks.INK_MIXER.get().defaultBlockState(), 3);
var mixer = (InkMixerBlockEntity) helper.getLevel().getBlockEntity(pos);
mixer.setItem(InkMixerBlockEntity.PAPER, new ItemStack(Items.PAPER));
mixer.setItem(InkMixerBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
var player = nearbyPlayer(helper, pos);
var menu = new InkMixerMenu(1, player.getInventory(), mixer);
helper.assertFalse(done(player, ProgressionAdvancements.LINK_PANEL),
"Opening the Ink Mixer must not award its milestone");
menu.clicked(InkMixerMenu.RESULT, 0, ClickType.PICKUP, player);
helper.assertTrue(done(player, ProgressionAdvancements.LINK_PANEL),
"Taking the completed Link Panel must award its milestone");
helper.succeed();
}
@GameTest(template = "empty")
public static void deskPreviewDoesNotAwardButCopyingDoes(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(0, PageItem.createSymbolPage(new SymbolReference(id("terrain/standard"))));
desk.setItem(WritingDeskBlockEntity.PAPER, new ItemStack(Items.PAPER));
desk.setItem(WritingDeskBlockEntity.INK, new ItemStack(ModItems.INK_VIAL.get()));
var player = nearbyPlayer(helper, pos);
var menu = new WritingDeskMenu(1, player.getInventory(), desk);
helper.assertFalse(done(player, ProgressionAdvancements.COPY_PAGE),
"Opening the Writing Desk must not award a copied Page");
menu.clicked(WritingDeskMenu.COPY_RESULT, 0, ClickType.PICKUP, player);
helper.assertTrue(done(player, ProgressionAdvancements.COPY_PAGE),
"Taking a copied Page must award its milestone");
helper.succeed();
}
private static ServerPlayer nearbyPlayer(GameTestHelper helper, BlockPos pos) {
var player = helper.makeMockServerPlayerInLevel();
player.moveTo(pos.getX() + 0.5, pos.getY() + 0.5, pos.getZ() + 0.5);
return player;
}
private static boolean done(ServerPlayer player, String path) {
var advancement = player.getServer().getAdvancements().get(id("progression/" + path));
return player.getAdvancements().getOrStartProgress(advancement).isDone();
}
private static ResourceLocation id(String path) {
return ResourceLocation.fromNamespaceAndPath(Rivencraft.MOD_ID, path);
}
}
@@ -1,5 +1,6 @@
package net.dnorberg.rivencraft.item; package net.dnorberg.rivencraft.item;
import net.dnorberg.rivencraft.advancement.ProgressionAdvancements;
import java.util.List; 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;
@@ -17,6 +18,7 @@ import net.minecraft.network.chat.Component;
import net.minecraft.network.chat.MutableComponent; import net.minecraft.network.chat.MutableComponent;
import net.minecraft.server.level.ServerPlayer; import net.minecraft.server.level.ServerPlayer;
import net.minecraft.server.level.ServerLevel; import net.minecraft.server.level.ServerLevel;
import net.minecraft.world.InteractionHand;
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;
@@ -40,14 +42,18 @@ public final class DescriptiveBookItem extends Item {
} }
public static boolean useWrittenBook(ServerPlayer player, ItemStack stack) { public static boolean useWrittenBook(ServerPlayer player, ItemStack stack) {
return useWrittenBook(player, stack, false); return useWrittenBook(player, stack, false, null);
}
public static boolean useHandheldBook(ServerPlayer player, InteractionHand hand) {
return useWrittenBook(player, player.getItemInHand(hand), false, hand);
} }
public static boolean usePortalBook(ServerPlayer player, ItemStack stack) { public static boolean usePortalBook(ServerPlayer player, ItemStack stack) {
return useWrittenBook(player, stack, true); return useWrittenBook(player, stack, true, null);
} }
private static boolean useWrittenBook(ServerPlayer player, ItemStack stack, boolean portal) { private static boolean useWrittenBook(ServerPlayer player, ItemStack stack, boolean portal, InteractionHand hand) {
AgeReference age = stack.get(ModDataComponents.AGE_REFERENCE.get()); AgeReference age = stack.get(ModDataComponents.AGE_REFERENCE.get());
if (age == null) { if (age == null) {
player.displayClientMessage(Component.translatable("message.rivencraft.descriptive_book.unwritten"), true); player.displayClientMessage(Component.translatable("message.rivencraft.descriptive_book.unwritten"), true);
@@ -67,7 +73,8 @@ public final class DescriptiveBookItem extends Item {
.forDescriptiveBook(); .forDescriptiveBook();
LinkingService.LinkResult result = portal LinkingService.LinkResult result = portal
? LinkingService.travelDescriptivePortal(player, ageTarget, properties) ? LinkingService.travelDescriptivePortal(player, ageTarget, properties)
: LinkingService.travelWithFooting(player, ageTarget, properties); : hand == null ? LinkingService.travelWithFooting(player, ageTarget, properties)
: LinkingService.travelHandheld(player, hand, stack, ageTarget, properties, true);
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;
@@ -86,6 +93,7 @@ public final class DescriptiveBookItem extends Item {
} }
} }
LinkVisualEffects.play(sourceLevel, sourcePosition, player, properties, portal); LinkVisualEffects.play(sourceLevel, sourcePosition, player, properties, portal);
ProgressionAdvancements.awardAgeTravel(player);
player.displayClientMessage(Component.translatable( player.displayClientMessage(Component.translatable(
createReturnLink ? "message.rivencraft.descriptive_book.linked_first" : "message.rivencraft.descriptive_book.linked", createReturnLink ? "message.rivencraft.descriptive_book.linked_first" : "message.rivencraft.descriptive_book.linked",
age.name() age.name()
@@ -1,5 +1,6 @@
package net.dnorberg.rivencraft.item; package net.dnorberg.rivencraft.item;
import net.dnorberg.rivencraft.advancement.ProgressionAdvancements;
import java.util.List; 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;
@@ -42,14 +43,19 @@ public final class LinkingBookItem extends Item {
} }
public static InteractionResultHolder<ItemStack> useBoundBook(ServerPlayer player, ItemStack stack) { public static InteractionResultHolder<ItemStack> useBoundBook(ServerPlayer player, ItemStack stack) {
return useBoundBook(player, stack, false); return useBoundBook(player, stack, false, null);
}
public static InteractionResultHolder<ItemStack> useHandheldBook(ServerPlayer player, InteractionHand hand) {
return useBoundBook(player, player.getItemInHand(hand), false, hand);
} }
public static InteractionResultHolder<ItemStack> usePortalBook(ServerPlayer player, ItemStack stack) { public static InteractionResultHolder<ItemStack> usePortalBook(ServerPlayer player, ItemStack stack) {
return useBoundBook(player, stack, true); return useBoundBook(player, stack, true, null);
} }
private static InteractionResultHolder<ItemStack> useBoundBook(ServerPlayer player, ItemStack stack, boolean portal) { private static InteractionResultHolder<ItemStack> useBoundBook(ServerPlayer player, ItemStack stack, boolean portal,
InteractionHand hand) {
LinkTarget target = stack.get(ModDataComponents.LINK_TARGET.get()); LinkTarget target = stack.get(ModDataComponents.LINK_TARGET.get());
if (target == null) { if (target == null) {
player.displayClientMessage(Component.translatable("message.rivencraft.linking_book.unbound"), true); player.displayClientMessage(Component.translatable("message.rivencraft.linking_book.unbound"), true);
@@ -61,9 +67,11 @@ public final class LinkingBookItem extends Item {
LinkProperties properties = stack.getOrDefault(ModDataComponents.LINK_PROPERTIES.get(), LinkProperties.NONE); LinkProperties properties = stack.getOrDefault(ModDataComponents.LINK_PROPERTIES.get(), LinkProperties.NONE);
LinkingService.LinkResult result = portal LinkingService.LinkResult result = portal
? LinkingService.travelPortal(player, target, properties) ? LinkingService.travelPortal(player, target, properties)
: LinkingService.travel(player, target, properties); : hand == null ? LinkingService.travel(player, target, properties)
: LinkingService.travelHandheld(player, hand, stack, target, properties, false);
if (result == LinkingService.LinkResult.SUCCESS) { if (result == LinkingService.LinkResult.SUCCESS) {
LinkVisualEffects.play(sourceLevel, sourcePosition, player, properties, portal); LinkVisualEffects.play(sourceLevel, sourcePosition, player, properties, portal);
ProgressionAdvancements.awardAgeTravel(player);
player.displayClientMessage(Component.translatable("message.rivencraft.linking_book.linked"), true); player.displayClientMessage(Component.translatable("message.rivencraft.linking_book.linked"), true);
return InteractionResultHolder.success(stack); return InteractionResultHolder.success(stack);
} }
@@ -1,5 +1,6 @@
package net.dnorberg.rivencraft.menu; package net.dnorberg.rivencraft.menu;
import net.dnorberg.rivencraft.advancement.ProgressionAdvancements;
import java.util.Optional; import java.util.Optional;
import net.dnorberg.rivencraft.block.entity.BookBinderBlockEntity; import net.dnorberg.rivencraft.block.entity.BookBinderBlockEntity;
import net.dnorberg.rivencraft.item.PageItem; import net.dnorberg.rivencraft.item.PageItem;
@@ -9,6 +10,7 @@ import net.dnorberg.rivencraft.registry.ModMenus;
import net.dnorberg.rivencraft.writing.PageContent; import net.dnorberg.rivencraft.writing.PageContent;
import net.dnorberg.rivencraft.writing.WritingGrammar; import net.dnorberg.rivencraft.writing.WritingGrammar;
import net.minecraft.network.RegistryFriendlyByteBuf; import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.server.level.ServerPlayer;
import net.minecraft.world.Container; import net.minecraft.world.Container;
import net.minecraft.world.SimpleContainer; import net.minecraft.world.SimpleContainer;
import net.minecraft.world.entity.player.Inventory; import net.minecraft.world.entity.player.Inventory;
@@ -210,7 +212,9 @@ public final class BookBinderMenu extends AbstractContainerMenu {
if (!moveItemStackTo(remainder, PLAYER_START, slots.size(), true) || !remainder.isEmpty()) { if (!moveItemStackTo(remainder, PLAYER_START, slots.size(), true) || !remainder.isEmpty()) {
return ItemStack.EMPTY; return ItemStack.EMPTY;
} }
binder.consumeAssembly(); if (!binder.consumeAssembly()) return ItemStack.EMPTY;
if (player instanceof ServerPlayer serverPlayer)
ProgressionAdvancements.award(serverPlayer, ProgressionAdvancements.BIND_AGE);
refreshResult(); refreshResult();
return book; return book;
} }
@@ -284,7 +288,11 @@ public final class BookBinderMenu extends AbstractContainerMenu {
return clientSide ? hasItem() : stillValid(player) && binder.canAssemble(); return clientSide ? hasItem() : stillValid(player) && binder.canAssemble();
} }
@Override public void onTake(Player player, ItemStack stack) { @Override public void onTake(Player player, ItemStack stack) {
if (!clientSide && binder.consumeAssembly()) refreshResult(); if (!clientSide && binder.consumeAssembly()) {
if (player instanceof ServerPlayer serverPlayer)
ProgressionAdvancements.award(serverPlayer, ProgressionAdvancements.BIND_AGE);
refreshResult();
}
super.onTake(player, stack); super.onTake(player, stack);
} }
} }
@@ -1,10 +1,12 @@
package net.dnorberg.rivencraft.menu; package net.dnorberg.rivencraft.menu;
import net.dnorberg.rivencraft.advancement.ProgressionAdvancements;
import net.dnorberg.rivencraft.block.entity.InkMixerBlockEntity; import net.dnorberg.rivencraft.block.entity.InkMixerBlockEntity;
import net.dnorberg.rivencraft.item.PageItem; import net.dnorberg.rivencraft.item.PageItem;
import net.dnorberg.rivencraft.registry.ModItems; import net.dnorberg.rivencraft.registry.ModItems;
import net.dnorberg.rivencraft.registry.ModMenus; import net.dnorberg.rivencraft.registry.ModMenus;
import net.minecraft.network.RegistryFriendlyByteBuf; import net.minecraft.network.RegistryFriendlyByteBuf;
import net.minecraft.server.level.ServerPlayer;
import net.minecraft.world.Container; import net.minecraft.world.Container;
import net.minecraft.world.SimpleContainer; import net.minecraft.world.SimpleContainer;
import net.minecraft.world.entity.player.Inventory; import net.minecraft.world.entity.player.Inventory;
@@ -109,6 +111,8 @@ public final class InkMixerMenu extends AbstractContainerMenu {
if (!moveItemStackTo(remainder, PLAYER_START, slots.size(), true) || !remainder.isEmpty()) if (!moveItemStackTo(remainder, PLAYER_START, slots.size(), true) || !remainder.isEmpty())
return ItemStack.EMPTY; return ItemStack.EMPTY;
if (!mixer.consumeLinkPanelMaterials()) return ItemStack.EMPTY; if (!mixer.consumeLinkPanelMaterials()) return ItemStack.EMPTY;
if (player instanceof ServerPlayer serverPlayer)
ProgressionAdvancements.award(serverPlayer, ProgressionAdvancements.LINK_PANEL);
refreshResult(); refreshResult();
return output; return output;
} }
@@ -148,7 +152,11 @@ public final class InkMixerMenu extends AbstractContainerMenu {
return clientSide ? hasItem() : stillValid(player) && mixer.canCreateLinkPanel(); return clientSide ? hasItem() : stillValid(player) && mixer.canCreateLinkPanel();
} }
@Override public void onTake(Player player, ItemStack stack) { @Override public void onTake(Player player, ItemStack stack) {
if (!clientSide && mixer.consumeLinkPanelMaterials()) refreshResult(); if (!clientSide && mixer.consumeLinkPanelMaterials()) {
if (player instanceof ServerPlayer serverPlayer)
ProgressionAdvancements.award(serverPlayer, ProgressionAdvancements.LINK_PANEL);
refreshResult();
}
super.onTake(player, stack); super.onTake(player, stack);
} }
} }
@@ -1,5 +1,6 @@
package net.dnorberg.rivencraft.menu; package net.dnorberg.rivencraft.menu;
import net.dnorberg.rivencraft.advancement.ProgressionAdvancements;
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;
@@ -317,7 +318,9 @@ public final class WritingDeskMenu extends AbstractContainerMenu {
if (!moveItemStackTo(movingCopy, PLAYER_START, slots.size(), true) || !movingCopy.isEmpty()) { if (!moveItemStackTo(movingCopy, PLAYER_START, slots.size(), true) || !movingCopy.isEmpty()) {
return ItemStack.EMPTY; return ItemStack.EMPTY;
} }
blockEntity.consumeCopyMaterials(); if (!blockEntity.consumeCopyMaterials()) return ItemStack.EMPTY;
if (player instanceof ServerPlayer serverPlayer)
ProgressionAdvancements.award(serverPlayer, ProgressionAdvancements.COPY_PAGE);
refreshOutput(); refreshOutput();
return copy; return copy;
} }
@@ -434,7 +437,11 @@ public final class WritingDeskMenu extends AbstractContainerMenu {
return clientSide ? hasItem() : WritingDeskMenu.this.stillValid(player) && canCopy(); return clientSide ? hasItem() : WritingDeskMenu.this.stillValid(player) && canCopy();
} }
@Override public void onTake(Player player, ItemStack stack) { @Override public void onTake(Player player, ItemStack stack) {
if (!clientSide && blockEntity.consumeCopyMaterials()) refreshOutput(); if (!clientSide && blockEntity.consumeCopyMaterials()) {
if (player instanceof ServerPlayer serverPlayer)
ProgressionAdvancements.award(serverPlayer, ProgressionAdvancements.COPY_PAGE);
refreshOutput();
}
super.onTake(player, stack); super.onTake(player, stack);
} }
} }
@@ -211,7 +211,7 @@ public final class ModNetworking {
ItemStack stack = player.getItemInHand(hand(payload.offhand())); ItemStack stack = player.getItemInHand(hand(payload.offhand()));
if (stack.is(ModItems.LINKING_BOOK.get()) && stack.has(ModDataComponents.LINK_TARGET.get())) { if (stack.is(ModItems.LINKING_BOOK.get()) && stack.has(ModDataComponents.LINK_TARGET.get())) {
LinkingBookItem.useBoundBook(player, stack); LinkingBookItem.useHandheldBook(player, hand(payload.offhand()));
} }
} }
@@ -245,7 +245,8 @@ public final class ModNetworking {
} }
if (stack.is(ModItems.DESCRIPTIVE_BOOK.get())) { if (stack.is(ModItems.DESCRIPTIVE_BOOK.get())) {
DescriptiveBookItem.useWrittenBook(player, stack); if (payload.fromStand()) DescriptiveBookItem.useWrittenBook(player, stack);
else DescriptiveBookItem.useHandheldBook(player, hand(payload.offhand()));
} }
} }
@@ -0,0 +1,30 @@
package net.dnorberg.rivencraft.registry;
import net.dnorberg.rivencraft.Rivencraft;
import net.dnorberg.rivencraft.entity.DroppedBookEntity;
import net.minecraft.core.registries.Registries;
import net.minecraft.world.entity.EntityType;
import net.minecraft.world.entity.MobCategory;
import net.neoforged.bus.api.IEventBus;
import net.neoforged.neoforge.registries.DeferredHolder;
import net.neoforged.neoforge.registries.DeferredRegister;
public final class ModEntities {
private static final DeferredRegister<EntityType<?>> ENTITIES =
DeferredRegister.create(Registries.ENTITY_TYPE, Rivencraft.MOD_ID);
public static final DeferredHolder<EntityType<?>, EntityType<DroppedBookEntity>> DROPPED_BOOK =
ENTITIES.register("dropped_book", () -> EntityType.Builder
.<DroppedBookEntity>of(DroppedBookEntity::new, MobCategory.MISC)
.sized(0.65F, 0.4F)
.clientTrackingRange(10)
.updateInterval(20)
.build(Rivencraft.MOD_ID + ":dropped_book"));
private ModEntities() {
}
public static void register(IEventBus bus) {
ENTITIES.register(bus);
}
}
@@ -369,5 +369,21 @@
"symbol.rivencraft.corrupted.medium": "Corrupted Page", "symbol.rivencraft.corrupted.medium": "Corrupted Page",
"symbol.rivencraft.corrupted.medium.description": "The writing shifts beyond comprehension.", "symbol.rivencraft.corrupted.medium.description": "The writing shifts beyond comprehension.",
"symbol.rivencraft.corrupted.small": "Corrupted Page", "symbol.rivencraft.corrupted.small": "Corrupted Page",
"symbol.rivencraft.corrupted.small.description": "The writing shifts beyond comprehension." "symbol.rivencraft.corrupted.small.description": "The writing shifts beyond comprehension.",
"advancement.rivencraft.root.title": "The Ending Has Not Yet Been Written",
"advancement.rivencraft.root.description": "Begin the Art of writing and linking Ages.",
"advancement.rivencraft.page.title": "A Strange Page",
"advancement.rivencraft.page.description": "Find a Page marked with the language of Ages.",
"advancement.rivencraft.linking_book.title": "A Way Back",
"advancement.rivencraft.linking_book.description": "Obtain a Linking Book and remember where you came from.",
"advancement.rivencraft.link_panel.title": "D'ni Ink",
"advancement.rivencraft.link_panel.description": "Create a Link Panel at the Ink Mixer.",
"advancement.rivencraft.copy_page.title": "The Art of Writing",
"advancement.rivencraft.copy_page.description": "Copy a Page at the Writing Desk.",
"advancement.rivencraft.bind_age.title": "A Book of Ages",
"advancement.rivencraft.bind_age.description": "Bind a completed Descriptive Book.",
"advancement.rivencraft.enter_age.title": "The Journey Begins",
"advancement.rivencraft.enter_age.description": "Safely link into an Age you have written.",
"advancement.rivencraft.open_portal.title": "A Window Between Ages",
"advancement.rivencraft.open_portal.description": "Activate a Crystal Portal with a bound book."
} }
@@ -0,0 +1,19 @@
{
"parent": "rivencraft:progression/link_panel",
"display": {
"icon": {
"id": "rivencraft:descriptive_book"
},
"title": {
"translate": "advancement.rivencraft.bind_age.title"
},
"description": {
"translate": "advancement.rivencraft.bind_age.description"
}
},
"criteria": {
"completed": {
"trigger": "minecraft:impossible"
}
}
}
@@ -0,0 +1,19 @@
{
"parent": "rivencraft:progression/page",
"display": {
"icon": {
"id": "rivencraft:writing_desk"
},
"title": {
"translate": "advancement.rivencraft.copy_page.title"
},
"description": {
"translate": "advancement.rivencraft.copy_page.description"
}
},
"criteria": {
"completed": {
"trigger": "minecraft:impossible"
}
}
}
@@ -0,0 +1,20 @@
{
"parent": "rivencraft:progression/bind_age",
"display": {
"icon": {
"id": "rivencraft:descriptive_book"
},
"title": {
"translate": "advancement.rivencraft.enter_age.title"
},
"description": {
"translate": "advancement.rivencraft.enter_age.description"
},
"frame": "goal"
},
"criteria": {
"completed": {
"trigger": "minecraft:impossible"
}
}
}
@@ -0,0 +1,19 @@
{
"parent": "rivencraft:progression/root",
"display": {
"icon": {
"id": "rivencraft:ink_mixer"
},
"title": {
"translate": "advancement.rivencraft.link_panel.title"
},
"description": {
"translate": "advancement.rivencraft.link_panel.description"
}
},
"criteria": {
"completed": {
"trigger": "minecraft:impossible"
}
}
}
@@ -0,0 +1,26 @@
{
"parent": "rivencraft:progression/root",
"display": {
"icon": {
"id": "rivencraft:linking_book"
},
"title": {
"translate": "advancement.rivencraft.linking_book.title"
},
"description": {
"translate": "advancement.rivencraft.linking_book.description"
}
},
"criteria": {
"completed": {
"trigger": "minecraft:inventory_changed",
"conditions": {
"items": [
{
"items": "rivencraft:linking_book"
}
]
}
}
}
}
@@ -0,0 +1,20 @@
{
"parent": "rivencraft:progression/linking_book",
"display": {
"icon": {
"id": "rivencraft:book_receptacle"
},
"title": {
"translate": "advancement.rivencraft.open_portal.title"
},
"description": {
"translate": "advancement.rivencraft.open_portal.description"
},
"frame": "goal"
},
"criteria": {
"completed": {
"trigger": "minecraft:impossible"
}
}
}
@@ -0,0 +1,26 @@
{
"parent": "rivencraft:progression/root",
"display": {
"icon": {
"id": "rivencraft:page"
},
"title": {
"translate": "advancement.rivencraft.page.title"
},
"description": {
"translate": "advancement.rivencraft.page.description"
}
},
"criteria": {
"completed": {
"trigger": "minecraft:inventory_changed",
"conditions": {
"items": [
{
"items": "rivencraft:page"
}
]
}
}
}
}
@@ -0,0 +1,21 @@
{
"display": {
"icon": {
"id": "rivencraft:descriptive_book"
},
"title": {
"translate": "advancement.rivencraft.root.title"
},
"description": {
"translate": "advancement.rivencraft.root.description"
},
"background": "minecraft:textures/gui/advancements/backgrounds/stone.png",
"show_toast": false,
"announce_to_chat": false
},
"criteria": {
"completed": {
"trigger": "minecraft:tick"
}
}
}
@@ -0,0 +1,32 @@
{
"parent": "minecraft:recipes/root",
"criteria": {
"has_material": {
"trigger": "minecraft:inventory_changed",
"conditions": {
"items": [
{
"items": "minecraft:iron_ingot"
}
]
}
},
"has_the_recipe": {
"trigger": "minecraft:recipe_unlocked",
"conditions": {
"recipe": "rivencraft:book_binder"
}
}
},
"requirements": [
[
"has_material",
"has_the_recipe"
]
],
"rewards": {
"recipes": [
"rivencraft:book_binder"
]
}
}
@@ -0,0 +1,32 @@
{
"parent": "minecraft:recipes/root",
"criteria": {
"has_material": {
"trigger": "minecraft:inventory_changed",
"conditions": {
"items": [
{
"items": "minecraft:glass_bottle"
}
]
}
},
"has_the_recipe": {
"trigger": "minecraft:recipe_unlocked",
"conditions": {
"recipe": "rivencraft:ink_mixer"
}
}
},
"requirements": [
[
"has_material",
"has_the_recipe"
]
],
"rewards": {
"recipes": [
"rivencraft:ink_mixer"
]
}
}
@@ -0,0 +1,32 @@
{
"parent": "minecraft:recipes/root",
"criteria": {
"has_material": {
"trigger": "minecraft:inventory_changed",
"conditions": {
"items": [
{
"items": "minecraft:leather"
}
]
}
},
"has_the_recipe": {
"trigger": "minecraft:recipe_unlocked",
"conditions": {
"recipe": "rivencraft:notebook"
}
}
},
"requirements": [
[
"has_material",
"has_the_recipe"
]
],
"rewards": {
"recipes": [
"rivencraft:notebook"
]
}
}
@@ -0,0 +1,32 @@
{
"parent": "minecraft:recipes/root",
"criteria": {
"has_material": {
"trigger": "minecraft:inventory_changed",
"conditions": {
"items": [
{
"items": "minecraft:feather"
}
]
}
},
"has_the_recipe": {
"trigger": "minecraft:recipe_unlocked",
"conditions": {
"recipe": "rivencraft:writing_desk"
}
}
},
"requirements": [
[
"has_material",
"has_the_recipe"
]
],
"rewards": {
"recipes": [
"rivencraft:writing_desk"
]
}
}