Stream Deck: control the scoreboard by button

Control your LemonScore scoreboard directly from an Elgato Stream Deck. Plugin installation, API key setup and an overview of all available actions.

With the Stream Deck plugin you control your scoreboard directly from the keys of your Elgato Stream Deck, without a mouse and without a browser window. Change the score, start the match clock, trigger animations: all at the press of a key.

💡

The Stream Deck plugin communicates via the LemonScore API (port 4001). You need an API key, which you create in Settings.

Requirements

  • Elgato Stream Deck with the Stream Deck software (version 7.0 or newer)
  • LemonScore desktop app on the same computer or in the same network
  • macOS 13+ or Windows 10+

Installing the plugin

  1. Download the LemonScore Stream Deck plugin.
  2. Double-click the installation file; the Stream Deck software installs the plugin automatically.
  3. After installation, the LemonScore category appears in the action list of the Stream Deck software.

Setting up the API key

The plugin needs an API key to connect to LemonScore.

  1. Open Settings in LemonScore.
  2. Go to the Connections tab.
  3. Enable the Enable API switch.
  4. Click Create API key and give it a name (e.g. "Stream Deck").
  5. Copy the generated key (it starts with lsk_).
⚠️

Copy the API key immediately after creating it. It will not be shown again afterwards.

  1. In LemonScore, click Connect to Stream Deck. The connection details (host, port, API key) are transferred to the plugin automatically.

If the automatic connection does not work, enter the host, port (4001) and API key manually in the plugin's global settings.

Available actions

The plugin provides 11 actions that you can place freely on your Stream Deck.

Score

Changes a team's score. In the key settings you choose:

  • Operation: Increase, decrease or reset
  • Team: Team 1 or Team 2

The key shows the current score and the team name directly.

Clock Start/Stop

Starts or stops the match clock with a single key press. The key switches automatically between the "Running" and "Stopped" states.

Blackout

Switches the screen blackout on or off. Useful for breaks or before kick-off. The key status updates automatically.

Play Animation

Triggers a specific animation (e.g. goal, yellow card, red card). You choose the desired animation in the key settings.

Penalty

Controls the penalty shoot-out. In the key settings you configure the action:

  • Start: Start the penalty shoot-out (with a choice of which team shoots first)
  • Stop: End the penalty shoot-out
  • Result: Record a goal, miss or save

Playlist

Starts or stops a playlist. Optionally, select a specific playlist in the settings. The key shows the current playback status.

Shows or hides the advertising banner. The key switches between "Visible" and "Hidden".

Music

Starts or stops music playback. The current status is shown directly on the key.

Volume (dial)

Exclusively for Stream Deck models with an encoder (e.g. Stream Deck+). Turn the dial to adjust the volume. Pressing it mutes the music.

Custom Shortcut

Runs a shortcut configured in LemonScore. In the key settings, select the desired shortcut card and slot.

Status display

All toggle actions (Clock, Blackout, Banner, Playlist, Music) show the current state directly on the key. The plugin synchronises the status automatically with LemonScore, even when you make changes via the desktop app or the Remote Control.

Troubleshooting

  • Keys show "--": The plugin is not connected to LemonScore. Check that LemonScore is running and the API is enabled.
  • Connection fails: Make sure the host and port are correct (default: localhost:4001). Test the connection by opening http://<host>:4001/api/v1/health in your browser.
  • API key invalid: If you have revoked a key in LemonScore, create a new one and enter it in the plugin.
  • Firewall: For network operation, port 4001 must be open for incoming connections in the firewall of the LemonScore computer.

Tips and notes

  • Create a profile: Set up a dedicated Stream Deck profile for LemonScore and arrange the actions to suit the way you work.
  • Multi-actions: Combine several LemonScore actions in one Stream Deck multi-action, e.g. "Goal Team 1" (increase score + play goal animation).
  • Multiple keys: You can place the same action several times, e.g. one score key per team.
  • Network operation: The plugin also works over the network. Enter the IP address of the LemonScore computer as the host.
⚠️

If you revoke an API key in LemonScore, the Stream Deck plugin loses its connection immediately. In that case, create a new key and connect again.