-
Notifications
You must be signed in to change notification settings - Fork 15
Renaming your module
-
Make sure you are happy for any changes in the main branch of the module to be included into beta builds of Companion
-
Ask in the module-development slack for approval on the new name
This is so that we can be sure the new name conforms to our standard structure ofcompanion-module-manufacturer-product
(orcompanion-module-manufacturer-protocol
). -
Once approved, the team will be able to rename the GitHub repository for you.
-
Some additional changes need to be made. This might be done for you, or might be left for you to do:
- Update the
name
and any urls in thepackage.json
- Update the
name
and related fields incompanion/manifest.json
- Add the old name to the
legacyIds
array incompanion/manifest.json
. This lets Companion know of the rename, so that existing users will be migrated accross.
- Update the
-
Once everything is updated, this can be included in the builds
A note for the maintainers running the build script, the old module name will need to be manually removed from the bundled-modules github repository.
Getting Started
- Home
- Module development 101
- Git crashcourse
- Upgrading a module built for Companion 2.x
- Companion module library versioning
- Releasing your module
Development
- File Structure
- manifest.json
- Logging
- Module packaging
- Actions
- Feedbacks
- Presets
- Input Field Types
- Module configuration
- Upgrade scripts
- Variables
Code quality
Advanced functionality