Installation and Setup

このページでは Box の導入方法とその設定方法についての情報を記載しています。

導入方法

1. Releases から最新バージョンのプラグイン Jar をダウンロードする
2. サーバーの plugins ディレクトリに Jar を配置する
3. サーバーを再起動する

以上の手順で Box の導入は完了です。必要に応じて plugins/Box/config.yml 等のファイルで設定を変更できます。

設定

デフォルトの config.yml は こちら をご覧ください。

ストレージ

現在、Box は3つのストレージに対応しています。

Yaml

デフォルトのストレージです。plugins/Box/data にアイテムやプレイヤーのデータを Yaml ファイルで保存します。

storage:
  type: "yaml"
  yaml:
    directory-name: "data" # 作成するディレクトリの名前

SQLite

plugins/Box/ 下にデータベースファイルを作成してそこにデータを保存します。

storage:
  type: "sqlite"
  sqlite:
    table-prefix: "box_" # テーブル名の接頭辞
    filename: "box-sqlite.db" # 作成するデータベースファイル名

MySQL

MySQL や MariaDB にデータを保存します。

storage:
  type: "mysql"
  mysql:
    table-prefix: "box_" # テーブル名の接頭辞
    address: "localhost" # データベースのホスト
    port: 3306 # データベースの接続ポート
    database-name: "box" # データベース名 (事前に作成する必要があります)
    username: "" # 接続するためのユーザー名
    password: "" # 接続するためのパスワード

ワールド制限

disabled-worlds にワールドの名前を設定することで、そのワールドでの Box の使用を禁止することができます。

disabled-worlds:
  - example_world_name

機能制限

disabled-features に機能名を設定することで、その機能を無効化することができます。

一部の機能は他の機能に依存されていることがあります。それを無効化すると、それに依存している機能も無効化されます。

disabled-features:
  - autostore # 自動収納機能を無効化します
  - bemode # BE 向けの引き出し・預け入れモードを無効化します
  - category # アイテムのカテゴリ機能を無効化します。同時にメニュー (gui) も無効化されます
  - command # `/box` や `/boxadmin` コマンドの主要なサブコマンドを無効化します
  - craft # メニューのクラフトモードを無効化します
  - gui # メニューを無効化します。同時に craft も無効化されます
  - stick # Box Stick を無効化します
  - notifier # 在庫変動時のアクションバーへの通知を無効化します

Box Stick

menu-command を変更することで、Box Stick のメニューを開く動作を他のコマンド実行に変えることができます。

stick:
  menu-command: "box gui" # デフォルトではプレイヤーに /box gui を実行させています