TresJS

Declarative ThreeJS using Vue Components

AnimationVueWebGL3D
Tresjs/trestresjs.org@tresjs/core

README

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 mantainance.

Installation


  1. ```bash
  2. pnpm install @tresjs/core three
  3. ```

Docs


Checkout the docs

Demos


- Stackblitz Collection

Ecosystem


PackageVersion
---------------------------:-------------------------------------------------------------------------------------------------
[Tres](packages/tres)![tres
[Cientos](packages/cientos)![cientos
[Post-processing](packages/post-processing)![post-processing

Contribution


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

Setup


  1. ```
  2. pnpm install --shamefully-hoist
  3. ```

Playground


To run the small playground

  1. ```
  2. pnpm run playground
  3. ```

Build lib


To build the core as library mode just use

  1. ```
  2. pnpm run build
  3. ```

Docs


To run de docs in dev mode

  1. ```bash
  2. pnpm run docs:dev
  3. ```

To build them

  1. ```bash
  2. pnpm run docs:build
  3. ```

License


MIT

Sponsors


Be the first to support this project here ☺️