cech12 / BucketLib

Minecraft library mod for custom buckets

BucketLib

BucketLib is a Minecraft Forge library mod for developers. The purpose is to provide functionality for developers to add their own buckets without having trouble implementing all special cases.

Features

• Highly configurable buckets:
  • Obtaining fluids, entities and blocks can be limited by using allow lists and block lists or by using the fluid temperature.
  • Buckets can be configured to crack when a fluid temperature exceeds a special value.
  • Coloring a bucket can be enabled
  • Milking entities can be disabled
• Compatible with all fluids: Water and Lava as well as all modded fluids are supported by buckets generated with this library mod.
• Entities can be obtained: Entities like Axolotl, fish and mobs of other mods can be obtained.
• Bucketable Blocks can be obtained: Powder Snow and bucketable blocks of other mods can be obtained.
• Compatible with all milk special cases: Entities like cows and goats can be milked and the milk is drinkable. Buckets filled with milk are also compatible with mods that contains a milk fluid.
• Dispense Behaviour works out of the box
• Fluid Handling: All buckets that are generated by this library mod are compatible with mods that are using fluid container items.

Adding it to your project:

Add the following to your build.gradle file:

repositories {
    maven {
      name 'Jitpack'
      url 'https://jitpack.io'
    }
}

dependencies {
    implementation fg.deobf("com.github.cech12:BucketLib:${loader}:${bucketlib_version}")
}

Replace ${loader} with the loader (forge or neoforge) you want to use.

Replace ${bucketlib_version} with the version of BucketLib that you want to use. The actual versions can be found here or on the Github Releases page.

BucketLib adds mixins and developers need to make sure to tweak their run configurations in order to launch the game in their development environment. Add both of these lines to the configureEach {} run configuration block in the build.gradle (or to both the client {} and server {}). These can be placed anywhere within the run configuration, the order does not matter.

property 'mixin.env.remapRefMap', 'true'
property 'mixin.env.refMapRemappingFile', "${buildDir}/createSrgToMcp/output.srg"

Don't forget to re-generate your IDE runs. (genIntellijRuns, genEclipseRuns, or genVSCodeRuns)

Before BucketLib 1.20.2-3.0.0.0 the build.gradle file adjustments were different.

For detailed information please see the Developer Guide.