Initial release (#1)

Author: ApexModder

.github/workflows/validate-pr.yml

@@ -23,20 +23,9 @@ jobs:
             java-vendor: temurin
             version: ${{ needs.generate-vars.outputs.version }}
 
-    check-local-changes:
-        name: Check local changes
-        needs: generate-vars
-        if: success()
-        uses: ApexStudios-Dev/.github/.github/workflows/_check-local-changes.yml@master
-        secrets: inherit
-        with:
-            java-version: 21
-            java-vendor: temurin
-            version: ${{ needs.generate-vars.outputs.version }}
-
     publish-maven:
         name: Publish Maven
-        needs: [ generate-vars, build, check-local-changes ]
+        needs: [ generate-vars, build ]
         if: success()
         uses: ApexStudios-Dev/.github/.github/workflows/_publish-maven.yml@master
         secrets: inherit

README.md

@@ -0,0 +1,48 @@
+# Registree
+
+`Registree` is a library-mod for Minecraft running on the [NeoForge modloader](https://neoforged.net/), designed to make handling all your registry needs easy and efficient. The name is a play on 'Registry' to emphasize its core purpose.
+
+### Key Features
+- **Deferred Holders**: Provides many more deferred holder types, making them easier to deal with.
+- **Reduced Boilerplate**: Automatically handles registering to the various registry types available, No more creating a 'DeferredRegister' for each registry just 1 'Registree'.
+
+### Obtaining Registree
+
+Registree is a development library and is not intended for end-users to download directly. It can not be found on platforms like CurseForge or Modrinth.
+To use it, you must add it as a dependency in your mod's `build.gradle` file.
+
+The library is available through our [Maven repository](https://maven.apexstudios.dev/releases).
+
+<details>
+<summary> Groovy DSL (build.gradle) </summary>
+
+```groovy
+repositories {
+    maven { url "https://maven.apexstudios.dev/releases" }
+}
+
+dependencies {
+    // Versions here must match
+    implementation "dev.apexstudios:registree:<version>"
+    jarJar "dev.apexstudios:registree:<version>"
+}
+```
+
+</details>
+
+<details>
+<summary> Kotlin DSL (build.gradle.kts) </summary>
+
+```groovy
+repositories {
+    maven("https://maven.apexstudios.dev/releases")
+}
+
+dependencies {
+    // Versions here must match
+    implementation("dev.apexstudios:registree:<version>")
+    jarJar("dev.apexstudios:registree:<version>")
+}
+```
+
+</details>

build.gradle.kts

@@ -1,9 +1,18 @@
 plugins {
-    id("apex-conventions.neoforge") version "0.1.74"
-    id("apex-conventions.maven-publishing") version "0.1.74"
+    id("apex-conventions.neoforge") version "0.1.75"
+    id("apex-conventions.maven-publishing") version "0.1.75"
 }
 
 group = "dev.apexstudios"
 
 apex.neoVersion("21.10.20-beta", "1.21.9", "2025.10.05")
 apex.extendCompilerErrors()
+
+tasks.withType<Jar> {
+    manifest {
+        attributes(
+            "FMLModType" to "GAMELIBRARY",
+            "Automatic-Module-Name" to "registree"
+        )
+    }
+}

src/main/java/dev/apexstudios/registree/api/Registree.java

@@ -0,0 +1,14 @@
+package dev.apexstudios.registree.api.holder;
+
+import net.minecraft.resources.ResourceKey;
+import net.neoforged.neoforge.registries.DeferredHolder;
+
+public class ApexDeferredHolder<TRegistry, TElement extends TRegistry> extends DeferredHolder<TRegistry, TElement> {
+    public ApexDeferredHolder(ResourceKey<TRegistry> registryKey) {
+        super(registryKey);
+    }
+
+    public boolean is(TRegistry other) {
+        return value() == other;
+    }
+}

src/main/java/dev/apexstudios/registree/api/holder/ApexDeferredHolder.java

@@ -0,0 +1,15 @@
+package dev.apexstudios.registree.api.holder;
+
+import net.minecraft.resources.ResourceKey;
+import net.minecraft.world.level.block.Block;
+import net.minecraft.world.level.block.state.BlockState;
+
+public final class DeferredBlock<TBlock extends Block> extends DeferredItemLike<Block, TBlock> {
+    public DeferredBlock(ResourceKey<Block> registryKey) {
+        super(registryKey);
+    }
+
+    public boolean is(BlockState blockState) {
+        return blockState.is(this);
+    }
+}

src/main/java/dev/apexstudios/registree/api/holder/DeferredBlock.java

@@ -0,0 +1,27 @@
+package dev.apexstudios.registree.api.holder;
+
+import net.minecraft.core.BlockPos;
+import net.minecraft.resources.ResourceKey;
+import net.minecraft.world.level.BlockGetter;
+import net.minecraft.world.level.block.Block;
+import net.minecraft.world.level.block.entity.BlockEntity;
+import net.minecraft.world.level.block.entity.BlockEntityType;
+import net.minecraft.world.level.block.state.BlockState;
+
+public final class DeferredBlockEntity<TBlockEntity extends BlockEntity> extends ApexDeferredHolder<BlockEntityType<?>, BlockEntityType<TBlockEntity>> {
+    public DeferredBlockEntity(ResourceKey<BlockEntityType<?>> registryKey) {
+        super(registryKey);
+    }
+
+    public TBlockEntity get(BlockGetter level, BlockPos pos) {
+        return value().getBlockEntity(level, pos);
+    }
+
+    public boolean isValid(BlockState blockState) {
+        return value().isValid(blockState);
+    }
+
+    public boolean isValid(Block block) {
+        return value().getValidBlocks().contains(block);
+    }
+}

src/main/java/dev/apexstudios/registree/api/holder/DeferredBlockEntity.java

@@ -0,0 +1,10 @@
+package dev.apexstudios.registree.api.holder;
+
+import net.minecraft.core.component.DataComponentType;
+import net.minecraft.resources.ResourceKey;
+
+public final class DeferredDataComponent<TData> extends ApexDeferredHolder<DataComponentType<?>, DataComponentType<TData>> {
+    public DeferredDataComponent(ResourceKey<DataComponentType<?>> registryKey) {
+        super(registryKey);
+    }
+}

src/main/java/dev/apexstudios/registree/api/holder/DeferredDataComponent.java

@@ -0,0 +1,11 @@
+package dev.apexstudios.registree.api.holder;
+
+import net.minecraft.resources.ResourceKey;
+import net.minecraft.world.entity.Entity;
+import net.minecraft.world.entity.EntityType;
+
+public final class DeferredEntity<TEntity extends Entity> extends ApexDeferredHolder<EntityType<?>, EntityType<TEntity>> {
+    public DeferredEntity(ResourceKey<EntityType<?>> registryKey) {
+        super(registryKey);
+    }
+}

src/main/java/dev/apexstudios/registree/api/holder/DeferredEntity.java

@@ -0,0 +1,33 @@
+package dev.apexstudios.registree.api.holder;
+
+import net.minecraft.resources.ResourceKey;
+import net.minecraft.world.level.material.Fluid;
+import net.minecraft.world.level.material.FluidState;
+import net.neoforged.neoforge.fluids.FluidStack;
+import net.neoforged.neoforge.fluids.FluidType;
+
+public final class DeferredFluid<TFluid extends Fluid> extends ApexDeferredHolder<Fluid, TFluid> {
+    public DeferredFluid(ResourceKey<Fluid> registryKey) {
+        super(registryKey);
+    }
+
+    public boolean is(FluidType fluidType) {
+        return value().getFluidType() == fluidType;
+    }
+
+    public boolean is(FluidState fluidState) {
+        return fluidState.is(value());
+    }
+
+    public boolean is(FluidStack stack) {
+        return stack.is(this);
+    }
+
+    public FluidStack toStack(int amount) {
+        return new FluidStack(this, amount);
+    }
+
+    public FluidStack toStack() {
+        return toStack(FluidType.BUCKET_VOLUME);
+    }
+}