This package contains tools and testing processes that enable the
<model-viewer> project to ensure high-fidelity 3D model rendering as well
as compare its rendering qualities to those of other renderers.
If you are looking for the <model-viewer> web component, please refer to the
<model-viewer> package and also the live docs and examples
on modelviewer.dev.
To get started, follow the instructions in the main README.md file.
In order to run npm run update-screenshots, you must have imagemagick installed.
On macOS, you can install imagemagick with homebrew: brew install imagemagick
On Debian/Ubuntu/Pop!_OS you can install imagemagick with apt: sudo apt install imagemagick
The following commands are available when developing modelviewer.dev:
| Command | Description |
|---|---|
npm run build |
Build artifacts required to run testing and review tools |
npm run clean |
Deletes all build artifacts |
npm run test |
Run a render fidelity check comparing <model-viewer> to other renderers |
npm run update-screenshots |
Update the "golden" screenshots for all renderers |
You can specify the scenarios when running npm run test and npm run update-screenshots by appending scenarios. (e.g. npm run update-screenshots khronos-BoomBox khronos-FlightHelmet will only update screenshots of these two scenarios) For npm run update-screenshots, you can further specify which renderers you want to update screenshots for. (e.g. npm run update-screenshots khronos-BoomBox babylon means update screenshots for khronos-BoomBox only with babylon)
After running npm run test, you can look at the results by starting a local web server
(e.g. npx http-server) in this folder, then opening test/results-viewer.html in a browser.