界面扩展组件速查

本页汇总书本、成就系统、物品分组/分页与微缩方块等"界面扩展"类内容的所有组件与字段，标注可选参数，方便快速查阅。

使用方法

• 书本配置写在 netease_books/ 目录下，通过脚本和 JSON 配合实现
• 成就系统通过 netease_achievements/ 配置，脚本监听事件
• 物品分组/分页写在行为包 netease_item_groups/ 和 netease_item_category/ 下
• 微缩方块通过 ModSDK 接口创建

自定义书本

book.json 字段（netease_books/）

字段	类型	可选参数	说明	详细文档
bookId	str	命名空间:书本名，如 "mymod:guide_book"	书本唯一标识符	自定义书本
title	str	任意字符串	书本标题	自定义书本
author	str	任意字符串	作者名称	自定义书本
pages	array	Rawtext 对象数组，如 [{"rawtext":[{"text":"内容"}]}]	页面列表	自定义书本
generation	int	0(原版) / 1(副本) / 2(副本的副本) / 3(破旧)	副本代数	自定义书本

titleArea 字段

字段	类型	可选参数	说明
text	str	任意字符串，支持 § 颜色代码	标题文本
color	str	十六进制颜色如 "#FF0000" 或颜色名	标题颜色
fontSize	int	正整数	字体大小
alignment	str	left / center / right	对齐方式

脚本接口

接口	可选参数	说明
OpenBook	playerId: str, bookId: str, page: int	打开指定书本
CloseBook	playerId: str	关闭书本
SetBookPage	bookId: str, page: int, content: object	设置书本页面内容

书本事件

事件	说明
OnBookPageTurnClientEvent	翻页事件（客户端）
OnBookPageTurnServerEvent	翻页事件（服务端）

自定义成就系统

成就节点字段

字段	类型	可选参数	说明	详细文档
id	str	命名空间:成就名，如 "mymod:first_craft"	成就唯一标识符	自定义成就系统
title	str	语言文件键名	成就标题	自定义成就系统
description	str	语言文件键名	成就描述	自定义成就系统
icon	str	贴图路径，如 "textures/ui/achievement_icon"	成就图标路径	自定义成就系统
parent	str	父成就 id，空字符串=根节点	父成就 id	自定义成就系统
trigger	object	{type: "impossible"} / {type: "custom"}	触发条件	自定义成就系统
reward	object	参见成就文档	完成奖励	自定义成就系统
hidden	bool	true / false	是否隐藏（完成前不显示）	自定义成就系统
repeatable	bool	true / false	是否可重复完成	自定义成就系统
order	int	正整数	排列顺序	自定义成就系统
frame	str	"task" / "challenge" / "goal"	边框类型	自定义成就系统
background	str	贴图路径	背景图片	自定义成就系统
show_toast	bool	true / false	完成时是否弹出提示	自定义成就系统
announce_to_chat	bool	true / false	完成时是否在聊天广播	自定义成就系统

触发类型

类型	说明
impossible	不可自动触发，需脚本手动授予
custom	自定义触发条件，通过脚本判断

脚本接口与事件

接口/事件	可选参数	说明
GrantAchievement	playerId: str, achievementId: str	授予成就
RevokeAchievement	playerId: str, achievementId: str	撤销成就
IsAchievementUnlocked	playerId: str, achievementId: str → bool	查询成就是否已解锁
OnAchievementUnlockedServerEvent	—	成就解锁事件
OnAchievementProgressServerEvent	—	成就进度事件

物品分组与分页

分组字段（netease_item_groups/）

字段	类型	可选参数	说明	详细文档
identifier	str	命名空间:分组名	分组唯一标识符	物品分组/分页
category	str	construction / equipment / items / nature / 自定义分页名	所属创造栏分类	物品分组/分页
group_name	str	语言文件键名，如 "itemGroup.mymod.custom_tools"	分组显示名称	物品分组/分页

分页字段（netease_item_category/）

字段	类型	可选参数	说明	详细文档
identifier	str	命名空间:分页名	分页唯一标识符	物品分组/分页
category	str	construction / equipment / items / nature	所属创造栏分类	物品分组/分页
group_name	str	语言文件键名	分页显示名称	物品分组/分页
is_hidden	bool	true / false	是否在创造栏中隐藏	物品分组/分页

微缩方块字段

字段	类型	可选参数	说明	详细文档
blockIdentifier	str	方块 identifier，如 "mymod:custom_ore"	对应方块的 identifier	物品分组/分页
blockAuxValue	int	方块附加值，默认 0	方块附加值	物品分组/分页
isFakeBlock	bool	true(仅展示) / false(真实方块)	是否为假方块	物品分组/分页

组件速写模板

自定义书本

{
  "bookId": "mymod:guide_book",
  "title": "Mod Guide",
  "author": "Developer",
  "generation": 0,
  "pages": [
    {
      "rawtext": [
        { "text": "Welcome to the guide!\n\nThis book explains all features." }
      ]
    },
    {
      "rawtext": [
        { "text": "Page 2 content here." }
      ]
    }
  ]
}

成就节点

{
  "id": "mymod:first_craft",
  "title": "achievement.mymod.first_craft",
  "description": "achievement.mymod.first_craft.desc",
  "icon": "textures/ui/achievement_icon",
  "parent": "",
  "trigger": { "type": "impossible" },
  "hidden": false,
  "repeatable": false,
  "show_toast": true,
  "announce_to_chat": true
}

物品分组

{
  "identifier": "mymod:custom_tools",
  "category": "equipment",
  "group_name": "itemGroup.mymod.custom_tools"
}