/tres

Declarative ThreeJS using Vue Components

Primary LanguageTypeScriptMIT LicenseMIT

repo-banner

npm package npm downloads discord chat netlify status

TresJS @tresjs/core

Declarative ThreeJS using Vue Components

  • 💡 Build 3D scene as they were Vue components
  • ⚡️ Powered by Vite
  • 🥰 It brings all the updated features of ThreeJS right away regardless the version
  • 🦾 Fully Typed

Tres (Spanish word for "three", pronounced /tres/ ) is a way of creating ThreeJS scenes with Vue components in a declarative fashion.

It's build on-top of a Vue Custom Renderer and it's powered by Vite.

The goal is to provide the Vue's community an easy way of building 3D scenes with Vue, always up to date with the latest ThreeJS features and with 0-to-none maintenance.

Installation

pnpm install @tresjs/core three

Docs

Checkout the docs

Demos

Ecosystem

Package Version
Tres tres version
Cientos cientos version
Post-processing post-processing version
Nuxt nuxt version
TresLeches 🍰 tresleches version

Contribution

We are open to contributions, please read the contributing guide to get started.

Setup

pnpm install --shamefully-hoist

Playground

To run the small playground

pnpm run playground

Build lib

To build the core as library mode just use

pnpm run build

Docs

To run de docs in dev mode

pnpm run docs:dev

To build them

pnpm run docs:build

License

MIT

Sponsors

sponsors