-
-
Notifications
You must be signed in to change notification settings - Fork 108
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0e28f56
commit 9792c6e
Showing
172 changed files
with
60,707 additions
and
8,275 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,25 @@ | ||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
pnpm-debug.log* | ||
lerna-debug.log* | ||
|
||
node_modules | ||
dist | ||
dist-ssr | ||
*.local | ||
coverage | ||
|
||
# Editor directories and files | ||
.vscode/* | ||
!.vscode/extensions.json | ||
.idea | ||
.DS_Store | ||
apps/.DS_Store | ||
packages/.DS_Store | ||
.pnpm-store/ | ||
# Local Netlify folder | ||
.netlify | ||
docs/.vitepress/dist | ||
docs/.vitepress/cache/ | ||
apps/love-vue-threejs/ | ||
*.suo | ||
*.ntvs* | ||
*.njsproj | ||
*.sln | ||
*.sw? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,46 +1,40 @@ | ||
![repository-banner.png](/public/github-banner.png) | ||
|
||
<p align="center"> | ||
<a href="https://www.npmjs.com/package/@tresjs/core"><img src="https://img.shields.io/npm/v/@tresjs/core?color=%2382DBCA" alt="npm package"></a> | ||
<a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/node/v/@tresjs/core.svg" alt="node compatibility"></a> | ||
<a href="https://discord.gg/tfY9aSNT"><img src="https://img.shields.io/badge/chat-discord-purple?style=flat&logo=discord" alt="discord chat"></a> | ||
</p> | ||
<br/> | ||
|
||
# Tres | ||
# @tresjs/core ▲ ■ ● | ||
|
||
> Declarative ThreeJS using Vue Components | ||
- 💡 Build a 3D scene working only with Vue components. | ||
- 💡 Build 3D scene as they were Vue components | ||
- ⚡️ Powered by Vite | ||
- 🥰 It brings all the updated features of ThreeJS right awayregardless 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. Think of it as a [React-three-fiber](https://docs.pmnd.rs/react-three-fiber) or [Lunchbox](https://github.com/breakfast-studio/lunchboxjs) but without the need of a [custom Vue3 Renderer](https://vuejs.org/api/custom-renderer.html). | ||
|
||
## Packages | ||
|
||
| Package | Version (click for changelogs) | | ||
| --------------------------- | :--------------------------------------------------------------------------------------------------------------------------- | | ||
| [Tres](packages/tres) | [![tres version](https://img.shields.io/npm/v/@tresjs/core.svg?label=%20&color=%2382DBCA)](packages/tres/CHANGELOG.md) | | ||
| [Cientos](packages/cientos) | [![tres version](https://img.shields.io/npm/v/@tresjs/cientos.svg?label=%20&color=%23f19b00)](packages/cientos/CHANGELOG.md) | | ||
## Setup | ||
|
||
## Docs | ||
``` | ||
pnpm install --shamefully-hoist | ||
``` | ||
|
||
Checkout the [docs](https://tresjs.org) | ||
## Dev | ||
|
||
## Demos | ||
To run the small playground without Histoire use | ||
|
||
- [Stackblitz Collection](https://stackblitz.com/@alvarosabu/collections/tresjs) | ||
``` | ||
pnpm run dev | ||
``` | ||
|
||
## Contribution | ||
## Histoire | ||
|
||
We are open to contributions, please read the [contributing guide](/CONTRIBUTING.md) to get started. | ||
All local demos will be inside [Histoire](https://histoire.dev/) stories. | ||
|
||
## License | ||
``` | ||
pnpm run story:dev | ||
``` | ||
|
||
[MIT](/LICENSE) | ||
## Build lib | ||
|
||
## Sponsors | ||
To build the core as library mode just use | ||
|
||
Be the first to support this project [here](https://github.com/sponsors/alvarosabu) ☺️ | ||
``` | ||
pnpm run build | ||
``` |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.