Lucidity

Part of Lucidity project.

This is a meta package for all libraries needed to create a 'lucid' app.

Installation

Currently only works with io.js.

npm install lucidity --save

Setup

Once installed, create an 'index.js' file in the root directory with:

require ( 'lucidity' )
.boot ()

Now you can start your application from within the root directory. Your application will be run by executing the code in the workbench: lucy/work/index.js.

electron .

Note: you can install electron with

npm install -g electron-prebuilt

Modules

• lucy-app Application runtime and main event loop.
• lucy-live Live coding support.
• lucy-compose Scene composition.
• lucy-three Scene composition for THREE.js.
• lucy-forge Minimal component/entity composition to 'mixin' behaviors.
• lucy-boot Electron application main process management.
• lucy-util Utility library (value smoothing, etc).

Tests

npm test

Contributing

Please use 'jessy style'.

Add unit tests (when possible) for any new or changed functionality.

Issues

Please fill in issues for the specific libraries, not the meta-package 'lucidity'.

Release History

• 0.1.2 (2015-09-03) Added lucy-compose and lucy-three.
• 0.1.1 (2015-09-02) Updated docs.
• 0.1.0 (2015-09-02) Initial release.