📁 Map Configuration

On this page, you will find an example of a map config.

#Example Map

Each map has its own file inside the maps folder. The example below is trimmed, since the display item and a long arena list make a real file much taller.

sort-order: 1000
enabled: true
type: FREE_MODE
identifier: map_7245
display-name: Map
display:
  ==: org.bukkit.inventory.ItemStack
  id: minecraft:minecart
  count: 1
template:
  universal-region:
    minimum:
      x: -20.0
      y: -14.0
      z: -26.0
    maximum:
      x: 19.0
      y: 15.0
      z: 26.0
  battle-region:
    minimum:
      x: -2.0
      y: -12.0
      z: 12.0
    maximum:
      x: 6.0
      y: 3.0
      z: 21.0
  ffa-positions: []
  teams:
    '0':
      positions:
        '0':
          x: 14.08244880949405
          y: -13.0
          z: 14.815054676272695
          yaw: 68.54266
          pitch: -3.449963
    '1':
      positions:
        '0':
          x: 12.878836385874612
          y: -13.0
          z: 15.231936686241397
          yaw: 73.492676
          pitch: -21.599962
    '2':
      positions: []
    '3':
      positions: []
  extras: {}
regeneration: false
post-round-regeneration: true
pre-match-regeneration: false
regen-engine: INTERNAL
teleport-to-lobby: false
allowed-modes:
- classic
team-colors:
- RED
- BLUE
- GREEN
- YELLOW
arenas:
  '0':
    reference:
      world: world
      x: 199
      y: 95
      z: 357
dont-edit:
  assistance-stage: 4
  blob-key: 6b7b172167a74f498cdc6c0327256529
auto-generation:
  enabled: false
  world: ''
  min-spacing: 250

#Options

Option	Description
sort-order	Where this map sits in the map list. Lower numbers come first.
enabled	Whether players can be sent to this map. A disabled map is still visible in the editor.
type	FREE_MODE, where you place every arena yourself, or GRID_MODE, where the plugin lays them out for you. See Grid Mode.
identifier	The map's unique id. Used by `allowed-modes`, commands and placeholders.
display-name	The name players see.
display	The item shown for this map in menus. Written by the editor; easier to change there than by hand.
template	The build itself: the two regions, the team spawns, and the optional FFA and spectator positions. See Edit the Arena.
allowed-modes	Which modes may be played here. An empty list means none, so the map is never picked.
team-colors	The colour assigned to each team slot, in order.
arenas	Every physical copy of this map, each with the world and coordinates it was pasted at.
teleport-to-lobby	Send players to the lobby after a match instead of back to where they were before it.
dont-edit	Written by the plugin. Leave it alone.

#Regeneration

Option	Description
regeneration	Whether the arena is restored after use at all. This must be on before players can break or place blocks in it.
post-round-regeneration	Restore the arena after every round rather than only at the end of the match.
pre-match-regeneration	Also restore the arena at the start of a match, during the first countdown. A safety net in case a previous regeneration failed.
regen-engine	INTERNAL uses the built-in engine, which restores blocks gradually and needs no other plugin. WORLDEDIT pastes a schematic, which is heavier on large arenas and requires WorldEdit or FAWE.

See Arena Regeneration for the full explanation, and Main Configuration for the two performance settings that control how fast the internal engine works.

#Auto Generation

When auto generation is on and every arena of this map is busy, the plugin pastes a new permanent one into the world you nominate rather than making players wait.

Option	Description
auto-generation.enabled	Whether new arenas are generated on demand.
auto-generation.world	The world new arenas are pasted into.
auto-generation.min-spacing	The minimum distance in blocks kept between every arena in that world.

Arenas created this way are permanent. On a busy server this grows the world file over time, so give it a dedicated, ideally void, world.

Last updated about 23 hours ago