AlphaTPADocs v2.0.0
AlphaTPAReferenceConfiguration

Configuration

What lives in each configuration file.

On this page

File layout

plugins/AlphaTPA/
  config.yml # features, teleport, requests, gui, sounds, theme, permissions
  lang/messages.yml # every player-facing message
  menus/players/tpa-request.yml, tpa-accept.yml, tpahere-request.yml, tpahere-accept.yml
  data/players.yml # runtime, per-player switches

Run /alphatpa reload after editing. The teleport and request settings are explained with the flow on Teleport requests.

Features

features:
  tpa: true
  tpahere: true
  gui: true
  auto-accept: true
  sounds: true
  override-conflicts: true
KeyTurns off
tpa / tpahereThat request type completely.
guiThe confirm and accept menus. Players can also opt out themselves with /tpaguitoggle.
auto-accept/tpauto.
soundsEvery sound below.
override-conflictsThe takeover of /tpa labels from CMI and EssentialsX. See Command takeover.

GUI settings

gui:
  popup-on-request: false
  location-icons:
    NORMAL: GRASS_BLOCK
    NETHER: NETHERRACK
    THE_END: END_STONE
  gamemode-icons:
    SURVIVAL: BREAD
    CREATIVE: DIAMOND
    ADVENTURE: MAP
    SPECTATOR: ENDER_EYE

popup-on-request opens the accept menu by itself the moment a request arrives. It is off by default, so the target only gets the chat message with [accept] and [deny], and the menu opens when they click [accept] or type /tpaccept. Players who turned menus off never get it either way. Any icon you do not list keeps the menu file's own material.

Sounds

sounds:
  request-sent: ENTITY_EXPERIENCE_ORB_PICKUP
  request-received: BLOCK_NOTE_BLOCK_PLING
  countdown: BLOCK_NOTE_BLOCK_HAT
  teleport: ENTITY_ENDERMAN_TELEPORT
  accept: ENTITY_PLAYER_LEVELUP
  deny: ENTITY_ITEM_BREAK
  cancel: UI_BUTTON_CLICK
  error: ENTITY_VILLAGER_NO
  toggle-on: BLOCK_BEACON_ACTIVATE
  toggle-off: BLOCK_BEACON_DEACTIVATE
  click: UI_BUTTON_CLICK
  menu-open: ""

Use a Bukkit sound name such as ENTITY_PLAYER_LEVELUP, or a namespaced key such as entity.player.levelup. Leave a value empty to silence that one event.

Theme

theme:
  accent-hex: "#00FF12"
  gradient-start: "#00FF12"
  gradient-end: "#00990F"

Any text coloured with accent-hex in a message or menu file is upgraded to a real gradient from gradient-start to gradient-end when it is shown, including the startup banner.

Each menu has title, size (27) and an items section. Every item has a slot, material, name, lore and an action:

ActionDoes
confirmConfirms in a request menu, or accepts in an accept menu.
cancelCancels in a request menu, or denies in an accept menu.
infoDisplay only. It does nothing when clicked.

The location item swaps its material per world type, and a PLAYER_HEAD item shows the skin of the player the menu is about. Menu files and lang/messages.yml carry a file-version. When a newer jar ships a higher version, the file is replaced on the next start and your old copy is kept as *.old, with a warning in the console.

Reload vs. restart

/alphatpa reload re-reads config.yml, the theme, lang/messages.yml and the four menus. It does not load a new jar, so an update needs a full restart.