GitHub - Shopify/screenshot-glb: A command line utility for taking screenshots of glTF 2.0 Binary 3D model files (original) (raw)

Easily take screenshots and create thumbnail images for glTF 2.0 Binary (GLB) files.

Install

Use npm to install this tool:

npm install ---save @shopify/screenshot-glb

Usage

To start taking screenshots of GLB files

$ screenshot-glb Options: --help Show help [boolean] --version Show version number [boolean] -i, --input Input glTF 2.0 binary (GLB) filepath [required] -o, --output Output PNG screenshot filepath [required] -t, --timeout Timeout length -w, --width Output image width -h, --height Output image height -c, --color Change the background color of the rendered image -@, --model_viewer_version Pass the version of Model Viewer which should be used .eg 1.9 -m, --model_viewer_attributes Pass attributes as a URL search param string -q, --image_quality Change the image quality of the rendered JPG default 0.92

Dependencies

The module relies on using puppeteer to spawn a headless instance of Chrome to render Google's web component with the GLB model loaded.

Development

For Shopify Employees

• dev up
• yarn link
• You may need to need to do chmod 755 dist/cli.js to allow for execution
• screenshot-glb -i <PATH_TO_MODEL> -o <PATH_TO_OUTPUT_IMAGE>

Outside Development

• yarn install
• yarn link
• screenshot-glb -i <PATH_TO_MODEL> -o <PATH_TO_OUTPUT_IMAGE>

Examples

// Simply render a GLB to a JPG
$ screenshot-glb -i <PATH_TO_MODEL> -o <PATH_TO_OUTPUT_IMAGE>

// Change the width and height of the render
$ screenshot-glb -i <PATH_TO_MODEL> -o <PATH_TO_OUTPUT_IMAGE> --width 600 --height 1200

// Change the exposure and environment-image
$ screenshot-glb -i <PATH_TO_MODEL> -o <PATH_TO_OUTPUT_IMAGE> -m "environment-image=neutral&exposure=0.92"

// Use a specific version of Model Viewer to create the screenshot
$ screenshot-glb -i <PATH_TO_MODEL> -o <PATH_TO_OUTPUT_IMAGE> -@ 1.9

Linux

You may need to install the following packages in order for the headless Chrome instance to work on headless Linux VM machines:

gconf-service
libasound2
libatk1.0-0
libatk-bridge2.0-0
libc6
libcairo2
libcups2
libdbus-1-3
libexpat1
libfontconfig1
libgcc1
libgconf-2-4
libgdk-pixbuf2.0-0
libglib2.0-0
libgtk-3-0
libnspr4
libpango-1.0-0
libpangocairo-1.0-0
libstdc++6
libx11-6
libx11-xcb1
libxcb1
libxcomposite1
libxcursor1
libxdamage1
libxext6
libxfixes3
libxi6
libxrandr2
libxrender1
libxss1
libxtst6
ca-certificates
fonts-liberation
libappindicator1
libnss3
lsb-release
xdg-utils
wget