When the broadcast component is attached to an entity, it will emit all specified component data, the entity ID, and the parent's ID to the WebSocket server once every 10ms (will be adjustable later).

When another client receives that data, it uses it to create an element with the ID if it doesn't exist, and then sync the component data to the entity with setAttribute.

Properties

Property	Description	Default Value
send	List of comma-delimited component names to broadcast	position, rotation
url	WebSocket server URL	http://localhost:12000

Usage

Server

There is a simple Node socket.io server in server/.

PORT=12000 node index.js

Browser Installation

Install and use by directly including the browser files:

<head>
  <title>My A-Frame Scene</title>
  <script src="https://aframe.io/releases/0.2.0/aframe.min.js"></script>
  <script src="https://rawgit.com/ngokevin/aframe-broadcast-component/master/dist/aframe-broadcast-component.min.js"></script>
</head>

<body>
  <a-scene broadcast="http://myserver.com:12000">
    <a-entity broadcast="send: geometry, material, position, rotation"
              camera look-controls wasd-controls
              geometry="primitive: box"
              material="color: #222"
              position="0 1.8 5"></a-entity>
  </a-scene>
</body>

NPM Installation

Install via NPM:

npm install aframe-broadcast-component

Then register and use.

require('aframe');
require('aframe-broadcast-component');

Keywords

FAQs

What is aframe-broadcast-component?

Is aframe-broadcast-component well maintained?

Package last updated on 13 May 2016

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

aframe-broadcast-component