メインコンテンツまでスキップ
バージョン: KPM v2

KPM 用語集

このページでは、このドキュメントまたはプラグイン内で使用されている用語を解説しています。


基本用語一覧

KPM

TeamKUNPluginManager の頭文字を取った略称です。
このドキュメントでは TeamKUNPluginManager を KPM と表記しています。適宜読み替えてください。

ヒント

将来的に、KPM は TeamKUNPluginManager の別名として使用され、略称ではなくなる可能性があります。(npm のように)

PaperMC

PaperMC は、SpigotBukkit と並ぶ、 Minecraft サーバーの実装です。
KPM は、 PaperMC 上でのみ動作します。詳しくはこちらを参照してください。

GitHub

GitHub は、Microsoft が運営する、プログラミング言語のソースコードを管理するためのサービスです。
KPM では、GitHub 上に公開されているプラグインをインストールできます。また、 KPM を使用するには GitHub アカウントが必要です。 詳しくはこちらを参照してください。 また、 GitHub 関連用語はこちらを参照してください。


GitHub 関連用語一覧

GitHub OAuth トークン

GitHub OAuth トークンは、GitHub にログインするためのトークンです。
KPM では、 GitHub と KPM を連携するために使用します。詳しくはこちらを参照してください。

GitHub リポジトリ

GitHub リポジトリは、GitHub 上に公開されているプラグインのソースコードを管理するための場所です。
KPM では、 GitHub リポジトリ上にリリースされているプラグインをインストールできます。詳しくはこちらを参照してください。

リリース

GitHub リリースは、GitHub リポジトリ上で公開されているプラグインのバージョンに似ています。 これは、KPM でインストールするプラグインのバージョンに相当します。


KPM 関連用語一覧

プラグイン解決

KPM がクエリ(文字列のこと。)からプラグインを一意に特定し、プラグインの情報を取得するまでの一連の処理のことです。 また、プラグインリゾルバ と呼ばれるモジュールでプラグインを解決します。

クエリ(クエリ文字列)

クエリは、 KPM がプラグインを解決するために使用する文字列です。 詳しくは以下を参照してください。

📄️ クエリ文字列とは?

クエリは、KPM がプラグインを解決するために使用する文字列です。

プラグインリゾルバ

プラグインリゾルバは、 KPM がプラグインを解決するために使用するモジュールです。 現在は、以下のプラグインリゾルバが存在します。

  • GitHub リゾルバ

    https://github.com/TemKun/StealPlugin や、 TeamKun/StealPlugin などのクエリを解決します。

  • Spigot MC リゾルバ

    https://www.spigotmc.org/resources/stealplugin.12345 などのクエリを解決します。

  • エイリアスリゾルバ

    u など、予め定義されたエイリアスのクエリを解決します。

  • CurseForge リゾルバ

    https://www.curseforge.com/minecraft/mc-mods/stealplugin や、 https://dev.bukkit.org/projects/stealplugin などのクエリを解決します。

リロード

プラグインを一度アンロードし、再度読み込むことをリロードと呼びます。

主なリロードの流れは以下の通りです:

  1. プラグインを無効化する
  2. プラグインをアンロードする
    1. プラグインが登録したコマンドを削除する
    2. プラグインが登録したレシピを削除する
  3. プラグインをサーバのインデックスから削除する
  4. プラグインのクラスローダーを削除する
  5. サーバ JVM のガベージ・コレクション(GC) を実行する
  6. プラグインを読み込む
  7. プラグインを有効化する

インストール

KPM がプラグインをサーバーにサーバに追加する一連の流れをインストールと呼びます。

主なインストールの流れは以下の通りです:

  1. プラグインを解決する
  2. プラグインの jar ファイルをダウンロードする
  3. プラグインの依存関係を解決する
  4. 依存関係の jar ファイルをダウンロードする
  5. 依存関係の依存関係がある場合, 3 と 4 を繰り返す
  6. 依存関係の読み込み順を計算する
  7. プラグインと依存関係を読み込む
  8. プラグインと依存関係を有効化する

アンインストール

KPM がプラグインをサーバーから削除する一連の流れをアンインストールと呼びます。

主なアンインストールの流れは以下の通りです:

  1. プラグインを無効化する
  2. プラグインをアンロードする
    1. プラグインが登録したコマンドを削除する
    2. プラグインが登録したレシピを削除する
  3. プラグインをサーバのインデックスから削除する
  4. プラグインのクラスローダーを削除する
  5. サーバ JVM のガベージ・コレクション(GC) を実行する
  6. プラグインのファイルを削除する