Getting Started

About the Substance 3D Web Viewer

There are multiple ways to start using the Substance 3D Web Viewer:

We recommend using npm packages to integrate the Substance 3D Web Viewer into your project. These packages provide support if you want to use the web components directly in your project.

NPM packages

The main packages to install are :

@a3d-viewer/viewer : The main package to install to use the Substance 3D Web Viewer

You can install them by :

Adding the following to your ~/.npmrc:


@a3d-viewer:registry=https://artifactory-uw2.adobeitc.com/artifactory/api/npm/npm-3dcs-release/
@a3d-ui:registry=https://artifactory-uw2.adobeitc.com/artifactory/api/npm/npm-3dcs-release/
@a3d-lib:registry=https://artifactory-uw2.adobeitc.com/artifactory/api/npm/npm-3dcs-release/
//artifactory-uw2.adobeitc.com/artifactory/api/npm/npm-3dcs-release/:always-auth=true

Then running:


npm install @a3d-viewer/viewer

CDN

You can also use the Substance 3D Web Viewer directly from a CDN.

This is not the recommended approach for production use, but it can be useful for testing or prototyping.


<script
  type="module"
  async
  src="https://cdn.substance3d.com/v2/files/public/a3d-viewer-latest.js"
></script>

Or with a specific version:


<script
  type="module"
  async
  src="https://cdn.substance3d.com/v2/files/public/a3d-viewer-1-12-0.js"
></script>