DUXPLIMA Documentation

Arena files

The file of one arena under arenas/, every key, what a missing key means, and editing by hand.

Every arena is one file, arenas/<id>.conf, where the file name is the arena's id. The operator commands and the editor write it; you can also write or copy one by hand. To copy an arena to another server, copy its file.

boundary {
  x1 = 18
  y1 = 61
  z1 = -48
  x2 = 28
  y2 = 76
  z2 = -38
}
display-name = "hill"
enabled = true
entry {
  clear-effects = true
  clear-inventory = true
  game-mode = ADVENTURE
}
exit {
  world = world
  x = 23.5
  y = 62.0
  z = -32.5
  yaw = 0
  pitch = 0
}
join-on-enter = true
plate {
  x = 23
  y = 68
  z = -43
}
spawn {
  world = world
  x = 23.5
  y = 62.0
  z = -38.5
  yaw = 180
  pitch = 0
}
world = world

The keys

KeyWhat it isLeft out
worldThe world of the box, the plate and the spawnThe arena has no world and is incomplete
display-nameThe name players read in messagesThe id
enabledWhether players can get intrue
join-on-enterWhether walking into the box joinstrue
boundary.x1, y1, z1Corner one, a blockCorner one is not set
boundary.x2, y2, z2Corner two, a blockCorner two is not set
plate.x, y, zThe plate, a blockNot set
spawn { world, x, y, z, yaw, pitch }Where a joining or respawning player is put. world defaults to the arena'sNot set
exit { world, x, y, z, yaw, pitch }Where a leaving player is put. world defaults to the arena'sNot set
entry.clear-inventoryPut the items away on entry, give them back on leavingtrue
entry.clear-effectsRemove potion effects on entrytrue
entry.game-modeSURVIVAL, CREATIVE, ADVENTURE or SPECTATORADVENTURE

A block piece is three whole numbers; a place takes decimals, and x = 23.5 is the middle of block 23. yaw is the direction faced: 0 south, 90 west, 180 north, -90 east. pitch is up and down, 0 level.

Rules

  • The file name is the id. It must be a valid id: one to 32 lower-case letters, digits and -, starting with a letter or a digit. A file whose name is not is skipped with a warning.
  • The plate must be inside the box. An arena whose plate is outside is incomplete, and the console says so for one that is switched on.
  • A file that cannot be read is skipped, with the reason in the console, and the other arenas load.
  • Missing is not zero. A piece left out is not set; it is never read as 0 0 0.

Editing by hand

Edit the file and run /uxmkotl reload: the arena files are read again with the rest. A file you add is a new arena, and a file you delete removes it. An edit by command or editor writes the whole file again from what the plugin holds, so your comments in an arena file do not survive the next edit.

Related: Arenas, Operator commands, Arena editor