API reference

Core weapons

ArmariaMeleeWeapon

Base class for all melee weapons. Extends Item and implements Chargeable.

• setTexture(Texture2D) — register the weapon texture
• getTexture() → Texture2D
• postHurtEnemy(ItemStack, LivingEntity, LivingEntity) — trigger on hit
• onChargeFull(LivingEntity) — trigger when charge is max

ArmariaRangedWeapon

Base class for ranged weapons. Extends BowItem.

• setTexture(Texture2D)
• getTexture() → Texture2D
• shootProjectile(ItemStack, LivingEntity, float) — override for custom projectiles

ArmariaMagicWeapon

Base class for magic weapons. Extends Item.

• setTexture(Texture2D)
• getTexture() → Texture2D
• cast(ItemStack, LivingEntity, int) → boolean — cast logic, returns true on success

Texture2D

public record Texture2D(Identifier id) {
    public static Texture2D of(String id);
    public static Texture2D get(Identifier id);
}

Register a texture path in your weapon constructor. The library auto-generates model JSONs.

VFX

VFXQueue

Thread-safe queue for client-side particle effects. Use enqueue directly or through presets.

VFXPresets

Convenience methods for the 12 built-in effect profiles:

• impactBurst
• voidTrail
• prismWave
• stormChain
• chronoShatter
• emberBurst
• frostShards
• dissolveBurst
• shockwave
• fresnelAura
• voidRupture
• impactShatter

VFXPipeline

Builder for custom effect profiles. Wired in v0.2.0 with shader pipeline.

BlendMode

Scaffolded blend modes: ADDITIVE, NORMAL. Wired in v0.2.0.