Sprite Zdog (英语:@fungi.computer/sprite-zdog(中文(简体) )
Sprite Zdog是用于由Zdog所建字符的可选 Canvas 渲染器. 这个 还提供了内置字符和工具,用于编写可移植字符 文档 丝绸 可以装入.
安装或设置
npm install @fungi.computer/sprite-zdog
套装舰只进行无害环境管理,并取决于效果,Zod, animejs, (中文(简体) ), zdog,以及
丝绸 在运行时间。 仅添加到已存在的主机中
使用Sprite和Zdog制作. 父 Sprite 主机仍然拥有玩家
资产政策。 根入点输出 Zdog 渲染器 . ./author 财务报告和审定财务报表
./portable 支持场景编写. ./builtins (和个人)
./builtins/base, (中文(简体) ), ./builtins/mushroom, (中文(简体) ), ./builtins/cat,以及
./builtins/burger subpaths)暴露了捆绑的作者定义.
./mushroom, (中文(简体) ), ./cat 财务报告和审定财务报表 ./burger 提供随时装入的本地字符,
分别带有其文件和渲染器. ./catalog 财务报告和审定财务报表 ./avatar 提供纯
avatar 验证和衍生,不导入 Canvas 渲染器.
快开始
这个示例将捆绑的蘑菇安装为本地字符 使用 Sprite React 组件制作 :
import { createSprite } from "@fungi.computer/sprite";
import { Sprite } from "@fungi.computer/sprite/react";
import { builtinCharacters } from "@fungi.computer/sprite-zdog";
const service = createSprite({
characters: builtinCharacters,
});
function Character() {
return (
<Sprite
service={service}
src={{ local: "mushroom" }}
activity="thinking"
role="img"
aria-label="Mushroom character"
/>
);
}
builtinCharacters 提供懒惰 mushroom, (中文(简体) ), cat 财务报告和审定财务报表 burger 无装载器
远程资产访问。 捆绑的字符提供了它的文档和 Zdog
造物师一起。 测试涵盖内置字符和玩家整合
src/builtins.test.ts 财务报告和审定财务报表
src/mushroom.test.ts。 。 。 .
核心概念
包根导出 Zdog 渲染器作为默认导出 。 制作
服务字符文档 renderer 实值 zdog在Sprite中注册.
此示例配置使用 assetPolicy 作为主机的配置
Sprite 资产政策 :
const service = createSprite({
assets: assetPolicy,
renderers: {
zdog: () => import("@fungi.computer/sprite-zdog"),
},
});
assetPolicy 代表主机配置的 Sprite 资产策略 。 承认
文档的来源并设定其字节和请求限制。 本地人物确实如此
不需要远程资产访问.
对于作者, defineSprite 验证信任的场景定义, check
返回紧凑的作者时间摘要,以及 toCharacter 转换定义
输入 JSON 字符文档。 由此产生的文档包含数据,而不是
可执行作者代码 . @fungi.computer/sprite-zdog/builtins 出口
蘑菇 猫和汉堡.
对于已存储的外观, 导入 avatarSchema 或者说 parseAvatar(data) 从
@fungi.computer/sprite-zdog/avatar。这些验证与内置
字符控制和表达式,而不是只检查信封.
deriveAgentAvatar(member, agentColors, seed, avoid?) 使用同样的目录;
agentColors 实值 "keep" 或者说 "shift"。 。 。 . avatarCatalog 也可从下列网址获得:
./catalog 使用Sprite的目录参数化帮助的呼叫者.
memberAvatarSchema 验证严格的 {avatar, agentColors} 优惠;
defaultMemberAvatar 向未定制的蘑菇提供颜色变化.
API 参考
见生成 软件包 API, (中文(简体) ),
正在编写 API,以及
便携式文档 API。软件包也暴露了
个人内置 @fungi.computer/sprite-zdog/builtins/<name>。 。 。 .
实例和检查
本地的Sprite故事中 src/*.stories.tsx。运行软件包测试
改为:
pnpm --filter @fungi.computer/sprite-zdog test
作者和便携式运行时间测试涵盖定义验证, 串行化,解码和清理.
限制和错误
Zdog渲染器需要浏览器窗口和画布. 它解码 字符的 Zdog 数据在创建渲染器并删除其画布之前 玩家选择关闭时的动画资源. 无效的场景数据, 缺少表达式, 或调色板颜色无效, 选择失败 .
作者的回调是信任的代码,在创建便携时运行 文档。 运行时渲染读取由此得到的JSON数据. 它不执行 写回电。 已送达的文档仍然使用 Sprite 的主机主机来源 和资产限制.
贡献和许可证
Sprite Zdog获得麻省理工学院的许可. 见 LICENSE 财务报告和审定财务报表
THIRD_PARTY_NOTICES。 。 。 .