Configurer Maven

Ajoutez ce qui suit au bloc <project> de votre pom.xml pour ajouter la dépendance SpongeAPI :

<repositories>
    <repository>
        <id>sponge</id>
        <url>https://repo.spongepowered.org/maven</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>org.spongepowered</groupId>
        <artifactId>spongeapi</artifactId>
        <version>5.1.0</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Utiliser l’Archétype du Plugin

Alternativement, Sponge a un archétype simple qui génère la structure de base d’un plugin.

Le fichier pom généré inclue un profil de sortie qui génère un jar de signature gpg pour javadocs, le binaire, et les sources comme il est recommandé dans les règles de validation de projets au Sonatype OSS (Cependant, cette option n’est actuellement pas disponible pour les plugins Sponge du fait que l’API Sponge n’est actuellement pas hébergée par Maven Central).

Propriétés

Le plugin archétype accepte quelques propriétés :

Propriété	Valeur d’exemple	Description
groupId	io.github.user	Le groupId maven, plus utile pour les plugins utilisés comme dépendances, mais qui devrait correspondre plus ou moins au nom de votre package
artifactId	monprojet	L’id du projet, également utilisé comme id du plugin et nom du dossier généré
version	1.0-SNAPSHOT	La version initial de votre plugin. Peut (et devrait) être changé au fur et à mesure que le développement progresse
package	io.github.user.monproject	Le package dans lequel la classe de votre plugin sera générée
githubProject	utilisateur/depot	Le projet GitHub. Si la valeur spécifiée n’est pas de type utilisateur/dépôt, le suivi d’erreurs et les sections SCM sont ajoutés au fichier pom

Celles-ci peuvent être spécifié comme arguments à Maven de cette manière -Dproperty=value

Usage

Cet archétype requière Maven 3 ou plus récent. Utilisez maven avec la commande archetype:generate. Maven vous demandera toutes les propriétés requises, mais les propriétés optionnelles doivent être spécifiées dans la ligne de commande.

$ mvn archetype:generate -DarchetypeArtifactId=sponge-plugin-archetype -DarchetypeGroupId=org.spongepowered -DarchetypeRepository=http://repo.spongepowered.org/maven -DarchetypeVersion=1.2 -DgithubProject=waylon531/spongeparty

Les quatre premiers arguments spécifient où est ce que maven trouvera l’archetype et quelle version utiliser. Le paramètre -DgithubProject=waylon531/spongeparty est une propriété optionnelle pour le projet généré et peut être laissée de coté si vous n’avez pas l’intention d’héberger votre plugin sur GitHub.

Après que votre projet soit généré, vous aurez besoin de l’importer dans votre IDE. Voir Mise en Place de votre Espace de Travail pour plus de détails.