https://github.com/codenameyau/playground
:package: Three.js core library
https://github.com/codenameyau/playground
Last synced: 4 days ago
JSON representation
:package: Three.js core library
- Host: GitHub
- URL: https://github.com/codenameyau/playground
- Owner: codenameyau
- License: mit
- Created: 2015-06-01T00:55:18.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2017-02-12T18:22:06.000Z (over 9 years ago)
- Last Synced: 2026-03-15T21:11:29.883Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 37.1 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# playground
Playground is an object-oriented Three.js boilerplate. Three.js projects
have a lot of boilerplate code that quickly becomes tedious to write.
Additionally as these projects grow, they become difficult to understand and
maintain. Playground attempts to solve those issues by providing a core
library that handles all the behind-the-scenes Three.js setup and rendering code.
Please see the [public example](https://github.com/codenameyau/playground/blob/master/public/assets/js/demo.js)
for basic usage. Please visit [Tribble](https://github.com/codenameyau/tribble/tree/master/public/projects/demo)
for more in-depth demos.
## Installation
```
bower install playground --save
```
#### Dependencies
You'll need to download and include the following dependencies.
- [Three.js](https://cdnjs.cloudflare.com/ajax/libs/three.js/r71/three.min.js)
- [Three.js Orbit Controls](https://github.com/mrdoob/three.js/blob/master/examples/js/controls/OrbitControls.js)
## Features
Some features include:
- Clock pausing and resuming on tab-switching.
- Manually pause the renderer with the 'space' key.
- Reset the camera with the 'r' key.
- Fully customizable key-bindings.
- Dynamically load and reset scenes.
- Automatic window resize.
## Contributing
Please work with `public/assets/js/lib/playground.js`. The files inside
`build/` should not be edited since they are autogenerated with gulp.