https://github.com/rozek/aframe-axeshelper
a trivial A-Frame component and primitive for the Three.js AxesHelper
https://github.com/rozek/aframe-axeshelper
aframe component javascript primitive three-js threejs typescript
Last synced: 2 months ago
JSON representation
a trivial A-Frame component and primitive for the Three.js AxesHelper
- Host: GitHub
- URL: https://github.com/rozek/aframe-axeshelper
- Owner: rozek
- License: mit
- Created: 2022-08-11T08:51:11.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-08-29T10:24:31.000Z (over 2 years ago)
- Last Synced: 2025-02-16T07:46:56.142Z (3 months ago)
- Topics: aframe, component, javascript, primitive, three-js, threejs, typescript
- Language: TypeScript
- Homepage:
- Size: 221 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# aframe-axeshelper #
a trivial [A-Frame](https://aframe.io/) component and primitive for the [Three.js](https://threejs.org/) [AxesHelper](https://threejs.org/docs/#api/en/helpers/AxesHelper)
**NPM users**: please consider the [Github README](https://github.com/rozek/aframe-axeshelper/blob/main/README.md) for the latest description of this package (as updating the docs would otherwise always require a new NPM package version)
## Installation ##
`aframe-axeshelper` may be used as an ECMAScript module (ESM) or explicitly loaded after the `` tag for A-Frame itself.
For the ESM variant, install the package into your build environment using [NPM](https://docs.npmjs.com/) with the command
```
npm install aframe-axeshelper
```
and `import` it into your code whereever needed
```javascript
import "aframe-axeshelper"
```
Otherwise, load the plain script file directly
```html
<script src="https://unpkg.com/aframe-axeshelper">
```
## Usage ##
Once loaded or imported, you may use the `aframe-axeshelper` either as an A-Frame component (usually for an already existing A-Frame entity)
```html
```
or as an A-Frame primitive
```html
```
whatever seems more appropriate.
### Example ###
Here is a complete example (albeit without the HTML boilerplate)
```html
```
## Build Instructions ##
You may easily build this package yourself.
Just install [NPM](https://docs.npmjs.com/) according to the instructions for your platform and follow these steps:
1. either clone this repository using [git](https://git-scm.com/) or [download a ZIP archive](https://github.com/rozek/aframe-axeshelper/archive/refs/heads/main.zip) with its contents to your disk and unpack it there
2. open a shell and navigate to the root directory of this repository
3. run `npm install` in order to install the complete build environment
4. execute `npm run build` to create a new build
You may also look into the author's [build-configuration-study](https://github.com/rozek/build-configuration-study) for a general description of his build environment.
## License ##
[MIT License](LICENSE.md)