@ud-viz/shared
v3.2.0
Published
UD-Viz shared Browser+Node framework
Downloads
5
Readme
@ud-viz/shared
@ud-viz/shared is a npm package based on Three.js including data processing and model plus a game engine.
Directory Hierarchy
UD-Viz/packages/shared
├── bin # Global NodeJS development
├── src # JS files composing the package
| ├── Game # Shared game engine
| | ├── Component # Components of `Game.Object3D`
| | ├── ScriptTemplate # JS script templates of Shared game engine
| | ├── State # Game state
| | ├── Context.js # Handle scripts, collisions and model of a game
| | ├── Object3D.js # Game node of a 3D scene
| ├── Command.js # Basic object communication
| ├── Data.js # Module for data processing (split string, converts to uri...)
| ├── index.js # API description (webpack entry point)
| ├── ProcessInterval.js # Manage loop process requesters
| ├── Type.js # Check if a string is a valid number
├── webpackConfig # Configs of bundles' creation
├── package.json # Global npm project description
├── Readme.md # It's a me, Mario!
Getting started
See here.
Developers
For pre-requisites see here.
Npm scripts
| Script | Description |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| npm run build
| Create a webpack bundle in production mode. See webpack.config.js |
| npm run build-debug
| Create a webpack bundle in developpement mode. See webpack.config.js |
| npm run test
| Run shared testing scripts. Uses this test script |
| npm run debug
| Launch a watcher for debugging. See here for more information |
Debugging
For debugging run:
npm run debug
This runs a watched routine debug.js with nodemon which:
- Runs a
npm run build-debug
- May run
npm run test
(true by default).