@threlte/xr 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +59 -8
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,13 +1,64 @@
|
|
|
1
|
-
<
|
|
1
|
+
<div align="right">
|
|
2
|
+
<a href="https://www.npmjs.com/package/@threlte/xr">
|
|
3
|
+
<img alt="npm" src="https://img.shields.io/npm/v/@threlte/xr?color=fe4100&labelColor=171d27&logo=npm&logoColor=white"/>
|
|
4
|
+
</a>
|
|
5
|
+
<a href="https://github.com/threlte/threlte/blob/main/LICENSE.md">
|
|
6
|
+
<img alt="license" src="https://img.shields.io/npm/l/@threlte/core?color=fe4100&labelColor=171d27&logo=git&logoColor=white"/>
|
|
7
|
+
</a>
|
|
8
|
+
<a href="https://discord.com/channels/985983540804091964">
|
|
9
|
+
<img alt="discord" src="https://img.shields.io/discord/985983540804091964?label=discord&color=fe4100&labelColor=171d27&logo=discord&logoColor=white"/>
|
|
10
|
+
</a>
|
|
11
|
+
<a href="https://threlte.xyz">
|
|
12
|
+
<img alt="docs" src="https://img.shields.io/website?down_color=red&down_message=offline&label=docs&color=fe4100&labelColor=171d27&up_message=online&url=https%3A%2F%2Fthrelte.xyz&logo=svelte&logoColor=white"/>
|
|
13
|
+
</a>
|
|
14
|
+
</div>
|
|
2
15
|
|
|
3
|
-
|
|
4
|
-
|
|
16
|
+
<a href="https://threlte.xyz">
|
|
17
|
+
<img src="https://threlte.xyz/logo/threlte-banner.jpg"/>
|
|
18
|
+
</a>
|
|
5
19
|
|
|
6
|
-
|
|
20
|
+
## Rapidly Build Interactive 3D Apps for the Web
|
|
7
21
|
|
|
8
|
-
|
|
9
|
-
> `threlte-xr` is early in development. There will likely be frequent breaking changes until it reaches 0.1.0. It will only work with Threlte v6 onward.
|
|
22
|
+
Threlte is a [Svelte](https://svelte.dev/) library that simplifies creating 3D apps for the web. It provides a **declarative**, **type-safe**, **reactive** and **interactive** API out-of-the-box.
|
|
10
23
|
|
|
11
|
-
|
|
12
|
-
|
|
24
|
+
Threlte's **3D rendering** is powered by [Three.js](https://threejs.org/), and it also provides a **physics engine** through [Rapier](https://rapier.rs/) and an **animation studio** via [Theatre.js](https://www.theatrejs.com/); see [packages](#packages) for details.
|
|
25
|
+
|
|
26
|
+
Check out our **[documentation](https://threlte.xyz)** and our **[Discord community](https://discord.gg/EqUBCfCaGm)**.
|
|
27
|
+
|
|
28
|
+
## @threlte/xr
|
|
29
|
+
|
|
30
|
+
[@threlte/xr](https://threlte.xyz/docs/reference/xr/getting-started) provides a set of components and hooks that make it easy to create XR experiences.
|
|
31
|
+
|
|
32
|
+
## Quickstart
|
|
33
|
+
|
|
34
|
+
### Installation
|
|
35
|
+
|
|
36
|
+
For a quick interactive setup of a fresh Threlte project, run:
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
npm create threlte my-project
|
|
13
40
|
```
|
|
41
|
+
and select the `@threlte/xr` option.
|
|
42
|
+
|
|
43
|
+
Alternatively you can check out the full [installation instructions](https://threlte.xyz/docs/learn/getting-started/installation).
|
|
44
|
+
|
|
45
|
+
### Support
|
|
46
|
+
|
|
47
|
+
Have questions? Feel free to ask in our [Discord support forum](https://discord.com/channels/985983540804091964/1031843197963477002).
|
|
48
|
+
|
|
49
|
+
## Contributing
|
|
50
|
+
|
|
51
|
+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
|
|
52
|
+
|
|
53
|
+
- **Filing Issues** - if you have feature requestions or you think you spotted a bug, [submit an issue](https://github.com/threlte/threlte/issues/new).
|
|
54
|
+
- **Contributing Code** - if you would like to drop us a PR, read the [contribution guide](https://github.com/threlte/threlte/blob/main/CONTRIBUTING.md) first.
|
|
55
|
+
|
|
56
|
+
## Sponsors
|
|
57
|
+
|
|
58
|
+
[](https://vercel.com/?utm_source=threlte&utm_campaign=oss)
|
|
59
|
+
|
|
60
|
+
---
|
|
61
|
+
|
|
62
|
+
### License
|
|
63
|
+
|
|
64
|
+
The MIT License (MIT). Please see the [License File](LICENSE.md) for more information.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@threlte/xr",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.3",
|
|
4
4
|
"author": "Micheal Parks <michealparks1989@gmail.com> (https://parks.lol)",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"devDependencies": {
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"typescript": "^5.1.6",
|
|
19
19
|
"vite": "^4.4.6",
|
|
20
20
|
"vite-plugin-mkcert": "^1.16.0",
|
|
21
|
-
"@threlte/core": "6.0.
|
|
21
|
+
"@threlte/core": "6.0.8"
|
|
22
22
|
},
|
|
23
23
|
"peerDependencies": {
|
|
24
24
|
"svelte": ">=4",
|