Developers notes
Developer Notes
Architecture: The plugin is built in a modular way with separate packages for commands (
sirHeadsWin.commands
) and main logic (sirHeadsWin.managers
). It uses a configuration-based approach for languages and messages, enabling easy localization.Extensibility: Developers can extend functionality by adding new commands or events. For example, you might integrate with an economy plugin to give rewards when a category is fully collected. (soon)
Troubleshooting: Ensure that all keys in your
messages_xx.yml
match those referenced in the code. Use the Adventure API for modern text formatting if needed.
Русский
Примеры использования
События по поиску голов: Создайте категорию, например, «Сумеречные головы» и спрячьте головы по всему миру. Используйте команды:
/sirheadswin start Сумеречные головы
– запускает настройку/sirheadswin set "Ты нашёл спрятанную голову!"
– назначает блок/sirheadswin finish Сумеречные головы
– активирует категорию Игрокам будут показываться сообщения о прогрессе (например,[1/7] Осталось найти 6
) и широковещательное сообщение при сборе всех голов.
Сезонные события: Организуйте события для разных сезонов (например, «Зимние головы», «Летние головы»). Настраивайте сообщения и звуки в файлах перевода для каждого события.
Заметки для разработчиков
Архитектура: Плагин построен модульно с разделением на пакеты для команд (
sirHeadsWin.commands
) и основной логики (sirHeadsWin.managers
). Для локализации используется конфигурационный подход, что позволяет легко добавлять новые языки или изменять сообщения без изменений в коде.Расширяемость: Разработчики могут расширять функционал, добавляя новые команды или интегрируя плагин с другими системами, например, с плагином экономики для выдачи наград. Можно добавить собственные события (Events), чтобы другие плагины могли реагировать на сбор голов. (soon)
Отладка: Проверьте, чтобы все ключи в файлах
messages_xx.yml
совпадали с тем, что используется в коде. Рекомендуется использовать систему контроля версий для удобного отслеживания изменений и исправлений.
Last updated