Skip to content

nicollasricas/unity-deck

Repository files navigation

Stream Deck for Unity

Enables Stream Deck integration within Unity.

It should work with any Unity version as long it targets .NET 4.0+.

GitHub Workflow Status GitHub release (latest by date) GitHub license

Getting Started

  1. Download the plugin for Stream Deck on the Stream Deck Store or here.

  2. Download the unity package here and import in any Unity project you wish to use it.

If you have downloaded the plugin and imported the package into your project, you should see this message:

Stream Deck Connected

Features

  • Add components to objects
  • Execute menus
  • Paste components
  • Pause/resume play mode
  • Reset and rotate objects
  • Select objects by name or tag
  • Switch between scene and game view
  • Toggle objects states

Settings

To open the package settings go to the menu: Tools > Stream Deck.

Settings

Execute Menu

To execute a menu, you have to write the full path, spaces included. Submenus use a slash (/) as a divider.

Window/Layouts/4 Split

4 Split Layout Menu

4 Split Layout Action

FAQ

  • The live link is not connecting

    Make sure you have installed the Stream Deck Plugin, imported the Unity Package into your project, the port you are using are available and the stream deck software is open. If you have to change the port don't forget to change it on the Unity Editor.

  • The default port is been used by another software

    You can change the port on the Settings menu, don't forget to change it on the Stream Deck Plugin.

  • Will this plugin be built into the compiled project??

    No, the plugin is tagged as editor only so it will only work on the unity editor.

  • I'm getting an Multiple precompiled assemblies with the same name websocket-sharp.dll included or the current platform error

    This plugin requires the Websocket-sharp library and if you are getting this error, it means that another package in your project is using it. In this case, I recommend that you remove the one from this package (Plugins/StreamDeck/Editor/websocket-sharp.dll) since it's tagged as editor only and if your build depends on it better let the other win the conflict.