https://github.com/sascha245/vue-threejs-composer
Compose beautiful 3D scenes with Vue and Three.js
https://github.com/sascha245/vue-threejs-composer
javascript threejs vue
Last synced: 10 days ago
JSON representation
Compose beautiful 3D scenes with Vue and Three.js
- Host: GitHub
- URL: https://github.com/sascha245/vue-threejs-composer
- Owner: sascha245
- License: mit
- Created: 2018-10-07T19:21:51.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-27T14:35:53.000Z (over 6 years ago)
- Last Synced: 2025-05-05T04:17:14.430Z (17 days ago)
- Topics: javascript, threejs, vue
- Language: TypeScript
- Homepage:
- Size: 3.32 MB
- Stars: 72
- Watchers: 6
- Forks: 16
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vue-threejs-composer
Build beautiful and interactive scenes in the easy way.
## Why?
Today there are already a few libraries out there to create scenes in Vue with Three.js:
- [vue-gl](https://github.com/vue-gl/vue-gl)
- [vue-threejs](https://github.com/fritx/vue-threejs)
These libraries are good for creating simple scenes, as they allow us to easily create basic 3D content, sometimes even with physics.
For more complex ones however, we need more control for some aspects:
- Better and easier management of your assets and scenes
- Creating content with pure THREE.js
This library allows us to do exactly that.
## Features
This library won’t include any basic geometries, materials and more advanced stuff.
It will only implement a base from which you can easily extend from, as well as implement some in-build functionalities to relieve the user of common problems experienced in normal THREE.js projects:
1. In-build asset and scene manager
2. Helpers for loading and instantiating 3D models.
3. Create custom content and components with pure THREE.js code.
## Installation
Install THREE.js:
`npm install three --save`
Optionally, install THREE.js typings:
`npm install @types/three --save-dev`
Install this package:
`npm install vue-threejs-composer --save`
## Samples
If you want to test out our samples, you can clone our repository and launch our samples with the following commands:
Install dependencies
`npm install`
Launch development server
`npm run serve`
Play around with the files in */samples*. The demo scene is situated at */samples/views/Demo.vue*
## Documentation
Here the link to the official [documentation](https://vue-threejs-composer.netlify.com/).
Note however that the writing of the documentation is still in progress.
If you can't find what you are looking for in the documentation, you can also open a new ticket describing your issue.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) for details
## Acknowledgments
- Inspired in some aspects by [vue-gl](https://github.com/vue-gl/vue-gl)