cajonzero 0.1.0 → 0.1.2

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  # cajonzero
2
2
 
3
- Serverless(Cloudflare)的 BOX3 **仅 Play 端**引擎:内置账号系统,房间跑在
4
- Durable Object 上,地图放在 OSS/CDN。
3
+ 运行在 Cloudflare 上的 BOX3 游玩端引擎:内置账号系统,每个房间是一个
4
+ Durable Object,地图存放在 OSS/CDN。
5
5
 
6
6
  ## 安装
7
7
 
@@ -10,39 +10,39 @@ npm install cajonzero
10
10
  npx cj0 --help
11
11
  ```
12
12
 
13
- ## 本地运行
13
+ ## 本地运行(本仓库)
14
14
 
15
15
  ```bash
16
16
  npm install
17
- npm run build # 构建大厅/后台
17
+ npm run build # 构建大厅与管理后台
18
18
  npm run demo # http://127.0.0.1:8787
19
19
  ```
20
20
 
21
- 打开页面后注册账号、选一张地图即可进入房间。
22
- 管理后台在 `/admin/login`,演示令牌为 `cajonzero-demo-admin-token`。
21
+ 管理后台地址 `/admin/login`,演示令牌 `cajonzero-demo-admin-token`。
23
22
 
24
- ## 创建自己的服务
23
+ ## 创建项目
25
24
 
26
25
  ```bash
27
- cj0 create my-server
26
+ npx cj0 create my-server
28
27
  cd my-server
29
28
  npm install
30
- npm run dev # 本地预览
29
+ npx cj0 setup # 交互配置 ENV:vars 写 wrangler.jsonc,密钥写 .dev.vars
30
+ npm run dev
31
31
  ```
32
32
 
33
- 部署前配置三项:
33
+ ## 部署
34
34
 
35
35
  ```bash
36
36
  npx wrangler kv namespace create CAJONZERO_KV # 把返回的 id 填进 wrangler.jsonc
37
37
  npx wrangler secret put CAJONZERO_SESSION_SECRET # 会话签名密钥
38
- npx wrangler secret put BOX_PLAY_ADMIN_TOKEN # 管理后台令牌
38
+ npx wrangler secret put BOX_PLAY_ADMIN_TOKEN # 管理后台令牌
39
39
  npm run deploy
40
40
  ```
41
41
 
42
42
  ## 配置地图
43
43
 
44
- 地图不随 worker 上传。把解包后的 `.boxplay` 目录传到 OSS/S3/CDN,
45
- 再在 `cajonzero/maps.json` 中登记:
44
+ 地图文件单独上传,不随 worker 打包。把解包后的 `.boxplay` 目录上传到
45
+ OSS/S3/CDN(需允许 CORS),然后在 `cajonzero/maps.json` 中登记:
46
46
 
47
47
  ```json
48
48
  {
@@ -52,23 +52,21 @@ npm run deploy
52
52
  "slug": "race",
53
53
  "root": "https://<你的 CDN>/box3/race/",
54
54
  "worldId": "<世界 id>",
55
- "name": "显示名",
56
- "etag": "v1"
55
+ "name": "显示名"
57
56
  }
58
57
  ]
59
58
  }
60
59
  ```
61
60
 
62
- 地图内容更新时记得提升 `etag`(否则会命中 KV 里的旧缓存)。
63
- 房间参数、地图拉取策略等在 `cajonzero/config.json` 中调整。
61
+ `root` 必须以 `/` 结尾;更新地图后刷新 CDN 缓存或改用带版本的路径。
62
+ 房间参数、地图拉取策略等配置位于 `cajonzero/config.json`。
64
63
 
65
64
  ## 常用命令
66
65
 
67
66
  ```bash
68
- cj0 serve [--port <port>] [--host <host>] # 本地启动
69
67
  cj0 create <folder> # 生成部署项目
70
- npm test # 运行测试
71
- npm run ci:gates # 完整检查(类型/测试/构建)
68
+ cj0 setup [--config <file>] # 交互配置必需/可选的 ENV
69
+ cj0 serve [--port <port>] [--host <host>] # 本地启动
70
+ npm test # 运行测试
71
+ npm run ci:gates # 完整检查(类型/测试/构建)
72
72
  ```
73
-
74
- 更多细节见 [`docs/`](./docs/)。