Как установить и настроить EssentialsX
Установите EssentialsX на сервер Minecraft Paper: точки дома, варпы, телепортация, киты, экономика и чат с подходящими правами LuckPerms.
На этой странице
EssentialsX добавляет на ваш сервер команды, которых ждут игроки: /home, /spawn, /tpa, /warp, /msg, а также киты и экономику. Это руководство объясняет, как установить его на Paper, выдать нужные права и настроить самые полезные параметры.
Предварительные требования
- Сервер на Paper с командой
mc-console, настроенной по руководству Установка и обновление плагинов на Paper - Установленный LuckPerms с группами из руководства Управление рангами и правами с помощью LuckPerms
В этом руководстве Steve — пример: замените его настоящим ником.
Выбор версии
Нужная версия зависит от вашей версии Minecraft. Проверьте её командой sudo mc-console version.
| Minecraft | Какой EssentialsX установить |
|---|---|
| 26.2 или 26.3 | Сборка для разработки 2.22.1 |
| 26.1.2 или 1.21.11 | Стабильная версия 2.22.0 |
Выбор модулей
EssentialsX разделён на несколько файлов, и обязателен только первый.
| Модуль | Назначение | В этом руководстве |
|---|---|---|
| EssentialsX | Основные команды, киты, экономика | Обязателен |
| EssentialsX Spawn | Точка спавна, /spawn, /setspawn |
Устанавливается |
| EssentialsX Chat | Формат чата, префиксы и суффиксы | Устанавливается |
| EssentialsX AntiBuild | Разрешение или запрет строительства через права | Необязателен |
| EssentialsX Protect | Настройки мира: урон от криперов, распространение огня | Необязателен |
| EssentialsX GeoIP | Приблизительное местоположение игроков | Необязателен |
| EssentialsX Discord и Discord Link | Мост и привязка к Discord | Необязательны |
| EssentialsX XMPP | Мост XMPP, исторический модуль | Необязателен |
Установка Vault и EssentialsX
Vault позволяет EssentialsX читать группы и префиксы LuckPerms. Без него префиксы и функции, связанные с группами, не работают.
Загрузите Vault, затем три модуля из сборки для разработки, подходящей для Minecraft 26.3:
sudo -u minecraft bash
cd /opt/minecraft/server/plugins
curl -fL -o Vault.jar https://github.com/MilkBowl/Vault/releases/latest/download/Vault.jar
BASE="https://ci.ender.zone/job/EssentialsX/lastSuccessfulBuild"
for MODULE in EssentialsX EssentialsXSpawn EssentialsXChat; do
FICHIER=$(curl -fsSL "$BASE/api/json?tree=artifacts%5BfileName%5D" | jq -r --arg m "$MODULE" '.artifacts[].fileName | select(startswith($m + "-"))')
curl -fL -o "$FICHIER" "$BASE/artifact/jars/$FICHIER"
done
ls -l Vault.jar EssentialsX*.jar
exitДля Minecraft 26.1.2 или 1.21.11 вместо приведённого выше цикла используйте стабильную версию:
BASE="https://github.com/EssentialsX/Essentials/releases/download/2.22.0"
for MODULE in EssentialsX EssentialsXSpawn EssentialsXChat; do
curl -fLO "$BASE/$MODULE-2.22.0.jar"
doneПерезапустите сервер и дождитесь строки Done:
sudo systemctl restart minecraft.service
sudo journalctl -u minecraft.service -fПроверка установки
Выйдите из просмотра журнала клавишами Ctrl+C, затем выполните:
sudo mc-console plugins
sudo mc-console vault-info
sudo mc-console 'essentials version'Вы должны увидеть:
Essentials,EssentialsChat,EssentialsSpawn,LuckPermsиVaultв списке плагиновPermission: LuckPermsиChat: LuckPermsв ответеvault-infoEconomy: Essentials Economyв том же ответе- одинаковую версию всех модулей в
essentials version
Файлы конфигурации находятся в /opt/minecraft/server/plugins/Essentials.
Выдача прав игрокам
Операторам доступно всё. Остальным игрокам команды EssentialsX недоступны, пока вы не выдадите им соответствующее право.
Выдайте распространённые команды всем игрокам:
for PERM in spawn home sethome delhome tpa tpaccept tpdeny back warp warp.list msg afk list motd rules help balance pay kit kits.tools; do
sudo mc-console "lp group default permission set essentials.$PERM true"
doneЗатем дополните права старших рангов:
for PERM in sethome.multiple sethome.multiple.vip fly; do
sudo mc-console "lp group vip permission set essentials.$PERM true"
done
for PERM in tp tphere kick mute tempban; do
sudo mc-console "lp group moderator permission set essentials.$PERM true"
done
for PERM in setspawn setwarp delwarp eco createkit; do
sudo mc-console "lp group admin permission set essentials.$PERM true"
done| Команда | Действие | Право |
|---|---|---|
/spawn |
Вернуться на точку спавна | essentials.spawn |
/sethome [имя] и /home [имя] |
Создать точку дома и переместиться к ней | essentials.sethome, essentials.home |
/delhome <имя> |
Удалить точку дома | essentials.delhome |
/tpa <игрок> |
Запросить телепортацию к игроку | essentials.tpa |
/tpaccept и /tpdeny |
Принять или отклонить запрос | essentials.tpaccept, essentials.tpdeny |
/back |
Вернуться на предыдущую позицию | essentials.back |
/warp [имя] |
Показать список варпов или переместиться к варпу | essentials.warp, essentials.warp.list |
/msg <игрок> <сообщение> и /r <сообщение> |
Личное сообщение и ответ на него | essentials.msg |
/balance и /pay <игрок> <сумма> |
Баланс и перевод денег | essentials.balance, essentials.pay |
/kit [имя] |
Показать список китов или получить кит | essentials.kit, essentials.kits.<имя> |
Полный список прав есть на сайте проекта.
Настройка конфигурации
Откройте файл от имени пользователя minecraft:
sudo -u minecraft nano /opt/minecraft/server/plugins/Essentials/config.ymlВ nano поиск параметра выполняется клавишами Ctrl+W. Изменяйте существующие строки, а не добавляйте новые, и используйте для отступов только пробелы.
# Язык сообщений (по умолчанию эта строка закомментирована)
locale: ru
# Ожидание между двумя телепортациями, в секундах
teleport-cooldown: 30
# Задержка перед телепортацией, отменяется, если игрок двигается или его атакуют
teleport-delay: 3
# Начальный баланс и валюта
starting-balance: 100
currency-symbol: '€'
currency-symbol-suffix: trueКоличество точек дома задаётся по рангам. Игрок без essentials.sethome.multiple может иметь только одну такую точку. С этим правом он получает значение default, а essentials.sethome.multiple.vip даёт ему значение vip:
sethome-multiple:
default: 3
vip: 5
staff: 10Примените изменения без перезапуска:
sudo mc-console 'essentials reload'Настройка точки спавна и варпов
Эти команды вводятся в игре, в нужном месте, с учётной записи оператора или участника группы admin:
/setspawn
/setspawn newbies
/setwarp boutique/setspawn задаёт общую точку спавна. /setspawn newbies задаёт точку для новых игроков, которая используется благодаря параметру newbies в config.yml:
newbies:
announce-format: '&dДобро пожаловать на сервер, {DISPLAYNAME}&d!'
spawnpoint: newbies
kit: toolsУказанный кит выдаётся при первом подключении, без проверки прав. Чтобы отключить его, укажите kit: ''.
Создание кита
Киты находятся в plugins/Essentials/kits.yml:
sudo -u minecraft nano /opt/minecraft/server/plugins/Essentials/kits.ymlДобавьте свой кит в раздел kits:. delay — время ожидания в секундах между двумя использованиями, а значение -1 делает кит одноразовым:
kits:
depart:
delay: 86400
items:
- stonesword 1
- stonepickaxe 1
- bread 16Перезагрузите конфигурацию и разрешите кит:
sudo mc-console 'essentials reload'
sudo mc-console 'lp group default permission set essentials.kits.depart true'Отображение рангов в чате
С EssentialsX Chat, Vault и LuckPerms формат чата настраивается в разделе chat файла config.yml:
chat:
radius: 0
format: '{DISPLAYNAME}&7:&r {MESSAGE}'{DISPLAYNAME} уже содержит префикс и суффикс LuckPerms. Поэтому не добавляйте рядом {PREFIX}, иначе префикс появится дважды. radius: 0 отправляет сообщения всему серверу.
Примените настройки командой sudo mc-console 'essentials reload', затем напишите сообщение в игре: должен отобразиться префикс, заданный в LuckPerms.
Управление экономикой
Из консоли можно изменить баланс игрока, который уже заходил на сервер:
sudo mc-console 'eco give Steve 100'
sudo mc-console 'eco take Steve 25'
sudo mc-console 'balance Steve'Благодаря Vault эту экономику могут использовать другие совместимые плагины.
Проверка результата
Войдите с учётной записью без статуса оператора, состоящей в группе default, и попробуйте:
/sethome maison
/home maison
/spawn
/kit tools
/balanceКаждая команда должна работать без сообщения You do not have access to that command. Если вы включили locale: ru, ответы будут отображаться на русском языке.
Резервное копирование и обновление
Папка plugins/Essentials содержит конфигурацию, данные игроков и варпы:
sudo tar -czf /opt/minecraft/backups/essentials-$(date +%F-%H%M).tar.gz -C /opt/minecraft/server/plugins EssentialsВсегда обновляйте все модули одновременно: у них должна быть одна и та же версия. Вот как обновить сборку для разработки:
sudo -u minecraft bash
mkdir -p /opt/minecraft/server/plugins/update
cd /opt/minecraft/server/plugins/update
BASE="https://ci.ender.zone/job/EssentialsX/lastSuccessfulBuild"
for MODULE in EssentialsX EssentialsXSpawn EssentialsXChat; do
FICHIER=$(curl -fsSL "$BASE/api/json?tree=artifacts%5BfileName%5D" | jq -r --arg m "$MODULE" '.artifacts[].fileName | select(startswith($m + "-"))')
curl -fL -o "$FICHIER" "$BASE/artifact/jars/$FICHIER"
done
exit
sudo systemctl restart minecraft.serviceПри возникновении проблем
«You are running an unsupported server version!»
Эта версия EssentialsX не поддерживает вашу версию Minecraft. Установите сборку, указанную в таблице в начале этого руководства.
«Version mismatch! Please update all Essentials jars to the same version»
Версии модулей не совпадают. Замените их все вместе, затем перезапустите сервер. С помощью ls /opt/minecraft/server/plugins убедитесь, что для одного модуля не осталось двух файлов.
«You do not have access to that command»
У игрока нет нужного права. Проверьте его, например для /home:
sudo mc-console 'lp user Steve permission check essentials.home'/r использует право essentials.msg, а для /spawn нужен модуль EssentialsX Spawn.
«You cannot set more than 1 homes»
Игрок достиг своего лимита. Выдайте ему essentials.sethome.multiple и при необходимости ранг, например essentials.sethome.multiple.vip.
«Detected supported permissions plugin LuckPerms without Vault installed»
Vault отсутствует или не загрузился. Убедитесь, что он есть в выводе sudo mc-console plugins, затем проверьте результат sudo mc-console vault-info.
«The file is broken and Essentials can't open it»
В YAML-файле есть ошибка, часто это табуляция или неверный отступ. В журнале указан проблемный файл. Исправьте его или восстановите резервную копию, затем перезапустите сервер.
Команда другого плагина подменяется
Если два плагина предлагают одну и ту же команду, используйте полную форму, например /essentials:home. Чтобы навсегда оставить приоритет за другим плагином, добавьте команду в disabled-commands в config.yml.
Подробнее читайте в официальной вики EssentialsX.