Resource Packs (Customizing Visuals)

You can customize the appearance of categories, render settings for entities, and descriptions using Resource Packs.

Entry Configuration (Scaling & Offsets)

Sometimes entities or blocks render too large, too small, or off-center in the book. You can adjust this by creating a JSON file at: assets/<namespace>/fieldguide/entries/<entry_id>.json

For example: assets/minecraft/fieldguide/entries/pig.json makes adjustments to minecraft:pig.

JSON Structure

Names, Descriptions & Localization

By default, Field Guide uses descriptions from Item Descriptions and its addon resource pack Mod Descriptions. To add names to custom categories, or names and descriptions to specific entries, add lines to your en_us.json (or other language file).

You can use /fieldguide export in-game to export all custom names/descriptions to a JSON file for easy editing.

If you write new entity descriptions and think others would find them helpful, feel free to make a pull request to the Mod Descriptions GitHub!

Texture Overrides (2D Sprites)

If an entity or entry renders poorly (or if you prefer 2D illustrations), you can force the Field Guide to use custom PNG textures instead of 3D models. Place textures in: assets/<namespace>/textures/fieldguide/entries/

Texture Naming Formats

File names use entry ID keys. The mod checks for textures using candidate prefixes in the following order:

1. Full Type Prefixed: <type>_<namespace>_<path>.png (e.g., entity_minecraft_pig.png, item_minecraft_diamond.png, block_minecraft_oak_log.png)
2. Alternate Type Prefixed: For IDs shared between entities and items (like minecraft:chicken), both item_minecraft_chicken.png and entity_minecraft_chicken.png are supported.
3. Namespaced Path: <namespace>_<path>.png (e.g., minecraft_pig.png)
4. Simple Path: <path>.png (e.g., pig.png)

View-Specific Textures

You can provide separate textures for the entry list (grid) and the details page:

• Details Page Only: <name>_page.png (e.g., entity_minecraft_pig_page.png or pig_page.png)
• List Grid Only: <name>_grid.png (e.g., entity_minecraft_pig_grid.png or pig_grid.png)
• General (Fallback): <name>.png (Used for both views if view-specific textures aren't found)

Variant Textures

To override images for specific entry variants (e.g., Cat breeds, Frog variants, Cobblemon forms), append _<variant_id> to the texture filename before view suffixes:

• Variant Details Page: <name>_<variant_id>_page.png (e.g., entity_minecraft_frog_warm_page.png or frog_warm_page.png)
• Variant List Grid: <name>_<variant_id>_grid.png (e.g., entity_minecraft_frog_warm_grid.png or frog_warm_grid.png)
• Variant General: <name>_<variant_id>.png (e.g., entity_minecraft_frog_warm.png or frog_warm.png)

Example: To override the Warm Frog variant, save your texture at assets/minecraft/textures/fieldguide/entries/entity_minecraft_frog_warm.png (or frog_warm.png).

Customizing the "Locked" Hint Text

When a player views an entry they haven't unlocked yet, the Field Guide tries to give them a dynamic hint based on the required triggers (e.g., "Defeat this creature to discover", "Eat this item to discover").

Modpack makers can override this default text to provide highly specific instructions (like "Obtain a diamond to discover") by using a Resource Pack and defining custom language keys in en_us.json.

The language key format follows the same structure as custom descriptions, but uses .hint instead:

• Base Entities: fieldguide.<namespace>.<path>.hint
• Variants: fieldguide.<namespace>.<path>.<variant_id>.hint

Example en_us.json:

{
  "fieldguide.minecraft.creeper.hint": "A creepy creature that comes out at night...",
  "fieldguide.my_mod.combat_mastery.hint": "Prove your worth by slaying the Warden.",
  "fieldguide.cobblemon.pikachu.hint": "Find this electric mouse in a Forest.",
  "fieldguide.cobblemon.rattata.alolan.hint": "A rare variant of a Rattata. Scan to learn more."
}

If a .hint key is not found, the hint will automatically fallback to the text based on the entry's unlock triggers.