mirror of https://github.com/CesiumGS/obj2gltf.git
101 lines
3.1 KiB
Markdown
101 lines
3.1 KiB
Markdown
# OBJ2GLTF
|
|
|
|
Convert OBJ assets to [glTF](https://www.khronos.org/gltf) 1.0.
|
|
|
|
## Getting Started
|
|
|
|
Install [Node.js](https://nodejs.org/en/) if you don't already have it, and then:
|
|
```
|
|
npm install --save obj2gltf
|
|
```
|
|
Using obj2gltf as a library:
|
|
```javascript
|
|
var obj2gltf = require('obj2gltf');
|
|
var convert = obj2gltf.convert;
|
|
var options = {
|
|
separateTextures : true // Don't embed textures in the converted glTF
|
|
}
|
|
convert('model.obj', 'model.gltf', options)
|
|
.then(function() {
|
|
console.log('Converted model');
|
|
});
|
|
```
|
|
Using obj2gltf as a command-line tool:
|
|
|
|
`node bin/obj2gltf.js model.obj`
|
|
|
|
`node bin/obj2gltf.js model.obj model.gltf`
|
|
|
|
`node bin/obj2gltf.js -i model.obj -o model.gltf`
|
|
|
|
`node bin/obj2gltf.js -i model.obj -o model.gltf -s`
|
|
|
|
## Usage
|
|
|
|
###Command line flags:
|
|
|
|
|Flag|Description|Required|
|
|
|----|-----------|--------|
|
|
|`-h`|Display help.|No|
|
|
|`-i`|Path to the obj file.| :white_check_mark: Yes|
|
|
|`-o`|Path of the converted glTF file.|No|
|
|
|`-b`|Save as binary glTF.|No, default `false`|
|
|
|`-s`|Writes out separate geometry data files, shader files, and textures instead of embedding them in the glTF file.|No, default `false`|
|
|
|`-t`|Write out separate textures only.|No, default `false`|
|
|
|`-c`|Quantize positions, compress texture coordinates, and oct-encode normals.|No, default `false`|
|
|
|`-z`|Use the optimization stages in the glTF pipeline.|No, default `false`|
|
|
|`-n`|Generate normals if they are missing.|No, default `false`|
|
|
|`--cesium`|Optimize the glTF for Cesium by using the sun as a default light source.|No, default `false`|
|
|
|`--ao`|Apply ambient occlusion to the converted model.|No, default `false`|
|
|
|`--bypassPipeline`|Bypass the gltf-pipeline for debugging purposes. This option overrides many of the options above and will save the glTF with the KHR_materials_common extension.|No, default `false`|
|
|
|
|
## Build Instructions
|
|
|
|
Run the tests:
|
|
```
|
|
npm run test
|
|
```
|
|
To run JSHint on the entire codebase, run:
|
|
```
|
|
npm run jsHint
|
|
```
|
|
To run JSHint automatically when a file is saved, run the following and leave it open in a console window:
|
|
```
|
|
npm run jsHint-watch
|
|
```
|
|
|
|
### Running Test Coverage
|
|
|
|
Coverage uses [istanbul](https://github.com/gotwarlost/istanbul). Run:
|
|
```
|
|
npm run coverage
|
|
```
|
|
For complete coverage details, open `coverage/lcov-report/index.html`.
|
|
|
|
The tests and coverage covers the Node.js module; it does not cover the command-line interface, which is tiny.
|
|
|
|
## Generating Documentation
|
|
|
|
To generate the documentation:
|
|
```
|
|
npm run jsdoc
|
|
```
|
|
|
|
The documentation will be placed in the `doc` folder.
|
|
|
|
### Debugging
|
|
|
|
* To debug the tests in Webstorm, open the Gulp tab, right click the `test` task, and click `Debug 'test'`.
|
|
* To run a single test, change the test function from `it` to `fit`.
|
|
|
|
## Contributions
|
|
|
|
Pull requests are appreciated. Please use the same [Contributor License Agreement (CLA)](https://github.com/AnalyticalGraphicsInc/cesium/blob/master/CONTRIBUTING.md) used for [Cesium](http://cesiumjs.org/).
|
|
|
|
---
|
|
|
|
Developed by the Cesium team.
|
|
<p align="center">
|
|
<a href="http://cesiumjs.org/"><img src="doc/cesium.png" onerror="this.src='cesium.png'"/></a>
|
|
</p>
|