companion-module-linux-show-player
v1.0.0
Published
Bitfocus Companion module to control Linux Show Player via OSC (start/stop cues, play/pause, navigation).
Maintainers
Readme
Companion Module: Linux Show Player (LSP)
Control Linux Show Player from a Bitfocus Companion button surface via OSC.
Features
- Trigger a specific cue by number
- Play/Pause current cue
- Stop current cue
- Next / Previous cue navigation
- Designed for quick expansion (add more OSC paths easily)
Installation
- Install this module (when published) from the Companion Module Store OR add the repository to a local dev environment.
- Add a new instance of "Linux Show Player" in Companion.
- Configure Host (IP of the machine running LSP) and Port (default 8000).
- Create buttons using the provided actions.
Configuration Fields
| Field | Description | |-------|-------------| | Host | IP or hostname where Linux Show Player runs | | Port | OSC UDP port (default 8000) |
Ensure that each cue in LSP has OSC enabled (Acquire checkbox) and that LSP is set to listen on the same port.
Provided Actions
| Action | Description |
|--------|-------------|
| Trigger Cue | Start a cue by number (sends /cue/<n>/start) |
| Play/Pause | Toggle playback of current cue |
| Stop | Stop current playing cue |
| Next Cue | Advance to next cue |
| Previous Cue | Go back to previous cue |
Roadmap / Ideas
- Feedback for current / selected cue
- Cue list polling & dynamic variables
- Labels reflecting cue names
Development
npm install
npm run buildDuring development:
npm run devThis compiles main.ts to dist/main.js (entrypoint referenced by companion/manifest.json).
Publish (Maintainer Notes)
- Update version in
package.json&companion/manifest.json npm run buildgit commit -am "release: vX.Y.Z"git tag vX.Y.Z && git push --tagsnpm publish
License
MIT © 2025 ninuxi
