Build Systems

Les Build systems comme Gradle ou Maven peuvent gérer la construction de vos projets. Comme un outil indépendant de votre IDE, vous pouvez l’utiliser pour gérer votre dépendance de SpongeAPI ou d’autres plugins et permettre à d’autres développeurs de facilement construire votre plugin depuis la source.

Note

Il n’est pas obligé d’utiliser un build system pour créer des plugins avec SpongeAPI, cependant nous recommandons fortement d’en utiliser un. À l’exception de la courte explication à Créer un plugin sans build system, les parties suivantes assument que vous utiliser un build system, qui gérera les dépendances pour vous.

Généralement, vous pouvez utiliser n’importe quel build system qui supporte Maven dependencies, qui est un standard supporté par la majorité d’entre eux pour des projets Java. La section suivante sera axée sur Gradle et Maven, qui sont deux des plus utilisé. Si vous ne savez pas lequel utiliser, nous recommandons Gradle puisqu’il est utilisé pour les projets Sponge et fourni la meilleure intégration pour les plugins Sponge.

Gradle

Gradle utilise un script basé sur Groovy pour configurer les projets. Un projet Gradle typique consiste en un fichier build.gradle dans le dossier racine de votre projet, qui indique à Gradle comment construire le projet.

Astuce

Référez vous au Gradle User Guide pour l’installation et l’introduction des concepts de base de Gradle. Si vous n’êtes intéressé que par comment utiliser Gradle pour un simple projet Java, le meilleur endroit où commencer serait le Gradle Java Quickstart.

Configurez votre espace de travail comme indiqué dans Mise en Place de votre Espace de Travail puis suivez Configurer Gradle.

Maven

Maven utilise une configuration basée sur XML appelée Project Object Model (ou POM) pour configurer vos projets. Un projet Maven typique contient un fichier pom.xml dans le dossier racine de votre projet, qui indique à Maven comment construire votre projet.

Astuce

Référez vous au Maven Users Centre pour l’installation et l’introduction des concepts de base de Maven. Si vous n’êtes intéressé que par comment utiliser Maven pour un simple projet Java, le meilleur endroit où commencer serait Maven in 5 Minutes.

Configurez votre espace de travail comme indiqué dans Mise en Place de votre Espace de Travail puis suivez Configurer Maven.

Créer un plugin sans build system

Il est également possible de créer un plugin Sponge sans utiliser de build system, seulement avec les outils inclus dans votre IDE.

Avertissement

Nous vous suggérons fortement de ne pas utiliser SpongeAPI sans système de construction. Sur le long terme, l’utilisation d’un build system simplifie le processus de développement pour vous comme pour toutes les personnes souhaitant contribuer à votre projet. Cette méthode de développement de plugins ne reçoit aucun test par l’équipe de Sponge.

Pour le développement de plugins sans build system vous devez télécharger SpongeAPI manuellement depuis la SpongeAPI Download Page. Nous fournissons un shaded artifact qui contient toutes les dépendances requises qui auraient été téléchargées automatiquement avec un build system.

Après avoir téléchargé ce shaded artifact et ajouté ce dernier dans votre IDE, vous pouvez commencer à développer votre plugin. Continuez vers Identifiants de Plugins pour choisir un identifiant pour votre projet, puis continuez vers Classe Principale du Plugin.