https://github.com/webarkit/arnft-threejs
A rendering package for https://github.com/webarkit/ARnft
https://github.com/webarkit/arnft-threejs
arnft hacktoberfest threejs typescript webar webarkit
Last synced: 3 months ago
JSON representation
A rendering package for https://github.com/webarkit/ARnft
- Host: GitHub
- URL: https://github.com/webarkit/arnft-threejs
- Owner: webarkit
- License: gpl-3.0
- Created: 2021-03-23T16:38:26.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-10-25T16:02:49.000Z (7 months ago)
- Last Synced: 2025-10-25T17:36:07.694Z (7 months ago)
- Topics: arnft, hacktoberfest, threejs, typescript, webar, webarkit
- Language: TypeScript
- Homepage:
- Size: 5.51 MB
- Stars: 24
- Watchers: 2
- Forks: 9
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ARnft-threejs
**ARnft-threejs** is the new rendering engine for [ARnft](https://github.com/webarkit/ARnft).
It is based on [Three.js](https://github.com/mrdoob/three.js) !!
## Use the library
You can clone with git:
`git clone https://github.com/webarkit/ARnft-threejs`
and then get the library in the dist folder:
```html
```
or load with raw.githack:
```html
```
or you can install from npm:
```
npm install @webarkit/arnft-threejs
```
or yarn:
```
yarn add @webarkit/arnft-threejs
```
and use it as a module:
```javascript
import ARnftThreejs from '@webarkit/arnft-threejs'
```
## Features
The library has **ES6** and typescript support. Type definitions are in the types folder.
## Build the docs
If you want to read the API doc run in the console:
```
yarn docs
```
and then access the generated html pages with a localhost server.
## Build the project
If you make changes to the project to the source code , then you need to build it again:
```
yarn dev-ts // for a development build
yarn build-ts // for a production build
```
## Contributing to the project
Contributions are very welcome! if you want to contribute read our [CONTRIBUTING](https://github.com/webarkit/ARnft-threejs/blob/main/CONTRIBUTING.md) page.