Library Ferret Mod Wiki

Library Ferret is a core utility mod designed to serve as the foundation for Jtorleon's modding ecosystem. It does not add significant gameplay content on its own; instead, it functions as a library that contains shared code, assets, and logic used by multiple other mods. By centralizing these resources, Library Ferret reduces file sizes, prevents code redundancy, and ensures that all dependent mods operate harmoniously within the Minecraft engine.

This mod is strictly required for users wishing to run content such as "The Wild Update" backport, "The Warden" standalone mod, and various other creature-focused mods by the same developer. It handles the heavy lifting for complex entity rendering and world-generation scripts.

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.

Library Ferret is the mandatory engine for the following projects. Without this library, these mods will fail to initialize or crash upon world loading:

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.

Upon the first launch, the mod generates a configuration file located in the /config folder of the Minecraft directory. This file, typically named library_ferret-common.toml, allows server administrators and players to tweak technical settings.

Configurable Options

• Debug Mode: Enables or disables detailed logging in the console. This is useful for troubleshooting animation glitches or registry errors.
• Animation Toggles: In some versions, players can toggle the advanced animation system if they are experiencing performance issues on low-end hardware.
• Entity Scaling: Provides global modifiers for the size and hitboxes of entities registered through the library.

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.