Craster

Turns 3D models into images. Accepts STL, OBJ, and 3DS files and returns a PNG sprite image with 360° rotations.

Usage

$ craster --help
Usage:
  craster [OPTIONS] [ARGS]

Options:
  -u, --url STRING       URL of the 3D model
      --path STRING      Path of the 3D model
  -i, --image PATH       Path to final image
  -n, --num [NUMBER]     Number of captures (Default is 20)
  -x NUMBER              3D X (Default is 0)
  -y NUMBER              3D Y for the start (Default is 0)
  -z NUMBER              3D Z (Default is 0)
  -W, --width [NUMBER]   Image width (Default is 1000)
  -H, --height [NUMBER]  Image height (Default is 1000)
  -c, --color [STRING]   Color for the 3D model (Default is eeeeee)
  -s, --no-progress      Disable progress
      --port NUMBER      Port for the http server that serves the viewer
      --server           Keep the http server open
  -k, --no-color         Omit color from output
      --debug            Show debug information
  -v, --version          Display the current version
  -h, --help             Display help and usage details

Example

$ craster --url http://wtf.sunfox.org/3d/cults-logo.stl --image logo.png

Install

$ npm install -g craster

Local Development

$ git clone https://github.com/sunny/craster
$ cd craster
$ npm install

You can then use the following command:

$ bin/craster

To test in a browser, you can use --server --port 9000 to keep the server open on a given port. You may need to launch a browser with CORS disabled. E.g., for Chrome under OS X:

$ open -na /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome \
  --args --user-data-dir="/tmp/chrome_dev_test" --disable-web-security

Release

Make sure you have the jq package installed.

Then change the version in package.json, update the CHANGELOG.md, then:

$ npm install
$ git add package.json package-lock.json CHANGELOG.md
$ git commit -m v`jq -r '.version' < package.json`
$ git tag v`jq -r '.version' < package.json`
$ git push && git push --tags
$ npm publish