～ ScriptAPI開発体験を刷新するTypeScriptベースのフレームワーク ～

概要

Keystoneとは、統合版MinecraftのBDS環境及びビヘイビア―パックのScriptAPIの開発を支援することを目的に作られたプロジェクトです。
Mojangが提供するAPIでは難しい処理の実装を簡単に行えるようにしているほか、Vector3をはじめとした様々な拡張クラスを実装しています。
JavaScriptの暗黙の型変換によるエラーで悩んでしまう時間を最小限になるように、TypeScriptを採用しています。

• 🗃️ イベントの優先順位を指定できるので一つのサブスクライブに縛られる必要はありません！
• ⏰ 豊富なタイマーで幅広い処理をスタイリッシュに！
• 🛠️ スリープ処理や条件待機処理で上から下への処理記法を実現し、if地獄から脱却！
• 🔢 拡張されたAABBクラスやVector3クラスで複雑な計算を簡単に！
• 📃 ボタンやコンポーネント毎に処理を置ける感覚的なフォームビルダーを提供

環境構築

1. Docker インストール
2. .env作成

cp .env.example .env

3. 起動

docker compose up -d

4. BDSログ確認

docker compose logs bds -f

5. サーバー終了

docker compose down

OR

 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/XxPMMPERxX/KeystoneCore/refs/heads/main/keystone-install.sh)"

開発手順

1. package.json の name をあなたのプロジェクト名に変更
2. src/ 配下にて TypeScript でコーディング (エントリとして必ず index.ts が必要です)
3. サーバー起動時に dist_behavior_pack/ 配下にビルドされます
4. ログを確認してデバッグなど

ライブラリ・プラグインとして配布する場合

npm run build:lib

を行うと dist/ 配下にビルドされます

ライブラリ・プラグインを入れたい場合

1. インストール

npm install <入れたいkeystoneライブラリのリポジトリURL>
# 例
# npm install git@github.com:XxPMMPERxX/MassBreak.git

2. インポート

// src/index.ts

import '<入れたいライブラリ名>';
// 例
// import '@gollilla/massbreak';

推奨事項

• VSCodeで開発する場合 .vscode/extensions.json に記載の拡張機能を入れるとよいです

ドキュメント

• イベント
  • 単一ファイルの場合のサンプル
  • ファイル分けした場合の推奨サンプル
• タイマー
  • 継続処理サンプル
  • 遅延処理サンプル
  • 条件待機処理サンプル
  • スリープ処理サンプル
• フォーム
  • ActionForm
  • ModalForm
  • MessageForm
  • サンプル