A high performance 3DGS renderer
Aholo Viewer
Monorepo for the Aholo Viewer package and its documentation website.
What is Aholo Viewer
Aholo Viewer is a high performance Renderer for 3DGS and Mesh. It uses Chunked Steaming Lod schema to handle huge 3DGS.
Usage
Follow the Manual.
If everything goes well you will see this
For npm package usage, see packages/renderer/README.md.
For AI-assisted integration, use docs/ai/skills/use-aholo-viewer/SKILL.md.
Build Requirements
- Node: >= 22.22.1
- pnpm(corepack preferred)
Clone this repository
This repository contains some submodules as dependencies, use following command to clone the repository.
git clone --recurse-submodules https://github.com/manycoretech/aholo-viewer.git
Structure
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
Commands
Run workspace commands from the repository root:
pnpm install
pnpm dev
pnpm check
pnpm build
pnpm preview
Targeted root commands:
pnpm build:renderer
pnpm build:website
pnpm check:content
pnpm check:renderer
pnpm check:website
pnpm docs:api
Project Docs
AGENTS.md: quick guide for AI agents and future coding sessionsdocs/architecture.md: current workspace structure and dependency flowdocs/ai/vibe-coding-guide.md: detailed guide for future AI-assisted changes, writing style, and handoffsdocs/ai/skills/use-aholo-viewer/SKILL.md: external npm package usage guide for AI coding agents.codex/skills/: local Codex skills split by repo area
Codex Skills
Project-local skills live in .codex/skills/. Use AGENTS.md for the current skill map.
External Source
external/egs-core is a required upstream submodule. Treat upstream code under external/ as read-only unless a task explicitly targets that package.
API Docs
API docs are generated from packages/renderer/src/index.ts into an ignored local directory:
website/.generated/api/
pnpm dev, pnpm build, and pnpm check regenerate them automatically. Run the generator directly when you want to refresh the local TypeDoc HTML and manifest without starting the site:
pnpm docs:api
Content Checks
pnpm check:content validates manual locale parity, empty pages, example source pairs, manual image references, orphan manual images, and internal-only documentation links. It is also part of pnpm check and pnpm check:website.
Playground URLs
The Playground keeps edited code in the URL with lz-string:
/zh-CN/playground/?example=basic-scene&code=<compressed-source>
Opening a URL with code restores the editor content automatically.
Examples are stored in website/src/content/examples/ as paired <slug>.json metadata and <slug>.ts source files. The same slug powers the Examples pages and Playground example query parameter.
Contributors
Made with contrib.rocks.