Giter Site home page Giter Site logo

aframe-p2p-component's Introduction

aframe-p2p-component

WORK IN PROGRESS demo

A component for A-Frame that enables sharing and updating objects with multiple peers over p2p WebRTC.

Built on top of unsigned-swarmlog, a WebRTC swarm that swarms around a hyperlog, an append-only Merkle DAG that replicates based on scuttlebutt logs and causal linking.

The A-Frame objects created with the A-Frame inspector persist in memory via memdb but could be altered to use leveldb if desired.

Note that substack's original swarmlog is intended to be a cryptographically-secure means of ensuring a publisher to a hyperlog is who they say they are. aframe-p2p-component uses a fork of this project that ignores the cryptographically-secure signing aspect of swarmlog, assuming that small teams of trusted individuals will be using this component to collaboratively build A-Frame scenes and objects without any servers.

CAVEATS: Be warned that not all objects are working just yet.

WARNING!: Physics and animation will trigger position and rotation changed events very frequently. The updating to hyperlog is de-bounced but nevertheless, it is NOT recommended that you use physics or animation with this component at this time.

API

Property Description Default Value
signalhub the signalling server url which is required for the peers to find each other https://signalhub.mafintosh.com
topic the topic (id) of the p2p channel the peers will be swarming in 'mytopic'

NOTE: HTTPS seems to be necessary sometimes for the signalhub property value.

Installation

Browser

Install and use by directly including the browser files:

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

<body>
  <a-scene p2p="signalhub: https://somesignalhub.com; topic: myprivatetopic">
  </a-scene>
</body>

npm

Install via npm:

npm install aframe-p2p-component

Then require and use.

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

aframe-p2p-component's People

Contributors

brodavi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.