| core logics for decode .spz |
| [babylonjs](./packages/babylonjs/README.md) | 
| integration for Babylon.js `GaussianSplattingMesh` |
| [playcanvas](./packages/playcanvas/README.md) | 
| integration for PlayCanvas Engine and `GSplat` Entity |
## Install & Usage
### Example of Babylon.js
Install like below. `@spz-loader/babylonjs` requires Babylon.js version 7 or later.
```sh
# for npm
npm i @babylonjs/core @spz-loader/babylonjs
# for pnpm
pnpm add @babylonjs/core @spz-loader/babylonjs
```
Code example of ESModule or TypeScript.
```ts
import "./style.css";
import { Engine, Scene } from "@babylonjs/core";
import { createGaussianSplattingFromSpz } from "@spz-loader/babylonjs";
import spzPath from "../assets/hornedlizard.spz?url";
const engine = new Engine(renderCanvas);
const scene = new Scene(engine);
// ...
const splat = await createGaussianSplattingFromSpzUrl(spzPath, scene);
```
### Core package
Install like below.
```sh
# for npm
npm i @spz-loader/core
# for pnpm
pnpm add @spz-loader/core
```
Usage example of core package.
```ts
import { loadSpz } from "@spz-loader/core";
import spzUrl from "../assets/racoonfamily.spz?url";
const splat = await loadSpzFromUrl(spzUrl);
console.log(splat.numPoints);
```
## Developing spz-loader
### Environment
Project author's local environment is below.
- Windows 11 Home
- Node.js 20.18.1
- pnpm 9.14.2
- Docker Desktop
- with VSCode dev container
- Emscripten 3.1.72 (on docker)
### Setup
Clone this repo and submodule
```sh
git clone https://github.com/drumath2237/spz-loader.git
git submodule update --init --recursive
```
Repository structure is below.
spz-loader is a monorepo project setup by pnpm-workspace.
```txt
/
โโ packages/
โ โโ core/
โ โ โโ lib/
โ โ โโ spz-wasm/
โ โ โ โโ spz/ <-- submodule
โ โ โโ build.sh
โ โ โโ index.ts
โ โโ babylonjs/
โ โ โโ lib/
โ โ โโ index.ts
โ โโ playcanvas/
โ โโ lib/
โ โโ index.ts
โโ package.json
โโ pnpm-lock.yaml
โโ pnpm-workspace.yaml
```
To install dependencies, you can run `pnpm install` on the root directory.
```sh
pnpm install
```
### Build packages
Run build script `build:all`.
This command does follow:
1. Build spz(C++) to WebAssembly by Emscripten on a Docker container
2. Build `@spz-loader/core` package by Vite library mode
3. Build `@spz-loader/babylonjs` package by Vite library mode
```sh
pnpm build:all
```
## Author
[@drumath2237](https://x.com/ninisan_drumath)