Bijih Plugin Panduan Pengajuan

Peringatan

This document refers to an outdated SpongeAPI version and is no longer actively maintained. The policies, guidelines, and some links have changed. Please refer to the latest version of the documentation instead.

Selamat datang di Bijih panduan pengajuan. Dokumen ini memberikan garis besar harapan kami untuk investasi proyek dan file kiriman.

Ingat bahwa ini hanya pedoman dan Bijih tim, yang disebut sebagai "staf" semua pedoman ini, dapat memilih untuk mengizinkan atau melarang suatu tindakan yang tidak secara eksplisit tercantum di sini, di kebijaksanaan kami sendiri.

Proyek

Proyek yang diajukan harus memenuhi harapan sebagai berikut:

Nama

Proyek ini diserahkan nama tidak harus mencakup versi, tagline, atau keterangan lainnya. Nama harus unik dan asli dan tidak harus memiliki nama yang menyiratkan itu adalah Spons proyek (misalnya SpongeWarp tidak diperbolehkan, Keren Warps untuk Sponge).

Halaman Dokumentasi Utama (Beranda)

Ini adalah halaman pertama ada yang melihat ketika mengunjungi proyek Anda. Informasi di sini harus mencakup deskripsi fitur proyek Anda. Berikut, jika hadir dalam Anda Plugin, harus didokumentasikan di halaman utama jika tidak didokumentasikan di tempat lain di Ore proyek: perintah, konfigurasi, dan node izin. Selain itu, informasi di bawah harus didokumentasikan di halaman utama jika relevan:

Koneksi Eksternal

Jika proyek anda menggunakan web API, telepon rumah untuk mengumpulkan data, atau jika tidak terhubung ke sistem eksternal ke server berjalan pada, kehadiran fitur ini juga sebagai informasi tentang bagaimana untuk mengaktifkan atau menonaktifkan itu harus ditampilkan dengan jelas di halaman utama. Jika proyek anda satu-satunya tujuan melibatkan memanfaatkan sistem eksternal (seperti Spons plugin yang menerjemahkan obrolan antara bahasa), pilihan konfigurasi untuk beralih membuat sambungan ke layanan yang tidak diperlukan. Jika plugin anda mengirimkan informasi (misalnya, plugin atau daftar data pemain), informasi yang dikumpulkan harus tercantum pada halaman utama.

Contoh sistem yang memerlukan dokumentasi:

  • Statistik atau penggunaan pengumpulan informasi ('metrik')

  • Geolokasi

  • Layanan terjemahan

  • Web server yang berjalan pada plugin, menyajikan informasi kepada pengguna

  • Server yang berjalan pada plugin, mendengarkan permintaan dari layanan lain

  • IRC/Perselisihan/Telegram/WhatsApp bot atau relay

Kategori

Kategori yang Anda pilih harus akurat. Proyek Anda harus menggunakan kategori sempit mungkin bukan kategori yang sedikit berlaku. Jika tidak ada kategori muncul akurat, kategori Miscellaneous harus digunakan.

Monetisasi / Iklan

Kiriman tidak dapat dijual, atau mungkin tambahan fitur unlockable dengan pembayaran. Iklan dan pendapatan lain menghasilkan link (misalnya ratusan pengunjung) tidak diizinkan. Dokumentasi ini mungkin berisi link ke sebuah halaman untuk menyumbang ke proyek pengelola atau kontributor lainnya seperti terima kasih, tapi halaman yang tidak mungkin menawarkan fitur tambahan atau plugin lainnya/mods untuk dijual.

"Retak" / modus Offline / online-mode=false Dukungan

Proyek-proyek yang secara eksplisit menyatakan mereka dirancang untuk penggunaan seperti tidak diperbolehkan. Beberapa proyek, seperti sistem otentikasi, mungkin memiliki fungsi yang dapat berguna untuk server terlepas dari penggunaan server otentikasi Mojang, tetapi mereka mungkin tidak mempromosikan penggunaan tambahan atau secara khusus dirancang untuk server menghindari Mojang auth. Proyek yang dirancang untuk proxy yang membutuhkan secara online-mode = false diperbolehkan, asalkan mereka tidak ditulis untuk memfasilitasi pengelakan Minecraft kepemilikan akun.

EULA

Kami bertujuan untuk mematuhi sepenuhnya dengan Mojang EULA. Plugin, jasa, posting, dan/atau link diduga melanggar EULA dapat dihapus pada kebijaksanaan dari Sponge Staf atau atas permintaan Mojang AB.

Garpu

Forks diperbolehkan, asalkan mereka memenuhi semua item dalam daftar di bawah ini. Staf memiliki kata akhir dalam apa yang merupakan garpu diterima. Ikuti lisensi proyek induk tepat.

Antara:

  • Mengandung perubahan yang signifikan yang memerlukan penciptaan sebuah proyek baru. Hal ini untuk menghindari "saya mengubah pesan warna di Plugin X dan sekarang saya mengklaim kredit!", atau

  • Melanjutkan Plugin yang telah ditinggalkan, dengan bukti penulis belum menjawab pesan atau telah menyatakan proyek ini akan tidak lagi diperbarui.

Mengakui atau kredit masa lalu Plugin dan pengembang. Pada dasarnya, tidak mengklaim itu adalah baru Plugin dan eksklusif kreasi Anda.

Berkas

Berkas yang diajukan harus memenuhi harapan sebagai berikut:

Kebingungan

Berkas yang memanfaatkan kebingungan akan ditolak kecuali berada dalam pengecualian berikut:

NMS Kebingungan

Ini hanya berlaku untuk plugin yang referensi Minecraft atau mod Forge. Contoh akan menjadi plugin yang menggunakan mixin atau plugin yang yang berfungsi sebagai Forge mod (hybrid Plugin). Asalkan satu-satunya referensi dikaburkan adalah sumber dikaburkan dihasilkan menggunakan ForgeGradle atau VanillaGradle, yang Plugin diperbolehkan untuk melanjutkan melalui proses peninjauan.

Mods inti dan mixin: Modifikasi Minecraft Basis Kode

Plugin dan mods yang menggunakan sistem yang mengubah kode dasar Minecraft saat runtime, (seperti mods inti dan mixin) harus mengungkapkan suntingan yang mereka buat untuk kode Minecraft, dan alasan mereka untuk mereka. Sponge plugin harus menggunakan spons API mana mungkin. Sponge implementasi dapat menerapkan pembatasan teknis untuk mencegah modifikasi tersebut dari yang diterapkan secara default. Berkas tidak diizinkan untuk mencoba untuk bekerja di sekitar pembatasan ini, namun dapat memberitahu pengguna bahwa peningkatan fungsi dapat diaktifkan melalui Sponge disediakan opsi konfigurasi.

Koneksi eksternal (Web API, Menelepon Rumah, dll.)

Banyak fitur yang besar dapat ditulis dengan membuat panggilan ke sistem eksternal. Serta yang jelas didokumentasikan dalam deskripsi proyek, fungsi tersebut harus dikonfigurasi dan dinonaktifkan secara default. Jika satu-satunya tujuan proyek Anda melibatkan memanfaatkan sistem eksternal (seperti Sponge Plugin yang menerjemahkan obrolan antara bahasa), menghubungkan ke sistem yang tidak perlu disableable. Jika Anda Plugin mengirimkan informasi (e.g. plugin yang daftar, data yang player, atau data peta) ke sistem eksternal, informasi yang dikumpulkan harus tercantum pada halaman utama (lihat di atas).

Pelaksanaan Kode yang diunduh

Ini adalah resiko keamanan yang tidak akan kami tolerir. Ini termasuk mengunduh berkas jar atau kelas, generasi kode byte dari sumber yang diunduh, dan pelaksanaan perlindungan naskah.

Monetisasi / Iklan

Semua fungsi hadir dalam Anda Plugin harus dapat digunakan tanpa batasan, dan tidak bisa memerlukan kunci lisensi untuk beroperasi. API eksternal, seperti terjemahan atau geolocation jasa, yang memerlukan pembayaran untuk fungsi dapat diperbolehkan tetapi harus dibicarakan antara staf sebelum persetujuan. Plugin tidak dapat digunakan untuk menampilkan iklan.

Perbarui Pemeriksaan

Memeriksa pembaruan harus dilakukan menggunakan yang disediakan Ore API. Anda Plugin mungkin tidak menghubungkan mana saja tapi Ore ketika mengarahkan pengguna Anda Plugin untuk men-download versi baru. Perhatikan bahwa update ini memeriksa dianggap sebagai koneksi eksternal, yang harus didokumentasikan dan yang konfigurasi harus ada untuk menonaktifkannya.

Pengabulan hak istimewa

Plugin tidak harus memberikan atau mencabut fitur akses untuk setiap pengguna tertentu atau kelompok pengguna ditentukan oleh pengembang plugin. Ini termasuk pemberian penulis sendiri yang khusus menampilkan nama atau membiarkan diri menggunakan perintah khusus. Fitur, ketika berlaku, harus terkunci di balik izin node, daripada akses yang telah ditentukan oleh penulis. Perintah untuk pemberian spesifik, pra-diprogram pengguna OP atau izin tidak dapat diterima.