@blockv/threejs-to-v3d/README.md

Converts any format supported by ThreeJS to V3D.

# ThreeJS to V3D converter

This module uses the importers on the Three.js library to convert 3D scene files to the .v3d format. It can be used via the command-line, from node, or from the browser.

*NOTE: Currently only supports FBX files*

## Use from the command-line

First, install the module:

```
npm install -g threejs-to-v3d
```

Then use it:

``` javascript
threejs-to-v3d --input file1.fbx file2.jpg --output file.v3d
```

## Use from Node

Require and use it:

``` javascript
require("threejs-to-v3d").convert(["file1.fbx", "file2.jpg"]).then(arraybuffer => fs.writeFile("file.v3d", new Buffer(arraybuffer)));
```

## Use from the browser via script

Include the script on your page:

``` html
<script src="threejs-to-v3d.min.js"></script>
```

Then use it, by passing in an array of [File](https://developer.mozilla.org/en-US/docs/Web/API/File) objects:

``` javascript
ThreeJSConverter.convert(files).then(function(arraybuffer) {
    saveAs(new File([arraybuffer], "output.v3d"));
});
```

## Use from the browser via webpack

First, since this module uses some native Node modules, they need to be excluded from packaging in your webpack config:

``` javascript
{
    ...
    externals: [
        { fs: true, "fs.promised": true }
    ]
    ...
}
```

Then, you can require and use it normally:

``` javascript
require("threejs-to-v3d").convert(files).then(arraybuffer => {
    saveAs(new File([arraybuffer], "output.v3d"));
});
```