# Araxer's Bestiary

A modern, lore-friendly bestiary for Minecraft that grows with your adventures. Learn about every creature, progress from E to S rank, and tailor how discovery works to suit your playstyle.

- Supports Forge 1.20.1
- Default E→S mode: points (deterministic, no RNG) with options for chance-based or sighting progression
- Server friendly, with datapack support to customize what the Bestiary shows for entity loot

## Why use this mod?

- Immersion: Creature knowledge is earned through play. Details start hidden and are revealed as you interact with the world. You can even hide undiscovered entries entirely for a true “fog of war” feel.
- Progression that fits any playthrough: Choose between deterministic points, classic RNG chances, or a spyglass “sighting” approach. Bosses can be treated specially.
- Customizable: Dozens of config options and simple datapacks let you decide how strict, informative, or minimal the Bestiary should be. Works great in modpacks.

## Highlights

- Bestiary Book with clean UI and 3D mob previews
- E→S rank progression per entity, with optional Rank-X challenges for late-game depth
- Multiple progression modes:
  - Points mode (default): earn points for kills, trading, feeding, taming, breeding, observing with a spyglass, and more
  - Chance mode: classic per-action chance to rank up
  - Sighting mode: discover entities by observing with a spyglass
- Progressive rank difficulty (optional): higher ranks take more effort
- Loot knowledge that updates over time:
  - Reads real loot tables when available
  - Can be extended or overridden with datapacks for full control
  - Dynamic drop tracking (optional) refines chances based on actual gameplay
- Global progression bar options (track S ranks or X ranks) for long-term goals
- Notifications on rank ups and a convenient keybind to open the Bestiary
- Performance options for low-end PCs and safe fallbacks for heavily modded packs

## Customization at a glance

- Configurable systems (server and client):
  - Switch E→S style with `esMode` (points or chance) and the high-level `progressionSystemType` (ranks, kills, sighting)
  - Tune points and thresholds, enable progressive rank difficulty, and set discovery visibility (e.g., `hideUndiscovered`, `forceObfuscation`)
  - Control loot discovery behavior: enable dynamic drop tracking, tune sampling, and choose safer fallbacks
  - Low-end mode, UI scale limits, and other QoL for smooth play
- Datapack support for loot pages:
  - Place JSON files under `data/<your_ns>/bestiary/<entity_ns>/<entity>.json`
  - Supplement vanilla loot or fully override it per entity
  - See full format and examples in the guides below

## Compatibility and performance

- Works on singleplayer and servers; drop the mod jar into the `mods` folder on both client and server
- Uses safe strategies to read loot in complex modded environments; optional fallbacks can be enabled in configs
- Low-end mode reduces GUI preview cost; adjustable entity preview scale helps on older GPUs
- Admin-friendly: change configs and use `/reload` after dropping datapacks to iterate quickly

## Installation

1) Install Forge 1.20.1
2) Download the mod from Modrinth or CurseForge
3) Put the jar in your `mods` folder (client and server if applicable)
4) Launch the game

## Quick start

1) Obtain or craft the Bestiary Book and press the keybind (default `B`) to open it
2) Interact with creatures to gain knowledge:
   - Fight, feed, trade, tame, breed, or observe with a spyglass (depending on mode)
3) As you rank up per entity, more details unlock: spawn info, stats, loot, and more
4) Want a different experience? Tweak configs or add a datapack to tailor the loot pages to your pack