Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/resaki1/coconut-xr-natuerlich
https://github.com/resaki1/coconut-xr-natuerlich
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/resaki1/coconut-xr-natuerlich
- Owner: Resaki1
- License: mit
- Created: 2024-08-12T09:45:15.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-08-14T09:55:20.000Z (6 months ago)
- Last Synced: 2024-08-14T11:26:28.084Z (6 months ago)
- Size: 159 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IMPORTANT NOTICE
This library was originally created by @coconut-xr. However, the code was migrated to uikit and react-three/xr under the pmndrs umbrella.
Since the original repo as well as the npm library have been deleted, I have re-uploaded the code here. Only use this library if you had already created a project with the original library and need it to keep working! Do not add this library to your project if you don't need to, as I am not actively maintaining it. Also, the original documentation has been deleted by the creators of the library.
The only thing I changed from the original code was the location of the plop sound, as it was externally hosted. The original file location does not exist anymore, which broke my code, so now the mp3 file is bundled directly with this library.
---
# @coconut-xr/natuerlich
[](https://npmjs.com/package/@coconut-xr/natuerlich)
[](https://github.com/coconut-xr/natuerlich/blob/master/LICENSE)
[](https://twitter.com/coconut_xr)
[](https://discord.gg/RbyaXJJaJM)
_WebXR Interaction for Three.js_
This library builds on [Three.js](https://github.com/mrdoob/three.js) (open-source WebGL library) and [WebXR](https://immersiveweb.dev/) (Web Standard for Augmented and Virtual Reality) to deliver **composable and extensible interactions for immersive experiences** .
We provide bindings to [react-three/fiber](https://github.com/pmndrs/react-three-fiber), enabling a **familiar Developer Experience** for react developers.
`npm install @coconut-xr/natuerlich`
## Check out the [Getting Started](https://coconut-xr.github.io/natuerlich/getting-started)
## Examples
| | |
| --- | --- |
| Spatial UI with Koestlich | Placing Objects - 3D Models from [Quaternius](https://quaternius.com/) |
| 
| 
|
| Rag Doll Physics - based on [R3F Example](https://codesandbox.io/s/wdzv4) | Auto Demo - VR Drift Racing |
| 
| 
|
| Klettern Demo - VR Climbing | Gamepad Example |
| 
|
|
## [Documentation](https://coconut-xr.github.io/natuerlich/)
| | |
| --- | --- |
| Getting Started - barebones WebXR, Hands, and Controllers | Interaction with Objects - build interactions with objects|
| 
| 
|
| Interaction with Koestlich - build interactive 3D UIs | Teleport - building a teleport interaction |
| 
| 
|
| Poses - detecting and generating hand poses | Layers - high quality content using WebXR layers|
| 
| 
|
| Anchors - spatial anchors using WebXR anchors | Tracked Planes - tracked room planes using WebXR planes|
| 
| 
|
| Head Up Display - placing content in front of the user's camera| Custom Input Sources - building custom interactive hands and controllers|
| 
| 
|
| Tracked Images -
image marker tracking using WebXR Image Tracking | Guards -
conditional rendering using guards |
| Use XR -
accessing the raw XR state | Configuration -
configuring foveation, frameRate, referenceSpace, and frameBufferScaling |
| | |
---
- All Components - API Documentation for all available components
- All Hooks - API Documentation for all available hooks
## Acknowledgements
This library is only possible because of the great efforts from the [Immersive Web Community Group and Immersive Web Working Group at the W3C](https://github.com/immersive-web), the [Three.js](https://github.com/mrdoob/three.js) team, and the [react-three-fiber](https://github.com/pmndrs/react-three-fiber) team. This work is inspired by existing libraries, such as [react-xr](https://github.com/pmndrs/react-xr) and [handy-work](https://github.com/AdaRoseCannon/handy-work).
**natuerlich** is funded by [Coconut Capital](https://coconut.capital/)