alvarosabu
eb35bc6a35
docs: fix getting-started types typo
|
1 年之前 | |
|---|---|---|
| .github | 2 年之前 | |
| .vscode | 2 年之前 | |
| docs | 1 年之前 | |
| playground | 1 年之前 | |
| public | 2 年之前 | |
| src | 1 年之前 | |
| .eslintignore | 2 年之前 | |
| .eslintrc.cjs | 1 年之前 | |
| .gitignore | 2 年之前 | |
| .npmrc | 2 年之前 | |
| .prettierrc.cjs | 2 年之前 | |
| .release-it.json | 2 年之前 | |
| CHANGELOG.md | 1 年之前 | |
| CODE_OF_CONDUCT.md | 2 年之前 | |
| CONTRIBUTING.md | 1 年之前 | |
| LICENSE | 2 年之前 | |
| README.md | 1 年之前 | |
| components.d.ts | 2 年之前 | |
| composables.d.ts | 2 年之前 | |
| netlify.toml | 2 年之前 | |
| package.json | 1 年之前 | |
| pnpm-lock.yaml | 1 年之前 | |
| pnpm-workspace.yaml | 2 年之前 | |
| renovate.json | 2 年之前 | |
| tsconfig.json | 2 年之前 | |
| tsconfig.node.json | 2 年之前 | |
| types.d.ts | 2 年之前 | |
| utils.d.ts | 2 年之前 | |
| vite.config.ts | 1 年之前 |
README.md
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
pnpm install @tresjs/core three
Docs
Checkout the docs
Demos
Ecosystem
| Package | Version |
|---|---|
| Tres |  |
| Cientos |  |
| Post-processing |  |
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
Sponsors
Be the first to support this project here ☺️