# sculpty

> [sculpty](https://github.com/danielesteban/sculpty) [![npm-version](https://img.shields.io/npm/v/sculpty.svg)](https://www.npmjs.com/package/sculpty) ==

Latest version **0.0.4** (published 2023-01-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install sculpty
pnpm add sculpty
yarn add sculpty
bun add sculpty
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2023-01-29 |
| First published | 2023-01-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 63 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | Daniel Esteban Nombela |
| Maintainers | danielesteban |

## Links

- npm: https://www.npmjs.com/package/sculpty
- Repository: https://github.com/danielesteban/sculpty
- Homepage: https://sculpty.gatunes.com
- Issues: https://github.com/danielesteban/sculpty/issues
- npm.io page: https://npm.io/package/sculpty

## Recent versions

- 0.0.4 (latest) — 2023-01-29
- 0.0.3 — 2023-01-29
- 0.0.2 — 2023-01-29
- 0.0.1 — 2023-01-29

## README

[sculpty](https://github.com/danielesteban/sculpty)
[![npm-version](https://img.shields.io/npm/v/sculpty.svg)](https://www.npmjs.com/package/sculpty)
==

### Installation

```bash
npm install sculpty
```

### Basic usage

```js
import { World } from 'sculpty';
import { PerspectiveCamera, Scene, sRGBEncoding, WebGLRenderer } from 'three';

const aspect = window.innerWidth / window.innerHeight;
const camera = new PerspectiveCamera(75, aspect, 0.1, 1000);
const renderer = new WebGLRenderer({ antialias: true });
renderer.outputEncoding = sRGBEncoding;
renderer.setSize(window.innerWidth, window.innerHeight);
document.getElementById('renderer').appendChild(renderer.domElement);

const scene = new Scene();
const world = new World();
world.update(Array.from({ length: 20 }, (_, i) => ({
  x: i - 10, y: Math.floor(Math.sin(i * 0.5) * 2), z: -10,
  r: 255, g: 255, b: 255,
  value: 255,
})));
scene.add(world);

renderer.setAnimationLoop(() => {
  renderer.render(scene, camera);
});
```

### Examples

 * Basic: [sculpty.glitch.me](https://sculpty.glitch.me) ([source](https://glitch.com/edit/#!/sculpty))
 * Editor: [sculpty.gatunes.com](https://sculpty.gatunes.com) ([source](example))

---
_Source: https://npm.io/package/sculpty · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._