The goal of this project is to design a set of HTML tags to describe 3D scenes in the browser.
We use three.js to render the new tags but the aim is to provide a way to declare 3D scenes independent from the rendering engine.
NOTE: For folks creating scenes and third-party components, we recommend getting started by instead using the vr-components library, a set of core resuable components.
Proceed below if you would like to use the minimal set of primitive components available here in vr-markup.
To get started, simply include these files in your project:
Or for local development you can use the unminified bundles (with source maps for the JS):
Also, be sure to check out these awesome examples:
First install from npm:
npm install @mozvr/vr-markup
And in your Browserify/Webpack modules, simply require the module:
require('@mozvr/vr-markup')
git clone https://github.com/MozVR/vr-markup.git
cd vr-markup
npm install
npm start
open http://localhost:9001/examples/
If you'd like to hack on this project and don't have access to the npm repos, contact @cvan and he'll give you the info you'll need to log in:
npm login
npm test
git checkout dev
git pull --rebase
npm install
npm start
open http://localhost:9001/examples/
Assuming you want to publish a version of dev to the private package for testing:
npm run release
And to push the tags to GitHub:
git push --tags
npm run dist
git commit -am 'Bump dist'
To publish to https://mozvr.github.io/vr-markup/:
npm run ghpages
To publish to https://cvan.github.io/vr-markup/:
npm run ghpages cvan
This program is free software and is distributed under an MIT License.