Initial Structure - babybluetit/Xaeros-Minimap-Modded-Support GitHub Wiki

Resource pack

For your files to be recognised by the minimap, they need to be stored in a resource pack. The initial layout of your pack should look like this:

my-resourcepack/
├─ assets/
│  ├─ xaerominimap/
│  │  ├─ entity/
│  │  │  ├─ icon/
│  │  │  │  ├─ definition/
│  │  │  │  ├─ sprite/
├─ pack.mcmeta

You will need to place this in your Minecraft installation's resourcepacks directory.

Your pack.mcmeta file should contain the pack_format number and an optional description, like so:

{
  "pack": {
    "pack_format": 6,
    "description": "My resource pack description"
  }
}

Please read the resource pack tutorials if you are unsure about any part of this.

Naming conventions

You need to make sure your directories and config files are suitably named, otherwise they will not be picked up by the minimap.

Rules

  • Mod identifiers are used as the name of a directory inside the definition directory
  • Entity identifiers are used as the name of a config file inside the corresponding mod's directory
definition/
├─ example_mod/
│  ├─ example_entity.json

This config file would correspond to example_mod:example_entity in game.

Example

Let's see how we would create a config file for the yeti mob from Creatures and Beasts. In Minecraft we can press the F3 hotkey to bring up the debug screen. If we look at the yeti, the debug screen tells us both the MOD ID and the ENTITY ID.

Imgur

  • MOD ID = cnb
  • ENTITY ID = yeti

So in this example, the contents of the definition directory are as follows:

definition/
├─ cnb/
│  ├─ yeti.json
⚠️ **GitHub.com Fallback** ⚠️