# voxel-mesh

> generate a three.js mesh from voxel data

Latest version **0.3.0** (published 2013-06-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install voxel-mesh
pnpm add voxel-mesh
yarn add voxel-mesh
bun add voxel-mesh
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2013-06-13 |
| First published | 2013-01-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 109 |
| Author | Max Ogden |
| Maintainers | maxogden |

## Links

- npm: https://www.npmjs.com/package/voxel-mesh
- Repository: http://github.com/maxogden/voxel-mesh
- npm.io page: https://npm.io/package/voxel-mesh

## Recent versions

- 0.3.0 (latest) — 2013-06-13
- 0.2.1 — 2013-03-23
- 0.2.0 — 2013-03-13
- 0.1.1 — 2013-01-31
- 0.1.0 — 2013-01-17
- 0.0.9 — 2013-01-17
- 0.0.8 — 2013-01-07
- 0.0.7 — 2013-01-05
- 0.0.6 — 2013-01-04
- 0.0.5 — 2013-01-04
- 0.0.4 — 2013-01-04
- 0.0.3 — 2013-01-04
- 0.0.2 — 2013-01-03
- 0.0.1 — 2013-01-01

## README

# voxel-mesh

generate a three.js mesh from voxel data. extracted from some code by @mikolalysenko

- original repo: https://github.com/mikolalysenko/mikolalysenko.github.com/tree/master/MinecraftMeshes2
- blog post: http://0fps.wordpress.com/2012/07/07/meshing-minecraft-part-2/
- webgl demo: http://mikolalysenko.github.com/MinecraftMeshes2/

# installation

it is recommended that you use browserify to use this module

```
npm install voxel-mesh
npm install browserify -g
browserify -r voxel-mesh > voxel-mesh-browserified.js
```

# usage

```javascript
var Mesh = require('voxel-mesh')
var voxelData = require('voxel').generator['Hilly Terrain']
var mesh = new Mesh(voxelData)
mesh.createSurfaceMesh()
threeJSScene.add(mesh)
```

## new Mesh(voxelData, meshingAlgorithm, scaleFactor)

`voxelData` and `meshingAlgorithm` are required, `scaleFactor` defaults to `new Three.Vector3(10, 10, 10)`.

## Mesh.prototype.createSurfaceMesh(material)

returns the generated surface mesh. `material` defaults to `new THREE.MeshNormalMaterial()`. after calling this method your mesh will also have `.surfaceMesh` populated with the new mesh

## Mesh.prototype.createWireMesh(hexColor)

returns the generated wire mesh. `hexColor` defaults to `0xffffff`. after calling this method your mesh will also have `.wireMesh` populated with the new mesh

## Mesh.prototype.addToScene(scene)

convenience method for adding the currently generated meshes (either `surfaceMesh` or `wireMesh`) to a `three.js` scene instance

## Mesh.prototype.setPosition(x, y, z)

convenience method for setting the position of the currently generated meshes (either `surfaceMesh` or `wireMesh`)

# license

MIT

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