鉱石プラグイン提出に関するガイドライン

歓迎の提出に関するガイドライン鉱石. このドキュメントの概要当社への期待の両方のプロジェクトファイルを投稿.

これだけのガイドラインの鉱石チーム, と呼ばれる “スタッフ” このガイドライン, 場合により、又は不可というアクションが明示的にリストされていない場では当社独自の判断.


案件

提出したプロジェクトの期待:

Name

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

主なドキュメンテーションページ (ホーム)

このページも見越しの際はプロジェクト. 情報がここに含める必要がありま説明プロジェクトの特徴. 以下, 場合に存在するプラグイン, 文書化されるべきであるメインページに記載されていない場合のその他の鉱山プロジェクト: コマンド, 設定, 許可ノード. さらに, 以下の情報キュメント化する必要がありますのページに関連する場合:

外部接続

の場合のプロジェクトweb API, 電話がホームデータを収集する, その他に接続システム外部のサーバーでないようにするには、, このような特徴などについての情報を有効または無効になければ目立つ場所に掲示し、メインページ. 場合はプロジェクトの目的を活用し、外部システム (など Sponge plugin 変換するチャットと言語), 設定オプションを切り替える作りにつながるサービスが不要. 場合はプラグイン情報を (例えば, plugin リストまたはプレイヤーデータ), 収集した情報に記載されていることをメインページ.

例システムを必要とする書類:

  • 統計の利用情報の収集 (‘メトリクス’)
  • ジオロケーション
  • 翻訳サービス
  • Webサーバ上で稼動するプラグイン, ィ情報をユーザー
  • サーバ上で稼動するプラグイン, 試聴からの要請その他サービス
  • IRC/Discord/Telegram/WhatsApp bot or relay

カテゴリ

カテゴリの選択は正確な. プロジェクトは最も狭い分類できなカテゴリにもと若干の適用. ない場合、カテゴリーが表示され精度, その他のカテゴリを使用する必要があります.

Monetization / Advertising

提出場することはしません。, せ機能を追加する解錠可能と支払い. 広告やその他の収益の発生のリンク (例えばadfly) は許可されない. の文書が含まれている場合がありめのリンクページへの寄付は、プロジェクトメンテナ又はその他の拠出者として感謝がる場合がありますので、あらかじめ提供してはならない追加機能やその他の プラグイン/改造 販売.

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

件を明示できるように設計されていなどの利用不可. プロジェクト, などの認証システム, して機能するために活用できるサーバーにかかわらずサーバーの利用Mojangの認証, ということを推進追加利用する専用のサーバーを避け、Mojang auth. 施設の特徴を活かしたサービスのための委任状が必要 オンライン-モード=falseの場合せ, 迂回を容易にするために書かれていない Minecraft 口座を保有.

EULA

を目指して完全には順守し、 Mojang EULA. 他のプラグイン, サービス, 投稿, そして/リンク違反の疑いがあるの EULA 削除される可能性がありの判断により Sponge スタッフ又は要請 Mojang AB.

フォーク

フォークを許可, いすべて満たす事項を以下にリスト. スタッフが最後に何をもって受付フォーク. のライセンスの親会社のプロジェクトを適切に.

のいずれか:

  • を含む重要な変更証を、新しいプロジェクト. これを回避することであ “私のメッセージ色Xプラグインになっ請求項信用!”, または
  • 継続プラグインがされてい, 証を著していない応答メッセージまたは述べてのプロジェクト間の更新.

ご了承くは信用のプラグインの開発. 基本的に, いである」といった新しいプラグインが、リスクや不確実性を自分で作り出し.


ファイル

ファイルで提出するためにサーバーに接続でき、以下の期待:

難読化

ファイルを利用した難読化されに該当する場合を除き、以下の例外:

NMS Obfuscation

これだけ適用されるプラグインを参照する Minecraft や鍛mod. 参考にすべきではないでしょうかプラグインを使用Mixinsやプラグインと併用でForge mod (プラグインハイブリッド). のみobfuscated参照をobfuscated源を用いて生成する ForgeGradle または VanillaGradle, プラグインが進行する審査プロセス.

コア Mods そして Mixins: の変更 Minecraft ベースコード

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

多くの大きな特徴できるようにとの通話を外部システム. ど明瞭に文書化したプロジェクトの説明, などの機能を設定可能、初期状態で無効にするようにした. 場合はプロジェクトの目的を活用し、外部システム (など Sponge プラグイン変換するチャットと言語), 接続するシステムの必要のないdisableable. 場合はプラグイン情報を (例えば、プラグイン一覧, プレイヤーデータ, や地図データ) 外部システム, 収集した情報に記載されていることをメインページ (上記参照).

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.

注釈

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.

Execution of Downloaded Code

このセキュリティリスクのない許容. このダウンロードを含むjarまたはクラスファイル, 世代のbytecodeからダウンロード源, 実行シェルスクリプト.

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.

更新チェック

チェックのための更新プログラムの実行を使用して鉱石 API. プあたりのリンクで鉱石が演出のユーザーのプラグインをダウンロードは、新しいバージョン. この更新チェックカウントとして外部接続, るキュメント化する必要があります、設定が存在しなければならな無効にすることもでき.

Privilege Granting

プラグインな助成又は取り消す機能へのアクセスは、特定のユーザーまたはグループのユーザーが定めるプラグイン開発. この中には著者の権を与えうる特別の表示名させたりすること自体が特徴のコマンド. 特徴, 適用できる場合, ロックする必要があ背後にノードを許可, よりアクセスが所定の著者. コマンドを与えるための特定, 事前にプログラムのユーザーまたはOP権限がない可能.