Library Ferret Mod — Guide
Supported Mods
Library Ferret is the mandatory engine for the following projects. Without this library, these mods will fail to initialize or crash upon world loading:
| Mod Name | Description |
|---|---|
| The Wild Update | A comprehensive backport of 1.19 features (Mangrove Swamps, Mud, etc.) to older versions. |
| The Warden | A standalone implementation of the Deep Dark's guardian with full animation support. |
| Frog Mod | Adds various frog species, tadpoles, and their unique breeding mechanics. |
| Allay Mod | Introduces the Allay entity and its item-gathering functionality. |
| Mangrove Swamp | A biome-specific mod focusing on the generation and flora of swamp environments. |
Technical Specifications
Library Ferret is built to be lightweight and has minimal impact on game performance when no dependent mods are active. It is designed to work across both Forge and NeoForge environments for versions 1.20.1 and 1.21.1.
| Feature | Specification |
|---|---|
| Network Sync | Handles packet synchronization for custom entity data between server and client. |
| Resource Loading | Optimizes the loading of high-resolution textures and 3D models for custom mobs. |
| World Gen API | Provides hooks for adding structures like Ancient Cities to the world-generation pipeline. |
Core Mechanics
The mod introduces several backend systems that enhance the capabilities of the Minecraft engine for modded content.
Animation Engine
Library Ferret includes a specialized animation API that allows for fluid, keyframe-based movements. This system is what enables mobs like the Warden or Frogs to have realistic walking, attacking, and idling animations that are more complex than the standard limb-swinging of vanilla mobs.
Entity AI Framework
To ensure consistent behavior across different creature mods, Library Ferret provides a shared AI framework. This includes: * Custom Pathfinding: Enhanced logic for navigating complex terrain like Mangrove Swamps or Ancient Cities. * Behavior Trees: Shared templates for aggressive, neutral, and passive mob states. * Sensory Logic: Code that allows mobs to "hear" vibrations or "smell" players, a feature primarily utilized by the Warden mod.
Registry and Compatibility
The mod acts as a registry manager, ensuring that blocks, items, and biomes from different Jtorleon mods are registered in a specific order to prevent ID conflicts and ensure smooth integration with other popular mods.
Items and Blocks
As a library mod, Library Ferret does not add blocks or items to the survival game world. However, it does add a custom Creative Tab to the creative menu. This tab is used to organize all items and blocks from Jtorleon's dependent mods into one convenient location, preventing the standard "Misc" or "Building Blocks" tabs from becoming cluttered.
- Creative Tab Icon: Typically represented by a ferret face or a specialized library icon.
- Functionality: Automatically populates with items from any installed mod that uses the Library Ferret API.