Custom compasses can be added via datapacks. Each custom compass is defined as a JSON file located at:

data/<namespace>/omnicompass/compass_type/<compass_name>.json

Compass Entries

The entries field defines a list of possible compass targets.

Biome and Structure Targets

Biome and structure targets can be specified using omnicompass:biome and omnicompass:structure.

  {
    "type": "omnicompass:biome",
    "name": "minecraft:plains"
  }

• name: ID of the biome/structure to search for.

Conditions

Each omnicompass:biome and omnicompass:structure target can have additional conditions required for it to load. This can be specified in a conditions list:

    {
      "type": "omnicompass:structure",
      "name": "minecraft:shipwreck",
      "conditions": [
        {
          "type": "omnicompass:advancement",
          "name": "minecraft:adventure/bullseye"
        }
      ]
    }

This example shows a shipwreck target that can be only selected by players with a Bullseye advancement. Players who don't meet the condition will not see the target in the compass' menu.

All of Target

If you just wish to allow the players to search for any biome or structure, you can use omnicompass:all_of.

    {
      "type": "omnicompass:all_of",
      "entryType": "minecraft:worldgen/biome"
    }

By default, only minecraft:worldgen/biome and minecraft:worldgen/structure can be used as the entryType.

Model

The model field specifies the model the compass uses. If not set, the vanilla compass model will be used.

Needle Colors

The needle_color and needle_shade_color fields are used to apply a color tint to the the needle and its shadow. If not set, there is no tint applied. This only works with models that use needle tinting, similar to biome or structure compass.

Full Example

The following example creates a compass that can be used to search for any biome. Additionally, if the player has the advancement Bullseye, they can also search for a Shipwreck structure. It uses biome compass' model and needle colors.

{
  "entries": [
    {
      "type": "omnicompass:all_of",
      "entryType": "minecraft:worldgen/biome"
    },
    {
      "type": "omnicompass:structure",
      "name": "minecraft:shipwreck",
      "conditions": [
        {
          "type": "omnicompass:advancement",
          "name": "minecraft:adventure/bullseye"
        }
      ]
    }
  ],
  "model": "omnicompass:biome_compass",
  "needle_color": 12754274,
  "needle_shade_color": 9860161
}