Skip to content

Latest commit

 

History

History
89 lines (63 loc) · 2.21 KB

README.md

File metadata and controls

89 lines (63 loc) · 2.21 KB
Raw

Neon Origami

An open-source distributed virtual world platform.

Also a collection of high quality A-Frame components you can use for your own work:

  • Physically based environment

See demo

How do I connect to the virtual web?

Requirements

Supported Devices:

  • Oculus Quest 1 or 2 using Firefox Reality Browser or Oculus Browser

Setup

  • Use the public access point Neon Origami

  • Setup your own access point by creating an index.html

<html>
    <head>
        <meta charset="utf-8">
        <script src="https://unpkg.com/neonorigami/neonorigami.js"></script>
    </head>
    <body>
        <neon-origami fullscreen></neon-origami>
    </body>
</html>

How can I use Neon Origami components in A-Frame?

<html>
  <head>
    <script src="https://aframe.io/releases/1.2.0/aframe.min.js"></script>
    <script src="https://unpkg.com/neonorigami/aframe-neonorigami.js"></script>
  </head>
  <body>
    <a-scene background="color: #FAFAFA">
      <a-entity position="-1 0.5 -3" rotation="0 45 0" color="#4CC3D9" shadow></a-box>
      <a-sphere position="0 1.25 -5" radius="1.25" color="#EF2D5E" shadow></a-sphere>
      <a-cylinder position="1 0.75 -3" radius="0.5" height="1.5" color="#FFC65D" shadow></a-cylinder>
      <a-entity neon-origami-environment></a-entity>
    </a-scene>
  </body>
</html>

See demo here

Developing the Neon Origami app

make dev
# open http://localhost:8080/

Developing components in isolation

If you just want to work on Neon Origami components for A-Frame

make dev-components
# open http://localhost:8081/

License

This project is licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in neonorigami by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.