Threlte is a Svelte library that simplifies creating 3D apps for the web. It provides a declarative, type-safe, reactive and interactive API out-of-the-box.
Threlte's 3D rendering is powered by Three.js, and it also provides a physics engine through Rapier and an animation studio via Theatre.js; see packages for details.
Check out our documentation and our Discord community.
For a quick interactive setup of a fresh Threlte project, run:
npm create threlte my-projectAlternatively you can check out the full installation instructions.
To get a hang of the basics, we recommend following our introductory tutorial.
Have questions? Feel free to ask in our Discord support forum.
-
Clean API transparently exposing all Three.js objects through declarative API.
-
Hooks providing easy access to low-level contexts like animation frames and the rendering engine.
-
Plugins making it easy to extend Threlte with custom code and logic.
-
Events enabling robust and Svelte-native access to state transformations in your scenes.
-
Interactivity makes it easy to react to user inputs on 3D objects.
Threlte is comprised of six distinct packages to allow you to import only what you need:
-
@threlte/core provides declarative and transparent Svelte binding to Three.js.
-
@threlte/extras boosts productivity with assorted enhancements that extend Threlte's functionality.
-
@threlte/gltf gives you a CLI to that turn GLTF assets into declarative and reusable Threlte components.
-
@threlte/rapier enables performant physics in your Threlte app through the Rapier engine
-
@threlte/theatre lets you animate in your Threlte app through the Theatre.js studio
-
@threlte/xr** - components and hooks for VR and AR environments
-
@threlte/flex** - components to easily use the flex engine
yoga-layoutwith Threlte.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Filing Issues - if you have feature requestions or you think you spotted a bug, submit an issue.
- Contributing Code - if you would like to drop us a PR, read the contribution guide first.
The MIT License (MIT). Please see the License File for more information.