Initial port to 1.17.1

Author: Darkhax

gradle.properties

@@ -1,5 +1,5 @@
 group=net.darkhax.bookshelf
-version=10.2
+version=11.0
 
 mod_name=Bookshelf
 mod_author=Darkhax
@@ -9,10 +9,10 @@ mod_source=https://github.com/Darkhax-Minecraft/Bookshelf
 mod_issues=https://github.com/Darkhax-Minecraft/Bookshelf/issues
 mod_description=A library for building other mods.
 
-minecraft_version=1.16.5
+minecraft_version=1.17.1
 
 # ForgeGradle properties (gradle/forge.gradle)
-forge_version=36.2.2
+forge_version=37.0.22
 forge_at=src/main/resources/META-INF/accesstransformer.cfg
 
 # CurseForge properties (gradle/curseforge.gradle)

gradle/forge.gradle

@@ -160,6 +160,7 @@ processResources {
 
     def buildProps = project.properties.clone()
 
+    // When patreon data is available add credits and supporter info.
     if (project.ext.has('patreon') && project.ext.patreon.pledges && !project.ext.patreon.pledges.isEmpty()) {
 
         def supporters = new ArrayList<String>()
@@ -177,6 +178,10 @@ processResources {
         buildProps.put('modCredits', "${project.ext.modCredits} and the supporters on Patreon: ${supporters.join(', ')}") 
     }
 
+    // Replaces FML's magic file.jarVersion string with the correct version at 
+    // build time.
+    buildProps.put('file', [jarVersion: project.version])
+    
     filesMatching(['META-INF/mods.toml', 'pack.mcmeta']) {
 
         expand buildProps

gradle/java.gradle

@@ -10,7 +10,7 @@ java {
     withJavadocJar()
 
     // Set minimum language version.
-    toolchain.languageVersion = JavaLanguageVersion.of(8)
+    toolchain.languageVersion = JavaLanguageVersion.of(16)
 }
 
 javadoc {

src/main/java/net/darkhax/bookshelf/Bookshelf.java

@@ -52,17 +52,17 @@
 import net.darkhax.bookshelf.loot.modifier.ModifierRecipe;
 import net.darkhax.bookshelf.loot.modifier.ModifierSilkTouch;
 import net.darkhax.bookshelf.registry.RegistryHelper;
-import net.minecraft.advancements.criterion.ItemPredicate;
-import net.minecraft.command.arguments.ArgumentSerializer;
-import net.minecraft.enchantment.EnchantmentType;
-import net.minecraft.item.AxeItem;
-import net.minecraft.item.HoeItem;
-import net.minecraft.item.PickaxeItem;
-import net.minecraft.item.ShearsItem;
-import net.minecraft.item.ShovelItem;
-import net.minecraft.item.SwordItem;
-import net.minecraft.loot.LootConditionType;
-import net.minecraft.util.ResourceLocation;
+import net.minecraft.advancements.critereon.ItemPredicate;
+import net.minecraft.commands.synchronization.EmptyArgumentSerializer;
+import net.minecraft.world.item.enchantment.EnchantmentCategory;
+import net.minecraft.world.item.AxeItem;
+import net.minecraft.world.item.HoeItem;
+import net.minecraft.world.item.PickaxeItem;
+import net.minecraft.world.item.ShearsItem;
+import net.minecraft.world.item.ShovelItem;
+import net.minecraft.world.item.SwordItem;
+import net.minecraft.world.level.storage.loot.predicates.LootItemConditionType;
+import net.minecraft.resources.ResourceLocation;
 import net.minecraftforge.common.ToolType;
 import net.minecraftforge.fml.common.Mod;
 import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;
@@ -86,19 +86,19 @@ public final class Bookshelf {
 
     private final RegistryHelper registry = new RegistryHelper(MOD_ID, LOG);
 
-    public final LootConditionType conditionIsMob;
-    public final LootConditionType conditionCheckVillage;
-    public final LootConditionType conditionCheckStructure;
-    public final LootConditionType conditionCheckSlimeChunk;
-    public final LootConditionType conditionCheckRarity;
-    public final LootConditionType conditionCheckRaid;
-    public final LootConditionType conditionCheckPower;
-    public final LootConditionType conditionCheckItem;
-    public final LootConditionType conditionCheckHarvestLevel;
-    public final LootConditionType conditionCheckEnergy;
-    public final LootConditionType conditionCheckEnchantability;
-    public final LootConditionType conditionCheckBiomeTag;
-    public final LootConditionType conditionCheckDimension;
+    public final LootItemConditionType conditionIsMob;
+    public final LootItemConditionType conditionCheckVillage;
+    public final LootItemConditionType conditionCheckStructure;
+    public final LootItemConditionType conditionCheckSlimeChunk;
+    public final LootItemConditionType conditionCheckRarity;
+    public final LootItemConditionType conditionCheckRaid;
+    public final LootItemConditionType conditionCheckPower;
+    public final LootItemConditionType conditionCheckItem;
+    public final LootItemConditionType conditionCheckHarvestLevel;
+    public final LootItemConditionType conditionCheckEnergy;
+    public final LootItemConditionType conditionCheckEnchantability;
+    public final LootItemConditionType conditionCheckBiomeTag;
+    public final LootItemConditionType conditionCheckDimension;
 
     public Bookshelf () {
 
@@ -107,8 +107,8 @@ public Bookshelf () {
 
         // Command arguments
         this.registry.commands.registerCommandArgument("enum", ArgumentTypeHandOutput.class, new ArgumentTypeHandOutput.Serialzier());
-        this.registry.commands.registerCommandArgument("mod", ArgumentTypeMod.class, new ArgumentSerializer<>( () -> ArgumentTypeMod.INSTACE));
-        this.registry.commands.registerCommandArgument("loot", ArgumentTypeLootTable.class, new ArgumentSerializer<>( () -> ArgumentTypeLootTable.INSTACE));
+        this.registry.commands.registerCommandArgument("mod", ArgumentTypeMod.class, new EmptyArgumentSerializer<>( () -> ArgumentTypeMod.INSTACE));
+        this.registry.commands.registerCommandArgument("loot", ArgumentTypeLootTable.class, new EmptyArgumentSerializer<>( () -> ArgumentTypeLootTable.INSTACE));
 
         // Loot Modifier
         this.registry.lootModifiers.register(ModifierClear.SERIALIZER, "clear");
@@ -159,20 +159,20 @@ public Bookshelf () {
         this.registry.ingredients.register("any_sword", IngredientToolType.create(i -> i instanceof SwordItem, null));
         this.registry.ingredients.register("any_shear", IngredientToolType.create(i -> i instanceof ShearsItem, null));
 
-        this.registry.ingredients.register("enchant_armor", IngredientEnchantmentType.create(EnchantmentType.ARMOR));
-        this.registry.ingredients.register("enchant_armor_feet", IngredientEnchantmentType.create(EnchantmentType.ARMOR_FEET));
-        this.registry.ingredients.register("enchant_armor_legs", IngredientEnchantmentType.create(EnchantmentType.ARMOR_LEGS));
-        this.registry.ingredients.register("enchant_armor_chest", IngredientEnchantmentType.create(EnchantmentType.ARMOR_CHEST));
-        this.registry.ingredients.register("enchant_armor_head", IngredientEnchantmentType.create(EnchantmentType.ARMOR_HEAD));
-        this.registry.ingredients.register("enchant_weapon", IngredientEnchantmentType.create(EnchantmentType.WEAPON));
-        this.registry.ingredients.register("enchant_digger", IngredientEnchantmentType.create(EnchantmentType.DIGGER));
-        this.registry.ingredients.register("enchant_fishing_rod", IngredientEnchantmentType.create(EnchantmentType.FISHING_ROD));
-        this.registry.ingredients.register("enchant_trident", IngredientEnchantmentType.create(EnchantmentType.TRIDENT));
-        this.registry.ingredients.register("enchant_breakable", IngredientEnchantmentType.create(EnchantmentType.BREAKABLE));
-        this.registry.ingredients.register("enchant_bow", IngredientEnchantmentType.create(EnchantmentType.BOW));
-        this.registry.ingredients.register("enchant_wearable", IngredientEnchantmentType.create(EnchantmentType.WEARABLE));
-        this.registry.ingredients.register("enchant_crossbow", IngredientEnchantmentType.create(EnchantmentType.CROSSBOW));
-        this.registry.ingredients.register("enchant_vanishable", IngredientEnchantmentType.create(EnchantmentType.VANISHABLE));
+        this.registry.ingredients.register("enchant_armor", IngredientEnchantmentType.create(EnchantmentCategory.ARMOR));
+        this.registry.ingredients.register("enchant_armor_feet", IngredientEnchantmentType.create(EnchantmentCategory.ARMOR_FEET));
+        this.registry.ingredients.register("enchant_armor_legs", IngredientEnchantmentType.create(EnchantmentCategory.ARMOR_LEGS));
+        this.registry.ingredients.register("enchant_armor_chest", IngredientEnchantmentType.create(EnchantmentCategory.ARMOR_CHEST));
+        this.registry.ingredients.register("enchant_armor_head", IngredientEnchantmentType.create(EnchantmentCategory.ARMOR_HEAD));
+        this.registry.ingredients.register("enchant_weapon", IngredientEnchantmentType.create(EnchantmentCategory.WEAPON));
+        this.registry.ingredients.register("enchant_digger", IngredientEnchantmentType.create(EnchantmentCategory.DIGGER));
+        this.registry.ingredients.register("enchant_fishing_rod", IngredientEnchantmentType.create(EnchantmentCategory.FISHING_ROD));
+        this.registry.ingredients.register("enchant_trident", IngredientEnchantmentType.create(EnchantmentCategory.TRIDENT));
+        this.registry.ingredients.register("enchant_breakable", IngredientEnchantmentType.create(EnchantmentCategory.BREAKABLE));
+        this.registry.ingredients.register("enchant_bow", IngredientEnchantmentType.create(EnchantmentCategory.BOW));
+        this.registry.ingredients.register("enchant_wearable", IngredientEnchantmentType.create(EnchantmentCategory.WEARABLE));
+        this.registry.ingredients.register("enchant_crossbow", IngredientEnchantmentType.create(EnchantmentCategory.CROSSBOW));
+        this.registry.ingredients.register("enchant_vanishable", IngredientEnchantmentType.create(EnchantmentCategory.VANISHABLE));
 
         // Block Ingredients
         BlockIngredient.register(BlockIngredientAny.SERIALIZER, BlockIngredientAny.ID);

src/main/java/net/darkhax/bookshelf/block/DisplayableBlockState.java

@@ -5,19 +5,19 @@
 import com.google.gson.JsonElement;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParseException;
-import com.mojang.blaze3d.matrix.MatrixStack;
+import com.mojang.blaze3d.vertex.PoseStack;
 
 import net.darkhax.bookshelf.serialization.ISerializer;
 import net.darkhax.bookshelf.serialization.Serializers;
 import net.darkhax.bookshelf.util.RenderUtils;
-import net.minecraft.block.BlockState;
-import net.minecraft.client.renderer.IRenderTypeBuffer;
-import net.minecraft.network.PacketBuffer;
-import net.minecraft.util.Direction;
-import net.minecraft.util.JSONUtils;
-import net.minecraft.util.math.BlockPos;
-import net.minecraft.util.math.vector.Vector3f;
-import net.minecraft.world.World;
+import net.minecraft.world.level.block.state.BlockState;
+import net.minecraft.client.renderer.MultiBufferSource;
+import net.minecraft.network.FriendlyByteBuf;
+import net.minecraft.core.Direction;
+import net.minecraft.util.GsonHelper;
+import net.minecraft.core.BlockPos;
+import com.mojang.math.Vector3f;
+import net.minecraft.world.level.Level;
 import net.minecraftforge.api.distmarker.Dist;
 import net.minecraftforge.api.distmarker.OnlyIn;
 
@@ -84,7 +84,7 @@ public void setRenderFluid (boolean renderFluid) {
     }
 
     @OnlyIn(Dist.CLIENT)
-    public void render (World world, BlockPos pos, MatrixStack matrix, IRenderTypeBuffer buffer, int light, int overlay, Direction... preferredSides) {
+    public void render (Level world, BlockPos pos, PoseStack matrix, MultiBufferSource buffer, int light, int overlay, Direction... preferredSides) {
 
         matrix.pushPose();
         this.getScale().ifPresent(vec -> matrix.scale(vec.x(), vec.y(), vec.z()));
@@ -108,7 +108,7 @@ public DisplayableBlockState read (JsonElement json) {
                 return new DisplayableBlockState(state, scale, offset, renderFluid);
             }
 
-            throw new JsonParseException("Expected properties to be an object. Recieved " + JSONUtils.getType(json));
+            throw new JsonParseException("Expected properties to be an object. Recieved " + GsonHelper.getType(json));
         }
 
         @Override
@@ -123,7 +123,7 @@ public JsonElement write (DisplayableBlockState toWrite) {
         }
 
         @Override
-        public DisplayableBlockState read (PacketBuffer buffer) {
+        public DisplayableBlockState read (FriendlyByteBuf buffer) {
 
             final BlockState state = Serializers.BLOCK_STATE.read(buffer);
             final Optional<Vector3f> scale = Serializers.VEC3F.readOptional(buffer);
@@ -133,7 +133,7 @@ public DisplayableBlockState read (PacketBuffer buffer) {
         }
 
         @Override
-        public void write (PacketBuffer buffer, DisplayableBlockState toWrite) {
+        public void write (FriendlyByteBuf buffer, DisplayableBlockState toWrite) {
 
             Serializers.BLOCK_STATE.write(buffer, toWrite.getState());
             Serializers.VEC3F.writeOptional(buffer, toWrite.getScale());

src/main/java/net/darkhax/bookshelf/block/IBookshelfBlock.java

@@ -2,7 +2,7 @@
 
 import javax.annotation.Nullable;
 
-import net.minecraft.item.Item;
+import net.minecraft.world.item.Item;
 
 public interface IBookshelfBlock {
 

src/main/java/net/darkhax/bookshelf/block/blockentity/BlockEntityBase.java

@@ -0,0 +1,64 @@
+/**
+ * This class was created by <Darkhax>. It is distributed as part of Bookshelf. You can find
+ * the original source here: https://github.com/Darkhax-Minecraft/Bookshelf
+ *
+ * Bookshelf is Open Source and distributed under the GNU Lesser General Public License version
+ * 2.1.
+ */
+package net.darkhax.bookshelf.block.blockentity;
+
+import net.minecraft.core.BlockPos;
+import net.minecraft.world.level.ChunkPos;
+import net.minecraft.world.level.block.entity.BlockEntity;
+import net.minecraft.world.level.block.entity.BlockEntityType;
+import net.minecraft.world.level.block.state.BlockState;
+import net.minecraftforge.common.util.Lazy;
+
+public abstract class BlockEntityBase extends BlockEntity {
+
+    /**
+     * Lazily gets the chunk position of the block entity. Used by {@link #getChunkPos()}.
+     */
+    private final Lazy<ChunkPos> chunkPos = Lazy.of( () -> new ChunkPos(this.getBlockPos()));
+
+    public BlockEntityBase (BlockEntityType<?> type, BlockPos pos, BlockState state) {
+
+        super(type, pos, state);
+    }
+    
+    /**
+     * Checks if the block entity has a valid world position.
+     * @return Whether or not the block has a valid position.
+     */
+    public boolean hasPosition () {
+
+        return this.worldPosition != null && this.worldPosition != BlockPos.ZERO;
+    }
+    
+    /**
+     * Checks if the block entity is initialized and loaded. Makes sure it has a world, position, and is in a loaded chunk.
+     * @return Whether or not the block entity is loaded.
+     */
+    public boolean isLoaded () {
+
+        return this.hasLevel() && this.hasPosition() && this.getLevel().isLoaded(this.getBlockPos());
+    }
+    
+    /**
+     * Gets the current block state at the position of the block entity. This will lookup the state rather than using the cached value.
+     * @return The block state that is currently at the position of the block entity.
+     */
+    public BlockState getCurrentState () {
+
+        return this.isLoaded() ? this.getLevel().getBlockState(this.worldPosition) : null;
+    }
+    
+    /**
+     * Gets the chunk position of the block entity. This will get the cached chunk position and is not serialized.
+     * @return The block entities chunk position.
+     */
+    public ChunkPos getChunkPos () {
+
+        return this.chunkPos.get();
+    }
+}

src/main/java/net/darkhax/bookshelf/block/blockentity/BlockEntityNetworked.java

@@ -0,0 +1,84 @@
+/**
+ * This class was created by <Darkhax>. It is distributed as part of Bookshelf. You can find
+ * the original source here: https://github.com/Darkhax-Minecraft/Bookshelf
+ *
+ * Bookshelf is Open Source and distributed under the GNU Lesser General Public License version
+ * 2.1.
+ */
+package net.darkhax.bookshelf.block.blockentity;
+
+import javax.annotation.Nullable;
+
+import net.darkhax.bookshelf.util.WorldUtils;
+import net.minecraft.core.BlockPos;
+import net.minecraft.nbt.CompoundTag;
+import net.minecraft.network.Connection;
+import net.minecraft.network.protocol.Packet;
+import net.minecraft.network.protocol.game.ClientboundBlockEntityDataPacket;
+import net.minecraft.server.level.ServerLevel;
+import net.minecraft.world.level.block.entity.BlockEntityType;
+import net.minecraft.world.level.block.state.BlockState;
+import net.minecraftforge.common.util.Constants.BlockFlags;
+
+public abstract class BlockEntityNetworked extends BlockEntityBase {
+
+    public BlockEntityNetworked (BlockEntityType<?> type, BlockPos pos, BlockState state) {
+
+        super(type, pos, state);
+    }
+
+    @Override
+    public ClientboundBlockEntityDataPacket getUpdatePacket () {
+
+        return new ClientboundBlockEntityDataPacket(this.worldPosition, 0, this.getUpdateTag());
+    }
+
+    @Override
+    public void onDataPacket (Connection net, ClientboundBlockEntityDataPacket packet) {
+
+        super.onDataPacket(net, packet);
+        this.readSyncData(packet.getTag());
+    }
+
+    @Override
+    public CompoundTag getUpdateTag () {
+
+        return this.writeSyncData(super.getUpdateTag());
+    }
+    
+    /**
+     * Forces a data sync from the server to the client.
+     * @param renderUpdate Whether or not a render update should also happen. This should be used when you want to change the baked block model.
+     */
+    public void sync (boolean renderUpdate) {
+    	
+    	// Tells the game to re-render the chunk in addition to updating the block entity.
+        if (renderUpdate) {
+
+            this.setChanged();
+            final BlockState state = this.getCurrentState();
+            this.level.sendBlockUpdated(this.worldPosition, state, state, BlockFlags.DEFAULT_AND_RERENDER);
+        }
+
+        // Tells the game to send a tracking packet to all players tracking the block entity.
+        else if (this.level instanceof ServerLevel) {
+
+            final Packet<?> packet = this.getUpdatePacket();
+            WorldUtils.sendToTracking((ServerLevel) this.level, this.getChunkPos(), packet, false);
+        }
+    }
+
+    /**
+     * Writes a data tag that will be sent to the client. This is used to keep the block entity in sync. This will be read by {@link #readSyncData(CompoundTag)} on the client.
+     * @param data The data tag that will be sent to the client. This is initially populated using the super {@link #getUpdateTag()}.
+     * @return The data tag to sync with the client.
+     */
+    @Nullable
+    public abstract CompoundTag writeSyncData(@Nullable CompoundTag data);
+    
+    /**
+     * Reads a data tag that was sent from the server. The tag should be assumed to have been written using {@link #writeSyncData(CompoundTag)}.
+     * @param data The data that was sent from the server.
+     */
+    public abstract void readSyncData(CompoundTag data);
+}