JouTak Plugin Template (Kotlin)

Заготовка для плагина на JouTak (ДжоуТек) (joutak.ru)

Перед использованием

1. Отредактируйте:
   • gradle.properties — укажите версию и название плагина, а также используемые версии Minecraft, Kotlin и Java
   • src/main/kotlin/com/joutak/ — переименуйте основной класс под название вашего плагина
   • src/main/resources/plugin.yml — укажите правильный путь до основного класса плагина и укажите себя как автора
   • Укажите полный путь до тестового сервера в переменной окружения системы SERVER_PATH

Tip

Указав путь до тестового сервера, можно собирать плагин с помощью конфигурации [Snapshot] Build, тогда jar-архив с вашим плагином сразу будет создаваться в нужной папке автоматически.

Сборка плагина

1. Открыть проект в IntelliJ IDEA
2. Нажать кнопку Run справа сверху для сборки:
   • [Snapshot] создает архив с плагином в папке plugins/ тестового сервера (путь до которого нужно указать в переменной окружения SERVER_PATH)
   • [Release] создает архив с плагином в папке build/ проекта

Перед началом выполнения тестового задания

Note

Данный параграф предназначен для тех, кто захотел попробовать себя в роли разработчка плагинов для Minecraft серверов в составе команды JouTak.

Базовое описание, что нужно сделать:

1. Сделать собственный fork данного репозитория
2. Склонировать созданный репозиторий себе по SSH (git clone)
3. Открыть проект в любой удобной для вас IDE

Tip

Рекомендуем использовать IntelliJ IDEA, так как полноценная поддержка Kotlin'а со всеми фишками и плюшками есть только в ней, но выбор за вами

4. Разобраться с расположением папочек и синтаксисом Kotlin'а, затем прописать базовую логику, которая была описана в вашем задании в issues (Любая креативность поощряется)
5. Собрать плагин с помощью Gradle

Tip

Конфиги уже заранее прописаны (один для тестовых целей, второй для полноценного релиза), вам самим ничего прописывать не надо. Для тестов лучше использовать [Snapshot] версию, чтобы каждый раз не перекидывать вручную плагин в папку сервера, главное не забудьте создать переменную окружения SERVER_PATH!

6. Запустить на своем компьютере локальный Purpur сервер
7. Подключиться на свой локальный сервер и проверить, что плагин работает исправно
8. Отправить pull request на GitHub и дождаться ответа

Tip

Если долго никто не отвечает, то можно пингануть кого-нибудь, чтобы реквест отсмотрели и приняли :)

Если плагин написан без базовых ошибок (синтаксических и т. п.), то на GitHub'е автоматически соберется такой же jar-архив, который будет так же работать на твоем локальном сервере.

Поначалу всё можно писать в основном классе, но потом все вещи по типу команд, listener'ов и различные event'ы нужно выделить в отдельные классы и пакеты.

Important

Главное, если есть какие-то вопросы - не стесняйся спрашивать!