Files
spark/docs/getting-started.md
T
Andreas Sundquist 8b5f854848 Remove obsolete code
2025-05-30 10:49:49 -07:00

53 lines
1.3 KiB
Markdown

# Getting Started
## Quick Start
Copy and paste code below in an `index.html` file or remix in the [Web Playground](https://glitch.com/edit/#!/forge-dev)
```html
<style> body {margin: 0;} </style>
<script type="importmap">
{
"imports": {
"three": "/node_modules/three/build/three.module.js",
"@worldlabsai/forge": "/dist/forge.module.js"
}
}
</script>
<script type="module">
import * as THREE from "three";
import { SplatMesh } from "@worldlabsai/forge";
const scene = new THREE.Scene();
const camera = new THREE.PerspectiveCamera(75, window.innerWidth / window.innerHeight, 0.1, 1000);
const renderer = new THREE.WebGLRenderer();
renderer.setSize(window.innerWidth, window.innerHeight);
document.body.appendChild(renderer.domElement)
`
const butterfly = new SplatMesh({ url: "../assets/splats/butterfly.spz"});
butterfly.quaternion.set(1, 0, 0, 0);
butterfly.position.set(0, 0, -1);
scene.add(butterfly);
renderer.setAnimationLoop(function animate(time) {
renderer.render(scene, camera);
butterfly.rotation.y += 0.01;
});
</script>
```
## Install with NPM
```shell
npm install forge-dev
```
## Develop and contribute to Forge
Build Forge (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.