threlte

mirror of https://github.com/benkoppe/threlte synced 2025-12-05 14:48:10 -08:00

No description

Find a file

Micheal Parks 79e7cf9e70 Merge pull request #1509 from threlte/changeset-release/main Version Packages		2025-05-12 16:45:24 +02:00
.changeset	Version Packages	2025-05-12 14:45:07 +00:00
.github	fix workflow	2025-05-09 15:52:23 +02:00
.vscode	add formatting tools	2025-05-08 17:47:05 +02:00
apps/docs	fix typecheck issues	2025-05-09 16:41:53 +02:00
assets	Add new banner to all READMEs	2023-07-30 22:17:55 +02:00
packages	Version Packages	2025-05-12 14:45:07 +00:00
.editorconfig	Monorepo initial commit	2022-07-09 14:21:55 +02:00
.eslintrc.js	Initial commit from Create Turborepo	2022-07-07 23:59:48 +02:00
.gitignore	Initial commit from Create Turborepo	2022-07-07 23:59:48 +02:00
.npmrc	This change enables the CodeFlow IDE	2023-02-16 10:17:59 +01:00
.prettierignore	prettier ignore autogenerated changesets	2024-02-08 19:41:37 -05:00
.prettierrc	mdx fixes	2024-07-10 19:06:34 -04:00
.stackblitzrc	.stackblitzrc update	2023-07-31 15:10:48 +02:00
bun.lock	chore: update svelte to version 5.26.2 across packages	2025-04-12 23:53:31 +02:00
CODE_OF_CONDUCT.md	ran format from top-level of project	2023-11-29 14:07:00 +13:00
CONTRIBUTING.md	add links to required dev tools	2025-01-10 15:26:49 +13:00
LICENSE.md	First README draft	2022-01-17 13:12:02 +01:00
package.json	revert pnpm version	2025-05-09 16:13:39 +02:00
pnpm-lock.yaml	chore: downgrade TypeScript to 5.4.5 and update related dependencies to ensure compatibility	2025-05-10 00:57:06 +02:00
pnpm-workspace.yaml	removed convert util	2023-03-18 11:48:09 +01:00
README.md	Remove references to create-threlte, remove @next tag	2025-01-20 22:20:37 +01:00
turbo.json	no test dependencies	2024-12-02 07:25:49 +01:00
vercel.json	vercel config needs to be in root now	2022-11-15 12:32:19 +01:00

README.md

Rapidly Build Interactive 3D Apps for the Web

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.

Quickstart

Installation

Check out the installation instructions.

Tutorial

To get a hang of the basics, we recommend following our introductory tutorial.

Support

Have questions? Feel free to ask in our Discord support forum.

Features

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.

Packages

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-layout with Threlte.

Contributing

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.