mirror of
https://github.com/WhitestormJS/whs.js.git
synced 2026-01-25 16:08:01 +00:00

Community chat. Join us!
Table of content
Basic setup
Download the minified library or link the one from CDN
<script src="js/three.min.js"></script>
<script src="js/whs.min.js"></script>
The code below makes a WHS.App instance which handles all your modules and components for better work with WebGL. This one creates a scene, camera and renderer - we add the following modules to the App.
const app = new WHS.App([
new WHS.ElementModule(), // Apply to DOM.
new WHS.SceneModule(), // Create a new THREE.Scene and set it to app.
new WHS.DefineModule('camera', new WHS.PerspectiveCamera({ // Apply a camera.
position: new Vector3(0, 0, 50)
})),
new WHS.RenderingModule({bgColor: 0x162129}), // Apply THREE.WebGLRenderer
new WHS.ResizeModule() // Make it resizable.
]);
app.start(); // Run app.
NPM
# Install npm version
$ npm install whs
Featured projects
Features
- 💎 Simple in usage
- 🚀 Speeds up 3D scene prototyping
- 🔌 Component based scene graph
- 💣 Simple integration of any high performance physics even with
Worker(Multithreading) - 💫 Automatization of rendering
- 🆕 ES2015+ based
- 🔷 Extension system (modules)
- 📦 Webpack friendly
- ✔️ Integrated Three.js rendering engine
- 💞 Work with whs.js and Three.js at the same time
External Modules
| Name | Status | Description |
|---|---|---|
| whs-module-statsjs | WhitestormJS module for JavaScript Performance Monitor ⚡⌛ | |
| whs-module-dat.gui | User Interface for runtime editing properties 🔑🛠🔩 | |
| physics-module-ammonext | Physics module based on Ammo.js | |
| whs-module-audio | WIP | Audio module for 3D positional sound 🔉 |
| whs-vrkit | Module for Virtual Reality |
Donate
Backers
Support us with a monthly donation and help us continue framework development🎉 and adding new features💡🎁.
Description
Languages
JavaScript
100%

