TwinlifyDocs
IntroDocumentationDemoGithub

Nexus v0.20.0

Getting started
  • Example
  • Configuration
Using CDN
  • Add Nexus in One Minute
  • Include the scripts
  • Add a DOM Container
  • Instanciate your nexus
Using a bundler
  • Install from npmjs
  • Add a DOM Container
  • Instanciate your nexus
Nexus API
  • Twin
    • Nexus.create
    • addColoring
  • Devices
    • createDevice
      • location
      • model
        • additional model properties
      • properties
      • reading
    • focusDeviceOnProperty
    • updateDeviceData
    • updateDeviceColor
  • HUD
    • closeMenu
Configuration API
  • Scene
    • create-scene
  • Connections
    • endpoint
    • reading
  • Customisation
    • coloring
  • WIP

Using a bundler

Install from npmjs

npm i --save @twinlify/nexus

Add a DOM Container

<div id="nexusContainer" style="width: 600px; height: 450px;" />

Instanciate your nexus

Include the following code in your JavaScript file.

import Nexus from '@twinlify/nexus';

Nexus.create({
  clientId: 'demo',
  containerId: 'nexusContainer',
  configId: 'rooms'
});