keystonemc 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +66 -0
- package/package.json +36 -0
package/README.md
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# KeystoneCore
|
|
2
|
+
|
|
3
|
+
## 概要
|
|
4
|
+
BDSのScriptAPIを用いたビヘイビアパックを開発するうえで使える便利な処理をまとめたライブラリのようなもの。
|
|
5
|
+
|
|
6
|
+
## 開発環境構築
|
|
7
|
+
1. リポジトリをクローンする
|
|
8
|
+
```bash
|
|
9
|
+
git clone https://github.com/XxPMMPERxX/KeystoneCore.git
|
|
10
|
+
# git clone git@github.com:XxPMMPERxX/KeystoneCore.git
|
|
11
|
+
|
|
12
|
+
cd KeystoneCore
|
|
13
|
+
```
|
|
14
|
+
2. NPM install
|
|
15
|
+
```bash
|
|
16
|
+
npm install --force && npm run build
|
|
17
|
+
```
|
|
18
|
+
3. 開発サーバーのクローン
|
|
19
|
+
```bash
|
|
20
|
+
git clone https://github.com/XxPMMPERxX/Keystone.git dev
|
|
21
|
+
# git clone git@github.com:XxPMMPERxX/Keystone.git dev
|
|
22
|
+
|
|
23
|
+
cd dev
|
|
24
|
+
```
|
|
25
|
+
4. `docker-compose.yml`を編集
|
|
26
|
+
```diff
|
|
27
|
+
dev:
|
|
28
|
+
image: node:20.10-alpine
|
|
29
|
+
- working_dir: /app
|
|
30
|
+
- volumes:
|
|
31
|
+
- - ".:/app"
|
|
32
|
+
- entrypoint: sh -c "npm install --force && npm run build:app"
|
|
33
|
+
+ working_dir: /workspace/dev
|
|
34
|
+
+ volumes:
|
|
35
|
+
+ - "..:/workspace"
|
|
36
|
+
+ entrypoint: sh -c "cd /workspace/dev && npm install --force && npm run build:app"
|
|
37
|
+
```
|
|
38
|
+
5. `.env`ファイルをコピーして生成
|
|
39
|
+
```bash
|
|
40
|
+
cp .env.example .env
|
|
41
|
+
# edit .env
|
|
42
|
+
```
|
|
43
|
+
6. `dev/package.json`の`"keystone"`を編集
|
|
44
|
+
```package.json
|
|
45
|
+
"keystone": "file:../",
|
|
46
|
+
```
|
|
47
|
+
7. 開発サーバーの起動
|
|
48
|
+
```bash
|
|
49
|
+
docker compose up
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### 開発手順
|
|
53
|
+
1. core/ 配下でライブラリを作成
|
|
54
|
+
1. `npm run build`
|
|
55
|
+
1. dev/src 配下でライブラリテスト用コードを書く
|
|
56
|
+
1. `cd dev` 後に `docker compose up` でビルド
|
|
57
|
+
|
|
58
|
+
### ドキュメント
|
|
59
|
+
- [イベント](./DOCUMENT.md#イベント)
|
|
60
|
+
- [単一ファイルの場合のサンプル](./DOCUMENT.md#サンプル)
|
|
61
|
+
- [ファイル分けした場合の推奨サンプル](./DOCUMENT.md#ファイル分けした場合の推奨サンプル)
|
|
62
|
+
- [タイマー](./DOCUMENT.md#タイマー)
|
|
63
|
+
- [継続処理サンプル](./DOCUMENT.md#継続処理サンプル)
|
|
64
|
+
- [遅延処理サンプル](./DOCUMENT.md#遅延処理サンプル)
|
|
65
|
+
- [待機処理サンプル](./DOCUMENT.md#待機処理サンプル)
|
|
66
|
+
- [サンプルコード](./DOCUMENT.md#サンプルコード)
|
package/package.json
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "keystonemc",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "ScriptAPI Wrapper",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"scripts": {
|
|
7
|
+
"build": "tsc && vite build"
|
|
8
|
+
},
|
|
9
|
+
"main": "./dist/index.js",
|
|
10
|
+
"module": "./dist/index.js",
|
|
11
|
+
"types": "./dist/core/index.d.ts",
|
|
12
|
+
"exports": {
|
|
13
|
+
".": {
|
|
14
|
+
"types": "./dist/core/index.d.ts",
|
|
15
|
+
"import": "./dist/index.js",
|
|
16
|
+
"default": "./dist/index.js"
|
|
17
|
+
},
|
|
18
|
+
"./vite-plugin": {
|
|
19
|
+
"types": "./dist/vite-plugin/index.d.ts",
|
|
20
|
+
"import": "./dist/vite-plugin/index.js",
|
|
21
|
+
"default": "./dist/vite-plugin/index.js"
|
|
22
|
+
}
|
|
23
|
+
},
|
|
24
|
+
"devDependencies": {
|
|
25
|
+
"@eslint/js": "^9.38.0",
|
|
26
|
+
"@minecraft/server": "^2.5.0-beta.1.21.130-preview.24",
|
|
27
|
+
"@minecraft/server-net": "^1.0.0-beta.1.21.114-stable",
|
|
28
|
+
"@minecraft/server-ui": "^2.1.0-beta.1.21.114-stable",
|
|
29
|
+
"@types/node": "^24.9.2",
|
|
30
|
+
"eslint": "^9.38.0",
|
|
31
|
+
"typescript": "~5.9.3",
|
|
32
|
+
"typescript-eslint": "^8.46.2",
|
|
33
|
+
"vite": "^7.1.7",
|
|
34
|
+
"vite-plugin-dts": "^4.5.4"
|
|
35
|
+
}
|
|
36
|
+
}
|