2.0.0+snapshot.312
beta
AnvilLib
AnvilLib is a NeoForge mod library developed by Anvil-Dev, providing Minecraft mod developers with a series of practical tools and frameworks.
787
AnvilLib
AnvilLib
AnvilLib is a NeoForge mod library developed by AnvilLib, providing Minecraft mod developers with a series of practical tools and frameworks.
Features
AnvilLib adopts a modular design and includes the following functional modules:
| Module | Description | |---------------------------|---------------------------------------------------| | Main | Annotation-based configuration system | | Main | Mod compatibility integration framework | | Main | Networking API with automatic packet registration | | Main | In-world recipe system | | Main | Support for block entities movable by pistons | | Main | Simplified registration system | | Main | Aggregated module that bundles all submodules |
Module Introduction
Config Module
Provides an annotation-based configuration management system to simplify the definition and management of mod configurations.
Key Features:
- Define configuration classes using `@Config` annotation - Add configuration comments with `@Comment` - Define numerical ranges with `@BoundedDiscrete` - Create nested configurations with `@CollapsibleObject` - Automatically generate client configuration GUI
Usage Example:
```java
@Config(name = "my_mod", type = ModConfig.Type.COMMON) public class MyModConfig { @Comment("Enable debug mode") public boolean debugMode = false;
@Comment("Maximum count") @BoundedDiscrete(min = 1, max = 100) public int maxCount = 10; }
// Register configuration MyModConfig config = ConfigManager.register("my_mod", MyModConfig::new); ```
Integration Module
Provides a framework for mod integrations, supporting automatic loading of integration code based on the presence of other mods.
Key Features:
- Declare integration classes with `@Integration` annotation - Support for version range matching - Support for different runtime environments (CLIENT / DEDICATED_SERVER / DATA)
Usage Example:
```java
@Integration(value = "jei", version = "[19.0,)") public class JEIIntegration { public void init() { // JEI integration logic } } ```
Network Module
Provides a NeoForge networking abstraction with package-based packet auto-registration.
Key Features:
- Define packet direction using `IClientboundPacket` / `IServerboundPacket` / `IInsensitiveBiPacket` - Automatically register packet classes in a package via `NetworkRegistrar.register(...)` - Supports `PLAY`, `CONFIGURATION`, and `COMMON` protocols
Usage Example:
```java
@SubscribeEvent public static void onRegisterPayload(RegisterPayloadHandlersEvent event) { PayloadRegistrar registrar = event.registrar("1"); NetworkRegistrar.register(registrar, "my_mod"); } ```
Recipe Module
Provides an in-world recipe system, allowing recipes to be executed in the world (rather than in crafting tables).
Key Features:
- Supports custom recipe triggers (Trigger) - Supports recipe predicates (Predicate) for conditional checks - Supports multiple recipe outcomes (Outcome) - Built-in priority system - Full datapack support
Recipe Components:
- Outcome: Conditions to trigger the recipe (e.g., item dropping, explosions) - Outcome: Recipe matching conditions - Outcome: Recipe execution results (e.g., spawning items, setting blocks)
Moveable Entity Block Module
Allows blocks with block entities to be pushed by pistons while preserving their data.
Usage Example:
```java public class MyBlock extends Block implements IMoveableEntityBlock { @Override public CompoundTag clearData(Level level, BlockPos pos) { // Return block entity data to preserve BlockEntity be = level.getBlockEntity(pos); return be != null ? be.saveWithoutMetadata(level.registryAccess()) : new CompoundTag(); }
@Override public void setData(Level level, BlockPos pos, CompoundTag nbt) { // Restore block entity data at new position BlockEntity be = level.getBlockEntity(pos); if (be != null) { be.loadAdditional(nbt, level.registryAccess()); } } } ```
Registrum Module
A registration system based on Registrate, simplifying the registration process for items, blocks, entities, etc.
Key Features:
- Chain-style API design - Automatic language file generation - Automatic datapack generation - Support for various builders
Usage Example:
```java public static final Registrum REGISTRUM = Registrum.create("my_mod");
public static final RegistryEntry<Item> MY_ITEM = REGISTRUM .item("my_item", Item::new) .properties(p -> p.stacksTo(16)) .register(); ```
Main Module
`anvillib-neoforge-1.21.1` is the aggregate artifact. It bundles and re-exports:
- `config` - `integration` - `network` - `recipe` - `moveable-entity-block` - `registrum`
Dependency Integration
Gradle (Groovy DSL)
```groovy repositories { mavenCentral() // This project is already uploaded to Maven Central }
dependencies { // Full library implementation "dev.anvilcraft.lib:anvillib-neoforge-1.21.1:2.0.0"
// Or import individual modules as needed implementation "dev.anvilcraft.lib:anvillib-config-neoforge-1.21.1:2.0.0" implementation "dev.anvilcraft.lib:anvillib-integration-neoforge-1.21.1:2.0.0" implementation "dev.anvilcraft.lib:anvillib-network-neoforge-1.21.1:2.0.0" implementation "dev.anvilcraft.lib:anvillib-recipe-neoforge-1.21.1:2.0.0" implementation "dev.anvilcraft.lib:anvillib-moveable-entity-block-neoforge-1.21.1:2.0.0" implementation "dev.anvilcraft.lib:anvillib-registrum-neoforge-1.21.1:2.0.0" } ```
Gradle (Kotlin DSL)
```kotlin repositories { mavenCentral() // This project is already uploaded to Maven Central }
dependencies { implementation("dev.anvilcraft.lib:anvillib-neoforge-1.21.1:2.0.0")
// Optional single-module example implementation("dev.anvilcraft.lib:anvillib-network-neoforge-1.21.1:2.0.0") } ```
> Keep the dependency version aligned with release tags (current project property is `mod_version=2.0.0`).
Building the Project
```bash
Clone repository
git clone https://github.com/Anvil-Dev/AnvilLib.git cd AnvilLib
Build on macOS / Linux
./gradlew build
Build on Windows (PowerShell / CMD)
gradlew.bat build ```
Requirements
- Java 21+ - Minecraft 1.21.1 - NeoForge 21.1.x
License
This project is licensed under the MIT License.
Part of the Registrum module code is based on Registrate and follows the Mozilla Public License 2.0.
Author
- Gugle - Main developer
Links
Versions
2.0.0+snapshot.275
beta
2.0.0+snapshot.218
beta
2.0.0+snapshot.234
beta
2.0.0+snapshot.248
beta
2.0.0+snapshot.279
beta
2.0.0+snapshot.251
beta
2.0.0+snapshot.317
beta
2.0.0+snapshot.308
beta
2.0.0+snapshot.278
beta
2.0.0+snapshot.276
beta
2.0.0+snapshot.252
beta
2.0.0+snapshot.291
beta
2.0.0+snapshot.337
beta
2.0.0+snapshot.262
beta
2.0.0+snapshot.320
beta
2.0.0+snapshot.289
beta
2.0.0+snapshot.320
beta
2.0.0+snapshot.333
beta
2.0.0+snapshot.261
beta
2.0.0+snapshot.297
beta
2.0.0+snapshot.331
beta
2.0.0+snapshot.277
beta
2.0.0+snapshot.237
beta
2.0.0+snapshot.360
beta
2.0.0+snapshot.256
beta
2.0.0+snapshot.311
beta
2.0.0+snapshot.238
beta
2.0.0+snapshot.357
beta
2.0.0+snapshot.265
beta
2.0.0+snapshot.337
beta
2.0.0+snapshot.269
beta
2.0.0+snapshot.282
beta
2.0.0+snapshot.277
beta
2.0.0+snapshot.322
beta
2.0.0+snapshot.306
beta
2.0.0+snapshot.316
beta
2.0.0+snapshot.318
beta
2.0.0+snapshot.253
beta
2.0.0+snapshot.279
beta
2.0.0+snapshot.294
beta
2.0.0+snapshot.299
beta
2.0.0+snapshot.331
beta
2.0.0+snapshot.252
beta
2.0.0+snapshot.304
beta
2.0.0+snapshot.237
beta
2.0.0+snapshot.213
beta
2.0.0+snapshot.242
beta
2.0.0+snapshot.343
beta
2.0.0+snapshot.291
beta
2.0.0+snapshot.320
beta
2.0.0+snapshot.229
beta
2.0.0+snapshot.253
beta
2.0.0+snapshot.338
beta
2.0.0+snapshot.300
beta
2.0.0+snapshot.259
beta
2.0.0+snapshot.247
beta
2.0.0+snapshot.290
beta
2.0.0+snapshot.271
beta
2.0.0+snapshot.360
beta
2.0.0+snapshot.326
beta
2.0.0+snapshot.234
beta
2.0.0+snapshot.213
beta
2.0.0+snapshot.286
beta
2.0.0+snapshot.335
beta
2.0.0+snapshot.342
beta
2.0.0+snapshot.263
beta
2.0.0+snapshot.315
beta
2.0.0+snapshot.255
beta
2.0.0+snapshot.220
beta
2.0.0+snapshot.216
beta
2.0.0+snapshot.217
beta
2.0.0+snapshot.309
beta
2.0.0+snapshot.249
beta
2.0.0+snapshot.226
beta
2.0.0+snapshot.259
beta
2.0.0+snapshot.229
beta
2.0.0+snapshot.276
beta
2.0.0+snapshot.259
beta
2.0.0+snapshot.254
beta
2.0.0+snapshot.227
beta
2.0.0+snapshot.260
beta
2.0.0+snapshot.297
beta
2.0.0+snapshot.240
beta
2.0.0+snapshot.257
beta
2.0.0+snapshot.332
beta
2.0.0+snapshot.261
beta
2.0.0+snapshot.274
beta
2.0.0+snapshot.305
beta
2.0.0+snapshot.330
beta
2.0.0+snapshot.243
beta
2.0.0+snapshot.275
beta
2.0.0+snapshot.220
beta
2.0.0+snapshot.250
beta
2.0.0+snapshot.303
beta
2.0.0+snapshot.310
beta
2.0.0+snapshot.316
beta
2.0.0+snapshot.313
beta
2.0.0+snapshot.218
beta
2.0.0+snapshot.341
beta
2.0.0+snapshot.314
beta
2.0.0+snapshot.349
beta
2.0.0+snapshot.346
beta
2.0.0+snapshot.254
beta
2.0.0+snapshot.303
beta
2.0.0+snapshot.291
beta
2.0.0+snapshot.257
beta
2.0.0+snapshot.319
beta
2.0.0+snapshot.338
beta
2.0.0+snapshot.301
beta
2.0.0+snapshot.272
beta
2.0.0+snapshot.214
beta
2.0.0+snapshot.264
beta
2.0.0+snapshot.275
beta
2.0.0+snapshot.256
beta
2.0.0+snapshot.341
beta
2.0.0+snapshot.292
beta
2.0.0+snapshot.271
beta
2.0.0+snapshot.255
beta
2.0.0+snapshot.282
beta
2.0.0+snapshot.273
beta
2.0.0+snapshot.343
beta
2.0.0+snapshot.282
beta
2.0.0+snapshot.325
beta
2.0.0+snapshot.348
beta
2.0.0+snapshot.294
beta
2.0.0+snapshot.292
beta
2.0.0+snapshot.310
beta
2.0.0+snapshot.222
beta
2.0.0+snapshot.308
beta
2.0.0+snapshot.330
beta
2.0.0+snapshot.250
beta
2.0.0+snapshot.272
beta
2.0.0+snapshot.348
beta
2.0.0+snapshot.296
beta
2.0.0+snapshot.308
beta
2.0.0+snapshot.319
beta
2.0.0+snapshot.254
beta
2.0.0+snapshot.339
beta
2.0.0+snapshot.324
beta
2.0.0+snapshot.295
beta
2.0.0+snapshot.325
beta
2.0.0+snapshot.229
beta
2.0.0+snapshot.263
beta
2.0.0+snapshot.315
beta
2.0.0+snapshot.257
beta
2.0.0+snapshot.293
beta
2.0.0+snapshot.330
beta
2.0.0+snapshot.264
beta
2.0.0+snapshot.349
beta
2.0.0+snapshot.269
beta
2.0.0+snapshot.241
beta
2.0.0+snapshot.241
beta
2.0.0+snapshot.239
beta
2.0.0+snapshot.263
beta
2.0.0+snapshot.242
beta
2.0.0+snapshot.239
beta
2.0.0+snapshot.278
beta
2.0.0+snapshot.270
beta
2.0.0+snapshot.248
beta
2.0.0+snapshot.299
beta
2.0.0+snapshot.325
beta
2.0.0+snapshot.256
beta
2.0.0+snapshot.270
beta
2.0.0+snapshot.227
beta
2.0.0+snapshot.322
beta
2.0.0+snapshot.347
beta
2.0.0+snapshot.326
beta
2.0.0+snapshot.299
beta
2.0.0+snapshot.221
beta
2.0.0+snapshot.329
beta
2.0.0+snapshot.302
beta
2.0.0+snapshot.357
beta
2.0.0+snapshot.217
beta
2.0.0+snapshot.233
beta
2.0.0+snapshot.295
beta
2.0.0+snapshot.247
beta
2.0.0+snapshot.266
beta
2.0.0+snapshot.339
beta
2.0.0+snapshot.300
beta
2.0.0+snapshot.305
beta
2.0.0+snapshot.321
beta
2.0.0+snapshot.258
beta
2.0.0+snapshot.233
beta
2.0.0+snapshot.239
beta
2.0.0+snapshot.243
beta
2.0.0+snapshot.290
beta
2.0.0+snapshot.242
beta
2.0.0+snapshot.316
beta
2.0.0+snapshot.314
beta
2.0.0+snapshot.228
beta
2.0.0+snapshot.357
beta
2.0.0+snapshot.346
beta
2.0.0+snapshot.321
beta
2.0.0+snapshot.243
beta
2.0.0+snapshot.304
beta
2.0.0+snapshot.297
beta
2.0.0+snapshot.267
beta
2.0.0+snapshot.251
beta
2.0.0+snapshot.298
beta
2.0.0+snapshot.336
beta
2.0.0+snapshot.312
beta
2.0.0+snapshot.347
beta
2.0.0+snapshot.317
beta
2.0.0+snapshot.327
beta
2.0.0+snapshot.260
beta
2.0.0+snapshot.296
beta
2.0.0+snapshot.311
beta
2.0.0+snapshot.273
beta
2.0.0+snapshot.329
beta
2.0.0+snapshot.255
beta
2.0.0+snapshot.294
beta
2.0.0+snapshot.270
beta
2.0.0+snapshot.360
beta
2.0.0+snapshot.289
beta
2.0.0+snapshot.301
beta
2.0.0+snapshot.247
beta
2.0.0+snapshot.345
beta
2.0.0+snapshot.344
beta
2.0.0+snapshot.265
beta
2.0.0+snapshot.317
beta
2.0.0+snapshot.328
beta
2.0.0+snapshot.348
beta
2.0.0+snapshot.323
beta
2.0.0+snapshot.331
beta
2.0.0+snapshot.305
beta
2.0.0+snapshot.322
beta
2.0.0+snapshot.298
beta
2.0.0+snapshot.240
beta
2.0.0+snapshot.284
beta
2.0.0+snapshot.303
beta
2.0.0+snapshot.342
beta
2.0.0+snapshot.265
beta
2.0.0+snapshot.241
beta
2.0.0+snapshot.289
beta
2.0.0+snapshot.284
beta
2.0.0+snapshot.313
beta
2.0.0+snapshot.268
beta
2.0.0+snapshot.292
beta
2.0.0+snapshot.250
beta
2.0.0+snapshot.268
beta
2.0.0+snapshot.266
beta
2.0.0+snapshot.309
beta
2.0.0+snapshot.249
beta
2.0.0+snapshot.327
beta
2.0.0+snapshot.315
beta
2.0.0+snapshot.323
beta
2.0.0+snapshot.324
beta
2.0.0+snapshot.258
beta
2.0.0+snapshot.218
beta
2.0.0+snapshot.327
beta
2.0.0+snapshot.319
beta
2.0.0+snapshot.222
beta
2.0.0+snapshot.277
beta
2.0.0+snapshot.284
beta
2.0.0+snapshot.324
beta
2.0.0+snapshot.345
beta
2.0.0+snapshot.251
beta
2.0.0+snapshot.304
beta
2.0.0+snapshot.318
beta
2.0.0+snapshot.238
beta
2.0.0+snapshot.328
beta
2.0.0+snapshot.293
beta
2.0.0+snapshot.293
beta
2.0.0+snapshot.220
beta
2.0.0+snapshot.313
beta
2.0.0+snapshot.326
beta
2.0.0+snapshot.312
beta
2.0.0+snapshot.306
beta
2.0.0+snapshot.273
beta
2.0.0+snapshot.295
beta
2.0.0+snapshot.213
beta
2.0.0+snapshot.302
beta
2.0.0+snapshot.311
beta
2.0.0+snapshot.240
beta
2.0.0+snapshot.214
beta
2.0.0+snapshot.268
beta
2.0.0+snapshot.333
beta
2.0.0+snapshot.335
beta
2.0.0+snapshot.314
beta
2.0.0+snapshot.310
beta
2.0.0+snapshot.278
beta
2.0.0+snapshot.283
beta
2.0.0+snapshot.338
beta
2.0.0+snapshot.290
beta
2.0.0+snapshot.344
beta
2.0.0+snapshot.332
beta
2.0.0+snapshot.283
beta
2.0.0+snapshot.262
beta
2.0.0+snapshot.228
beta
2.0.0+snapshot.253
beta
2.0.0+snapshot.249
beta
2.0.0+snapshot.267
beta
2.0.0+snapshot.309
beta
2.0.0+snapshot.227
beta
2.0.0+snapshot.296
beta
2.0.0+snapshot.266
beta
2.0.0+snapshot.336
beta
2.0.0+snapshot.349
beta
2.0.0+snapshot.274
beta
2.0.0+snapshot.271
beta
2.0.0+snapshot.337
beta
2.0.0+snapshot.252
beta
2.0.0+snapshot.274
beta
2.0.0+snapshot.222
beta
2.0.0+snapshot.258
beta
2.0.0+snapshot.248
beta
2.0.0+snapshot.272
beta
2.0.0+snapshot.344
beta
2.0.0+snapshot.216
beta
2.0.0+snapshot.262
beta
2.0.0+snapshot.343
beta
2.0.0+snapshot.214
beta
2.0.0+snapshot.342
beta
2.0.0+snapshot.332
beta
2.0.0+snapshot.283
beta
2.0.0+snapshot.260
beta
2.0.0+snapshot.269
beta
2.0.0+snapshot.237
beta
2.0.0+snapshot.264
beta
2.0.0+snapshot.216
beta
2.0.0+snapshot.286
beta
2.0.0+snapshot.261
beta
2.0.0+snapshot.346
beta
2.0.0+snapshot.286
beta
2.0.0+snapshot.347
beta
2.0.0+snapshot.306
beta
2.0.0+snapshot.279
beta
2.0.0+snapshot.298
beta
2.0.0+snapshot.276
beta
2.0.0+snapshot.221
beta
2.0.0+snapshot.345
beta
2.0.0+snapshot.323
beta
2.0.0+snapshot.238
beta
2.0.0+snapshot.341
beta
2.0.0+snapshot.339
beta
2.0.0+snapshot.335
beta
2.0.0+snapshot.228
beta
2.0.0+snapshot.318
beta
2.0.0+snapshot.336
beta
2.0.0+snapshot.300
beta
2.0.0+snapshot.217
beta
2.0.0+snapshot.321
beta
2.0.0+snapshot.233
beta
2.0.0+snapshot.234
beta
2.0.0+snapshot.301
beta
2.0.0+snapshot.329
beta
2.0.0+snapshot.267
beta
2.0.0+snapshot.302
beta
2.0.0+snapshot.226
beta
2.0.0+snapshot.328
beta
2.0.0+snapshot.333
beta
2.0.0+snapshot.226
beta
2.0.0+snapshot.221
beta