Vaultを利用したプラグインの作成

このページでは、Vaultを利用したプラグインの作成方法について説明します。

Vaultとは

Vaultとは、Bukkit/Spigot/PaperなどのMinecraftサーバーにおいて、主にお金のやり取りを行う際に利用されるプラグインです。Vaultを利用することで、複数のプラグイン間でお金のやり取りを行うことができます。

Vaultを利用したプラグインの作成方法

Vaultには、APIが提供されており、これを利用することでVaultを利用したプラグインを作成することができます。以下に、Vaultを利用したプラグインの作成方法を説明します。

プラグインの作成

まず、プラグインを作成します。プラグインの作成方法については、以前の資料を参照してください。

Vaultの導入

まず、ほかのプラグインとの連携を行うには、プラグイン本体が導入されている必要があり、その本体に対してAPIを利用することで連携を行います。そのため、まずVaultを導入します。

Vaultのダウンロードページから、最新のjarファイルをダウンロードします。また、Vaultが提供するのはインターフェースであり、実際の機能は他のプラグインが提供します。そのため、Vaultを利用するには、Vaultを利用するプラグインも導入する必要があります。今回は、EssentialsXを導入します。EssentialsXのダウンロードページから、最新のjarファイルをダウンロードします。ダウンロードしたjarファイルをプラグインの/pluginsフォルダに配置し、サーバーを再起動します。

runServerを利用している場合

runServerを利用している場合、build.gradle.ktsに以下の記述を追加します。

runServer {
        minecraftVersion("1.21.3")
        val plugins = runPaper.downloadPluginsSpec {
            //Vault
            url("https://github.com/MilkBowl/Vault/releases/download/1.7.3/Vault.jar")
            //EssestialsX
            url("https://ci.ender.zone/job/EssentialsX/1576/artifact/jars/EssentialsX-2.21.0-dev+93-3a6fdd9.jar")
        }
        downloadPlugins {
            downloadPlugins.from(plugins)
        }
}

こうすることで、Vaultが自動的にダウンロードされ、サーバーが起動する際に読み込まれるようになります。

VaultのAPIを利用する

依存関係の追加

VaultのAPIを利用するためには、以下の依存関係を追加します。

[versions]
+ vault = "1.7"

[libraries]
+ vault-api = { group = "com.github.MilkBowl", name = "VaultAPI", version.ref = "vault" }

repositories {
+    maven("https://jitpack.io")
}

dependencies {
+    compileOnly(libs.vault)
}

VaultAPIの利用

VaultAPIを利用するには、まずVaultAPIのEconomyを取得します。以下のコードを参考にしてください。

package dev.nikomaru.vaultTest;

import net.milkbowl.vault.economy.Economy;
import org.bukkit.plugin.java.JavaPlugin;

public final class VaultTest extends JavaPlugin {

    @Override
    public void onEnable() {
        // Plugin startup logic
        if (getServer().getPluginManager().getPlugin("Vault") == null) {
            getLogger().severe("Vault not found!");
            return;
        }
        Economy economy = getServer().getServicesManager().getRegistration(Economy.class).getProvider();
    }

    @Override
    public void onDisable() {
        // Plugin shutdown logic
    }
}

このようにして、VaultAPIを利用することができます。

金銭のやり取り

Vaultを利用することで、プラグイン側から金銭のやり取りを行うことができます。以下に、金銭のやり取りの例を示します。

void pay(Player player, double amount) {
    Economy economy = getServer().getServicesManager().getRegistration(Economy.class).getProvider();
    economy.depositPlayer(player, amount);
}

void receive(Player player, double amount) {
    Economy economy = getServer().getServicesManager().getRegistration(Economy.class).getProvider();
    economy.withdrawPlayer(player, amount);
}

このようにして、Vaultを利用したプラグインを作成することができます。

演習

Payコマンドを作成し、プレイヤーにお金を支払うコマンドを作成してください。
Setコマンドを作成し、プレイヤーの所持金を設定するコマンドを作成してください。
Balanceコマンドを作成し、プレイヤーの所持金を表示するコマンドを作成してください。
Payコマンドについてお金を持っていない場合には、コマンドを実行できないようにしてください。

まとめ

このページでは、Vaultを利用したプラグインの作成方法について説明しました。Vaultを利用することで、複数のプラグイン間でお金のやり取りを行うことができます。Vaultを利用したプラグインの作成方法を理解し、実際にプラグインを作成してみてください。

また、Vaultに限らず、他のプラグインとの連携を行う際には、APIを利用することが一般的です。APIを利用することで、他のプラグインとの連携を行うことができます。APIを利用する際には、APIの仕様を理解し、適切に利用することが重要です。

Vaultとは​

Vaultを利用したプラグインの作成方法

プラグインの作成​

Vaultの導入​

runServerを利用している場合​

VaultのAPIを利用する​

依存関係の追加​

VaultAPIの利用​