Skip to content

Avatar 编辑器与开发者接入 ​

OneWorks Avatar 是浏览器端 3D 几何头像编辑器,也提供与在线编辑器共用同一套渲染器的开发者组件。你可以保存可继续编辑的源、导出 SVG/PNG/GIF,或在 React、Vue 和原生 JavaScript 应用中直接渲染与编辑版本化 Avatar definition。

在线编辑器:oneworks.cloud/avatar。

创建与导出 ​

  1. 从首页选择内置形象,或进入编辑器构建自己的几何形象。
  2. 调整姿态、位置、缩放、面部、材质、光照、阴影、描边和动画。
  3. 进入相机模式,选择画面尺寸、相框与背景。
  4. 复制 SVG,或下载 SVG、PNG 和动画 GIF。

编辑器支持简体中文和英文,主题可跟随系统或手动切换明暗模式。

格式用途说明
SVG静态矢量资源保留当前 3D 场景的矢量投影、相机背景与相框裁切。
PNG静态位图资源支持透明背景,适合应用头像、社交平台和设计稿。
GIF动画资源导出当前选中的动画;未选择动画时不可用。

可选尺寸为 128、256 和 512 像素。相机背景可使用颜色或透明,相框可选方形、圆角或圆形。圆角和圆形相框外部保持透明。

开发者接入 ​

3D Runtime 与框架适配器统一使用 1.0.0-rc.6。@oneworks/avatar 已直接升级为框架无关的 3D 核心包,旧的 2D 像素 renderer 不再保留。

bash
pnpm add @oneworks/avatar@rc
# 按项目选择一个或多个适配器
pnpm add @oneworks/avatar-react@rc @oneworks/avatar-vue@rc @oneworks/avatar-web@rc
包用途
@oneworks/avatar版本化 definition、校验、序列化和动画运行时。
@oneworks/avatar-reactReact Avatar 渲染组件和完整 AvatarEditor。
@oneworks/avatar-vueVue OneWorksAvatar 和 OneWorksAvatarEditor。
@oneworks/avatar-web原生 JavaScript mount API 和显式注册 Web Component。

按接入目标继续阅读:

保存可编辑源与应用资源 ​

即使应用使用 Runtime,也建议同时保存编辑源和部署资源:

ts
interface AvatarAssetRecord {
  definition: AvatarDefinition
  editorUrl?: string
  assetUrl?: string
  format?: 'svg' | 'png' | 'gif'
}
  • definition 用于 Runtime 渲染和程序化动画。
  • editorUrl 是编辑器生成的完整分享链接;将它作为不可拆解的整体保存。
  • assetUrl 指向上传到静态资源服务或媒体存储的导出文件。
  • 编辑器链接不是图片直链,不能直接用于 <img src>。

Agent Skill ​

Avatar 仓库包含 oneworks-avatar Agent Skill,用于创建、调试、导出和接入头像:

bash
npx skills@latest add oneworks-ai/avatar

这个 Skill 使用真实编辑器及其 3D 场景模型,不会通过图像生成器重新绘制结果。

源码、本地开发与部署 ​

3D 编辑器、@oneworks/avatar Runtime、框架适配器和导出链路统一位于 oneworks-ai/avatar。

Avatar 仓库作为 assets/avatar submodule 挂载回 app 仓库;四个公开包同时是 app 根 workspace 的成员。Avatar 仓库也可以单独检出,并通过 app-source checkout 或软链接使用共享包源码。

bash
pnpm install --no-frozen-lockfile
ln -s /path/to/oneworks-app app-source
ONEWORKS_APP_SOURCE_DIR=app-source pnpm dev
ONEWORKS_APP_SOURCE_DIR=app-source pnpm test
ONEWORKS_APP_SOURCE_DIR=app-source pnpm typecheck:sdk
ONEWORKS_APP_SOURCE_DIR=app-source pnpm smoke:sdk

Avatar 页面由 Avatar 仓库的 deploy-avatar.yml workflow 发布。app 仓库在 assets/avatar、assets/avatar/** 或 .github/workflows/deploy-avatar.yml 变化时触发它。文档页由主站 docs workflow 从 .oo/docs 发布。

One Works 文档站独立构建,面向用户接入与使用。支持邮箱:support@oneworks.cloud。