usco-headless-renderer

Headless webgl renderer thumbnail image renderer for 3d files : stl, obj, ctm

This is a command line thumbnail image renderer of 3d files, using webgl

Table of Contents

• usco-headless-renderer
  • Table of Contents
  • Installation
  • System dependencies
  • Usage
  • Contribute
  • License

Installation

as a command line tool (typical use case)

npm install -g --production usco/usco-headless-renderer

as a module

npm install usco/usco-headless-renderer

System dependencies

You also need to install a few packages on your system (needed for headless webgl rendering): for Debian/Ubuntu these are :

• sudo apt-get install pkg-config
• sudo apt-get install xvfb
• sudo apt-get install libx11-dev
• sudo apt-get install libxi-dev
• sudo apt-get install libgl1-mesa-dev

Usage

  usco-headless-renderer input=<PATH-TO-FILE> output=<PATH-TO-OUTPUT.png> resolution=320x240 cameraPosition=[75,75,145] verbose=true

IMPORTANT !!! do NOT use spaces when defining the resolution or cameraPosition parameters, or things will break !

Contribute

PRs accepted.

Small note: If editing the Readme, please conform to the standard-readme specification.

License

The MIT License (MIT) (unless specified otherwise)