# @umbra3d/umbrajs

> **Stream in optimized 3D scenes for high performance rendering**

Latest version **1.7.51** (published 2020-12-21) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @umbra3d/umbrajs
pnpm add @umbra3d/umbrajs
yarn add @umbra3d/umbrajs
bun add @umbra3d/umbrajs
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.7.51 |
| Published | 2020-12-21 |
| First published | 2019-07-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 1.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | pvaananen, umbrabuild |

## Links

- npm: https://www.npmjs.com/package/@umbra3d/umbrajs
- Repository: https://github.com/UmbraSoftware/umbrajs
- Homepage: https://github.com/UmbraSoftware/umbrajs#readme
- Issues: https://github.com/UmbraSoftware/umbrajs/issues
- npm.io page: https://npm.io/package/@umbra3d/umbrajs

## Recent versions

- 1.7.51 (latest) — 2020-12-21
- 1.7.50 — 2020-12-14
- 1.7.49 — 2020-12-07
- 1.7.48 — 2020-11-30
- 1.7.47-hotfix1 — 2020-11-16
- 1.7.41-hotfix1 — 2020-09-21
- 1.7.38-hotfix1 — 2020-09-01
- 1.7.31-hotfix1 — 2020-07-08
- 1.7.31 — 2020-07-06
- 1.7.28 — 2020-06-15
- 1.7.26-rc2 — 2020-05-25
- 1.7.26-rc1 — 2020-05-25
- 1.7.20-rc1 — 2020-04-17
- 1.7.19 — 2020-04-16
- 1.7.9-rc1 — 2020-01-27
- … 14 more at https://npm.io/package/@umbra3d/umbrajs/versions

## README

# Umbra.js low-level API

**Stream in optimized 3D scenes for high performance rendering**

This is a library that allows you to stream 3D scenes from [Umbra's cloud service](https://www.umbra3d.com/).
For three.js support you should use the [`umbrajs-three`](https://github.com/UmbraSoftware/umbrajs-three) high-level package instead.

See the [API reference](https://github.com/UmbraSoftware/umbrajs/wiki/API-reference) if you want to use Umbra with your own renderer.

## Getting the library

    npm install @umbra3d/umbrajs

## Building it

To build an UMD module `dist/umbra.js` run

    npm install
    npm run build

### Building it together with umbrajs-three

To test local changes in umbrajs-three you can use the `npm link` feature in the following way.

    cd ~/umbrajs
    npm install
    npm run build
    npm link # make a symlink

    cd ~/umbrajs-three
    npm install
    npm install three@0.110.0 --no-save
    npm link @umbra3d/umbrajs # use symlinked local package, not NPM
    npm run build

During development you may want to build first umbrajs and then umbrajs-three:

    cd ~/umbrajs && npm run build && cd ~/umbrajs-three && npm run build

## Testing

    npx http-server -c 0

Then visit `http://127.0.0.1:8000/examples/runtime_example.html`. Remember to run `npm run build` beforehand.

## License

MIT

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