Overview

A module package is simply a collection of one or more Modules.

The basic principle is that there's a main.json at the Module Package root and then each Module and it's assets exists in their own sub-folder.

When you load a Module Package into Somiibo, it looks at the main.json to know about which Modules are in the package.

Module Package File Structure

my-module-package

my-module-1
- module.js - Logic that controls the module itself
- settings.html - User interface for the module's settings
- settings.js - Logic that controls any custom settings.html behavior
- settings.json - Defaults, min, max, and more for the module's settings
... - Additional individual module folders exist on this level (same contents as my-module-1)
main.json - Defines data about the package as a whole and each individual module

Want to see a full example?

You can download a fully working Module Package from our examples repo on GitHub.

Boilerplate

In this example, we have defined one module in main.json with name = module-1.

The main.json file contains meta data for the package as a whole, as well as the meta data for the individual modules contained in the package. Read the main.json API

        
          {
  "id": "863d3118-dee7-4002-a45f-464ae71e3322",
  "title": "Package Boilerplate",
  "description": "A starting point for your first module package.",
  "author": "Your Name",
  "repository": "https://github.com/username/repo.git",
  "modules": [
    {
      "id": "c41c1553-1ef4-4cf8-820e-df861aefd675",
      "name": "module-1",
      "title": "My first module",
      "description": "A starting point for your first module.",
      "icon": "fa-code",
      "version": "1.0.0",
      "versionRequired": "0.2.900",
      "status": "online",
      "url": "https://google.com",
      "width": 1280,
      "height": 720,
      "userAgent": ""
    }
  ]
}

The module.js script is the actual logic behind a module. It controls the webpages and performs actions on websites. Read the module.js API

        
          let somiibo;
async function main(mod) {
  somiibo = mod;

  // Build your module logic here

  somiibo.loop(main);
}

module.exports = main;

The settings.html API works in conjunction with settings.js and settings.json to deliver a customizable experience to the user. Read the settings.html API

        
          <settings>
  <form>
    <!-- Build your settings interface here -->
    <button type="submit" class="btn btn-lg btn-block btn-primary">Continue</button>
  </form>
</settings>

The settings.js API works in conjunction with settings.html and settings.json to deliver a customizable experience to the user. Read the settings.js API

        
          let settings;
async function main(mod) {
  settings = mod;

  // Build your settings logic here

}

module.exports = main;

The settings.json API works in conjunction with settings.html and settings.js to deliver a customizable experience to the user. Read the settings.json API

        
          {
  "fields": [

  ]
}

Overview

Module Package File Structure

Want to see a full example?

Boilerplate

{title}