Note: This documentation is for the old 0.4.0 version of A-Frame. Check out the documentation for the current 1.0.0 version
Welcome! Make sure to read the introduction. If you’re ready to go, there are multiple ways of getting started.
The boilerplate contains:
- A simple HTML file that links to the current version of A-Frame of A-Frame
- An optional local development server
- An easy deployment workflow for GitHub Pages to share with the world
We can grab the boilerplate in one of two ways:
In either case, it is important to serve the project using a local server so that assets load properly.
If we want to just include the JS build from the CDN, we can drop a
<script> tag straight into our HTML:
<!-- Production Version, Minified -->
If we want to serve it locally, we can download the JS build:
Note it is important to serve the project using a local server so that assets load correctly.
For more advanced users who want to use their own build steps, we can install through npm:
# Latest stable version (https://www.npmjs.com/package/aframe)
Then we can just require A-Frame from our app, perhaps built with Browserify or Webpack:
We should develop projects using a local server so that files are properly served. We can either:
- Download the Mongoose application and open it from the same directory as your HTML file.
- Use Node and npm to start the local server with
npm install && npm run start.
If you have npm, you can get started with scene template right from the command
angle, a command line interface for A-Frame:
npm install -g angle && angle initscene