1
0
mirror of https://github.com/troisjs/trois.git synced 2024-11-24 04:12:02 +08:00
trois/README.md
Kevin Levron a67d322790 readme
2021-03-04 17:38:58 +01:00

70 lines
2.1 KiB
Markdown

# ✨ ThreeJS + VueJS 3 + ViteJS ⚡
I wanted to code something similar to [react-three-fiber](https://github.com/react-spring/react-three-fiber) but for VueJS.
<p>
<a href="https://troisjs.github.io"><img src="/screenshots/troisjs1.jpg" width="45%" /></a>
<a href="https://troisjs.github.io"><img src="/screenshots/troisjs3.jpg" width="45%" /></a>
<a href="https://troisjs.github.io"><img src="/screenshots/troisjs4.jpg" width="45%" /></a>
<a href="https://troisjs.github.io"><img src="/screenshots/troisjs5.jpg" width="45%" /></a>
</p>
- 💻 Examples (wip) : https://troisjs.github.io/ ([sources](https://github.com/troisjs/troisjs.github.io/tree/master/src/components))
- 📖 Doc (wip) : https://troisjs.github.io/guide/ ([repo](https://github.com/troisjs/troisjs.github.io))
- 🚀 Codepen examples : https://codepen.io/collection/AxoWoz
I started from scratch, I will rewrite some of my [WebGL demos](https://codepen.io/collection/AGZywR) to see if this little toy can do the job.
*Trois* is a french word, it means *Three*.
## HMR
Thanks to VueJS/ViteJS, **TroisJS use watchers and HMR to update ThreeJS objects when you update a template or a prop**. This means the result in your browser will be automatically updated without reloading all the stuff. **This is really helpful when you are creating a TroisJS Scene**.
## Features
- [ ] Lights
- [x] AmbientLight
- [x] DirectionalLight
- [x] PointLight
- [x] SpotLight
- [ ] ...
- [ ] Materials
- [x] Basic
- [x] Lambert
- [x] Mapcat
- [x] Phong
- [x] Physical
- [x] Standard
- [x] SubSurface
- [x] Toon
- [ ] ...
- [ ] Geometries
- [x] Box
- [x] Circle
- [x] Cone
- [x] Cylinder
- [x] Dodecahedron
- [x] Icosahedron
- [x] Lathe
- [x] Octahedron
- [x] Polyhedron
- [x] Ring
- [x] Sphere
- [x] Tetrahedron
- [x] Torus
- [x] TorusKnot
- [x] Tube
- [ ] ...
- [ ] Post Processing
- [x] EffectComposer
- [x] BokehPass
- [x] FilmPass
- [x] FXAAPass
- [x] HalftonePass
- [x] Renderpass
- [x] SMAAPass
- [x] UnrealBloomPass
- [ ] ...
- [ ] ...