29 lines
1.0 KiB
Markdown
29 lines
1.0 KiB
Markdown
# @manycore/aholo-viewer
|
|
|
|
`@manycore/aholo-viewer` is the full-featured npm package for building browser-based Aholo Viewer applications. It includes the rendering runtime and TypeScript declarations for rendering 3D Gaussian Splatting (3DGS) and mesh content in WebGL/WebGL2-capable browsers.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
npm install --save @manycore/aholo-viewer
|
|
```
|
|
|
|
The package is ESM-only and ships TypeScript declarations through `dist/index.d.ts`.
|
|
|
|
## Quick Start
|
|
|
|
Follow the [Getting Started guide](https://aholojs.dev/en-US/manual/getting-started/) to create a Vite app, initialize a viewer, load a 3DGS splat, and render the first frame.
|
|
|
|
## Documentation
|
|
|
|
- Website: https://aholojs.dev/
|
|
- Getting Started: https://aholojs.dev/en-US/manual/getting-started/
|
|
- API Reference: https://aholojs.dev/en-US/api/
|
|
- Examples: https://aholojs.dev/en-US/examples/
|
|
- AI-friendly docs: https://aholojs.dev/llms.txt
|
|
- AI coding skill: https://github.com/manycoretech/aholo-viewer/blob/master/docs/ai/skills/use-aholo-viewer/SKILL.md
|
|
|
|
## License
|
|
|
|
MIT
|