KeystoneCore

概要

BDSのScriptAPIを用いたビヘイビアパックを開発するうえで使える便利な処理をまとめたライブラリのようなもの。

開発環境構築

1. リポジトリをクローンする

git clone https://github.com/XxPMMPERxX/KeystoneCore.git
# git clone [email protected]:XxPMMPERxX/KeystoneCore.git

cd KeystoneCore

2. NPM install

npm install --force && npm run build

3. 開発サーバーのクローン

git clone https://github.com/XxPMMPERxX/Keystone.git dev
# git clone [email protected]:XxPMMPERxX/Keystone.git dev

cd dev

4. docker-compose.ymlを編集

  dev:
    image: node:20.10-alpine
-   working_dir: /app
-   volumes:
-     - ".:/app"
-   entrypoint: sh -c "npm install --force && npm run build:app"
+   working_dir: /workspace/dev
+   volumes:
+     - "..:/workspace"
+   entrypoint: sh -c "cd /workspace/dev && npm install --force && npm run build:app"

5. .envファイルをコピーして生成

cp .env.example .env
# edit .env

6. dev/package.jsonの"keystone"を編集

"keystone": "file:../",

7. 開発サーバーの起動

docker compose up

開発手順

1. core/ 配下でライブラリを作成
2. npm run build
3. dev/src 配下でライブラリテスト用コードを書く
4. cd dev 後に docker compose up でビルド

ドキュメント

• イベント
  • 単一ファイルの場合のサンプル
  • ファイル分けした場合の推奨サンプル
• タイマー
  • 継続処理サンプル
  • 遅延処理サンプル
  • 待機処理サンプル
• サンプルコード