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

Package detail

parse-magica-voxel

kevzettler55GPLv32.1.2

Parse MagicaVoxel .vox format to JS objects

Vox, MagicaVoxel, Magica, Voxel, voxel, .vox, loader, parser

readme

Parse MagicaVoxel .vox file format

Javascript parser for MagicaVoxel .vox file format:

https://github.com/ephtracy/voxel-model/blob/master/MagicaVoxel-file-format-vox.txt

Works in Browser and Node.js server environments

Install

npm install parse-magica-voxel

Usage

see examples

  • Node.js `javascript var fs = require('fs'); var parseMagicaVoxel = require('parse-magica-voxel');

fs.readFile("./chr_old.vox", function (err, Buffer) { if (err) throw err; console.log(JSON.stringify(parseMagicaVoxel(Buffer))); });


* Browser

You will have to bundle the module with Webpack or Browserify and load the voxel file using `fetch` or another `XMLHttpRequest` utility
```javascript
var parseMagicaVoxel = require('parse-magica-voxel');
var myRequest = new Request('magicavoxel.vox');
fetch(myRequest).then(function(response) {
    return response.arrayBuffer();
  }).then(function(buffer) {
     console.log(JSON.stringify(parseMagicaVoxel(Buffer));
    });
  });
};

Result

{
  "VOX ": 150,
  "PACK": 1,
  "SIZE": {
    "x": 20,
    "y": 21,
    "z": 20
  },
  "XYZI": [
   {x, y, z, c},
   //... more voxels
  ],
  "RGBA": [
   {r,g,b,a},
   //... more rgba values
  ],
}