AlphaPracticeReferenceConfiguration

Configuration

What lives in each configuration file.

On this page

File layout
Storage and saving
Ranked and queues
Match settings
Ladder files
Divisions
Other sections

File layout

plugins/AlphaPractice/
  config.yml # rules, queue, ranked, party, events, FFA, storage, panel
  divisions.yml # the division names and ELO thresholds
  ladders/ # one YAML file per ladder
  lang/language.yml, scoreboard.yml # chat text and sidebars
  menus/guis.yml, shop.yml, inventories.yml, playerkit.yml # menus

config.yml has a VERSION field. Review the new template when you upgrade.

Storage and saving

MYSQL-DATABASE:
  ENABLED: false
  SAVE-PERIOD: 5
  CONNECTION:
    HOST: localhost
    PORT: 3306
    DATABASE: alpha_duels
    USER: root
    PASSWORD: mysecretpassword

AUTO-SAVE:
  ENABLED: true
  ALERT: true
  INTERVAL: 10

Data is stored in files by default. With MySQL enabled, statistics sync every SAVE-PERIOD minutes. Back up before you switch.
Auto-save runs every 10 minutes and again on shutdown. ALERT tells players when it happens.
Change the shipped MySQL password before you enable it.

Ranked and queues

DIVISIONS:
  ENABLED: true
  MIN-DIVISION-FOR-RANKED: SILVER2

QUEUE:
  RANKED:
    MAX-QUEUE-TIME: 300
    DEFAULT-ELO: 500
    ELO-RANGE-TIME: 5
    ELO-RANGE-INCREASE: 20
    ELO-CHANGE: 5-12
    ELO-K-FACTOR: 32
    MAX-PING: 300
  UNRANKED:
    MAX-QUEUE-TIME: 300
    DIVISION-SEARCH:
      ENABLED: true

The queue menus have their own layout under SELECTOR-GUI, with category buttons, ladder slots, a quick-match button and a mode switch.

Match settings

MATCH-SETTINGS covers team names and colors, match type names, the start countdown, the delay before players return to the lobby, the health indicator under names, the build limit, commands that run when a match starts or ends (with %player% and %opponent%), duel invitations and the round selector, and special rules for ender pearls, fireballs, TNT sumo, boxing, rematches and golden heads. KNOCKBACK sets the normal and combo knockback values.

Ladder files

name: Pot
enabled: true
type: BASIC
settings:
  ranked: true
  editable: true
  hitdelay: 20
  rounds: 1
  epcooldown: 13
  startcountdown: 5
  knockback: DEFAULT
  maxduration: 900
  matchtypes:
    - DUEL
    - PARTY_FFA
    - PARTY_SPLIT
    - PARTY_VS_PARTY
  weightClass: UNRANKED_AND_RANKED
  elo-tags:
    Lt5: 0
    Ht5: 900

Key	Meaning
`type`	One of the 13 ladder types, see Ladders.
`ranked`, `weightClass`	Whether the ladder can be played ranked, unranked or both.
`editable`	Whether players can edit their kit.
`hitdelay`, `knockback`	Combat feel.
`rounds`, `maxduration`, `startcountdown`	Match length. Duration is in seconds.
`matchtypes`	Which of `DUEL`, `PARTY_FFA`, `PARTY_SPLIT` and `PARTY_VS_PARTY` it supports.
`elo-tags`	The ELO ranges behind the tag names shown by `/tags`.

Divisions

divisions.yml lists each division with its name and the ELO needed to reach it, so a player moves between divisions as their ELO changes. REQUIRE.ELO turns ELO into a requirement. Rename divisions or move the thresholds to fit your server.

Other sections

Chat. Server chat, party chat, private messages and staff chat, with a #message shortcut.
Sounds. Every sound has its own on switch, sound, volume and pitch.
Spectators. Spectator mode, the menu, vanish and random match cooldowns, and fly speed.
Player. Joining teleports to the lobby, lobby protection, nametags and default settings.
Events and FFA. The event options and each event own section, and the FFA options.
Admin settings. Several OP-BYPASS switches stop commands from changing an operator ELO, limits and experience.

The panel block holds the approval settings.

The shipped text uses a red and green palette in places. Edit lang/language.yml and the menus to match your server theme.