Mempersiapkan Maven

Tambahkan baris berikut ke <project> blok pom.xml untuk menambah SpongeAPI ketergantungan:

<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>

Menggunakan Archetype Plugin

Sebagai alternatif, Sponge memiliki pola dasar sederhana yang menghasilkan struktur dasar umtuk sebuah plugin.

Yang dihasilkan pom termasuk profil pelepasan yang menghasilkan gpg-ditandatangani botol untuk javadocs, biner, dan sumber-sumber yang direkomendasikan dalam pedoman untuk mengajukan proyek-proyek untuk Sonatype OSS (Namun, pilihan ini tidak tersedia saat ini untuk Sponge plugin karena fakta bahwa Spons API saat ini tidak di-host di Maven Central).

Kekayaan

Arketipe plugin menerima beberapa sifat:

Properti

Nilai contoh

Deskripsi

groupId

io.github.user

Maven groupId, lebih berguna untuk plugin yang digunakan sebagai ketergantungan, tetapi harus lebih atau kurang sesuai dengan nama paket

artifactId

proyek saya

Id proyek, juga digunakan sebagai plugin id dan nama folder yang dihasilkan

versi

1.0-poto

Versi awal untuk plugin anda, bisa (dan seharusnya) diubah seiring perkembangan pembangunan

paket

io.github.pengguna.myproject

Paket kelas plugin anda akan dihasilkan

proyekgithub

pengguna/repo

Proyek GitHub. Jika nilai yang ditentukan yang tidak user/repo, pelacakan masalah dan SCM bagian ditambahkan ke pom

Ini dapat ditentukan sebagai argumen untuk Maven di bentuk -Dproperty=nilai

Pemakaan

Pola dasar ini membutuhkan Maven 3 atau yang lebih baru. Memohon maven dengan tujuan pola dasar:menghasilkan. Maven akan meminta untuk setiap diperlukan sifat, tetapi opsional sifat yang harus ditentukan pada baris perintah.

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

Pertama empat argumen yang menentukan di mana maven akan menemukan pola dasar dan versi yang digunakan. -DgithubProject=waylon531/spongeparty parameter adalah opsional properti untuk dihasilkan proyek dan dapat dibiarkan keluar jika anda tidak berniat untuk menjadi tuan rumah plugin anda di GitHub.

Setelah proyek anda telah dihasilkan, anda perlu impor dalam IDE anda. Lihat ../kerja/index untuk rincian.