Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aframevr/aframe-inspector

:mag: Visual inspector tool for A-Frame. Hit *<ctrl> + <alt> + i* on any A-Frame scene.
https://github.com/aframevr/aframe-inspector

aframe editor inspector threejs virtual-reality virtualreality vr webvr

Last synced: 23 days ago
JSON representation

:mag: Visual inspector tool for A-Frame. Hit *<ctrl> + <alt> + i* on any A-Frame scene.

Awesome Lists containing this project

README

        

# A-Frame Inspector

A visual inspector tool for [A-Frame](https://aframe.io) scenes. Just hit
` + + i` on any A-Frame scene to open up the Inspector.

- [Documentation / Guide](https://aframe.io/docs/master/introduction/visual-inspector-and-dev-tools.html)
- [Example](https://aframe.io/aframe-inspector/examples/)

Also check out:

- [A-Frame Watcher](https://github.com/supermedium/aframe-watcher) - Companion server to sync changes to HTML files.

![Inspector Preview](https://user-images.githubusercontent.com/674727/50159991-fa540c80-028c-11e9-87f1-72c54e08d808.png)

## Using the Inspector

### Keyboard Shortcut

A-Frame comes with a **keyboard shortcut** to inject the inspector. Just open
up any A-Frame scene (running at least A-Frame v0.3.0) and press **` +
+ i`** to inject the inspector, just like you would use a DOM inspector:

### Specifying Inspector Build

This is done with the `inspector` component. By default, this is set on the
scene already. If we want, we can specify a specific build of the Inspector to
inject by passing a URL. For debugging:

```html

```

To use the master branch of the Inspector:

```html

```

## Local Development

```bash
git clone [email protected]:aframevr/aframe-inspector.git
cd aframe-inspector
npm install
npm start
```

Then navigate to __[http://localhost:3333/examples/](http://localhost:3333/examples/)__

## Self-hosting the sample-assets directory

The textures modal is using https://aframe.io/sample-assets/dist/images.json
to get the available textures.
The GitHub repository for those assets is https://github.com/aframevr/sample-assets

If you want to self-host this directory, do the following:

```bash
cd examples
git clone [email protected]:aframevr/sample-assets.git
```

edit `index.html` and define before any script tag this global variable:

```html
window.AFRAME_SAMPLE_ASSETS_ROOT = "./sample-assets/";
```