Skip to content

Latest commit

 

History

History
91 lines (56 loc) · 2.25 KB

README.md

File metadata and controls

91 lines (56 loc) · 2.25 KB

repository-banner.png

npm package npm downloads discord chat


Cientos

Collection of useful helpers and fully functional, ready-made abstractions for Tres

  • 💡 Build a 3D scene working only with Vue components.
  • ⚡️ Powered by Vite
  • 🥰 It brings all the updated features of ThreeJS right away regardless the version
  • 🦾 Fully Typed

Cientos (the Spanish word for "hundreds", pronounced /θjentos/ ) is a collection of useful ready-to-go helpers and components that are not part of the core package. The name uses the word used in Spanish to multiply by 100, to refer to the potential reach of the package to hold an amazing abstraction.

The cientos package uses three-stdlib module under the hood instead of the three/examples/jsm module. This means that you don't need to extend the catalog of components using the extend method from the core, cientos does it for you.

It just works. 💯

Installation

pnpm i @tresjs/cientos

Docs

Checkout the docs

Demos

Contributing

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

Build

To build the package run:

pnpm run build

Playground

To run the playground run, is a great way to test the components and helpers locally:

First, install dependencies

pnpm i

And then to run the development server on http://localhost:5173

pnpm run playground

Test

TODO...

Docs

To run de docs in dev mode

pnpm run docs:dev

To build them

pnpm run docs:build

License

MIT

Sponsors

Be the first to support this project here ☺️.