Installation

Note: This documentation is for the old 0.1.0 version of A-Frame. Check out the documentation for the current 1.7.0 version

Boilerplate Starter Kit

The boilerplate starter kit is a great way to start a new A-Frame project. It includes a few basic elements within an <a-scene> element, and links to the latest version of the framework. There are several ways to get started with the boilerplate:

Download Boilerplate Fork Boilerplate CodePen Clone Boilerplate Repo

Cloning the repo is recommended for users who are comfortable with git. For npm users, the boilerplate also includes an optional local development server with Live Reloading (via @mattdesl‘s fantastic budo) and built-in (optional) support for Browserify, as well as a GitHub Pages deployment workflow.

Standalone Downloads

If you don’t need the Boilerplate and want to work with just the A-Frame JavaScript, download or link to the version from below, and then include A-Frame within a <script> tag. This gives you access to the full A-Frame feature set, and registers AFRAME as a global variable.

Production Version 0.1.2 Minified Development Version 0.1.2 Uncompressed, includes source maps

_**Note:** The minified version is not recommended for use during development, as it does not provide the useful warnings for common mistakes that the unminified version does._

npm

npm is the recommended installation method when building scenes with A-Frame. It pairs nicely with a CommonJS module bundler such as Webpack or Browserify.

# latest stable version
$ npm install aframe

# dev build (directly from GitHub)
$ npm install mozvr/aframe#dev

AMD Module Loaders

The standalone downloads or versions installed via npm are wrapped with UMD so they can be used directly as an AMD module.