sapdon 3.3.3 → 3.4.0

package/README.md

@@ -26,7 +26,7 @@ Minecraft Bedrock 版 Addon 开发框架，将 JSON 配置抽象为 TypeScript
 
 ### 环境要求
 
-- Node.js 16+
+- Node.js 18+
 - npm
 
 ### 安装
@@ -61,10 +61,10 @@ my_addon/
 
 ```typescript
 // main.ts
-import { ItemAPI, EntityAPI, registry, ItemComponent } from '@sapdon/core'
+import { ItemAPI, ItemCategory, EntityAPI, registry, ItemComponent } from '@sapdon/core'
 
 // 创建一个物品
-ItemAPI.createItem('my_addon:magic_ingot', 'items', 'magic_ingot')
+ItemAPI.createItem('my_addon:magic_ingot', ItemCategory.Items, 'magic_ingot')
   .addComponent(ItemComponent.setDisplayName('魔法锭'))
 
 // 提交注册
@@ -91,15 +91,17 @@ sapdon build .
 ### 物品
 
 ```typescript
+import { ItemAPI, ItemCategory } from '@sapdon/core'
+
 // 基础物品
-ItemAPI.createItem('my:item', 'items', 'texture')
+ItemAPI.createItem('my:item', ItemCategory.Items, 'texture')
 
 // 食物
-ItemAPI.createFood('my:food', 'items', 'apple')
-  .addComponent(ItemComponent.setFoodComponent(4, 0.6))
+ItemAPI.createFood('my:food', ItemCategory.Items, 'apple')
+  .addComponent(ItemComponent.setFoodComponent({ nutrition: 4, saturationModifier: 0.6 }))
 
 // 带自定义组件的物品
-ItemAPI.createItem('my:tool', 'items', 'tool_tex')
+ItemAPI.createItem('my:tool', ItemCategory.Items, 'tool_tex')
   .addComponent(ItemComponent.setHandEquipped(true))
   .addComponent(ItemComponent.setDurability(250))
   .format_version = '1.21.90'
@@ -209,6 +211,8 @@ RecipeAPI.registerSimpleFurnace('my:smelted', 'my:ore')
 | [实体教程](./doc/user/tutorials/entity.md) | 创建实体 → 组件 → AI 行为 |
 | [方块教程](./doc/user/tutorials/block.md) | 基础方块 → 旋转 → 作物 |
 | [配方教程](./doc/user/tutorials/recipe.md) | 有序/无序/熔炉配方 |
+| [指南书教程](./doc/user/tutorials/neo-guidebook.md) | NeoGuidebook API 用法 |
+| [指南书实战经验](./doc/user/tutorials/neo-guidebook-experience.md) | 接入流程与踩坑清单 |
 | [物品 API](./doc/user/api/item.md) | ItemAPI、Item、ItemComponent |
 | [实体 API](./doc/user/api/entity.md) | EntityAPI、EntityComponent、AI |
 | [方块 API](./doc/user/api/block.md) | BlockAPI、BlockComponent |
@@ -239,6 +243,12 @@ npm run build
 
 ---
 
+## 致谢
+
+感谢 [Bedrock Wiki](https://wiki.bedrock.dev/) 提供的物品、方块、实体等组件与功能的方法文档，本项目（尤其是 `examples/items_demo` 中的自定义武器、投掷物品等示例）参考了其中的规范实现。
+
+---
+
 ## 社区
 
 - QQ 群：`810904181`