Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/FlorianFe/vox-reader
Browse files Browse the repository at this point in the history
  • Loading branch information
Florian Fechner authored and Florian Fechner committed Jun 6, 2018
2 parents 12efb3c + 83a0c59 commit 633af3c
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,17 @@
# vox-reader
npm module for reading .vox files
npm module for reading [.vox](https://github.com/ephtracy/voxel-model/blob/master/MagicaVoxel-file-format-vox.txt) files which can be exported in [MagickaVoxel](https://ephtracy.github.io/).

```bash
npm install --save vox-reader
```

```js
const readVox = require('vox-reader');

fs.readFile('my-voxel-art.vox', (error, buffer) =>
{
if (error) throw error;

console.log(readVox(buffer));
});
```

0 comments on commit 633af3c

Please sign in to comment.