https://github.com/threejs/three-devtools

three.js devtools
https://github.com/threejs/three-devtools

Last synced: 2 months ago
JSON representation

three.js devtools

• Host: GitHub
• URL: https://github.com/threejs/three-devtools
• Owner: threejs
• License: mit
• Archived: true
• Created: 2019-05-07T20:41:50.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-07T02:18:48.000Z (about 2 years ago)
• Last Synced: 2024-08-01T16:30:34.826Z (5 months ago)
• Language: JavaScript
• Homepage: https://chrome.google.com/webstore/detail/threejs-developer-tools/ebpnegggocnnhleeicgljbedjkganaek
• Size: 5.33 MB
• Stars: 602
• Watchers: 18
• Forks: 80
• Open Issues: 37
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-web - Three.js DevTools

README

        
# three-devtools

**three-devtools** is a web extension that allows inspection of three.js content.

> ## 🚨 Status: Experimental

> **three-devtools** is very much in an alpha/experimentation stage. Use at your own risk. Follow the [Baseline Milestone](https://github.com/jsantell/three-devtools/milestone/1) for issues and considerations that need to be solved in order for some stability.

## Installing

The alpha version of the developer tools can be installed as a web extension on [Firefox Add-ons/AMO](https://addons.mozilla.org/en-US/firefox/addon/three-js-developer-tools/) and for Chrome via [Chrome Web Store](https://chrome.google.com/webstore/detail/threejs-developer-tools/ebpnegggocnnhleeicgljbedjkganaek). See [DEVELOPMENT.md](DEVELOPMENT.md) for local installation.

## Current API

This API has not been thought out at all, but this will register your

THREE.Scene and THREE.Renderer to be observed by the tools.

```js

// Observe a scene or a renderer

if (typeof __THREE_DEVTOOLS__ !== 'undefined') {

  __THREE_DEVTOOLS__.dispatchEvent(new CustomEvent('observe', { detail: scene }));

  __THREE_DEVTOOLS__.dispatchEvent(new CustomEvent('observe', { detail: renderer }));

}

```

## Development

Architecture & development notes can be found in [DEVELOPMENT.md](DEVELOPMENT.md).