Érc Plugin Benyújtás Iránymutatások

Üdvözöljük a Érc benyújtására vonatkozó iránymutatás. Ez a dokumentum felvázolja a várakozások mindkét projekt fájl beadványt.

Ne feledje, hogy ezek csak irányelvek, valamint az Érc csapat, a továbbiakban a „személyzet” az egész ezeket az irányelveket, előfordulhat, hogy engedélyezi vagy letiltja azt a műveletet, amelyet kifejezetten nem szerepel itt a saját belátása szerint.


Projektek

A benyújtott projektek megfelel az alábbi elvárásoknak:

Név

Your project’s submitted name should not include a version, tagline, or other description. The name should be unique and original and must not have a name implying it is an official Sponge project.

Examples of names that are not acceptable:

  • SpongeWarp
  • SpongeHome
  • SpongeEssentials
  • SpongeCloud

Examples of names that are acceptable:

  • CoolWarps-Sponge
  • MoneyMiner-Sponge
  • Golfball-for-Sponge
  • Calendar-for-Sponge

Fő Dokumentáció Oldal (Home)

Ez az első oldal valaki látja, amikor a látogató a projekt. Információ itt kell tartalmaznia leírása a projekt jellemzői. a következő, ha jelen van a plugin, dokumentálni kell a főoldalon, ha nem dokumentált máshol az Érc projekt: parancsok, konfiguráció, engedélyt csomópontok. Továbbá, az alábbi információkat kell dokumentálni a fő oldal, ha az releváns:

Külső Kapcsolatok

Ha a projekt használ egy web API, telefon haza, hogy adatokat gyűjt, vagy más módon csatlakozik a rendszer külső, hogy a szerver fut, a jelenléte ezt a funkciót, valamint információ arról, hogyan engedélyezéséhez vagy letiltásához meg kell jól láthatóan megjelenik a főoldalon. Ha a projekt egyetlen célja magában foglalja kihasználva egy külső rendszer (mint egy Szivacs plugin, ami lefordítja a chat nyelvek között), konfigurációs opció, hogy a váltás csatlakoztatás, hogy ez a szolgáltatás nem szükséges. Ha a plugin küld adatokat (például plugin lista vagy a játékos adat), az összegyűjtött információkat fel kell tüntetni a főoldalon.

Példák az igénylő rendszerek dokumentáció:

  • Statisztikák vagy a használat, adatok gyűjtése (a továbbiakban mutatók»)
  • Geolocation
  • Translation service
  • Web server fut a plugin szolgáló információkat felhasználók
  • Server that runs on the plugin, listening to requests from other services
  • IRC/Discord/Telegram/WhatsApp bot or relay

Category

A kategóriát válassza a pontos legyen. A projekt használja a legszűkebb kategória lehetséges, inkább, mint bármely kategória, hogy kissé vonatkozik. Ha nem kategória jelenik meg, pontos, az Egyéb kategóriát kell alkalmazni.

Monetization / Advertising

Beadvány nem lehet eladni, sem további funkciók kinyitható a fizetés. Hirdetések, illetve egyéb jövedelemtermelő linkek (pl. adfly) nem megengedett. A dokumentáció tartalmazhat egy linket egy oldalra, hogy donate, hogy a projekt fenntartó, illetve egyéb közreműködők, mint köszi, de az oldalon nem kínál kiegészítő funkciók, vagy más plugins/mod eladó.

“Cracked” / Offline-mode / online-mode=false Support

Projektek, amelyek kifejezetten arra tervezték, hogy az ilyen használat nem engedélyezett. Egyes projektek, mint például a hitelesítési rendszerek, lehet, funkció, ami hasznos lehet a szerverek, függetlenül attól, hogy a szerver használata Mojang hitelesítés, de lehet, hogy nem támogassák ezt a további használat, vagy kifejezetten szerverek, elkerülve a Mojang auth. A projektek célja a proxy igénylő online-mode=hamis megengedett, feltéve, hogy azok nem írtam, hogy megkönnyítse kijátszásának Minecraft számla tulajdonlása.

EULA

Célunk, hogy felel meg teljesen a Mojang EULA. Olyan plugin, szolgáltatások, hozzászólás, és/vagy linkek gyanítható, hogy megsértik az EULA lehet távolítani belátása szerint a Szivacs Személyzet kérésére vagy Mojang AB.

Forks

Villa megengedett, feltéve, hogy azok megfelelnek a tételek az alábbi listát. A személyzet az utolsó szó, hogy mi minősül egy elfogadott villát. Kövesse az engedélyt a szülő projekt megfelelően.

Either:

  • Tartalmaz jelentős változás indokolja, hogy a teremtés egy új projekt. Ezzel elkerülheti, hogy „nem változott az üzenet színek Plugin X most pedig azt állítják, hitel!”, vagy
  • Továbbra is egy plugin, hogy már elhagyott, a bizonyíték arra, hogy a szerző nem válaszol az üzenetekre, illetve kijelentette, hogy a projekt már nem lesz frissítve.

Tudomásul veszi, vagy hitel az elmúlt plugin pedig fejlesztői. Lényegében nem mondja, hogy ez egy új plugin kizárólag a teremtés.


Files

Files submitted should meet the following expectations:

Obfuscation

A file that utilizes obfuscation will be denied unless it falls under the following exception:

NMS Obfuscation

Érvényes ez a plugin, amely referencia-Minecraft, vagy egy Forge mod. Példák erre egy plugin segítségével Mixins vagy egy plugin, amely kétszer akkora, mint egy Forge mod (hibrid plugin). Feltéve, hogy az egyetlen összezavarva hivatkozások összezavarva forrás felhasználásával ForgeGradle vagy VanillaGradle, a plugin lehetővé, hogy folytassa a felülvizsgálati folyamat.

Core Mod-és Mixins: Módosítását a Minecraft Kód Alap

Plugins and mods that use a system that modifies the Minecraft base code at runtime, (such as core mods and mixins) must disclose the edits that they make to the Minecraft code, and their reasoning for them. Sponge plugins should use SpongeAPI where possible. Sponge implementations may implement technical restrictions to prevent such modifications from being applied by default. Files are not permitted to attempt to work around these restrictions, but can notify the user that enhanced functionality can be enabled via the Sponge provided configuration options.

External Connections (Web API, Phoning Home, etc.)

Sok remek funkciók is írta, így kéri, hogy a külső rendszerek. Valamint, hogy egyértelműen dokumentált projekt leírások, ilyen funkciót kell konfigurálható, alapértelmezés szerint le van tiltva. Ha a projekt egyetlen célja magában foglalja kihasználva egy külső rendszer (mint egy Szivacs plugin, ami lefordítja a chat nyelvek között), csatlakoztatása, hogy ez a rendszer nem kell disableable. Ha a plugin küld információkat (pl. egy plugin lista, játékos adatok, vagy a térkép adatok) külső rendszerek, az összegyűjtött információkat fel kell tüntetni a főoldalon (lásd fent).

Metrics (Data Collection)

Whenever data collected about the server (often referred to as „stats” or „metrics” data, such as server or plugin versions, as well as usage information) is to be sent to an external service, the plugin must first query the Sponge API MetricsConfigManager. Documentation on doing so can be found Here. This API must be checked each time data is sent, not only once. Plugins may not modify the values the API returns, but may encourage users to make the decision to enable the collection and sending of this data for their plugin.

Megjegyzés

This API was added in API 7.1.0. Plugins built against older API versions must instead check against a variable in a configuration file unique to that plugin for the enabled/disabled status, which must also default to disabled.

Végrehajtás a Letöltött Kód

Ez biztonsági kockázatot jelent, nem tűrjük. Ez magában foglalja letöltése jar, vagy class fájlokat, generációs bytecode a letöltött források, valamint a végrehajtási shell scriptek.

Monetization / Advertising

All functionality present in your plugin should be usable without restriction, and cannot require a license key to operate. External APIs, such as translation or geolocation services, that require payment for functionality can be allowed but must be discussed among staff prior to approval. Plugins may not be used to display advertisements.

Update Checking

Ellenőrzi a frissítéseket kell végezni a mellékelt Érc API. A plugin nem link sehova, de Érc, amikor a rendező a felhasználók a plugin letölthető az új verziók. Vegye figyelembe, hogy ez a frissítés ellenőrzése számít, mint egy külső kapcsolat, ami kell dokumentálni, amelyek konfigurációs léteznie kell, hogy kikapcsoljam.

Privilege Granting

Check the updates should be done with the supplied Ore API. The plugin doesn’t link anywhere, but Ore, when the director of the users the plugin download the new version. Note that this update checks count as an external relationship that must be documented, which configuration must exist to turn it off.