📁 Mode Configuration

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

#Example Mode

Each mode has its own file inside the modes folder. The example below is trimmed: the display item and the scoreboard's animated header are both much longer in a real file.

sort-order: 1
enabled: true
identifier: crystal
display-name: Crystal
display-description:
- This is a custom arena mode.
display:
  ==: org.bukkit.inventory.ItemStack
  id: minecraft:end_crystal
  count: 1
allowed-player-type:
- UNRANKED_SOLO
- UNRANKED_DUO
- RANKED_SOLO
- RANKED_DUO
- CUSTOM_SOLO
- SOLO_CHALLENGE
- PARTY_CHALLENGE
- PARTY_FFA
- PARTY_TEAM_FIGHT
loadout:
  type: PREMADE_KIT
  kit-id: crystal
scoreboard:
  enabled: true
  header-frames:
  - '&5&lPHOENIX DUELS'
  - '&d&lP&5&lHOENIX DUELS'
  lines:
  - ''
  - '&fTime Left: &a%time_left%'
  - ''
  - '&f%opponents%'
  - ''
  - '&fMode: &a%mode%'
  - '&fMap: &a%map%'
rules:
- 'ENDER_PEARL_COOLDOWN;{5}'
permission:
  required: false
  permission: phoenixduels.mode.example
rounds-to-win: 1
pre-fight-delay-seconds: 10
duration-seconds: 300
cooldown-seconds: 0
public-broadcast: true
commands:
  when-starting: []
  when-ending: []
  when-winning: []
  when-losing: []

#Options

Option	Description
sort-order	Where this mode sits in the mode menus. Lower numbers come first.
enabled	Whether players can play it. A disabled mode stays visible in the editor.
identifier	The mode's unique id. Used by placeholders, commands and a map's `allowed-modes`.
display-name	The name players see.
display-description	The lore shown under the mode in the menus.
display	The item shown for this mode in menus. Written by the editor.
allowed-player-type	Which kinds of match may use this mode. Remove an entry to block it.
loadout	What players fight with. See below.
scoreboard	This mode's own scoreboard. New modes start from templates.yml.
rules	The gamemode rules applied, with their settings in braces.
permission	Set `required` to true to restrict the mode to holders of `permission`.
rounds-to-win	The rounds value. What it means depends on the server's `match.rounds-format` setting.
pre-fight-delay-seconds	The countdown before the fight starts.
duration-seconds	How long a round may run before it is called.
cooldown-seconds	How long a player must wait before playing this mode again. `0` means no cooldown.
public-broadcast	Announce the result of every match in this mode to the server.
commands	Commands run by the console at each stage of a match.

#Loadout

loadout.type decides what players are given when the match starts:

PREMADE_KIT - everyone fights with the kit named by kit-id, which points at a file in the kits folder.
PLAYER_INVENTORY - players fight with whatever they are already carrying. kit-id is not used.

Add-ons register more types. Player Kits adds PLAYER_KIT and SHARED_PLAYER_KIT.

#Player Types

allowed-player-type controls both the team sizes and the kinds of match this mode appears in.

Value	Allows
UNRANKED_SOLO / DUO / TRIO / QUAD	Unranked queue at 1v1, 2v2, 3v3 and 4v4.
RANKED_SOLO / DUO / TRIO / QUAD	Ranked queue at the same sizes.
CUSTOM_SOLO / DUO / TRIO / QUAD	Custom matches at the same sizes.
SOLO_CHALLENGE	A direct `/duel` between two players.
PARTY_CHALLENGE	One party challenging another.
PARTY_FFA	A free-for-all inside one party.
PARTY_TEAM_FIGHT	Splitting one party into two teams.
PARTY_MULTI_TEAM_FIGHT	Splitting one party into up to four teams. Off by default on new modes.

PARTY_MULTI_TEAM_FIGHT also needs the map to have third and fourth team spawn positions defined, otherwise there is nowhere to put the extra teams.

Last updated about 22 hours ago