The aframe-altspace-component from lelapinblanc327

aframe-altspace-component's Introduction

aframe-altspace-component

Component to make an A-Frame scene compatible with AltspaceVR. When loading your scene in Altspace, the Altspace Render is used instead of the WebGLRender. Behavior outside of Altspace is not affected.

Live examples: http://altspacevr.github.io/aframe/examples/ (forked from aframevr/aframe)

Note that when running in Altspace, the scene will not be synchronized between users. In addition, some A-Frame features are currently not supported in Altspace, such as lighting and video. For details, see the Three.js Feature Support section in the AltspaceSDK repo.

Properties

Property	Description	Default Value
`usePixelScale`	Treat a unit as a CSS Pixel, and have your scene scale with the scale of the AltspaceVR web browser. This is the default behavior in AltspaceVR for three.js apps. In A-Frame, however, the default value is `false`, as units are in meters by default.	`false`
`verticalAlign`	Puts the scene origin at the bottom, middle, or top of the Altspace enclosure. If your scene seems to be floating in midair, try setting this to 'bottom'.	`middle`

Usage

Add the "altspace" parameter on your <a-scene> like so: <a-scene altspace>

Example

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://cdn.rawgit.com/AltspaceVR/aframe-altspace-component/v0.2.2/dist/aframe-altspace-component.min.js"></script>
</head>

<body>
  <a-scene altspace>
    <a-entity geometry="primitive: box" material="color: #C03546"></a-entity>
  </a-scene>
</body>

Recommend Projects