Configuración de Maven
Añadir lo siguiente para el bloque <project>
de su pom.xml
para agregar la dependencia de 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>6.0.0</version>
<scope>provided</scope>
</dependency>
</dependencies>
Utilizando el Arquetipo del Complemento
Alternativamente, Sponge tiene un arquetipo simple que genera la estructura básica para un complemento.
El pom generado incluye un perfil de lanzamiento que genera jars con firma gpg para Javadocs, binarios y fuentes recomendadas en los lineamientos para enviar el proyecto a Sonatype OSS (Sin embargo, esta opción no está disponible actualmente para complementos de Sponge debido a que la la Sponge API actualmente no está alojado en Maven Central).
Propiedades
El complemento del arquetipo acepta algunas propiedades:
Propiedad |
Valor de ejemplo |
Descripción |
---|---|---|
groupId |
io.github.user |
El groupId de maven, más útil para los complementos utilizados como dependencia, pero debería coincidir más o menos con el nombre de su paquete |
artifactId |
myproject |
El ID del proyecto, también se utiliza como ID del plugin y nombre de la carpeta generada |
versión |
1.0-INSTANTÁNEA |
La versión inicial de su complemento. Puede (y debe) ser cambiado mientras progresa el desarrollo |
paquete |
io.github.user.myproject |
El paquete de su clase de complemento será generado en |
githubProject |
usuario/repo |
El proyecto GitHub. Si un valor es especificado que no es usuario/repo, el seguimiento del problema y las secciones SCM son agregados al pom |
Éstos pueden ser especificados como argumentos de Maven en la forma -Dproperty=value
Uso
Este arquetipo requiere Maven 3 o más reciente. Invoca a Maven con la meta archetype:generate
. Maven indicará cualquier propiedad requerida, pero las propiedades opcionales deben ser especificadas en la línea de comando.
$ mvn archetype:generate -DarchetypeArtifactId=sponge-plugin-archetype -DarchetypeGroupId=org.spongepowered -DarchetypeRepository=https://repo.spongepowered.org/maven -DarchetypeVersion=1.2 -DgithubProject=waylon531/spongeparty
Los primeros cuatro argumentos especifican donde maven encontrará el arquetipo y que versión utilizar. El parámetro -DgithubProject=waylon531/spongeparty
es una propiedad opcional para la generación de proyecto y puede ser omitida si no pretende alojar su complemento en GitHub.
Después que su proyecto ha sido generado, necesita importarlo en su IDE. Vea Configuración de su Espacio de Trabajo para más detalles.