https://github.com/orgoldfus/aframe
This is a clone of specific commit in aframe - for temporary use
https://github.com/orgoldfus/aframe
Last synced: about 1 year ago
JSON representation
This is a clone of specific commit in aframe - for temporary use
- Host: GitHub
- URL: https://github.com/orgoldfus/aframe
- Owner: orgoldfus
- License: mit
- Created: 2018-04-12T12:38:32.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-12T12:49:49.000Z (about 8 years ago)
- Last Synced: 2025-02-10T18:11:19.262Z (over 1 year ago)
- Language: JavaScript
- Size: 201 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Roadmap: ROADMAP.md
Awesome Lists containing this project
README
A-Frame
A web framework for building virtual reality experiences.
## Examples
*Find more examples on [the homepage](https://aframe.io), [A Week of A-Frame](https://aframe.io/blog/), and [WebVR Directory](https://webvr.directory).*
## Features
:eyeglasses: **Virtual Reality Made Simple**: A-Frame handles the 3D and WebVR
boilerplate required to get running across platforms including mobile, desktop,
Vive, and Rift just by dropping in ``.
:heart: **Declarative HTML**: HTML is easy to read and copy-and-paste. Since
A-Frame can be used from HTML, A-Frame is accessible to everyone: web
developers, VR enthusiasts, educators, artists, makers, kids.
:electric_plug: **Entity-Component Architecture**: A-Frame is a powerful
framework on top of three.js, providing a declarative, composable, reusable
entity-component structure for three.js. While A-Frame can be used from HTML,
developers have unlimited access to JavaScript, DOM APIs, three.js, WebVR, and
WebGL.
:zap: **Performance**: A-Frame is a thin framework on top of three.js.
Although A-Frame uses the DOM, A-Frame does not touch the browser layout
engine. Performance is a top priority, being battle-tested on highly
interactive WebVR experiences.
:globe_with_meridians: **Cross-Platform**: Build VR applications for Vive,
Rift, Daydream, GearVR, and Cardboard. Don't have a headset or controllers? No
problem! A-Frame still works on standard desktop and smartphones.
:mag: **Visual Inspector**: A-Frame provides a built-in visual 3D inspector
with a workflow similar to a browser's developer tools and interface similar to
Unity. Open up any A-Frame scene and hit ` + + i`.
:runner: **Features**: Hit the ground running with A-Frame's built-in
components such as geometries, materials, lights, animations, models,
raycasters, shadows, positional audio, tracked controllers. Get even further
with community components such as particle systems, physics, multiuser, oceans,
mountains, speech recognition, or teleportation!
## Usage
### Example
Build VR scenes in the browser with just a few lines of HTML! To start playing
and publishing now, remix the starter example on Glitch:
[](https://glitch.com/~aframe)
```html
```
With A-Frame's [entity-component
architecture](https://aframe.io/docs/0.8.0/core/), we can drop in community
components from the ecosystem (e.g., ocean, physics) and plug them into our
objects straight from HTML:
[](https://glitch.com/~aframe-registry)
```html
```
### Builds
To use the latest stable build of A-Frame, include [`aframe.min.js`](https://aframe.io/releases/0.8.0/aframe.min.js):
```js
```
To check out the stable and master builds, see the [`dist/` folder](dist/).
### npm
```sh
npm install --save aframe
# Or yarn add aframe
```
```js
require('aframe') // e.g., with Browserify or Webpack.
```
## Local Development
```sh
git clone https://github.com/aframevr/aframe.git # Clone the repository.
cd aframe && npm install # Install dependencies.
npm start # Start the local development server.
```
And open in your browser **[http://localhost:9000](http://localhost:9000)**.
### Generating Builds
```sh
npm run dist
```
## Questions
For questions and support, [ask on StackOverflow](https://stackoverflow.com/questions/ask/?tags=aframe).
## Stay in Touch
- To hang out with the community, [join the A-Frame Slack](https://aframevr-slack.herokuapp.com).
- [Follow `A Week of A-Frame` on the A-Frame blog](https://aframe.io/blog).
- [Follow @aframevr on Twitter](https://twitter.com/aframevr).
## Contributing
Get involved! Check out the [Contributing Guide](CONTRIBUTING.md) for how to get started.
## License
This program is free software and is distributed under an [MIT License](LICENSE).