Bitfocus Companion
Cliqer integrates with Bitfocus Companion, the popular open-source button control software for live production. The Cliqer module is automatically installed when Cliqer detects Companion on your system — no manual setup required.
How It Works
Cliqer communicates with Companion over a real-time WebSocket connection for instant timer updates, and uses the local HTTP API for actions.
Companion ←→ Cliqer (WebSocket + HTTP API)
Setup
- Install Bitfocus Companion if you haven't already
- Launch Cliqer — the module is installed automatically
- Open Companion and add a Cliqer connection
- Configure the Host IP and API Port (defaults:
127.0.0.1/24601)
Available Actions
The module provides the following actions for your Companion buttons:
| Action | Description |
|---|---|
| Previous Slide | Go to previous slide |
| Next Slide | Go to next slide |
| Timer Start / Stop | Start or stop the timer |
| Timer Reset | Reset timer to active preset |
| Timer +1 / +2 / +5 min | Add minutes to the timer |
| Timer −1 / −2 / −5 min | Subtract minutes from the timer |
| Preset 1 / 2 / 3 / 4 | Set timer to a preset duration |
Feedbacks
Companion feedbacks change button appearance based on the current timer state:
| Feedback | Description |
|---|---|
| Timer Running | True when the timer is actively counting |
| Timer Stopped | True when the timer is paused |
| Timer Overtime | True when the timer has passed 0:00 in countdown mode |
Variables
The following variables are available for use in button labels and triggers:
| Variable | Description | Example |
|---|---|---|
timer_display | Current timer value | 14:30 |
timer_minutes | Minutes component | 14 |
timer_seconds | Seconds component | 30 |
timer_state | Timer state | running / stopped |
preset1_label – preset4_label | Preset durations | 05:00 |
Presets
The module includes 16 pre-configured button presets organised into logical groups:
- Slide Control — Previous / Next slide buttons
- Timer — Start/Stop, Reset, and timer display
- Quick Adjust — ±1 / ±2 / ±5 minute buttons
- Presets — Preset 1–4 buttons
Drag these presets onto your Companion pages for an instant Cliqer control surface.
Platform Support
| Platform | Auto-Install Location |
|---|---|
| macOS | ~/Library/Application Support/companion/modules/ |
| Windows | %APPDATA%\companion\modules\ |
Troubleshooting
Module Not Appearing in Companion
- Ensure Companion is installed before launching Cliqer
- Restart Companion after Cliqer's first launch to detect the newly installed module
- Check that Companion's modules directory exists and is writable
Connection Issues
- Verify that Cliqer is running on the configured host and port
- The default API port is 24601 — ensure it matches your Cliqer configuration
- Check that your firewall is not blocking local connections
See also: Stream Deck Integration · Timer