Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
AlbertoElias committed Feb 12, 2018
0 parents commit e000bf8
Show file tree
Hide file tree
Showing 113 changed files with 659,608 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
test/*
build/*
gulpfile.js
karma.conf.js
node_modules/*
67 changes: 67 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
{
"parserOptions": {
"ecmaVersion": 7,
"sourceType": "module",
"ecmaFeatures": {
"experimentalObjectRestSpread": true
}
},
"env": {
"es6": true,
"browser": true
},
"extends": "eslint:recommended",
"rules": {
"no-empty": ["error", { "allowEmptyCatch": true }],
"no-extra-parens": "warn",
"valid-jsdoc": "warn",
"no-console": "warn",

"curly": "error",
"eqeqeq": "error",
"no-eval": "error",
"no-extend-native": "error",
"no-extra-bind": "error",
"no-loop-func": "error",
"no-lone-blocks": "error",
"no-multi-spaces": "error",
"no-useless-call": "error",
"no-useless-escape": "error",
"wrap-iife": "error",

"strict": "error",

"no-unused-vars": "error",

"array-bracket-spacing": "error",
"block-spacing": "error",
"brace-style": "error",
"camelcase": "error",
"capitalized-comments": "error",
"comma-dangle": "error",
"comma-spacing": "error",
"comma-style": "error",
"eol-last": "error",
"func-call-spacing": "error",
"indent": ["error", "tab"],
"new-cap": "error",
"no-multiple-empty-lines": "error",
"no-trailing-spaces": "error",
"no-unneeded-ternary": "error",
"one-var": ["error", "never"],
"quotes": ["error", "single", { "allowTemplateLiterals": true }],
"require-jsdoc": "error",
"semi": "error",

"arrow-body-style": "error",
"arrow-parens": "error",
"generator-star-spacing": ["error", "neither"],
"prefer-const": "error",
"prefer-rest-params": "warn",
"prefer-spread": "warn",
"prefer-template": "error",

"no-var": "error",
"yield-star-spacing": ["error", "after"]
}
}
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
node_modules/
npm-debug.log
.git
.DS_Store
*.swp
yarn-error.log
.vscode
13 changes: 13 additions & 0 deletions CREDITS
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
This application uses Open Source components. You can find the source code of their open source projects along with license information below. We acknowledge and are grateful to these developers for their contributions to open source.

Project: aframe-teleport-controls https://github.com/fernandojsg/aframe-teleport-controls
Copyright (c) 2016 Fernando Serrano
License (MIT) https://github.com/fernandojsg/aframe-teleport-controls/blob/master/LICENSE

Project: aframe-daydream-controller-component https://github.com/ryanbetts/aframe-daydream-controller-component
Copyright (c) 2015 Kevin Ngo
License (MIT) https://github.com/ryanbetts/aframe-daydream-controller-component/blob/master/LICENSE

Project: ray-input https://github.com/borismus/ray-input
Copyright (c) 2015 Google Inc
License (Apache) https://github.com/borismus/ray-input/blob/master/COPYING
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License

Copyright © 2016 holonet authors

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.
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# holonet

Create social virtual worlds that anyone can interact with using Virtual Personas, a self-sovereign identity.

## Quick Start

Install via [npm](https://npmjs.com) or [yarn](https://yarnpkg.com)

```
npm install --save holonet
yarn add holonet
```

And then import it using ES2015 Modules, CommonJS or with a `<script>` tag:

```
import * as holonet from 'holonet';
const holonet = require('holonet');
<script src="./node_modules/holonet/build/holonet.script.js"></script>
```

## Entities

The library provides a set of entities to help create your virtual world, the two most important ones being **Scene** and **VirtualPersona**

Here's the list:

### Scene

Imports a GLTF Scene and renders it to an HMD

### VirtualPersona

Imports a GLTF avatar model that could be your single identity to transverse the WebVR metaverse. Also provides movement and animation mechanics

### Physics

Possible small physics library

## API

You can check out the API in our [JSDoc](https://holonet.one/docs)

## Third party libraries

Currently, [holonet](https://holonet.one) is dependent on several third party libraries:

* [Three.js](https://threejs.org): Most used WebGL library
* [Three.VRControls](https://github.com/mrdoob/three.js/blob/dev/examples/js/controls/VRControls.js): VR Controls helper from Three.JS
* [Three.VREffect](https://github.com/mrdoob/three.js/blob/dev/examples/js/effects/VREffect.js): WebVR helper to render to an HMD
* [WebVR Polyfill](https://github.com/googlevr/webvr-polyfill): Polyfill for mobile devices
* [uport-connect](https://github.com/uport-project/uport-connect): Underlying identity system that Virtual Personas is currently based on
Loading

0 comments on commit e000bf8

Please sign in to comment.