Initial commit 🚀

networked-aframe · Oct 25, 2017 · bada0fc · bada0fc
commit bada0fc
Show file tree

Hide file tree

Showing 16 changed files with 5,339 additions and 0 deletions.
diff --git a/.babelrc b/.babelrc
@@ -0,0 +1,3 @@
+{
+  "presets": ["env"]
+}
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -0,0 +1,7 @@
+{
+  "extends": ["prettier"],
+  "plugins": ["prettier"],
+  "rules": {
+    "prettier/prettier": "error"
+  }
+}
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+.DS_Store
+node_modules/
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Hayden Lee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,60 @@
+# Networked-AFrame Deepstream Adapter
+
+Network adapter for [networked-aframe](https://github.com/haydenjameslee/networked-aframe) that uses Deepstream as a backend.
+
+## Running the Example
+
+```
+git clone https://github.com/networked-aframe/naf-deepstream-adapter
+cd naf-deepstreame-adapter
+npm install # or use yarn
+# Set deepstream credentials in example/index.html
+npm start
+```
+
+With the server running, browse the example at http://localhost:8080. Open another browser tab and point it to the same URL to see the other client.
+
+## Setting Up Deepstream
+
+
+Deepstream is an open-source "serverless" network solution. In NAF's case it can be used to establish connections between clients in a peer-to-peer fashion, without having to host a signalling (connection) server.
+
+Steps to setup Deepstream:
+
+1. Sign up for a DeepstreamHub account: https://deepstreamhub.com/
+2. On the left navbar, click "Apps"
+3. Add application
+4. Name your application and choose a region close to you
+5. Copy the URL at the bottom of your new project, it'll start with wss://xxx.deepstreamhub
+6. Replace `YOUR_URL_HERE` in the [Deepstream Demo](https://github.com/haydenjameslee/networked-aframe/blob/master/server/static/deepstream-basic.html)
+7. Open two tabs of the demo and you should see the other tab's avatar
+
+
+## Use in an existing project
+
+After setting up deepstream include and configure `naf-deepstream-adapter`.
+
+```html
+<html>
+<head>
+  <script src="https://aframe.io/releases/0.7.0/aframe.min.js"></script>
+  <script src="https://unpkg.com/networked-aframe/dist/networked-aframe.min.js"></script>
+  <!-- Include naf-deepstream-adapter *after* networked-aframe -->
+  <script src="https://unpkg.com/naf-deepstream-adapter/dist/naf-deepstream-adapter.min.js"></script>
+
+  <!-- Set the Deepstream credentials -->
+  <script>
+    window.deepstreamConfig = {
+      'url': 'YOUR_URL_HERE'
+    };
+  </script>
+</head>
+<body>
+    <!-- Set adapter to deepstream -->
+   <a-scene networked-scene="
+        adapter: deepstream;
+    ">
+  </a-scene>
+</body>
+</html>
+```