Система сборки

Системы сборки такие как Gradle или Maven могут управлять процессом сборки ваших проектов. Этот инструмент не зависит от IDE. Он может управлять зависимостями вашего проекта от SpongeAPI или других плагинов. Так же он позволяет другим людям легко собирать ваш плагин из исходных файлов.

Примечание

Использование SpongeAPI в качестве зависимости при создании плагинов не обязательно, однако мы настоятельно рекомендуем использовать именно его. В следующих частях предполагается, что вы используете системы сборки, которые могут управлять зависимостями, за одним исключением в теме Создание плагина без использования систем сборки.

Как правило, можно использовать любую систему сборки, которая поддерживает зависимости из Maven репозитория, который по умолчанию включен в большинство систем сборки Java проектов. Следующие разделы будут сосредоточены на двух наиболее популярных системах сборки Gradle и Maven. Если вы не знаете какой из них выбрать, то мы рекомендуем использовать Gradle, так как он так же используется для проектов Sponge и обеспечивает лучшую интеграцию со Sponge плагинами.

Gradle

Gradle uses Groovy or Kotlin based scripts for configuring projects. A Gradle project typically consists of a build.gradle file in your project’s root directory, which tells Gradle how to build the project.

Совет

См. Gradle User Guide для установки Gradle и изучения общих понятий, используемых в Gradle. Если вам интересно только то, как использовать Gradle для простого Java-проекта, см. Gradle Java Quickstart.

Настройте свое рабочее пространство, как описано в Подготовка рабочего пространства, затем Gradle, как описано в Настройка Gradle.

Maven

Maven использует XML-конфигурации под названием Project Object Model (или ПОМ) для настройки проектов. Maven проект обычно содержит файл pom.xml в корневом каталоге проекта, который говорит Maven как построить проект.

Совет

См. Maven User Guide для установки Maven и изучения общих понятий, используемых в Maven. Если вам интересно только то, как использовать Maven для простого Java-проекта, см. Maven in 5 Minutes.

Настройте свое рабочее пространство, как описано в Подготовка рабочего пространства, затем Maven, как описано в Настройка Maven.

Создание плагина без использования систем сборки

Также можно создавать Sponge плагины без использования систем сборки, используя только инструменты вашей IDE.

Предупреждение

Мы настоятельно рекомендуем использовать SpongeAPI только через системы сборки. В долгосрочной перспективе использование систем сборки упрощает процесс разработки для вас и других людей, желающих внести в ваш проект свою лепту. Команда Sponge не одобряет методы разработки плагинов без использования систем сборки.

For developing plugins without a build system, you need to download the SpongeAPI dependency manually from the SpongeAPI Download Page. For developing without a build system, we provide the shaded artifact which bundles all dependencies that would normally be automatically downloaded by the build system.

После загрузки shaded артефакта и добавления его к проекту в IDE, вы можете начать разработку вашего плагина. Обратитесь к Идентификаторы плагина для выбора идентификатора вашего проекта, затем обратитесь к Основной класс плагина.