Yet Another World Protector
Yet Another World Protector (YAWP) — это основной инструмент администратора для защиты вашего сервера Minecraft (выделенного, LAN, а также в одиночной игре!). Он доступен для (Neo-)Forge и Fabric.
YAWP разработан для использования на выделенных серверах, но также может использоваться в мирах для одного игрока и мирах, открытых для LAN. Он позволяет администраторам (и игрокам с назначенными разрешениями) защищать свои постройки от различных событий/действий игроков, мобов и окружающей среды.
Создавайте регионы для своих построек и применяйте флаги регионов для их защиты. Назначайте игроков или команды vanilla на регионы, чтобы они могли управлять своими собственными регионами.
YAWP был вдохновлен модом для forge WorldProtector и плагином WorldGuard.
Мод в настоящее время находится в состоянии бета-тестирования, многие функции еще не реализованы, но появятся. Эти функции будут включать в себя большую часть того, что вам известно из WorldProtector и WorldGuard.
Этот мод будет выпущен для версий Minecraft 1.16.5+. Если вы живете в прошлом и ищете версию для Minecraft 1.12.2, предлагаю посмотреть в сторону использования WorldDefender.
Начиная с Minecraft 1.20.4, YAWP больше не будет доступен для Forge и перейдет на NeoForge.
В YAWP существует три различных типа регионов для защиты вашего сервера:
Глобальный регион
Глобальный регион... ну, глобальный. Флаги, установленные в Глобальном регионе, применяются ко всем измерениям сервера и, следовательно, ко всем Локальным регионам.
Измерительные регионы (Dimensional Regions)
Измерительные регионы — это особые регионы, которые привязаны к одному измерению — подобно флагам игровых правил для разных измерений.
Измерительные регионы не имеют пространственных ограничений в соответствующем измерении. Они работают как обычные регионы, но привязаны к измерению.
Они не могут быть созданы вручную. Фактически, они автоматически генерируются с каждым новым измерением. Первый Измерительный регион для overworld создается при создании сервера.
Следующие Измерительные регионы создаются всякий раз, когда игрок перемещается в новое измерение, создавая таким образом новое измерение с его соответствующим Измерительным регионом. Модовые измерения также поддерживаются.
Локальные регионы
Локальные регионы — это регионы, которые вы, скорее всего, знаете по WorldGuard или WorldProtector. Они имеют определенную область, в которой они действуют и к которой ограничены.
С помощью Локальных регионов вы можете создавать области в своем мире, которые хотите защитить от определенных действий/событий, вызванных игроками, другими сущностями или окружающей средой.
Чтобы создать Локальный регион, вам потребуется разрешение от родительского региона или разрешение из конфигурации.
Локальные регионы можно создавать, пометив область с помощью RegionMarker и выполнив соответствующую команду или просто используя команду без RegionMarker.
Пока область региона может быть определена в форме кубоида или сферы, но в будущих обновлениях планируется добавить больше форм для областей регионов.
Свойства регионов
Свойства регионов, флагов, групп и т.д. можно управлять через интерактивный CLI.
Цветной текст указывает на интерактивные ярлыки команд или предложения команд. Весь цветной текст имеет всплывающую подсказку, которая кратко объясняет, что делает соответствующий элемент при нажатии.
Щелчок по ним дает игроку предложение выполнить команду или иногда прямо выполняет команду, указанную в тексте подсказки.
Регионами могут управлять только их владельцы, или игроки, имеющие необходимый уровень OP или запись в конфигурации. Для получения дополнительной информации посетите вики.
Всякий раз, когда новый Локальный регион создается без указания родительского региона, родителем устанавливается Измерительный регион, в котором создается новый Локальный регион.
Локальные регионы также могут иметь дочерние регионы. Дочерние регионы Локального региона должны содержаться в области родительского региона. Иерархия регионов также определяет приоритеты регионов. Дочерние регионы всегда должны иметь более высокий приоритет, чем их родитель.
Измерительные регионы всегда имеют Глобальный регион в качестве родителя, и, таким образом, Глобальный регион имеет все Измерительные регионы в качестве дочерних регионов.
Регионы имеют владельцев и обычных участников. Владельцы могут управлять регионом и обходить флаги, участники могут только обходить флаги, установленные в регионе.
Владельцами и участниками могут быть отдельные игроки или команда.
Группы позволяют назначать определенные разрешения региона разным игрокам и командам. В настоящее время есть только две группы по умолчанию: владельцы и участники.
Владельцы могут сами управлять своим регионом и добавлять других игроков/команды в регион. Они также могут создавать свои собственные подрегионы within their region, управлять флагами и т.д., и, конечно же, владельцы обходят флаги.
Участники могут только обходить флаги.
Планируется добавать интеграцию с LuckPerms в будущем обновлении, чтобы вы могли определять свои собственные группы и разрешения.
Флаги являются ядром системы защиты регионов. Они определяют, какие действия разрешены или запрещены в регионе. Флаги можно установить в:
- Разрешено, чтобы разрешить соответствующее действие,
- Запрещено, чтобы запретить соответствующее действие,
- Отключено, чтобы отключить конкретный флаг для проверок.
Дочерние регионы наследуют флаги от своих родительских регионов. Кроме того, можно переопределить состояние флага для дочерних регионов, установив свойство override флага родительского региона соответствующим образом.
См. страницу Флаги для получения более подробной информации о различных флагах.
Планируется добавить больше флагов в будущем. Список предлагаемых флагов, которые я постепенно добавлю в мод, можно найти здесь: Предложения по флагам
В будущем также появятся более сложные флаги. Например, ListFlag, который позволит вам определить список разрешенных блоков/сущностей/.., которые запрещены в контексте флага.
Команды мода также разработаны для использования консолью сервера и могут выполняться командными блоками.
Это позволяет автоматизировать настройку регионов, добавлять/удалять игроков, включать или отключать регионы и т.д.
YAWP предоставляет растущий API для интеграции с модами и модпаками для более простой интеграции. В настоящее время API позволяет другим модам прослушивать события создания, изменения и удаления регионов и отменять эти события, чтобы предотвратить их возникновение.
Кроме того, существуют события для проверок флагов и их результатов, которые можно использовать для манипулирования результатом проверки флага.
Установка мода на стороне клиента обеспечивает поддержку языка (I18n) в виде ресурспака. В настоящее время поддерживаются английский, немецкий и русский языки.
Начиная с версии мода 0.0.2.9-beta2 и версии Minecraft 1.19.4, YAWP предоставляет перевод по умолчанию на английский язык.
Если ваш язык еще не поддерживается, не стесняйтесь обращаться ко мне через discord или создавать pull request через github! :)
Конфигурация мода позволяет контролировать, кому разрешено использовать мод, устанавливает флаги по умолчанию для Локальных и Измерительных регионов, параметры интерфейса командной строки и т.д.
Конфигурация разделена на разные файлы, охватывающие разные темы.
yawp-common.toml— конфигурация для разрешений командyawp-flags.toml— конфигурация для флагов, пользовательских сообщений флагов и т.д.yawp-region-defaults.toml— конфигурация для свойств регионов по умолчанию
Поскольку YAWP — это серверный мод, его конфигурация находится в каталоге /serverconfig в каталоге вашего мира Minecraft.
Документация мода небольшая, но растущая. Я стараюсь успевать за контентом. Вы можете найти документацию << здесь >>.
Документация охватывает
- описания различных регионов
- начало работы и ЧАВО
- доступные команды и флаги
- конфигурацию
- и многое другое ...
План разработки
Предстоит еще много функций. Мод находится в активной разработке! Следующий список не является исчерпывающим.
- Различные типы флагов (List, Effect, ...) для более детального контроля
- Конфигурация флагов на основе датапаков
- Визуализация границ регионов
- Определение собственных групп регионов для более детального управления регионами (LuckPerms)
- Более детальная система разрешений (в сочетании с функциями более детальных групп)
- Шаблоны регионов для более удобного управления одинаковыми регионами с разными пространственными свойствами
- Триггеры регионов для входа/выхода из региона (для отображения сообщений, выполнения команд и т.д.)*
- Регионы разной формы (Цилиндр, Призма, 3DPolygon)*
- <ваше предложение здесь>
