mirror of
https://github.com/storytold/spark.git
synced 2026-10-13 23:52:44 +00:00
Diego Marcos Segura
71 lines
2.0 KiB
Markdown
71 lines
2.0 KiB
Markdown
# Getting Started
|
|
|
|
## Quick Start
|
|
|
|
Copy and paste code below in an `index.html` file or remix in the [Web Playground](https://stackblitz.com/edit/spark)
|
|
|
|
```html
|
|
<style> body {margin: 0;} </style>
|
|
<script type="importmap">
|
|
{
|
|
"imports": {
|
|
"three": "https://cdnjs.cloudflare.com/ajax/libs/three.js/0.174.0/three.module.js",
|
|
"@sparkjsdev/spark": "https://sparkjs.dev/releases/spark/0.1.8/spark.module.js"
|
|
}
|
|
}
|
|
</script>
|
|
<script type="module">
|
|
import * as THREE from "three";
|
|
import { SplatMesh } from "@sparkjsdev/spark";
|
|
|
|
const scene = new THREE.Scene();
|
|
const camera = new THREE.PerspectiveCamera(60, window.innerWidth / window.innerHeight, 0.1, 1000);
|
|
const renderer = new THREE.WebGLRenderer();
|
|
renderer.setSize(window.innerWidth, window.innerHeight);
|
|
document.body.appendChild(renderer.domElement)
|
|
|
|
const splatURL = "https://sparkjs.dev/assets/splats/butterfly.spz";
|
|
const butterfly = new SplatMesh({ url: splatURL });
|
|
butterfly.quaternion.set(1, 0, 0, 0);
|
|
butterfly.position.set(0, 0, -3);
|
|
scene.add(butterfly);
|
|
|
|
renderer.setAnimationLoop(function animate(time) {
|
|
renderer.render(scene, camera);
|
|
butterfly.rotation.y += 0.01;
|
|
});
|
|
</script>
|
|
```
|
|
|
|
## Install with NPM
|
|
|
|
```shell
|
|
npm install @sparkjsdev/spark
|
|
```
|
|
## Develop and contribute to Spark
|
|
|
|
Build Spark (It requires [Rust](https://www.rust-lang.org/tools/install) installed in your machine)
|
|
```
|
|
npm install
|
|
npm run dev
|
|
```
|
|
|
|
This will run a Web server at [http://localhost:8080/](http://localhost:8080/) with the examples.
|
|
|
|
## Table of Contents
|
|
|
|
- [Spark Overview](overview.md)
|
|
- [System Design](system-design.md)
|
|
- [SparkRenderer](spark-renderer.md)
|
|
- [SparkViewpoint](spark-viewpoint.md)
|
|
- [SplatMesh](splat-mesh.md)
|
|
- [PackedSplats](packed-splats.md)
|
|
- [Loading Gsplats](loading-splats.md)
|
|
- [Procedural Splats](procedural-splats.md)
|
|
- [Splat RGBA-XYZ SDF editing](splat-editing.md)
|
|
- [Dyno overview](dyno-overview.md)
|
|
- [Dyno standard library](dyno-stdlib.md)
|
|
- [Controls](controls.md)
|
|
- [Performance tuning](performance.md)
|
|
- [Community Resources](community-resources.md)
|