AcornLib

AcornLib is a powerful library for Minecraft mod developers, offering a wide range of tools and components to simplify the mod creation process.

Main Features

Modding Utilities

• Kill effects: Items with kill effects (standard and no death - effect triggers but entity remains alive, like using a totem)
• Event system:
  • Can consume event (prevents entities from eating when false)
  • Can entity heal event (prevents entities from healing when false)
  • Custom riptide event (returns optional identifier)
  • Render screen overlay event (displays overlay over player's screen)
• Item settings class: Simplified component application
• Advanced burning item: Applies fire before damage, allowing cooked food drops with one hit
• Base items with skins
• Shield-breaking item: Returns number of seconds to disable shield
• Utility classes: ItemUtils, MiscUtils, ParticleUtils, PortingUtils, VelocityUtils

ModMenu Compatibility

• Change mod name color in ModMenu
• Add up to two icons for your mod

Additional Item Components

• Two-handed component
• Camera following component (item points in holder's look direction)
• Show hand component when holding item
• Undroppable component
• Item skin component
• Custom hit particle component
• Custom hit sound component
• Sweep particle component
• Secondary model component (displays custom item with identical components)
• Tertiary model component

Additional Commands

• Velocity command (exact and directional)
• AcornLib command (development only, checks if player is supporter)

Support System

• Ability to make mods available only to supporters
• Custom perks for supporters and friends in other mods

Usage Examples

Custom Hit Particle Component

give @s acornlib:gnarp_plush[acornlib:hit_particle={particle:"acornlib:green_sweep"}]

Important: Must specify valid identifier for sweep particles, otherwise may cause server disconnection or crash.

Custom Hit Sound Component

give @s acornlib:gnarp_plush[acornlib:hit_sound={soundEvent:"acornlib:block.gnarp_plush.honk"}]

Secondary/Tertiary Model Component

give @s acornlib:gnarp_plush[acornlib:secondary_model="carrot"]

Implementation Guide

Add to repositories:

repositories {
    // Modrinth
    exclusiveContent {
        forRepository {
            maven {
                name = "Modrinth"
                url = "https://api.modrinth.com/maven"
            }
        }
        filter {
            includeGroup "maven.modrinth"
        }
    }

    // Mod Menu
    maven {
        name = "Terraformers"
        url = "https://maven.terraformersmc.com/"
    }
}

Add to dependencies:

dependencies {
    // AcornLib
    modImplementation "maven.modrinth:acornlib:${project.acornlib_version}"

    // Config
    modApi ("com.terraformersmc:modmenu:${project.modmenu_version}")
    modImplementation ("maven.modrinth:midnightlib:${project.midnightlib_version}+1.21.4-fabric")
}

Credits

Acorn texture created by user ShinyEmerald in resource pack available at the link.