Lazuli

Lazuli is a personal library mod designed to simplify the mod development process and reduce routine tasks.

This library combines all the basic code and APIs that I developed for my mods. The constant need to rewrite the same components became tedious, so I decided to create another library for developers.

Main Features

Lazuli offers numerous helper functions covering various aspects of development. Here are the key components:

Block Operations:

• Universal helpers for blocks with entities (AbstractBlockWithEntity)
• Energy system support (IEnergyBE, AbstractEnergyBE, AbstractCapacitorBE, AbstractGeneratorBE)
• Inventory management (IInventoryBE, AbstractInventoryBE)
• Fluid handling (IFluidBE, AbstractSingleTankBE)
• Zoned block entities from Minefactorial (IZonedBE)

Client Functions:

• Particle utilities
• 2D particle engine for interfaces and other applications (IParticleEngine2D, ScreenParticleEngine2D)
• Screen helpers

Crafting:

• Ingredients and results for world blocks, entities, items, and fluids

Additional Components:

• Collections (flexible WeightedRandomList implementation, HistoryList)
• Color handling (UnpackedColour, ColourPalette)
• Energy systems (LazuliEnergyStorage, ProtectiveEnergyStorage)
• Fluid management
• Inventories (ContainerUtils, RoundRobinInventory, GhostStackHandler)
• Items (GhostItemStack)
• Mathematical functions (CubicBezier, QuadraticBezier)
• Menus and interfaces (AbstractBlockEntityContainer, GhostSlot, SlotOutputOnly)
• Various utilities (TickScheduler)
• World helpers (AABBHelpers, FakePlayerHelpers, Raycasting)

Usage

Lazuli has comprehensive documentation in Javadoc format. Source codes and JAR files with documentation are also available for integration via Gradle.

To add Lazuli to your project, use modImplementation in Gradle:

// Applies to all Gradle plugins
repositories {
    // Modrinth Maven is currently the most convenient and reliable place for publication.
    // Source codes and JavaDocs are also published here.
    exclusiveContent {
        forRepository {
            maven("https://api.modrinth.com/maven")
        }
        filter {
            includeGroup("maven.modrinth")
        }
    }
}

dependencies {
    // Loom and Architectury Loom
    modImplementation("maven.modrinth:lazuli:VERSION")
}