Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@sh-dave/format-vox

sh-dave140zlib0.1.6

A reader for MagicaVoxel's VOX file format

VOX, magicavoxel

readme

haxe-format-vox

A reader for MagicaVoxels's VOX files. Reads most of the v0.99 chunks including the world builder nodes.

  • <input checked="" disabled="" type="checkbox"> PACK - skipped / unused
  • <input checked="" disabled="" type="checkbox"> SIZE
  • <input checked="" disabled="" type="checkbox"> XYZI
  • <input checked="" disabled="" type="checkbox"> RGBA
  • <input checked="" disabled="" type="checkbox"> MATT - skipped / unused
  • <input checked="" disabled="" type="checkbox"> MATL
  • <input checked="" disabled="" type="checkbox"> nTRN
  • <input checked="" disabled="" type="checkbox"> nSHP
  • <input checked="" disabled="" type="checkbox"> nGRP
  • <input disabled="" type="checkbox"> rOBJ - missing specs
  • <input disabled="" type="checkbox"> LAYR - missing specs

haxe

usage in haxe

var data: BytesData = ...;
format.vox.VoxReader.read(data, function( ?vox, ?err ) {
    if (err != null) {
        trace(err);
        return;
    }

    // use vox.models to get the meshes
    // use vox.nodeGraph to access to world builder nodes
});

haxe examples

javascript

usage in javascript

const VoxReader = require('@sh-dave/format-vox').VoxReader;
const data = ...some ArrayBuffer...;

VoxReader.read(data, (vox, err) => {
    if (err) {
        console.error(err);
        return;
    }

    // use vox.models to get the meshes
    // use vox.nodeGraph to access to world builder nodes
});

javascript library build instructions

All dependencies are simply installed via npm thanks to lix

npm install
npx haxe build-js.hxml