Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
[slack]: https://aframevr.slack.com/join/shared_invite/zt-f6rne3ly-ekVaBU~Xu~fsZHXr56jacQ
[stackoverflow]: http://stackoverflow.com/questions/tagged/aframe

Interested in contributing? As an open source project, we'd appreciate any help
Expand All @@ -8,26 +7,23 @@ contribute to these related projects:
- [aframe-inspector](https://github.com/aframevr/aframe-inspector)
- [aframe-site](https://github.com/aframevr/aframe-site)

# Join the Community on Slack
# Join the Community

1. [Invite yourself][slack] to the A-Frame Slack channel.
2. [Join the discussion](https://aframevr.slack.com)!
Join the community on [Discord and other social media platforms](https://aframe.io/community/)

# Get Help or Ask a Question

If you're not sure how to do something with A-Frame, please post a question
(and any code you've tried so far) to [Stack Overflow under the 'aframe'
tag][stackoverflow]. Questions there will automatically create notifications in
[Slack][slack], and are easier for others to find so new developers can learn
from your questions too.
tag][stackoverflow]. You can also hang out on Discord.

# File an Issue

1. Search the [issue tracker](https://github.com/aframevr/aframe/issues) for similar issues.
2. Specify the version of A-Frame in which the bug occurred.
3. Specify information about your browser and system (e.g., "Firefox Nightly on OS X")
4. Describe the problem in detail (i.e., what happened and what you expected would happen).
5. If possible, provide a small test case with [CodePen](http://codepen.io), a link to your application, and/or a screenshot. You can fork this [sample pen](http://codepen.io/anon/pen/KVWpbb).
5. If possible, provide a small test case by [remixing the base A-Frame Glitch](https://glitch.com/~aframe)

# Contribute Code to A-Frame

Expand Down Expand Up @@ -58,7 +54,7 @@ under the [MIT License](LICENSE).

1. Create something awesome like a scene, a component, or a shader.
2. Publish your work to Github (and GitHub pages) so everyone can learn from your work.
3. Share it on [Slack][slack] or Twitter.
3. Share it on Discord or X.
4. Let us know about it so we can feature it on our blog: [A Week of A-Frame](https://aframe.io/blog/).
4. For bonus points, write and publish a case study to explain how you built it.

Expand Down Expand Up @@ -94,9 +90,9 @@ Glitch and update the `src` URL.

# Help Your Fellow A-Framers

## On Slack
## On Discord

1. [Invite yourself][slack] to the A-Frame Slack channel.
1. [Invite yourself][https://aframe.io/community/] to Discord.
2. Help answer questions that people might have and welcome new people.
3. Redirect or cross-post questions to the [Stack Overflow A-Frame tag][stackoverflow].

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,13 +119,13 @@ architecture](https://aframe.io/docs/1.7.0/introduction/entity-component-system.
components from the ecosystem (e.g., ocean, physics) and plug them into our
objects straight from HTML:

[![Remix](https://cloud.githubusercontent.com/assets/674727/24572421/688f7fc0-162d-11e7-8a35-b02bc050c043.jpg)](https://glitch.com/~aframe-registry)
[See example](https://aframe.io/aframe/examples/docs/community-components/)

```html
<html>
<head>
<script src="https://aframe.io/releases/1.7.0/aframe.min.js"></script>
<script src="https://unpkg.com/@c-frame/[email protected]/dist/aframe-particle-system-component.min.js"></script>
<script src="https://aframe.io/releases/1.7.1/aframe.min.js"></script>
<script src="https://cdn.jsdelivr.net/gh/c-frame/[email protected]/dist/aframe-particle-system-component.min.js"></script>
<script src="https://cdn.jsdelivr.net/gh/c-frame/[email protected]/dist/aframe-extras.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/@fern-solutions/aframe-sky-background/dist/sky-background.umd.min.js"></script>
</head>
Expand All @@ -136,7 +136,7 @@ objects straight from HTML:
<a-entity id="sphere" geometry="primitive: sphere"
material="color: #EFEFEF; shader: flat"
position="0 0.15 -5"
light="type: point; intensity: 5"
light="type: point; intensity: 15.7"
animation="property: position; easing: easeInOutQuad; dir: alternate; dur: 1000; to: 0 -0.10 -5; loop: true"></a-entity>

<a-entity id="ocean" ocean="density: 20; width: 50; depth: 50; speed: 4"
Expand Down
2 changes: 1 addition & 1 deletion docs/components/anchored.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ examples: []

It requires a browser supporting the [WebXR Anchors module][webxranchors].

Fix any entity to a position and rotation in the real world. Apply the anchored component to an entity and call the method `el.components.createAnchor(position, quaternion)` to anchor it to a position and rotation corresponding to real world coordinates. If `creatorAnchor` is not called the entity is anchored to its initial position and rotation. The anchoring only applies when in immersive mode.
Fix any entity to a position and rotation in the real world. Apply the anchored component to an entity and call the method `el.components.anchored.createAnchor(position, quaternion)` to anchor it to a position and rotation corresponding to real world coordinates. If `creatorAnchor` is not called the entity is anchored to its initial position and rotation. The anchoring only applies when in immersive mode.


## Example
Expand Down
6 changes: 3 additions & 3 deletions docs/components/animation.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ Accessed as `el.components.animation.<MEMBER>`.

### Controlling Animations using setAttribute

Like any A-Frame component, the animation component can be configured from JavaScript by calling [setAttribute()]( https://aframe.io/docs/1.7.0/introduction/javascript-events-dom-apis.html#updating-a-component-with-setattribute) on an element.
Like any A-Frame component, the animation component can be configured from JavaScript by calling [setAttribute()](../introduction/javascript-events-dom-apis.md#updating-a-component-with-setattribute) on an element.

By default, the animation will begin playing immediately (autoplay is true by default).

Expand Down Expand Up @@ -149,13 +149,13 @@ We can use the `startEvents` property to animate upon events:

[Remix the Animating on Events Glitch][eventsglitch].

To start an animation by explicitly [emitting a custom event](https://aframe.io/docs/1.7.0/introduction/javascript-events-dom-apis.html#emitting-an-event-with-emit), you can do the following:
To start an animation by explicitly [emitting a custom event](../introduction/javascript-events-dom-apis.md#emitting-an-event-with-emit), you can do the following:

```
el.emit(`triggeranimation`, null, false);
```

The [third parameter of emit](https://aframe.io/docs/1.7.0/core/entity.html#emit-name-detail-bubbles) set to "false" parameter ensures the event won't bubble up to parents, so that you can target the animation at just one particular element.
The [third parameter of emit](../core/entity.md#emit-name-detail-bubbles) set to "false" parameter ensures the event won't bubble up to parents, so that you can target the animation at just one particular element.

This assumes that an animation has already been configured to respond to that custom start event, for example like this:

Expand Down
2 changes: 1 addition & 1 deletion docs/components/background.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: background
type: components
layout: docs
parent_section: components
source_code: src/components/background.js
source_code: src/components/scene/background.js
examples: []
---

Expand Down
2 changes: 1 addition & 1 deletion docs/components/embedded.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ a-scene {

An inline example of an embedded scene:

<script src="https://aframe.io/releases/1.7.0/aframe.min.js"></script>
<script src="https://aframe.io/releases/1.7.1/aframe.min.js"></script>

<style>
#myEmbeddedScene {
Expand Down
2 changes: 1 addition & 1 deletion docs/components/gltf-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ parent_section: components
source_code: src/components/gltf-model.js
examples:
- title: Modifying Material of Model
src: https://glitch.com/edit/#!/aframe-modify-model-material?path=index.html:1:0
src: https://aframe.io/aframe/examples/test/gltf-model/modify-materials.html
---

[about-gltf]: https://www.khronos.org/gltf
Expand Down
2 changes: 1 addition & 1 deletion docs/components/light.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ parent_section: components
source_code: src/components/light.js
examples:
- title: Animated Lights
src: https://glitch.com/edit/#!/aframe-animated-lights?path=index.html
src: https://aframe.io/aframe/examples/showcase/dynamic-lights/
---

The light component defines the entity as a source of light. Light affects all
Expand Down
16 changes: 8 additions & 8 deletions docs/components/logitech-mx-ink-controls.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
---
title: logiteck-mx-ink-controls
title: logitech-mx-ink-controls
type: components
layout: docs
parent_section: components
source_code: src/components/logiteck-mx-ink-controls.js
source_code: src/components/logitech-mx-ink-controls.js
examples: []
---

[trackedcontrols]: ./tracked-controls.md

The logiteck-mx-ink-controls component interfaces with the Logitech MX Ink tracked pen. It
The `logitech-mx-ink-controls` component interfaces with the Logitech MX Ink tracked pen. It
wraps the [tracked-controls component][trackedcontrols] while adding button
mappings, events, and a pencil model.

## Example

```html
<a-entity logiteck-mx-ink-controls="hand: left"></a-entity>
<a-entity logiteck-mx-ink-controls="hand: right"></a-entity>
<a-entity logitech-mx-ink-controls="hand: left"></a-entity>
<a-entity logitech-mx-ink-controls="hand: right"></a-entity>
```

## Value
Expand Down Expand Up @@ -46,8 +46,8 @@ mappings, events, and a pencil model.
Listen to the `tipchanged` event.

```html
<a-entity logiteck-mx-ink-controls="hand: left" tip-logging></a-entity>
<a-entity logiteck-mx-ink-controls="hand: right" tip-logging></a-entity>
<a-entity logitech-mx-ink-controls="hand: left" tip-logging></a-entity>
<a-entity logitech-mx-ink-controls="hand: right" tip-logging></a-entity>
```

```javascript
Expand All @@ -63,4 +63,4 @@ AFRAME.registerComponent('tip-logging',{

## Assets

- [Logiteck MX Ink glTF](https://cdn.aframe.io/controllers/logitech/logitech-mx-ink.glb)
- [Logitech MX Ink glTF](https://cdn.aframe.io/controllers/logitech/logitech-mx-ink.glb)
4 changes: 1 addition & 3 deletions docs/components/material.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ layout: docs
parent_section: components
source_code: src/components/material.js
examples:
- title: Displacement Shader
src: https://glitch.com/edit/#!/aframe-displacement-shader?path=client/index.js:1:0
- title: Shader Walkthrough
src: https://codepen.io/machenmusik/pen/WZyQNj
- title: Grid Shader
Expand Down Expand Up @@ -417,7 +415,7 @@ Let's walk through an [example CodePen][example] with step-by-step commentary.
As always, we need to include the A-Frame script.

```js
<script src="https://aframe.io/releases/1.7.0/aframe.min.js"></script>
<script src="https://aframe.io/releases/1.7.1/aframe.min.js"></script>
```

Next, we define any components and shaders we need after the A-Frame
Expand Down
2 changes: 1 addition & 1 deletion docs/components/obj-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ parent_section: components
source_code: src/components/obj-model.js
examples:
- title: Modifying Material of Model
src: https://glitch.com/edit/#!/aframe-modify-model-material?path=index.html:1:0
src: https://aframe.io/aframe/examples/test/gltf-model/modify-materials.html
---

The obj-model component loads a 3D model and material using a
Expand Down
5 changes: 3 additions & 2 deletions docs/components/reflection.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: reflection
type: components
layout: docs
parent_section: components
source_code: src/components/reflection.js
source_code: src/components/scene/reflection.js
examples: []
---

Expand All @@ -30,8 +30,9 @@ Once the user leaves AR this light may have a different color, intensity and pos
The example below sets the reflection color to red and use lighting estimation for AR.

```html
<a-scene reflection="directionalLight:a-light#dirlight;"></a-scene>
<a-scene reflection="directionalLight:a-light#dirlight;">
<a-light id="dirlight" intensity="1" light="castShadow:true;type:directional" position="1 1 1"></a-light>
</a-scene>
```

## Properties
Expand Down
2 changes: 1 addition & 1 deletion docs/components/text.md
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@ Lastly, you should specify the character set used in your HTML by using `<meta>`
<html>
<head>
<meta charset="UTF-8">
<script src="https://aframe.io/releases/1.7.0/aframe.min.js"></script>
<script src="https://aframe.io/releases/1.7.1/aframe.min.js"></script>
</head>
<body>
<a-scene>
Expand Down
2 changes: 1 addition & 1 deletion docs/components/visible.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ contain an entire group of entities that you can flip on an off with `visible`.

## Updating Visibility

[update]: ../introduction/javascript-events-and-dom-apis.md#updating-a-component-with-setattribute
[update]: ../introduction/javascript-events-dom-apis.md#updating-a-component-with-setattribute

It is slightly faster to update visibility at the three.js level versus [via
`.setAttribute`][update].
Expand Down
28 changes: 14 additions & 14 deletions docs/core/entity.md
Original file line number Diff line number Diff line change
Expand Up @@ -448,20 +448,20 @@ entity.is('selected'); // >> false

## Events

| Event Name | Description |
|----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| child-attached | A child entity was attached to the entity. |
| child-detached | A child entity was detached from the entity. |
| componentchanged | One of the entity's components was modified. This event is throttled. Do not use this for reading position and rotation changes, rather [use a tick handler](../camera.md#reading-position-or-rotation-of-the-camera). |
| componentinitialized | One of the entity's components was initialized. |
| componentremoved | One of the entity's components was removed. |
| loaded | The entity has attached and initialized its components. |
| object3dset | `THREE.Object3D` was set on entity using `setObject3D(name)`. Event detail will contain `name` used to set on the `object3DMap`. |
| pause | The entity is now inactive and paused in terms of dynamic behavior. |
| play | The entity is now active and playing in terms of dynamic behavior. |
| stateadded | The entity received a new state. |
| stateremoved | The entity no longer has a certain state. |
| schemachanged | The schema of a component was changed. |
| Event Name | Description |
|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| child-attached | A child entity was attached to the entity. |
| child-detached | A child entity was detached from the entity. |
| componentchanged | One of the entity's components was modified. This event is throttled. Do not use this for reading position and rotation changes, rather [use a tick handler](../components/camera.md#reading-position-or-rotation-of-the-camera). |
| componentinitialized | One of the entity's components was initialized. |
| componentremoved | One of the entity's components was removed. |
| loaded | The entity has attached and initialized its components. |
| object3dset | `THREE.Object3D` was set on entity using `setObject3D(name)`. Event detail will contain `name` used to set on the `object3DMap`. |
| pause | The entity is now inactive and paused in terms of dynamic behavior. |
| play | The entity is now active and playing in terms of dynamic behavior. |
| stateadded | The entity received a new state. |
| stateremoved | The entity no longer has a certain state. |
| schemachanged | The schema of a component was changed. |

### Event Detail

Expand Down
2 changes: 1 addition & 1 deletion docs/core/mixins.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ order: 7
source_code: src/core/a-mixin.js
examples:
- title: Animated Lights
src: https://glitch.com/edit/#!/aframe-animated-lights?path=index.html
src: https://aframe.io/aframe/examples/showcase/dynamic-lights/
---

Mixins provide a way to compose and reuse commonly-used sets of component
Expand Down
2 changes: 1 addition & 1 deletion docs/core/systems.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ type: core
layout: docs
parent_section: core
order: 4
source_code: src/core/systems.js
source_code: src/core/system.js
examples:
- title: System providing envMaps
src: https://glitch.com/~aframe-refraction-system
Expand Down
Loading