create-yeow 0.2.120 → 0.2.121
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/package.json
CHANGED
|
Binary file
|
|
@@ -7,13 +7,21 @@
|
|
|
7
7
|
|
|
8
8
|
| 页面 | URL | 摘要 |
|
|
9
9
|
| -------------- | -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
10
|
+
| 关于 Yeow | `https://yeow.yeside.top/v1/about` | 定位、设计目标、基本原则（避免平台绑定、不提供调用 Java 方法的 API）、愿景（Minecraft 的 Web 标准 / YEOW = Your Entry to an Open World） |
|
|
10
11
|
| 概览 | `https://yeow.yeside.top/v1/overview` | 项目总览：用 TypeScript 写 Paper 插件（QuickJS 引擎，每插件独立线程）。按角色（初学者/开发者/服主/平台实现者）的文档入口导引 + 关键概念速览 |
|
|
11
12
|
| AI 辅助启动指南 | `https://yeow.yeside.top/v1/ai-agent` | 面向 AI 代理 / Vibe Coding：Yeow 项目简介、启动命令（`--ts`）、下一步、文档查阅策略（站点地图/docs.zip/Harness 用法） |
|
|
12
13
|
| 快速开始 | `https://yeow.yeside.top/v1/getting-started` | 从零开始：`npm create yeow` 建项目 → `npm run dev` 开发（热重载）→ `npm run build` 构建 → 三种部署方式。含第一个插件示例（/back 传送）、异步/同步约定、权限声明、原生服务批准、/yeow 管理命令、运行时配置 |
|
|
13
14
|
| CLI 参考 | `https://yeow.yeside.top/v1/cli` | create-yeow 脚手架与 dev-server 的命令行用法：交互式/非交互创建、开发服务器参数（-y/--stop/--proxy）、构建脚本、调试体验（source-map 错误定位与异步调用链） |
|
|
14
15
|
| 构建与分发 | `https://yeow.yeside.top/v1/distribution` | 两种产物：标准 Paper JAR（plugins/）与平台无关 .yeow.zip（plugins/Yeow/ 自动扫描或 /yeow install）；分发建议与 Modrinth 发布 |
|
|
15
16
|
| 运行时警告 | `https://yeow.yeside.top/v1/runtime-warning` | 预警引擎：heartbeat.timeout / event.slow / plugin.hung / budget.congested 等告警的触发条件、含义与解决方案；配置阈值；动态扩容机制 |
|
|
16
|
-
| 进阶知识 | `https://yeow.yeside.top/v1/advanced` |
|
|
17
|
+
| 进阶知识 | `https://yeow.yeside.top/v1/advanced` | 进阶索引（拆分后）：架构/调度器/事件/生命周期/通道/服务/运维与安全的入口 |
|
|
18
|
+
| 进阶 · 架构与线程模型 | `https://yeow.yeside.top/v1/advanced/architecture` | 包结构、启动流程、线程模型、插件实体抽象、Worker（虚拟插件）、开发模式错误回显、资源路径机制（getAssetsPath） |
|
|
19
|
+
| 进阶 · 调度器与任务 | `https://yeow.yeside.top/v1/advanced/scheduler` | 三级优先级调度器（时间片预算/自动降级/空闲自旋）、异步 vs 同步、手动分片、任务执行时机（onLoad/onInit） |
|
|
20
|
+
| 进阶 · 事件与回调 | `https://yeow.yeside.top/v1/advanced/events` | 事件桥（EventBridge）：并发/串行、事件数据、处理器操作与模式选择 |
|
|
21
|
+
| 进阶 · 生命周期与热重载 | `https://yeow.yeside.top/v1/advanced/lifecycle` | onInit/onLoad/onUnload、统一回调系统、热重载、生产 /yeow reload/unload |
|
|
22
|
+
| 进阶 · 环境能力与通道 | `https://yeow.yeside.top/v1/advanced/channels` | $_send/$send 封装、各消息通道、运行时配置（config.yml） |
|
|
23
|
+
| 进阶 · 服务机制 | `https://yeow.yeside.top/v1/advanced/service` | Plugin Service（插件间通信）与 Native Service（原生扩展） |
|
|
24
|
+
| 进阶 · 运行时运维与安全 | `https://yeow.yeside.top/v1/advanced/operations` | 预警引擎、动态扩容（BudgetScaler）、全量分析、平台无关性、定时器资源管理、安全 |
|
|
17
25
|
| 编写依赖包 | `https://yeow.yeside.top/v1/package-author` | 将共享逻辑与资源封装为 npm 依赖包：assets 命名空间、三类 Service 包（SDK / JS 服务 / 原生服务）、权限声明、native 可信性声明 |
|
|
18
26
|
| 路线图 | `https://yeow.yeside.top/v1/todo` | v1 方向性规划：API/事件覆盖、调试工具、Folia 支持；Worker API 已实现 |
|
|
19
27
|
| 索引（README） | `https://yeow.yeside.top/v1/` | 文档首页：快速上手命令、为什么用 Yeow（工程化/线程分离/平台无关/原生扩展）、对比表、文档与工具链索引 |
|
|
@@ -23,9 +31,10 @@
|
|
|
23
31
|
| 页面 | URL | 摘要 |
|
|
24
32
|
| ----------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
25
33
|
| API 索引 | `https://yeow.yeside.top/v1/api/` | 全部 API 模块的分组索引 |
|
|
26
|
-
| Player
|
|
27
|
-
| Server
|
|
28
|
-
| Env
|
|
34
|
+
| Player | `https://yeow.yeside.top/v1/api/player` | 玩家：属性（血量/饥饿/经验/飞行等）、位置、消息（Message 对象）、Title/ActionBar、音效、资源包、传送、权限、`performCommand`、手持物品（ItemStack 快照） |
|
|
35
|
+
| Server | `https://yeow.yeside.top/v1/api/server` | 服务器级：广播、MOTD（setMotd 全局默认）、serverPing 事件回写（按次覆盖 motd/icon/人数）、版本、TPS、最大玩家数 |
|
|
36
|
+
| Env | `https://yeow.yeside.top/v1/api/env` | 运行时环境信息（同步）：CPU 核心数、内存、系统架构、Minecraft 版本、Yeow 运行时信息、epoch 微秒时间戳 |
|
|
37
|
+
| Permission | `https://yeow.yeside.top/v1/api/permission` | 权限：`registerPermission`（default: all/op/none）、命令权限、检查流程、`permissionCheck` Yeow 生态钩子（优先级/触发范围/无限循环提醒）、Paper 兼容（permissions.yml/LuckPerms） |
|
|
29
38
|
| World | `https://yeow.yeside.top/v1/api/world` | 世界：时间/天气/难度/规则、方块（getBlock/setBlock，Block 对象）、区块、光照、生物群系、实体查询、掉落/闪电/爆炸/生成 |
|
|
30
39
|
| Chunk | `https://yeow.yeside.top/v1/api/chunk` | 区块快照（进阶性能工具）：3D 完整快照与 2D 顶部快照（short[] base64 零拷贝视图 + 方块索引映射） |
|
|
31
40
|
| Location | `https://yeow.yeside.top/v1/api/location` | 坐标与朝向：x/y/z/yaw/pitch/world |
|
|
@@ -58,6 +67,7 @@
|
|
|
58
67
|
| 页面 | URL | 摘要 |
|
|
59
68
|
| -------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
60
69
|
| 规范总览 | `https://yeow.yeside.top/v1/specifications/` | 协议层总纲：包结构（yeow.json/.yeow/main.js/assets）、加载流程、权限模型、运行时架构、任务执行器、事件/命令桥、Native Service、合格运行时检查清单 |
|
|
70
|
+
| Java 插件集成 | `https://yeow.yeside.top/v1/specifications/java-api` | 其他 Java 插件调用 Yeow 服务（requestService 请求-响应、subscribeService 订阅事件）、提交游戏任务、约束 |
|
|
61
71
|
| 适配器规范 | `https://yeow.yeside.top/v1/specifications/adapter/` | 多语言/社区适配器：PluginEntity 接口、消息契约、submitTask、注册 API、检查清单 |
|
|
62
72
|
| 运行时环境标准 | `https://yeow.yeside.top/v1/specifications/runtime/` | JS 环境：语言标准（ES2025+SecU8）、回调系统（cb 语义）、事件循环、通道总览与权限、全局变量（$send/$dev/fetch/timers） |
|
|
63
73
|
| 原生服务 | `https://yeow.yeside.top/v1/specifications/native-service/` | 原生子进程协议：平台选择、提取、TCP JSON line（ready/request/response/publish） |
|