Island Instance

The btcsky_instance entry allows you to spawn persistent entities (like NPCs, Shops, or Decorative Mobs) defined in other extensions directly into a specific island dimension. These entities persist across server restarts and world unloads.

Configuration

targetDimension — String

The island dimension ID (e.g. overworld, nether) where this entity should spawn.

entity

" required> Reference to the entity or model definition to spawn. This usually points to a MythicMobs NPC or BetterModel entry.

spawnOffset — Vector

The relative coordinate offset from the dimension's center (0,0,0) to spawn the entity.

roadNetwork

"> Optional reference to a road network for advanced NPC navigation within the island.

Usage Example

Add this entry to your island configuration nodes to ensure that specific world elements (like a starter NPC or an island-bound shop) are correctly initialized whenever the island world is loaded.

instance:
  type: btcsky_instance
  targetDimension: "overworld"
  spawnOffset:
    x: 5.0
    y: 65.0
    z: 5.0
  entity: "my_shop_npc"