Skip to content
bhoustonPublic

About

A TypeScript/JavaScript suite of tools for viewing, converting, validating MaterialX materials.

Topics

Resources

Contributing

Stars

9 stars

Watchers

0 watching

Forks

Latest commit

 

History

357 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mtlx logo


npm package npm downloads coverage discord chat documentation


mtlx

View, edit, validate, and ship MaterialX materials on the web.

  • 🎨 Interactive 3D Material Preview
  • 🧩 Drop-In Web Component
  • 🕸️ Node Graph Editing
  • ✅ Validation and Inspection
  • 📦 Portable .mtlx.zip Packages
  • 💻 CLI and VS Code Extension

mtlx is a set of TypeScript and JavaScript tools for working with MaterialX materials. Work with loose .mtlx files or portable .mtlx.zip archives in the browser, terminal, or VS Code.

Read the Docs to Learn More.

Packages

Package Version (click for changelogs)
mtlx-core mtlx-core version
mtlx-viewer mtlx-viewer version
mtlx-cli mtlx-cli version
mtlx-sdk mtlx-sdk version
mtlx-vscode-extension mtlx-vscode-extension version

Try the viewer · Open the editor · Get started

MaterialX preview and inspection controls

Embed a material

Add <material-viewer> to any HTML page. No React or build step is required.

<script type="module" src="https://cdn.jsdelivr.net/npm/mtlx-viewer/dist/material-viewer.js"></script>
<material-viewer
  src="https://mtlx.ben3d.ca/materials/copper/copper.mtlx"
  alt="Copper material under neutral studio lighting"
  settings-panel="closed"
  style="display:block;width:100%;height:440px"
></material-viewer>

Element guide and live demo

Use the CLI

npm install --global mtlx-cli
mtlx check material.mtlx
mtlx view material.mtlx
mtlx transform material.mtlx -o material.mtlx.zip --profile web

Choose a library

Package Use it for Documentation
mtlx-core Parsing, validation, packaging, transforms, and headless graph editing Core guide
mtlx-viewer Web component, React wrapper, and Three.js preview APIs Viewer guide
mtlx-cli Local workflows and MTLX.ai commands CLI guide
mtlx-sdk Typed MTLX.ai service client SDK guide
mtlx-editor Reusable React node editor (source workspace package) Editor guide
VS Code extension Previews, node graphs, and packaging inside your editor Extension guide

Node tools require Node.js 22+. Browser rendering needs GPU-backed WebGPU or WebGL2. Validation covers selected document rules; preview support follows Three.js's MaterialX loader.

Releases

See RELEASING.md for how releases are published and GitHub Releases for changes.

Contribution

See Contributing Guide.

License

MIT

Author

Ben Houston, Sponsored by Land of Assets.

About

A TypeScript/JavaScript suite of tools for viewing, converting, validating MaterialX materials.

Topics

Resources

Contributing

Stars

9 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages