@companion-module/base
Advanced tools
This module provides the base class and framework needed to write a module for [Companion 3.0](https://github.com/bitfocus/companion) and later in NodeJS.
This module provides the base class and framework needed to write a module for Companion 3.0 and later in NodeJS.
In the future it will be possible to write modules in other languages, but it is not recommended as it will reduce the change of gettings other in the community to contribute features and fixes. If you interested in doing this then reach out and we can work together on creating an alternate framework for the language you are using.
Each version of Companion supports a limited range of versions of this library listed below. Any patch version (the third number) are not relevant for the compatibility check, so are not listed here
| Companion | Module-base |
|---|---|
| v3.0 | v1.0 - v1.4 |
| v3.1 | v1.0 - v1.5 |
| v3.2 | v1.0 - v1.7 |
| v3.3 | v1.0 - v1.8 |
| v3.4 | v1.0 - v1.10 |
| v3.5 | v1.0 - v1.11 |
| v4.0 | v1.0 - v1.12 |
| v4.1 | v1.0 - v1.13 (unconfirmed) |
To get started with creating a new module, you should start with one of the following templates. These should be kept up to date, but you should make sure all the dependencies are up to date before you begin.
You can view detailed generated documentation here.
Or refer to the wiki for a more handwritten version
FAQs
This module provides the base class and framework needed to write a module for [Companion 3.0](https://github.com/bitfocus/companion) and later in NodeJS.
The npm package @companion-module/base receives a total of 488 weekly downloads. As such, @companion-module/base popularity was classified as not popular.
We found that @companion-module/base demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket CEO Feross Aboukhadijeh discusses the recent npm supply chain attacks on PodRocket, covering novel attack vectors and how developers can protect themselves.
Security News
Maintainers back GitHub’s npm security overhaul but raise concerns about CI/CD workflows, enterprise support, and token management.
Product
Socket Firewall is a free tool that blocks malicious packages at install time, giving developers proactive protection against rising supply chain attacks.
