# aframe-supercraft-loader

> Supercraft loader for A-Frame.

Latest version **3.0.0** (published 2018-07-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install aframe-supercraft-loader
pnpm add aframe-supercraft-loader
yarn add aframe-supercraft-loader
bun add aframe-supercraft-loader
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2018-07-13 |
| First published | 2018-06-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 846.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Supermedium |
| Maintainers | ngokevin |
| Keywords | aframe, supermedium, supercraft, webvr, threejs |

## Links

- npm: https://www.npmjs.com/package/aframe-supercraft-loader
- Homepage: https://supermedium.com/supercraft/
- npm.io page: https://npm.io/package/aframe-supercraft-loader

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 3.0.0 (latest) — 2018-07-13
- 2.0.0 — 2018-07-06
- 1.1.3 — 2018-06-07
- 1.1.2 — 2018-06-07
- 1.1.1 — 2018-06-07
- 1.1.0 — 2018-06-07
- 1.0.0 — 2018-06-06

## README

## aframe-supercraft-loader

Loader for scenes and objects created with
[Supercraft](https://supermedium.com/supercraft), an in-VR creation tool built
with WebVR and A-Frame.

![Supercraft](https://user-images.githubusercontent.com/674727/40456476-6bfd8400-5ea6-11e8-9430-e3a34cb1e7d5.jpg)

### API

#### supercraft-loader

Load a Supercraft object into an A-Frame scene.

Use either `src` or `name` to point to a Supercraft asset.

| Property           | Description                                                                                                                                                               | Default Value |
|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| includeEnvironment | Whether to include environment (sky, ground, lights).                                                                                                                     | true          |
| includeShadows     | Whether the mesh should receive and cast shadows. Alternatively, just set the `shadow` component.                                                                         | true          |
| name               | Name of Supercraft asset hosted on server. For example, if the site was at `https://supermedium.com/craft/hello-world`, then set `supercraft-loader="name: hello-world"`. | ''            |
| src                | Selector to `<a-asset-item>` or URL to Supercraft JSON.                                                                                                                   | ''            |

![](https://user-images.githubusercontent.com/674727/41128194-2ee1b420-6a62-11e8-9354-57d6e2946fb1.png)

#### supercraft-visualizer

Similar to supercraft-loader, but loads shapes in over time, visualizing the
creation process over a set duration. Really cool!

| Property           | Description                                                                                                                                                               | Default Value |
|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| autoplay           | Whether to start visualizing immediately.                                                                                                                                 | false         |
| dur                | Duration of visualization in millseconds.                                                                                                                                 | 2000          |
| deprioritizeThings | Comma-separated list of IDs of Supercraft Things to load last at the end to control the visualization process. (e.g., `thing45`).                                         | ''            |
| prioritizeThings   | Comma-separated list of IDs of Supercraft Things to load first at the beginning to control the visualization process. (e.g., `thing25`).                                  | ''            |
| name               | Name of Supercraft asset hosted on server. For example, if the site was at `https://supermedium.com/craft/hello-world`, then set `supercraft-loader="name: hello-world"`. | ''            |
| src                | Selector to `<a-asset-item>` or URL to Supercraft JSON.                                                                                                                   | ''            |

To trigger the visualization, emit `supercraftvisualizerstart`.

![](https://user-images.githubusercontent.com/674727/41128749-02425f1c-6a64-11e8-9d2a-509a8f9a6333.gif)

### Getting the JSON

Supercraft sites are stored in Amazon S3. Download from the URL:

`https://supercraftsite.s3-us-west-2.amazonaws.com/<SITE_NAME>`

### Installation

#### Browser

Install and use by directly including the [browser files](dist):

```html
<head>
  <title>My A-Frame Scene</title>
  <script src="https://aframe.io/releases/0.8.2/aframe.min.js"></script>
  <script src="https://unpkg.com/aframe-supercraft-loader/dist/aframe-supercraft-loader.min.js"></script>
</head>

<body>
  <a-scene>
    <a-entity supercraft-loader="name: wealthy-dock"></a-entity>

    <a-entity supercraft-visualizer="name: icky-snake"></a-entity>

    <!-- OR. -->

    <a-assets>
      <a-asset-item id="supercraft" src="supercraft.json"></a-asset-item>
    </a-assets>
    <a-entity supercraft-loader="src: #supercraft"></a-entity>
  </a-scene>
</body>
```

#### npm

Install via npm:

```bash
npm install aframe-supercraft-loader
```

Then register and use.

```js
require('aframe');
require('aframe-supercraft-loader');
```

---
_Source: https://npm.io/package/aframe-supercraft-loader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._