MCPcopy Index your code
hub / github.com/WhitestormJS/whs.js

github.com/WhitestormJS/whs.js @v2.1.6 sqlite

repository ↗ · DeepWiki ↗ · release v2.1.6 ↗
3,244 symbols 7,232 edges 273 files 178 documented · 5%
README

Three Build Status

Community chat. Join us!

Discord

Table of content

Basic setup

Download the minified library or link the one from CDN

<script src="https://github.com/WhitestormJS/whs.js/raw/v2.1.6/js/three.min.js"></script>
<script src="https://github.com/WhitestormJS/whs.js/raw/v2.1.6/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

NPM Version

Featured projects

http://abdaily.surge.sh/4/

http://abdaily.surge.sh/3/

http://abdaily.surge.sh/2/

http://abdaily.surge.sh/1/

http://theroguepixel.com/

http://supertiny.agency/

https://alexbuzin.me/

https://spatial.100shapes.com/

http://plateaux.space/

Features

  • 💎 Simple in usage
  • :rocket: Speeds up 3D scene prototyping
  • 🔌 Component based scene graph
  • 💣 Simple integration of any high performance physics even with Worker (Multithreading)
  • :dizzy: Automatization of rendering
  • 🆕 ES2015+ based
  • :large_blue_diamond: Extension system (modules)
  • :package: Webpack friendly
  • ✔️ Integrated Three.js rendering engine
  • :revolving_hearts: Work with whs.js and Three.js at the same time

External Modules

Name Status Description
whs-module-statsjs statsjs-npm WhitestormJS module for JavaScript Performance Monitor ⚡⌛
whs-module-dat.gui datgui-npm User Interface for runtime editing properties 🔑🛠🔩
physics-module-ammonext physics-ammonext-npm Physics module based on Ammo.js
whs-module-audio WIP Audio module for 3D positional sound 🔉
whs-vrkit physics-ammonext-npm Module for Virtual Reality

Donate

OpenCollective Backers OpenCollective Sponsors

Backers

Support us with a monthly donation and help us continue framework development🎉 and adding new features💡🎁.

Extension points exported contracts — how you extend this code

DodecahedronBufferGeometry (Interface)
* this is missing in @types from three.js :( * * @interface DodecahedronBufferGeometry * @extends {Geometry} [74 implementers]
types/components/meshes/Dodecahedron.d.ts
TextureParams (Interface)
* Texture properties
types/modules/mesh/TextureModule.d.ts
LightComponentParams (Interface)
(no doc)
types/core/LightComponent.d.ts
ParametricBufferGeometry (Interface)
(no doc) [74 implementers]
types/components/meshes/Parametric.d.ts
NativeParam (Interface)
* ResizeModule native param
types/modules/app/VirtualMouseModule.d.ts
CameraComponentParams (Interface)
(no doc)
types/core/CameraComponent.d.ts
IcosahedronBufferGeometry (Interface)
(no doc) [74 implementers]
types/components/meshes/Icosahedron.d.ts
PostProcessorModuleParams (Interface)
* PostProcessorModule properties
types/modules/app/PostProcessorModule.d.ts

Core symbols most depended-on inside this repo

fA
called by 499
examples/assets/ammo.js
n
called by 344
examples/assets/physics-module.js
WC
called by 311
examples/assets/ammo.js
G
called by 265
examples/assets/physics-module.js
$
called by 233
examples/assets/physics-module.js
addTo
called by 188
src/core/Component.js
tv
called by 139
examples/assets/ammo.js
wrapPointer
called by 131
examples/assets/ammo.js

Shape

Function 2,555
Method 362
Class 279
Interface 48

Languages

TypeScript100%

Modules by API surface

examples/assets/ammo.js2,136 symbols
modules/DatGUIModule.module.js70 symbols
modules/DatGUIModule.js70 symbols
deprecation.js47 symbols
src/modules/app/controls/lib/ThreeOrbitControls.js41 symbols
docs/template/publish.js33 symbols
examples/assets/physics-module.js28 symbols
modules/VRKit.module.js21 symbols
modules/VRKit.js21 symbols
src/modules/app/StateModule.js15 symbols
src/modules/app/RenderingModule.js15 symbols
src/core/Component.js15 symbols

Dependencies from manifests, versioned

@types/node8.0.4 · 1×
@types/three0.84.16 · 1×
babel6.23.0 · 1×
babel-core6.25.0 · 1×
babel-eslint7.2.3 · 1×
babel-jest20.0.3 · 1×
babel-loader7.1.0 · 1×
babel-plugin-add-module-exports0.2.1 · 1×
babel-plugin-external-helpers6.22.0 · 1×
babel-plugin-istanbul4.1.4 · 1×
babel-plugin-transform-class-properties6.24.1 · 1×
babel-plugin-transform-decorators-legacy1.3.4 · 1×

For agents

$ claude mcp add whs.js \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact