Note

本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。
English · 原始项目 · 上游 README
原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。

Aholo Viewer

Aholo Viewer 软件包及其文档网站的 Monorepo。

Aholo Viewer 是什么

Aholo Viewer 是一款面向 3DGS 与 Mesh 的高性能渲染器（Renderer）。它使用 Chunked Steaming Lod schema 来处理大规模 3DGS。

用法

请遵循 手册.

如果一切顺利，你将看到 这个

有关 npm 软件包用法，请参阅 packages/renderer/README.md。

要进行 AI 辅助集成，请使用 docs/ai/skills/use-aholo-viewer/SKILL.md。

构建要求

• Node: >= 22.22.1
• pnpm（推荐使用 corepack）

克隆本仓库

本仓库包含一些作为依赖的子模块，请使用以下命令克隆仓库。

git clone --recurse-submodules https://github.com/manycoretech/aholo-viewer.git

结构

aholo-viewer/
  AGENTS.md             Agent-facing project guide
  website/              Astro website: home, manual, examples, API docs, playground
  packages/renderer/    Renderer TypeScript source package
  scripts/              Shared build and documentation scripts
  docs/                 Architecture and AI collaboration notes
  external/             Required upstream and workspace dependency sources
  .codex/skills/        Project-local Codex skills

命令

在仓库根目录运行工作区命令：

pnpm install
pnpm dev
pnpm check
pnpm build
pnpm preview

针对性的根目录命令：

pnpm build:renderer
pnpm build:website
pnpm check:content
pnpm check:renderer
pnpm check:website
pnpm docs:api

项目文档

• AGENTS.md：面向 AI 智能体及后续编码会话的快速指南
• docs/architecture.md：当前工作区结构与依赖流向
• docs/ai/vibe-coding-guide.md：面向后续 AI 辅助改动的详细指南，涵盖写作风格与交接事项
• docs/ai/skills/use-aholo-viewer/SKILL.md：面向 AI 编码智能体的外部 npm 软件包使用指南
• .codex/skills/：按仓库区域划分的本地 Codex skills

Codex Skills

项目本地 skills 位于 .codex/skills/。使用 AGENTS.md 查看当前 skill 映射。

外部源码

external/egs-core 是必需的上游子模块。external/splat-transform 是必需的工作区软件包，必须保留在仓库中。除非任务明确要求修改该软件包，否则请将 external/ 下的上游代码视为只读。

API 文档

API 文档由 packages/renderer/src/index.ts 生成到被忽略的本地目录中：

website/.generated/api/

pnpm dev、pnpm build 和 pnpm check 会自动重新生成它们。若要在不启动站点的情况下刷新本地 TypeDoc HTML 与 manifest，请直接运行生成器：

pnpm docs:api

内容检查

pnpm check:content 会校验手册各语言版本的一致性、空页面、示例源码配对、手册图片引用、孤立的手册图片，以及仅限内部的文档链接。它也是 pnpm check 和 pnpm check:website 的一部分。

Playground URL

Playground 通过 lz-string 将编辑后的代码保存在 URL 中：

/zh-CN/playground/?example=basic-scene&code=<compressed-source>

打开带有 code 的 URL 会自动恢复编辑器内容。

示例以配对的 <slug>.json 元数据与 <slug>.ts 源文件形式存储于 website/src/content/examples/。同一 slug 同时驱动 Examples 页面与 Playground 的 example 查询参数。

贡献者

由 contrib.rocks. 制作

Star 历史

有用链接

• 讨论区
• 官方网站
• CHANGELOG

许可证

MIT License。