Template Scaffolding

Once you successfully create a Module, you'll find a new folder in your local App Data that is scaffolded and ready-to-go for your new Module. You can find the location of this folder based on your Operating System:

  • Windows - C:\Users\{user}\AppData\Roaming\CastHub\modules
  • Linux - ~/.config/CastHub/modules

Or by clicking the Button when viewing the Module page.

The folder generated for your Module will be the same as your key.


All Modules have a single export point, and in this scaffold it is index.js. The name of the file isn't important, as long as the main in your package.json points to it (See Metadata for more on this)

The returned class in your index.js must be a subclass of window.casthub.module. The Stock Elements all inherit from this base class, so you are also able to extend them directly instead.

How do I see it?

By now, you have a registered Module with a scaffold set-up for the Module Element itself. Now you'll need to add it to one of your Dashboards to see it in-action.

Using Unpublished Modules