Настройка IntelliJ IDEA

Эта статья рассказывает о том, как настроить Ваше рабочее пространство в IntelliJ IDEA для разработки плагинов с использованием SpongeAPI и а системы сборки, таких как Maven или Gradle или Плагин разработки Minecraft.

Если вы хотите создать ваш проект полностью с нуля, пожалуйста, пропустите все до секции Gradle или Maven. Используя плагин Minecraft Dev, он установит точку старта и устранит ваши попытки понять что означают те или функции при поднятии вашего проекта «с земли».

Использование IDEA Minecraft Dev плагина для создания рабочей отправной точки

Плагин Minecraft Development для IntelliJ это отличный плагин, который делает процесс создания плагина гораздо проще, а также предоставляет некоторые аккуратные и полезные возможности для разработки. По умолчанию он создаст проект, который использует Gradle как инструмент сборки.

Установка Плагина Разработки Minecraft

Этот плагин доступен в репозитории плагинов JetBrains IntelliJ.

Благодаря нему, вы можете установить плагин через внутренний браузер IntelliJ. Перейдите в File -> Settings -> Plugins и нажмите на кнопку Browse Repositories... внизу окна. В окне поиска просто найдите Minecraft. Вы можете установить его там и перезапустить IntelliJ, чтобы активировать плагин.

Создание Вашего Проекта из Шаблона

  • Откройте IntelliJ IDEA.

  • Нажмите Create New Project.

  • Выберите Minecraft в всплывающем меню.

  • Убедитесь, что в SDK проекта установлена версия 8/1.8 Java.

  • Выберите Sponge plugin для типа вашего проекта, затем нажмите Next.

  • Введите Ваши Group ID, Artifact ID, и Version.

    • Group ID обычно должен соответствовать названию Вашего пакета Java. Для подробностей смотрите Основной класс плагина.

    • Artifact ID обычно должен соответствовать Вашему plugin ID, который задавался Вами ранее, например myplugin.

    • Your Version is up to you. See Номер версии for details.

  • Выберите нужные инструмент сборки, Gradle или Mave, затем нажмите Next.

  • Проверьте **Plugin Name**(имя плагина) и **Main Class Name**(имя главного класса) для убеждения в том, что все верно.

  • Укажите description**(описание), **authors**(авторы), **website**(сайт), и **dependencies**(зависимости плагина) которые вы хотите.

  • Нажмите Next для дальнейших действий.

  • Проверьте имя проекта, местоположение и информацию о модулях, затем нажмите Finish.

  • Плагин создаст основной java файл как точку начала, с введенным журналом. Вы можете добавить logger.info() в событии onServerStart для того, чтобы видеть, что плагин работает когда вы запускаете сервер.

Изменение конфигурации проекта

Перейдите в Gradle или Maven секцию, в зависимости от того, что вы выбрали при создании проекта.

Создание плагина с нуля – Gradle

  • Откройте IntelliJ IDEA.

  • Нажмите Create New Project.

  • Выберите Gradle в раскрывшемся списке.

  • Если вы хотите, выберите любые дополнительные библиотеки и фреймворки, например Kotlin.

  • Убедитесь, что в SDK проекта установлена версия 8/1.8 Java.

  • Нажмите Next для дальнейших действий.

  • Введите Ваши Group ID, Artifact ID, и Version.

    • Group ID обычно должен соответствовать названию Вашего пакета Java. Для подробностей смотрите Основной класс плагина.

    • Artifact ID обычно должен соответствовать Вашему plugin ID, который задавался Вами ранее, например myplugin.

    • Your Version is up to you. See Номер версии for details.

  • Нажмите Next два раза, назовите проект и нажмите Finish.

  • Проект будет создан без каталога src. Если вы добавите java файлы в неправильную директорию проекта, они будут игнорироваться и не будут скомпилированы. Поэтому, рекомендуем поставить флажок на «Create directories for empty content roots», в:

    • Windows: File -> Settings -> Build, Execution, Deployment -> Gradle

    • Mac: Intellij IDEA -> Preferences -> Build, Execution, Deployment -> Build Tools -> Gradle

  • Включение Use Auto-import в том же месте позволит изменить конфигурацию gradle для автоматического обновления без постоянных запросов от IDEA.

  • При включении этих настроек, будет создана директория /src/main/java, где вы можете начать создавать основные файлы кода плагина.

Редактирование Скрипта Сборки

  • Откройте build.gradle в навигаторе и добавьте зависимости.

  • Отредактируйте build-скрипт, как описано в статье Настройка Gradle.

  • Откройте Gradle tab в правой части окна программы и нажмите кнопку обновления (refresh).

  • Установка Gradle завершена! Теперь Вы можете приступить к написанию кода Вашего плагина.

Создание плагина с нуля – Maven

Создание Вашего Проекта

  • Откройте IntelliJ IDEA.

  • Нажмите Create New Project.

  • Выберите Maven в раскрывающемся списке.

  • Убедитесь, что в SDK проекта установлена версия 8/1.8 Java.

  • Нажмите Next для дальнейших действий.

  • Введите Ваши Group ID, Artifact ID, и Version.

    • Group ID обычно должен соответствовать названию Вашего пакета Java. Для подробностей смотрите Основной класс плагина.

    • Artifact ID обычно должен соответствовать Вашему plugin ID, который задавался Вами ранее, например myplugin.

    • Your Version is up to you. See Номер версии for details.

  • Нажмите Next.

  • Введите имя Вашего проекта и нажмите кнопку Finish.

Изменение конфигурации проекта

  • Откройте pom.xml в навигаторе.

  • Отредактируйте build-скрипт, как описано в статье Настройка Maven.

  • Обновите Ваш проект Maven.

  • Импортируйте изменения Maven, если появилась подсказка.

Тестирование Вашего Плагина

Следующие инструкции созданы для быстрого способа тестирования вашего плагина, но не являются самым эффективным способом для постоянной разработки.

Для создания .jar файла, используя Gradle:

  • Перейдите в View -> Tool Windows -> Gradle

  • Под Tasks -> Build, нажмите на jar

  • Процесс сборки должен создать jar в build\libs

Для создания .jar файла, используя Mave:

  • Перейдите в View -> «Tool Windows`` -> Maven Projects

  • В окне Maven Projects, укажите название вашего проекта

  • В Plugins, укажите jar

  • Сделайте двойной щелчок по jar:jar

  • Процесс сборки должен создать jar в taget

Скопируйте ваш jar файл в директорию mods рабочего Sponge сервера, затем перезапустите сервер для проверки.

Для более эффективного процесса разработки, смотрите Отладка плагина для инструкций по запуску как на сервере Sponge, так и плагина внутри IDEA. Этот процесс позволяет вам изменять код плагина без перезапуска сервера.

Импорт Существующего Проекта (Gradle или Maven)

Если вы уже начали работу с вашим проектом и хотите снова импортировать его позже, вам необходимо его импортировать вместо повторного создания внутри вашей IDE:

  • Нажмите Файл > Открыть или Импортировать Проект.

  • Gradle: Переместитесь к файлу build.gradle и выберите его.

  • Maven: Переместитесь к файлу pom.xml и выберите его.

  • Убедитесь, что все настройки верны и нажмите Ок.

Git Интеграция

JetBrain предлагает документацию по интеграции Git:

https://www.jetbrains.com/help/idea/using-git-integration.html