![Field Guide banner](https://raw.githubusercontent.com/evanbones/Field-Guide/refs/heads/1.20.1/images/banner_image.png)

<div><a href="https://files.minecraftforge.net/" rel="nofollow"><img alt="forge" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/forge_vector.svg"></a> <a href="https://fabricmc.net/" rel="nofollow"><img alt="fabric" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/fabric_vector.svg"></a> <a href="https://neoforged.net/" rel="nofollow"><img alt="neoforge" height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/neoforge_vector.svg"></a></div>

***

_Ever wondered what makes a Creeper tick? Or what that weird glowing block deep in the caves is? Grab your spyglass,
adventurer: it's time to start taking notes!_

**Field Guide** is an exploration-focused mod that lets you scan and discover monsters, animals and plants with your
trusty spyglass to unlock them in your own in-game Field Guide!

![List view](https://raw.githubusercontent.com/evanbones/Field-Guide/refs/heads/1.20.1/images/list_view.png)

## Features

![Scanning view](https://raw.githubusercontent.com/evanbones/Field-Guide/refs/heads/1.20.1/images/scanning_view.png)

* **Finally, Spyglasses have a use**! Scan plants and critters at a distance using a spyglass.
* **Your own personal encyclopedia!** Every successful scan unlocks a brand-new entry in your Field Guide.
* **Reward your curiosity!** Gives true explorers a reason to seek out every rare creature and biome.
* **Gotta scan 'em all!** Works seamlessly with almost _every_ modded entity, no configuration necessary!
* **Multiplayer-friendly!** Your progress is saved on a per-server basis. Build your Field Guide with friends!
* **Take notes!** Write your own notes for each entry, or
  add [Item Descriptions](https://modrinth.com/mod/item-descriptions) to prefill them with useful information!

![List view](https://raw.githubusercontent.com/evanbones/Field-Guide/refs/heads/1.20.1/images/details_view.png)

## Easily Configurable, Made for Modpacks!

Whether you are using it for your personal game or designing a modpack, Field Guide can be configured how you want it!

* Categories and their contents are fully controlled by datapacks, and can contain any entity, block or even multiblock
  structures like trees!
* Allow scanning without a spyglass or require players to defeat a monster to discover it.
* Grant XP or run commands when a player makes a discovery.
* Add your own descriptions to provide players with clues and lore.
* Hide names, entries or whole categories until they are discovered.
* And much more...

For full information, tutorials, and examples, please refer to the 
**[Field Guide Wiki](https://moddedmc.wiki/en/project/field-guide/latest/docs)**.

![List view](https://raw.githubusercontent.com/evanbones/Field-Guide/refs/heads/1.20.1/images/modded_view.png)

## Recommended Mods

Field Guide stands on the shoulders of giants! To get the full, feature-complete experience, you'll want the following
mods:

| Icon                                                                                                                           | Link                                                                                                                              | Feature Added                                                                     |
|--------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|
| <img src="https://raw.githubusercontent.com/evanbones/Field-Guide/refs/heads/1.20.1/images/immersive_overlays.jpg" width="64"> | <strong><a href="https://modrinth.com/mod/immersive-overlays" target="_blank" rel="nofollow">Immersive Overlays</a></strong>      | <strong>Biome Displays</strong> — Shows beautiful spawn details for entities.     |
| <img src="https://raw.githubusercontent.com/evanbones/Field-Guide/refs/heads/1.20.1/images/item_descriptions.jpg" width="64">  | <strong><a href="https://modrinth.com/mod/item-descriptions" target="_blank" rel="nofollow">Item Descriptions</a></strong>        | <strong>Entry Descriptions</strong> — Automatically fills in entry lore.          |
| <img src="https://raw.githubusercontent.com/evanbones/Field-Guide/refs/heads/1.20.1/images/mod_descriptions.jpg" width="64">   | <strong><a href="https://modrinth.com/resourcepack/mod-descriptions" target="_blank" rel="nofollow">Mod Descriptions</a></strong> | <strong>Modded Support</strong> — Adds automatic descriptions for modded entries. |

## Future Plans

### Expanded integration with other mods

We've got exciting features planned for integrations with mods like Jade/WAILA, EMI, and
Scholar - Stay tuned!

### More features...

More configuration options, logbook, more multiplayer features - We've got a lot of ideas!

## License

[![Assets license (ARR)](https://img.shields.io/badge/assets%20license-All%20Rights%20Reserved-red.svg?style=flat-square)](https://github.com/evanbones/Field-Guide/blob/1.20.1/LICENSE) [![Code%20license%20(MIT)](https://img.shields.io/badge/code%20license-MIT-green.svg?style=flat-square)](https://github.com/evanbones/Field-Guide/blob/1.20.1/LICENSE)

If you are thinking about using the code or assets from Field Guide, please note the mod's licensing. All assets of
Field Guide are all rights reserved by their respective creators, unless specified otherwise. The source code of the mod
is available under the MIT license.

## Credits

This mod was created as a collaboration between [evanbones](https://github.com/evanbones)
and [Kobber](https://github.com/Kobber). Assets were made by Kobber and evanbones, with additional contributions
from [Nekomaster](https://www.curseforge.com/members/nekomaster1000).

The book texture is modified from mortuusar's [Scholar](https://modrinth.com/mod/scholar), with permission, which also
works well when used alongside Field Guide!

The banner image uses textures from the [Bare Bones](https://modrinth.com/resourcepack/bare-bones) texture pack.

---

[![discord-plural](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/social/discord-plural_vector.svg)](https://discord.com/invite/JcGRdT6Pbx) [![github-plural](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/compact/social/github-plural_vector.svg)](https://github.com/evanbones/Field-Guide)
