# @fungi\.computer/sprite-zdog 中文文档

规范地址：https://npmcn.com/package/%40fungi.computer/sprite-zdog/

版本：0\.3\.2
npm 元数据更新时间：2026-11-08T18:14:55.985Z
中文译文更新时间：2026-11-15T18:56:21.498Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40fungi.computer/sprite-zdog
原文对照：https://npmcn.com/package/%40fungi.computer/sprite-zdog/?lang=original
项目主页：https://github.com/fungi-computer/sprite-zdog#readme
源码仓库：https://github.com/fungi-computer/sprite-zdog

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：306 kB，50 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2026-10-15T08:00:07.132Z
- 最新版本发布：2026-11-08T18:14:55.859Z
- 近 30 天下载量：6999（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 7 个）

## 中文简介

可选 Zdog 外观渲染器和便携式场景作者

## 安装

```sh
npm install @fungi.computer/sprite-zdog
```

也可以使用：`pnpm add @fungi.computer/sprite-zdog`、`yarn add @fungi.computer/sprite-zdog`、`bun add @fungi.computer/sprite-zdog`

## README

# Sprite Zdog (英语:`@fungi.computer/sprite-zdog`(中文(简体) )

Sprite Zdog是用于由Zdog所建字符的可选 Canvas 渲染器. 这个 还提供了内置字符和工具,用于编写可移植字符 文档 [丝绸](https://npmcn.com/package/%40fungi.computer/sprite/README.md) 可以装入.

## 安装或设置

```sh
npm install @fungi.computer/sprite-zdog
```

套装舰只进行无害环境管理,并取决于效果,Zod, `animejs`, (中文(简体) ), `zdog`,以及 [丝绸](https://npmcn.com/package/%40fungi.computer/sprite/README.md) 在运行时间。 仅添加到已存在的主机中 使用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 组件制作 :

```tsx
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`](https://npmcn.com/package/%40fungi.computer/sprite-zdog/src/builtins.test.ts) 财务报告和审定财务报表 [`src/mushroom.test.ts`](https://npmcn.com/package/%40fungi.computer/sprite-zdog/src/mushroom.test.ts)。 。 。 .

## 核心概念

包根导出 Zdog 渲染器作为默认导出 。 制作 服务字符文档 `renderer` 实值 `zdog`在Sprite中注册. 此示例配置使用 `assetPolicy` 作为主机的配置 Sprite 资产政策 :

```ts
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](https://npmcn.com/package/%40fungi.computer/sprite-zdog/docs/api/README.md), (中文(简体) ), [正在编写 API](https://npmcn.com/package/%40fungi.computer/sprite-zdog/docs/api/author.md),以及 [便携式文档 API](https://npmcn.com/package/%40fungi.computer/sprite-zdog/docs/api/portable.md)。软件包也暴露了 个人内置 `@fungi.computer/sprite-zdog/builtins/<name>`。 。 。 .

## 实例和检查

本地的Sprite故事中 `src/*.stories.tsx`。运行软件包测试 改为:

```sh
pnpm --filter @fungi.computer/sprite-zdog test
```

作者和便携式运行时间测试涵盖定义验证, 串行化,解码和清理.

## 限制和错误

Zdog渲染器需要浏览器窗口和画布. 它解码 字符的 Zdog 数据在创建渲染器并删除其画布之前 玩家选择关闭时的动画资源. 无效的场景数据, 缺少表达式, 或调色板颜色无效, 选择失败 .

作者的回调是信任的代码,在创建便携时运行 文档。 运行时渲染读取由此得到的JSON数据. 它不执行 写回电。 已送达的文档仍然使用 Sprite 的主机主机来源 和资产限制.

## 贡献和许可证

Sprite Zdog获得麻省理工学院的许可. 见 [`LICENSE`](https://npmcn.com/package/%40fungi.computer/sprite-zdog/LICENSE) 财务报告和审定财务报表 [`THIRD_PARTY_NOTICES`](https://npmcn.com/package/%40fungi.computer/sprite-zdog/THIRD_PARTY_NOTICES)。 。 。 .

## 常见问题

### @fungi\.computer/sprite-zdog 是什么？

可选 Zdog 外观渲染器和便携式场景作者

### 如何安装 @fungi\.computer/sprite-zdog？

在项目目录运行 npm install @fungi\.computer/sprite-zdog，或使用 pnpm add / yarn add / bun add。

### @fungi\.computer/sprite-zdog 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @fungi\.computer/sprite-zdog 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @fungi\.computer/sprite-zdog 可以商用吗？

@fungi\.computer/sprite-zdog 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @fungi\.computer/sprite-zdog 的下载量有多少？

根据 npm 官方下载统计，@fungi\.computer/sprite-zdog 在 2026/10/16 – 2026/11/14 这 30 天内被下载 6,999 次，日均约 233 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @fungi\.computer/sprite-zdog 还在维护吗？

最新版本 0\.3\.2 发布于 2026/11/09（7 天前）；至今共发布 7 个版本，其中过去 12 个月发布了 7 个；首次发布于 2026/10/15。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。