Install Companion on a Mac

Companion also runs on Windows and Pi. This article will focus on a Mac installation.

Running Companion is one of those “easy when you know how” things. This article will show you how. Easy!

 

1. COMPANION (2.2.0 – beta build)

  • Download Companion:

    • Companion 2.2.0. While 2.2.0 is still pre-release, it’s generally pretty stable and you can grab the latest build available. That said, make sure you thoroughly test your setup before implementing in a live production. The current version the DJF profile has been tested with is 2.2.0 build 3399.
  • Open Companion

    • If running for the first time, right click the Companion app and select “Open”.
    • You’ll receive a notification that the developer is unknown. Cancel this.
    • Right-click “Open” a second time, and now you can open the app.
    • Companion’s Web Server icon will be in the top-right menu bar. Click it to open the tray.
    • Check the server is running locally on 127.0.0.1 (easiest setup).
  • Install the DJF Companion Profile

    • Launch GUI in a web browser. Navigate tabs to Buttons > Import/Export.
    • If you already have your own Companion setup, click “Export” to save a backup of your profile.
    • Select Import. Choose the DJF Companion Profile (ends with “.companionconfig”)
    • Select “Replace current configuration”. Note that this will wipe all existing Companion pages, so make sure you’ve backed up any essential work first.
  • Set ATEM Module’s Target IP Address

    • Under the Connections tab, click “Edit” for the “atem Blackmagic Design” module. Update the Target IP to the IP address for your ATEM Mini/Pro/ISO.
      • **Note: you can find the ATEM IP using BlackMagic’s “ATEM Setup Software”. Setting a static IP address is recommended.
    • All other modules (VLC, H2R, VICREO, OSC) are pre-set to local 127.0.0.1 and don’t need to be changed.
  • Set the Home Page

    • Under the Surfaces tab, click the green “Settings” button for the “Elgato Streamdeck Plugin” (or the actual Stream Deck serial number, if running Companion solo).
    • Slide the Page number for your specific profile:
      • 32-button Profile’s Home Page uses PAGE 1
      • 15-button Profile’s Home Page uses PAGE 31
      • Vertical Profile for Stream Deck Mobile app uses PAGE 71
  • Troubleshooting:

    • If the profile is not showing up on your Stream Deck, go to Companion’s “Surfaces” tab, and click “Rescan USB”
    • If you’d like to run this without an actual Stream Deck (on a computer or tablet) , click on “Emulator” in the top left corner.
    • If there’s a conflict while running Elgato Stream Deck’s native software simultaneously, quit both applications, then try opening Elgato’s Stream Deck software first, then starting the Companion server secondly. Make sure you have installed the Companion Plugin within the native Elgato Stream Deck app.
    • **Note: The DJF Companion Profiles require running Companion 2.2.0 to support the most up-to-date features and modules. Some functions will be missing if you try to operate the profile using Companion 2.1.3.
Read More