インストールコマンド
プラグインを新規インストールします。
コマンド概要 - /kpm install
プラグインを新規インストールします。
コマンドの実行結果と入力の説明はこちらを参照してください。
エイリアス
- i
コマンド構文
install <クエリ>
第一引数には、対象のプラグインの有効なクエリを指定します。
権限
kpm.install
kpm.*
スクリーンショット
インストールの流れ
インストールコマンドを発行した後の KPM の動作と、ユーザが必要な操作を包括的に説明しています。
動作1. クエリを解決する
インストール対象のプラグインの .jar ファイルをダウンロードするために、クエリを解決し直リンクを入手します。
また、プラグインの候補が複数ある場合、インストーラはそれらを全て表示して選択を促します。
選択肢
選択は、チャットまたはコンソールに選択肢をそのまま入力します。
/
や *
などの接頭辞は入力する必要ありません。
0. - ...
や、1. - ...
など、候補のインデックスがある選択肢
これは、通常のプラグインの候補です。基本的に、プラグインに複数のリリースまたはバージョンがある場合に表示されます。a - 自動で最適なプラグインを選択する
この選択肢を選ぶと、インストーラは自動で最適なプラグインを選択しようとします。基本的に最新のバージョンのプラグインが選択されますが詳しくは以下を参照してください。
c - キャンセル
インストールをキャンセルします。
動作2. プラグインをダウンロードする
選択されたプラグインの .jar ファイルをダウンロードします。
これに関して、特に選択肢はありません。
動作3. 環境をチェックする
KPM はプラグインとサーバ、および KPM に互換性があるかどうかを確認します。
チェックされる項目は以下の通りです:
プラグインが除外リストに含まれているかどうか
プラグインが除外リストに含まれている場合、かつ強制的にインストールできる場合は、以下の選択肢が表示されます。
y - はい
警告を無視してプラグインをインストールします。危険この警告はシステムを保護するために表示されています。これを無視すると、予期しない問題を引き起こす可能性があります。
n - いいえ
インストールをキャンセルし、全てのキャッシュを破棄します。
プラグインが重複していないかどうか
PaperMC(Bukkit) のプラグインは重複を許可しません。そのため、重複したプラグインはどちらか一方が適用されます。 重複したプラグインをインストールしようとした場合、それぞれのプラグインの基本情報と、インストールを続行するかどうかを選ぶプロンプトが表示されます。
y - はい
警告を無視してプラグインをインストールします。危険この警告はシステムを保護するために表示されています。これを無視すると、予期しない問題を引き起こす可能性があります。
n - いいえ
インストールをキャンセルし、全てのキャッシュを破棄します。
KPM 情報ファイルが正しいかどうか
KPM は、正しい KPM 情報ファイルのみを受け入れます。間違った構文や、不正な値が含まれている場合、KPM はそれを無視しようとします。
このような場合、 インストールを続行するかどうかを選ぶプロンプトが表示されます。y - はい
警告を無視してプラグインをインストールします。危険この警告はシステムを保護するために表示されています。これを無視すると、予期しない問題を引き起こす可能性があります。
n - いいえ
インストールをキャンセルし、全てのキャッシュを破棄します。
備考プラグインが KPM 情報ファイルを持っていない場合、このチェックはスキップされます。
動作4. 依存関係を解決する
KPM は、上記の手順を依存関係に対しても行います。これは再帰的な操作です。
動作5. プラグインをダウンロードする
プラグインとその依存関係のビルドの成果物をキャシュにダウンロードします。
ダウンロードされたファイルは、ランダムな文字列 + .jar という名前で保存されます。
動作6. プラグインをインストールする
KPM は、以下の手順に従って一つのプラグインをインストールします。
- プラグインを
plugins/
ディレクトリに再配置する - プラグインのクラス・ローダーを作成し、 JAR ファイルを読み込む
- プラグインの
onLoad()
メソッドを呼び出す - プラグインの
onEnable()
メソッドを呼び出す - プラグインのトリガを処理する
この手順は、依存関係のプラグインから順に実行され、最後に対象のプラグインがインストールされます。 また KPM は依存ツリーが深いプラグインから優先して読み込みます。