PlaceholderAPI

PlaceholderAPI (или просто PAPI) - это фундаментальный плагин для серверов Майнкрафт на базе Spigot, Paper или Purpur. По факту, он решает одну из главных проблем администраторов: как вывести информацию из одного плагина в интерфейс другого.

Представьте ситуацию: у вас стоит экономика от Vault, права от LuckPerms и статистика игроков. Вам нужно сделать кастомный скорборд (таблицу на стороне экрана), где будет виден баланс, префикс и количество убийств. Без PAPI вам пришлось бы писать костыли или просить разработчика скорборда добавить поддержку конкретно ваших плагинов. PlaceholderAPI создает единый стандарт - вы просто пишете %vault_eco_balance% или %luckperms_prefix%, и плагин сам подтягивает нужное значение. Скачать плагин PlaceholderAPI стоит хотя бы потому, что 90% современных плагинов на интерфейсы, чаты и HUD требуют его как зависимость.

Как это работает и экспансии

Сам по себе плагин PlaceholderAPI ничего не выводит. Это пустышка, мост. Чтобы он начал считывать данные, например, из Essentials, нужны так называемые экспансии (expansions).

На данный момент существует более 230 экспансий. Поддержка есть практически для всего: Factions, Vault, LuckPerms, mcMMO и так далее. Скачиваются они прямо из игры через встроенное облако - PAPI Expansion Cloud. Команда /papi ecloud открывает доступ к базе. Если вы разработчик и хотите, чтобы ваш плагин умел отдавать данные в PAPI, достаточно воспользоваться их открытым API.

Настройка и конфигурация

Базовые настройки лежат в config.yml. Там же хранятся опции для скачанных экспансий. Когда вы ставите новую экспансию, плагин при следующей загрузке автоматически допишет нужные секции в конфиг, если у этой экспансии есть свои настройки.

# PlaceholderAPI
# Version: 2.11.4
# Created by: extended_clip
# No placeholders are provided with this plugin by default.
# Download placeholders: /papi ecloud
check_updates: true
cloud_enabled: true
cloud_sorting: "name"
cloud_allow_unverified_expansions: false
boolean:
  'true': 'yes'
  'false': 'no'
date_format: MM/dd/yy HH:mm:ss
debug: false

Команды плагина

Управление PAPI достаточно простое, но функциональное. Все команды начинаются с /papi.

Парсинг (проверка плейсхолдеров)

• /papi bcparse <player|--null|me> <string> - проверка с отправкой результата всем на сервер.
• /papi cmdparse <player|me> <string> - парсинг с выполнением команды.
• /papi parse <player|--null|me> <string> - локальная проверка, видите результат только вы.
• /papi parserel <player> <player> <string> - проверка плейсхолдеров, зависящих от отношений двух игроков (полезно для кланов).

Управление eCloud (облаком экспансий)

• /papi ecloud status - статус облака.
• /papi ecloud clear - очистка локального кэша экспансий.
• /papi ecloud download <expansion> [version] - скачать нужную экспансию.
• /papi ecloud update <expansion/all> - обновить экспансии.
• /papi ecloud info <expansion> [version] - информация о конкретной экспансии.
• /papi ecloud list <all|<author>|installed> [page] - список доступных экспансий.
• /papi ecloud placeholders <expansion> - список плейсхолдеров конкретной экспансии.
• /papi ecloud refresh - обновить кэш списка.

Управление локальными экспансиями

• /papi info <expansion> - информация об установленной экспансии.
• /papi list - список установленных экспансий.
• /papi register <jar file> - ручная регистрация файла экспансии.
• /papi unregister <jar file> - удаление экспансии.

Утилиты

• /papi dump - создать дамп данных (полезно при баг-репортах).
• /papi reload - перезагрузить конфиг плагина без перезапуска сервера.
• /papi version - узнать версию PAPI.

Права доступа

По умолчанию все административные права выдаются только операторам сервера (op). Ниже представлено полное дерево прав, если вы захотите выдать доступ к eCloud или парсингу обычным администраторам через LuckPerms.

permissions:
  placeholderapi.*:
    description: "Ability to use all PAPI commands"
    children:
      placeholderapi.admin: true
      placeholderapi.ecloud.*: true
  placeholderapi.admin:
    description: "Ability to use all PAPI commands"
    children:
      placeholderapi.help: true
      placeholderapi.info: true
      placeholderapi.list: true
      placeholderapi.parse: true
      placeholderapi.reload: true
      placeholderapi.version: true
      placeholderapi.register: true
      placeholderapi.unregister: true
      placeholderapi.updatenotify: true
  placeholderapi.ecloud.*:
    description: "Ability to use all PAPI ecloud commands"
    children:
      placeholderapi.ecloud: true
      placeholderapi.ecloud.info: true
      placeholderapi.ecloud.list: true
      placeholderapi.ecloud.clear: true
      placeholderapi.ecloud.status: true
      placeholderapi.ecloud.update: true
      placeholderapi.ecloud.refresh: true
      placeholderapi.ecloud.download: true
      placeholderapi.ecloud.placeholders: true
  placeholderapi.help:
    default: "op"
    description: "Allows you to view the list of PAPI commands"
  placeholderapi.info:
    default: "op"
    description: "Allows you to view expansion information"
  placeholderapi.list:
    default: "op"
    description: "Allows you to list active expansions"
  placeholderapi.ecloud:
    default: "op"
    description: "Allows you to access PAPI eCloud"
  placeholderapi.parse:
    default: "op"
    description: "Allows you to parse placeholders"
  placeholderapi.reload:
    default: "op"
    description: "Allows you to reload PAPI and its configuration"
  placeholderapi.version:
    default: "op"
    description: "Allows you to view the version of PAPI installed"
  placeholderapi.register:
    default: "op"
    description: "Allows you to register expansions"
  placeholderapi.unregister:
    default: "op"
    description: "Allows you to unregister expansions"
  placeholderapi.updatenotify:
    default: "op"
    description: "Notifies you when there is a PAPI update"
  placeholderapi.ecloud.info:
    default: "op"
    description: "Allows you to view cloud expansion information"
  placeholderapi.ecloud.list:
    default: "op"
    description: "Allows you to list eCloud expansions"
  placeholderapi.ecloud.clear:
    default: "op"
    description: "Allows you to clear the local eCloud expansion cache"
  placeholderapi.ecloud.status:
    default: "op"
    description: "Allows you to view the status of eCloud expansions"
  placeholderapi.ecloud.update:
    default: "op"
    description: "Allows you to update registered eCloud expansions"
  placeholderapi.ecloud.refresh:
    default: "op"
    description: "Allows you to refresh the local eCloud expansion cache"
  placeholderapi.ecloud.download:
    default: "op"
    description: "Allows you to download an expansion from the eCloud"
  placeholderapi.ecloud.placeholders:
    default: "op"
    description: "Allows you to view the placeholders of a eCloud expansion"

Нюансы установки и хостинг

Если вы планируете запускать сервер Minecraft онлайн и собирать на нем игроков, вам нужен надежный хостинг. Плагин должен заработать на BungeeHost (https://bungee.host) в 1 клик, а значит создать сервер Майнкрафт и настроить его под PAPI не составит труда. Это отличный вариант, если вы хотите арендовать сервер и поиграть с друзьями без лагов и задержек при обработке скорбордов.

Важный нюанс: PlaceholderAPI - это инструмент для разработчиков и админов. Если вы просто закинете его в папку plugins и ничего не настроите, в игре ничего не изменится. Плагин работает в фоне, ожидая, пока другие ресурсы (например, плагин на скорборд или чат) обратятся к нему за данными.