Finding and Installing Modules

Modules extend the core or provide some additional functionality. Scenes are modules, providing Scene models to the database and code to handle user interaction with those scenes. You can also imagine any number of utility modules, like analytic event aggregators or whole new permission systems.

Finding Modules

http://code.lot.gd/ is our growing collection of module code.

To make your module a part of http://code.lot.gd, simply put up a pull request adding it to satis.json.

Installing a Module

Modules are installed via Composer packages. Composer is a common dependency manager for PHP, providing centralized storage and easy installation of code. We are hosting our own repository of packages at http://code.lot.gd.

1. To install a new module, add it as a Composer dependency. See the example of specifying the HelloWorld module in the crate-sample repo.
2. Run composer update to install the module's code.
3. Finally, register any newly added modules with the core by using the daenerys tool:

vendor/bin/daenerys module:register

Note: modules are added to crates, so these instructions are to be run from a crate directory.