Installation Instructions (on a Mac)

** UPDATED MARCH 21, 2023 **

1. COMPANION (2.4.2)

Install the DJF Companion Profile

• • Navigate tabs to Buttons > Import/Export.
  • If you already have your own custom Companion setup, click “Export” to save a backup of your profile first!

• Replace Current Configuration (recommended)
  • Select Import. Choose the DJF Companion Profile file (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!

• Individual page import (not recommended)
  • Note that the DJF Companion Profile pages are heavily inter-connected, hence it is recommended to “replace current configuration”. While you can copy and paste buttons quite easily after the initial “replace current configuration”, importing individual pages will require manually updating the Page-jump actions, plus you must be careful to target the correct instance label of a module when importing.
  • If you still wish to import individual pages, note that there are also several “backend” service pages need to be imported to very specific pages to maintain integrity:

• • • • Backend service pages for v3.1:
        • Extreme………..Pages 55, 56, 57, 58
        • Pro………………Pages 83, 84
        • PTZ……………..Pages 86, 87
      • Backend service pages for v2.5:
        • Pro………………Pages 22, 23

• • Once those backend pages have been imported to their specific page numbers, you can import individual pages to any other Companion page.
    • If dealing with a dual profile that contains both ATEM Extreme and ATEM Pro, make sure you target the correct instance (i.e. “ext-atem” and “pro-atem” are completely different implementations of the same ATEM Module).
    • Note that any Menu or Page-jump buttons will need to have their action “Set surface with s/n to…” updated manually.
  • For example, if you wanted to import the Extreme’s VLC page:
    • Import DJF Companion Profile Pages 55, 56, 57, 58 to their respective Pages, 55, 56, 57, 58 in your Companion profile.
    • Import the Extreme VLC (Page 30) to whatever blank page you have available in your configuration.
    • Update the Page-jump button actions (ie VLC Page’s Button #1) to target your configuration layout.

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, and for your ATEM Mini Extreme/ISO if running dual systems.
    • **Note: it is recommended to keep the connection labels the way they are (i.e. “ext-atem” and “pro-atem” etc.) Changing the connection label names will update most – but not all – variable names, and will leave some button text (i.e. the BLK button) unable to find the new name.
    • **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’s HOME PAGE: 

• • • • • DJF PROFILE v3.1
          • 32-button Extreme…………………..PAGE 1
          • 32-button Pro…………………………PAGE 66
          • PTZ……………………………………..PAGE 88
          • Vertical Pro…………………………….PAGE 96
          • Vertical Extreme……………………..PAGE 98

• • • • • DJF PROFILE v2.5
          • 32-button Pro…………………………PAGE 1
          • 15-button Pro…………………………PAGE 31
          • Vertical Pro…………………………….PAGE 71

Make Changes to Companion’s Settings

• • “Remove the Topbar on all buttons”:
    • Go to Companion > Settings > Navigation Buttons > “Remove the topbar on each button” > SELECT “Enabled”.
    • **Note that the PNGs and text layout on the DJF Companion Profile buttons have been designed for the full 72 x 72px.m The buttons will look squished unless you remove the topbar.
  • “Enable OSC”:
    • Go to Companion > Settings > OSC > SELECT “Enabled”.
    • Set the OSC Listen Port to “12321”.

Troubleshooting:

• • If your Stream Deck is plugged in but the Companion buttons are not showing up, go to Companion’s “Surfaces” tab, and click “Rescan USB”
  • If you’d like to run this without a the actual Stream Deck hardware (i.e. use it on a computer or tablet instead), click on “Emulator” in the top left corner. Locally, the address will be http://127.0.0.1:8000/emulator
  • If there’s a conflict while running Elgato Stream Deck’s native software simultaneously with Companion, quit both applications.
    • Then try opening Elgato’s Stream Deck software first;
    • then starting the Companion server secondly.
      • (Make sure the Companion Plugin within the native Elgato Stream Deck app has been installed – see “Stream Deck” installation instructions below).