NPC Quests

ВАЖНО: Это дополнительный плагин для NPC Плагин Dialog. NPC Диалог должен быть установлен и работать перед установкой NPC Quests.

Сервер поддержки - https://discord.gg/DRxwt8Qg2W

NPC Quests - это дополнительный плагин для плагина NPC Dialog. Это дополнение расширяет NPC Dialog с полной функциональностью квеста и требований. NPC Диалог должен быть установлен первым, так как NPC Quests зависит от него. Это дополнение позволяет администраторам серверов создавать сложные интерактивные системы квестов с NPC, не требуя никаких знаний кодирования.

Аддон работает бесшовно с основным плагином NPC Dialog, автоматически обнаруживая, когда он установлен, и включая функции квеста во всей диалоговой системе. Когда аддон установлен, каждая кнопка на каждой диалоговой странице получает возможность настраивать требования и вознаграждения.

Ключевые функции включают в себя несколько типов требований, таких как требования к элементам, где игроки должны иметь определенные элементы в своем инвентаре, предпосылки NPC, где игроки должны сначала взаимодействовать с другими NPC, и пользовательские требования, которые интегрируются с другими плагинами через API. Система вознаграждения одинаково гибкая, поддерживает награды за элементы, награды за пользовательский плагин и выполнение команд консоли.

Плагин отслеживает все взаимодействия игроков с NPC, обеспечивая последовательное продвижение квеста. Игроки не могут получить доступ к NPC или кнопкам, если они не выполнили необходимые условия. Это позволяет создавать разветвленные сюжетные линии и сложные цепочки квестов, где важен порядок взаимодействия NPC.

Одной из мощных функций является система «Последняя кнопка», которая позволяет помечать любую кнопку в качестве конечного взаимодействия. Когда игрок нажимает последнюю кнопку, диалог закрывается, и он больше не может взаимодействовать с этим NPC. Это идеально подходит для завершения сюжетных линий или блокировки контента после завершения. Когда игрок пытается взаимодействовать с NPC после нажатия последней кнопки, он видит завершенную страницу с настраиваемыми сообщениями.

Аддон включает в себя полный пользовательский интерфейс администратора, доступный через команду /npcquest. Этот интерфейс обеспечивает легкую настройку всех параметров, связанных с квестами, без необходимости редактирования файлов JSON вручную. Администраторы могут выбирать NPC, диалоговые страницы и отдельные кнопки для настройки своих требований и вознаграждений.

Руководство по координации:

Показатель:

Предупреждение: NPC Диалоговый плагин должен быть установлен и работать до установки NPC Quests.

1. Установите и настройте плагин NPC Dialog
2. Поместите файл NPC Quests JAR в папку модов вашего сервера
3. Перезагрузить сервер
4. Аддон будет автоматически обнаруживать и интегрироваться с NPC Dialog.

Получение ADMIN UI:

Используйте команду /npcquest или /npcquests, чтобы открыть интерфейс конфигурации квеста. Вы должны иметь npcquests. Административное разрешение на использование этой команды.

Базовый текст:

1. Выберите NPC из выпадающего списка в верхней части
2. Выберите страницу диалога для этого NPC
3. Выберите, какую кнопку вы хотите настроить (Next, Previous, Close, Custom Button 1, или Custom Button 2).
4. Настройка требований и вознаграждений по мере необходимости
5. щелкнуть Сохранить свои изменения

Типы требований:

Требования к пункту:
Требования к предметам проверяют, есть ли у игрока конкретные предметы в инвентаре, прежде чем позволить ему нажать кнопку. Вы можете добавить несколько требований к одной кнопке.

Для добавления требования к пункту:
Введите идентификатор элемента в поле идентификатора элемента (например: Plant_Fruit_Apple)
- Введите количество, необходимое в количественном поле
Проверьте чекбокс потребления, если вы хотите, чтобы предметы были удалены при выполнении требования.
- Нажмите Add Item Requirement

Для устранения требования к предмету:
Найти требование в списке
Нажмите кнопку Remove рядом с ней

Идентификаторы предметов должны точно соответствовать системе элементов Hytale. Обычные идентификаторы включают Plant_Fruit_Apple, Ore_Iron, Weapon_Sword_Wooden и т.д.

NPC Предварительные условия:
Предпосылки NPC требуют от игроков взаимодействия с другими NPC, прежде чем они смогут получить доступ к определенным кнопкам или NPC. Это создает цепочки квестов, где игроки должны разговаривать с NPC в определенном порядке.

Чтобы добавить условие NPC:
Перейдите в файл npcs.json, найдите NPC и скопируйте идентификатор NPC.
Добавить NPC Prerequisite

Для устранения предпосылки NPC:
Найти предпосылку в списке
Нажмите кнопку Remove рядом с ней

Предпосылки NPC проверяются при:
Игрок пытается взаимодействовать с NPC (проверяет требования к кнопке страницы)
- Игрок нажимает кнопку, настроенную с предпосылками NPC

Если предпосылки не выполнены, игрок видит настраиваемое сообщение о сбое и не может продолжить.

Пользовательские требования:
Пользовательские требования интегрируются с другими плагинами через API RequirementChecker. Это позволяет NPC Dialog проверять условия из других плагинов, таких как экономические системы, системы уровней или пользовательские трекеры квестов.

Чтобы добавить таможенное требование:
Введите идентификатор требования (это зарегистрировано другим плагином через API)
- Введите требуемую сумму (используйте 0 для булевых проверок)
- Нажмите Добавить пользовательские требования

Для устранения таможенного требования:
Найти требование в списке
Нажмите кнопку Remove рядом с ней

Идентификатор требований должен быть зарегистрирован другим плагином с использованием API NPC Dialog. Свяжитесь с разработчиком другого плагина, чтобы узнать, какие идентификаторы требований доступны.

РЕЗУЛЬТАТЫ:

Пункт Вознаграждение:
Награды за предметы дают игрокам предметы, когда они нажимают кнопку, на которой настроены награды. Вы можете добавить несколько вознаграждений в одну кнопку.

Чтобы добавить вознаграждение за товар:
- Введите идентификатор элемента в поле идентификатора элемента
Введите количество, чтобы дать в количественном поле
Нажмите Add Item Reward

Чтобы удалить элемент вознаграждения:
Найдите награду в списке
Нажмите кнопку Remove рядом с ней

Предметы отдаются инвентарю игрока. Если инвентарь заполнен, предметы могут быть потеряны или утеряны в зависимости от настроек сервера.

Custom Rewards:
Пользовательские награды интегрируются с другими плагинами через API RewardProvider. Это позволяет NPC Dialog предоставлять вознаграждения от других плагинов, таких как экономические системы, системы опыта или пользовательские трекеры вознаграждений.

Чтобы добавить награду:
Введите идентификатор вознаграждения (это зарегистрировано другим плагином через API)
Введите сумму, чтобы дать
Добавить Custom Reward

Чтобы удалить заказное вознаграждение:
Найдите награду в списке
Нажмите кнопку Remove рядом с ней

Идентификатор вознаграждения должен быть зарегистрирован другим плагином с использованием API NPC Dialog. Свяжитесь с разработчиком другого плагина, чтобы узнать, какие идентификаторы вознаграждения доступны.

Консольные команды:
Консольные команды выполняют команды сервера, когда нажимается кнопка с наградами. Команды выполняются как консоль, то есть они имеют полные разрешения и могут использовать команды администратора.

Чтобы добавить команду консоли:
Введите полную команду в поле Command (например: give @p Plant_Fruit_Apple --quantity=5)
Добавить команду Console

Чтобы удалить команду консоли:
Найти команду в списке
Нажмите кнопку Remove рядом с ней

Команды поддерживают заполнители, такие как @p для игрока, который запустил кнопку. Все команды выполняются с разрешения консоли.

РЕКОМЕНДУЮЩАЯ ПАГИЧЕСКАЯ КОНФИГРАЦИЯ:

Страница требований - это специальная диалоговая страница, которая отображается, когда игрок впервые взаимодействует с NPC, но не отвечает требованиям для доступа к основному диалогу. Вы можете настроить эту страницу, выбрав «Требуемая страница» из выпадающего списка страницы.

NPC Обязательное сообщение об отказе:
Это сообщение показывается игрокам, когда они не разговаривали с обязательными NPC. Вы можете использовать заполнитель {PREREQNPC} для предварительного имени NPC и заполнитель {NPC} для текущего имени NPC.

Требования Not Met Title:
Этот заголовок отображается в строке заголовка диалога, когда требования не выполняются. Оставьте пустой, чтобы использовать заголовок страницы.

Близкая кнопка Текст:
Текст отображается на кнопке закрытия, когда требования не выполняются. Оставьте пустой, чтобы использовать текст по умолчанию.

Последний БУТТОН:

Функция «Последняя кнопка» позволяет пометить любую кнопку как окончательное взаимодействие с NPC. Когда игрок нажимает последнюю кнопку:

1. Диалог закрывается немедленно
2. Взаимодействие отмечено как завершенное
3. Игрок больше не может взаимодействовать с этим NPC.

Если игрок попытается взаимодействовать с NPC после нажатия последней кнопки, он увидит завершенную страницу вместо обычного диалога.

Чтобы включить последнюю кнопку:
1. Выберите NPC, страницу и кнопку, которую вы хотите сделать последней.
2. Проверьте флажок «Mark as Last Button»
3. Настройка настроек готовой страницы (см. ниже)
4.Нажмите Сохранить

Окончательная сортировка страницы:

Завершенная страница отображается, когда игрок пытается взаимодействовать с NPC после нажатия последней кнопки. Настройте эту страницу в пользовательском интерфейсе администратора, когда включен флажок последней кнопки.

Завершенное название страницы:
Заголовок, показанный в диалоговой строке заголовка при отображении готовой страницы.

Завершенное сообщение страницы:
Главное сообщение, показанное игроку, объясняющее, что они уже завершили это взаимодействие.

Оригинальное название Close Button Text:
Текст отображается на кнопке закрытия готовой страницы.

СТОРОГА данных:

Все данные конфигурации квеста хранятся в файлах JSON в Hyronix_. Папка NPC Quests в каталоге данных вашего сервера. Файл interactionHistory.json отслеживает, с какими игроками взаимодействовали NPC, в том числе какие взаимодействия помечены как завершенные.

Структура папки данных:
Hyronix_NPC Квесты/
- npcs/ (индивидуальные файлы NPC JSON)
- interactionHistory.json (отслеживание взаимодействия игроков)

Интерактивная торговля:

Плагин автоматически отслеживает все взаимодействия игроков с NPC. Это отслеживание используется для:
Проверьте предварительные условия NPC
Предотвращение повторных взаимодействий при включении последней кнопки
Поддерживать состояние прогресса квеста

История взаимодействия хранится на одного игрока и сохраняется при перезапуске сервера. Чтобы сбросить историю взаимодействия игрока, вы можете вручную редактировать или удалять их запись в истории взаимодействия. Джейсон.

БУТТОННАЯ КОНФИГРАЦИЯ:

Вы можете настроить требования и вознаграждения для следующих кнопок:
- Следующая кнопка: Кнопка, которая переходит на следующую страницу диалога
- Предыдущая кнопка: Кнопка, которая возвращается к предыдущей странице диалога
- Кнопка закрытия: Кнопка, которая закрывает диалог
Пользовательская кнопка 1: Первая настраиваемая кнопка (если она включена на странице диалога)
Пользовательская кнопка 2: Вторая настраиваемая кнопка (если включена на странице диалога)

Каждая кнопка может иметь:
- Требования к нескольким пунктам
Несколько предпосылок NPC
- Множественные индивидуальные требования
- Многократное вознаграждение
- Множественные заказные награды
- Несколько команд консоли
Статус последней кнопки

BUTTON WORKFLOW:

Когда игрок нажимает кнопку, происходит следующее:

1. Требования проверяются:
- Требования к пункту: Проверка, требуется ли игроку
- Предпосылки NPC: Проверьте, разговаривал ли игрок с требуемыми NPC
- Пользовательские требования: Проверки с зарегистрированными контрольными требованиями

2. Если какое-либо требование не выполняется:
Сообщение о сбое показывается игроку
- Вознаграждение не выплачивается
- Действие кнопки не продолжается

3. Если все требования проходят:
Потребляемые предметы потребляются (если потребление разрешено)
- Вознаграждаются:
- Награды за товары добавляются в инвентарь
Пользовательские вознаграждения обрабатываются зарегистрированными поставщиками вознаграждений.
Консольные команды выполняются

4. Если включена последняя кнопка:
Диалог закрывается
Взаимодействие отмечено как завершенное
Игрок не может снова взаимодействовать с этим NPC

5. Если последняя кнопка не включена:
Нормальное действие кнопки продолжается (изменение страницы, закрытие диалога и т. Д.)

КВЕСТНАЯ СИСТЕМА USAGE GUIDE

В этом руководстве объясняется, как использовать систему квестов с помощью NPC Dialog, в частности, идентификаторы вознаграждений и требований.

-
Оригинальное название: How to Make a Quest
-
Выполните эти 3 простых шага, чтобы сделать основной квест (называемый квест_a):

1. Начать буттон (Пусть принимают)
- Reward ID:quest:start:quest_a
- Идентификатор требований:quest:status:quest_a:AVAILABLE
Результат: Кнопка показывает, только если у них ее нет. Нажав на него, начинается квест.

2. Финиш Баттон (Пусть завершают)
- Reward ID:quest:complete:quest_a
- Идентификатор требований:quest:active:quest_a
Результат: Кнопка показывает только тогда, когда у них есть квест. Щелчок его завершает его.

3. Следующий бутон (Пусть идут дальше)
- Идентификатор требований:quest:completed:quest_a
Результат: игрок не может нажать «Далее», пока не закончит квест.

-
Идентификаторы переоформления (Action to take)
-
1.quest:start:<quest_id>
- Описание: Запускает указанный квест (устанавливает статус на ACTIVE).
- Примечания: Ничего не делает, если квест уже активен или завершен.

2.quest:complete:<quest_id>
- Описание: Завершает указанный квест (устанавливает статус COMPLETED).

3.quest:set_status:<quest_id>:<status>
- Статусы: Закрыт, доступен, активен, укомплектован.

-
Требование Идентификаторы (Check quest status)
-
1.quest:active:<quest_id>
- Условие: Игрок должен иметь квест в статусе ACTIVE.

2.quest:completed:<quest_id>
- Условие: Игрок должен иметь квест в статусе COMPLETED.

3.quest:status:<quest_id>:<status>
- Условие: Игрок должен обладать определенным статусом.

-
Пример: 4-BUTTON SETUP (жизненный цикл "quest_a")
-

Эта настройка позволяет NPC обрабатывать весь поток квеста с помощью 4 кнопок.

1. КУСТОМ БУТТОН 1: "Принять квест"
- Требования:quest:status:quest_a:AVAILABLE
- Награда: квест: Начало:квест_a
- Логика: Сначала видна только кнопка. Нажатие на него запускает квест и заставляет эту кнопку исчезнуть.

2.КУСТОМ БУТТОН 2: "Полный поиск"
- Требование:quest:active:quest_a
- Награда: квест:полный:квест_a
- Логика: Он появляется только тогда, когда у вас есть квест. На клике, он заканчивает его. (Здесь вы также можете добавить дополнительные требования!)

3. Next Button (Навигация по умолчанию)
- Требование: Quest: Completed:quest_a
- Логика: Эта кнопка «выключена» или скрыта, пока вы не закончите квест. Перейти на следующую страницу диалога можно только после завершения.

4. CLOSE BUTTON (навигация по умолчанию)
- Требования: (нет)
- Логика: Всегда доступен, чтобы игрок мог оставить разговор.

-
СОВЕТ
-
- Множественные требования: Вы можете комбинировать требования к поиску с предметами (например, нужно иметь 5 яблок и квест должен быть активным).
- Выступление: Квесты обрабатываются локально на объекте игрока.

Пермиссионы:

Единственное необходимое разрешение — npcquests. Админ для доступа к команде /npcquest. Вся логика и требования квеста работают автоматически для всех игроков после настройки.

Советы и лучшие практики:

1. Планируйте свои цепочки квестов, прежде чем создавать их. Определите, с какими NPC нужно поговорить в каком порядке.

2. Используйте значимые имена NPC и диалоговый контент, чтобы естественным образом направлять игроков по цепочкам квестов.

3. Тщательно проверьте свои цепочки квестов. Убедитесь, что предпосылки работают правильно, а награды даются правильно.

4. Используйте функцию последней кнопки экономно. Только помечайте кнопки как «Последние кнопки», когда вы действительно хотите предотвратить дальнейшее взаимодействие.

5. Держите ваши идентификаторы требований и идентификаторы вознаграждения задокументированными, если вы интегрируетесь с пользовательскими плагинами. Это облегчает конфигурацию.

6. Используйте команды консоли для сложных сценариев вознаграждения, с которыми элемент или пользовательские вознаграждения не могут справиться.

7. Всегда сохраняйте изменения после настройки требований или вознаграждений. Несохраненные изменения будут потеряны.

8. Пользовательский интерфейс администратора показывает все настроенные требования и вознаграждения. Используйте это для проверки вашей конфигурации перед тестированием в игре.

Беспокойство:

Вопрос: Требования не проверяются
Решение: Убедитесь, что вы выбрали правильный NPC, страницу и кнопку, прежде чем добавлять требования. Убедитесь, что вы нажали Save после внесения изменений.

Вопрос: Вознаграждения не выплачиваются
Решение: проверить, выполняются ли требования. Вознаграждение запускается только тогда, когда все требования проходят. Проверьте, что идентификаторы элементов верны, и зарегистрированы пользовательские идентификаторы вознаграждения.

Вопрос: Предпосылки NPC не работают
Решение: Убедитесь, что предпосылка NPC настроена в NPC Dialog. Предпосылка NPC должна существовать и быть доступной. Проверка истории взаимодействия отслеживается правильно.

Вопрос: Последняя кнопка не препятствует взаимодействию
Решение: Убедитесь, что вы сохранили конфигурацию последней кнопки. Убедитесь, что файл interactionHistory.json написан правильно.

Проблема: Невозможность доступа к admin UI
Решение: Убедитесь, что у вас есть npcquests. Разрешение администратора. Убедитесь, что плагин NPC Dialog установлен и работает. Убедитесь, что NPC Quests загружается без ошибок.

Проблема: Пользовательские требования или вознаграждения не работают
Решение: Убедитесь, что другой плагин зарегистрировал свой RequirementChecker или RewardProvider с помощью NPC Dialog. Проверьте, что идентификаторы требований и идентификаторы вознаграждения точно совпадают между плагинами.

Расширенные объекты:

Добавление NPC Quests включает поддержку API-интерфейсов RequirementChecker и RewardProvider. Другие плагины могут регистрировать пользовательские проверки требований и поставщиков вознаграждений, что позволяет обеспечить глубокую интеграцию между NPC Dialog и другими серверными системами.

ДОКУМЕНТАЦИЯ NPC DIALOG API для разработчиков:

Начинается:

Получите экземпляр плагина:
плагин NPCDialogPlugin = NPCDialogPlugin.getInstance();
если (plugin == null)
Возвращение // NPC Диалог не установлен
?

РЕКОМЕНДУЮЩИЙ CHECKER API:

Регистрируйте пользовательские требования, которым должны соответствовать игроки, чтобы продолжить диалоги NPC.

Интерфейс: com.hytale.npcdialog.api.RequirementChecker

Методы:
Boolean CheckRequirement (Игрок, Требование к струне) Ид
Возвращается, если игрок соответствует требованиям.

Струна получает ErrorMessage (строчное требование) Ид
Необязательно. Возвращает пользовательское сообщение об ошибке или нуль по умолчанию.

Регистрация:
plugin.registerRequirementChecker("economy.money", new RequirementChecker()) {
@Override
Public Boolean CheckRequirement (Игрок, Струнное требование) Id) {
// Проверьте, достаточно ли у игрока денег.
возвратить достаточно денег (игрок);
?
    
@Override
Публичное струнное сообщение (String Requirement) Id) {
возвращение «У вас недостаточно денег»;
?
}

Провайдер API:

Зарегистрируйте пользовательские награды, которые могут быть предоставлены игрокам через взаимодействие NPC.

Интерфейс: com.hytale.npcdialog.api.RewardProvider

Методы:
Boolean GiveReward (Игрок, Стринг) Ид, двойная сумма
Возвращается, если вознаграждение было успешно получено.

Струнная награда (String reward) Ид, двойная сумма
Возвращает сообщение, чтобы показать, когда награда дается.

Регистрация:
plugin.registerRewardProvider("эконом.деньги", новый RewardProvider()) {
@Override
public boolean giveReward (Игрок, Стринг вознаграждение, двойная сумма)
// Дайте деньги игроку
возвратить дополнительные деньги (игрок, сумма);
?
    
@Override
String getRewardMessage (Стринговое вознаграждение) Id, двойная сумма {
возвращение "Вы получили "+сумма +" монеты!"
?
}

USAGE:

После регистрации администраторы могут использовать ваши идентификаторы требований и идентификаторы вознаграждения в пользовательском интерфейсе администратора NPC Quests. Используйте описательные идентификаторы, такие как «yourplugin.feature.requirement».

Убрать:

Незарегистрируйтесь во время отключения плагина:
plugin.unregisterRequirementChecker («эконом.деньги»)
plugin.unregisterRewardProvider («эконом.деньги»)

Уведомление о распространении:
Этот мод не может быть перераспределен или объединен со сторонними настройками без Ясный и видимый кредит Hyronix Studios и название мода. В противном случае перераспределение не допускается.