# 📁 Map Configuration

## 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.

```yaml
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

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

## Regeneration

<table data-full-width="true"><thead><tr><th width="270">Option</th><th>Description</th></tr></thead><tbody><tr><td>regeneration</td><td>Whether the arena is restored after use at all. This must be on before players can break or place blocks in it.</td></tr><tr><td>post-round-regeneration</td><td>Restore the arena after every round rather than only at the end of the match.</td></tr><tr><td>pre-match-regeneration</td><td>Also restore the arena at the start of a match, during the first countdown. A safety net in case a previous regeneration failed.</td></tr><tr><td>regen-engine</td><td>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.</td></tr></tbody></table>

See [Arena Regeneration](../../main-features/create-a-map/arena-regeneration.md) for the full explanation, and [Main Configuration](main-configuration.md) 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.

<table data-full-width="true"><thead><tr><th width="270">Option</th><th>Description</th></tr></thead><tbody><tr><td>auto-generation.enabled</td><td>Whether new arenas are generated on demand.</td></tr><tr><td>auto-generation.world</td><td>The world new arenas are pasted into.</td></tr><tr><td>auto-generation.min-spacing</td><td>The minimum distance in blocks kept between every arena in that world.</td></tr></tbody></table>

> **Warning:**
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.

Source: https://www.phoenixplugins.com/docs/phoenix-duels/configurations/configuration-files/map-configuration