Getting Started

UP Deck is comprised of three components in order to do its thing:

  • Mobile App

  • UP Deck Server

  • OBS Lua script

Mobile App

The mobile app is the preferred interface for working with your deck. Android and iOS versions are available on their respective stores.

UP Deck server

UP Deck Server is a lua application written on top of the love2d engine, this allows the server to be portable to Windows, macOS and Linux

Note

A GPU Driver Capable of OpenGL ES 2.0 is required

Windows and macOS

For Windows and macOS, simply download the desktop app and use the installer to set up both the server and install love2d if it’s not already.

Linux

For Linux download the desktop app and use your distribution’s installer to install a version of love2d:

# apt-get install love

You can launch the app via the CLI:

$ love UPDeck_xxx.love

OBS Lua script

You can Download the OBS lua script and save it just about anywhere. To install it simply Launch OBS and go to Tools ‣ Scripts and use the ( + ) to add the script.

Warning

Set the message path. OBS will not respond with out it.

Note

Some times the script is not copied or configured when creating a new Scene Collection in OBS, this appears to be an OBS bug, check your message path is still configured after creating a new Scene Collection.

The only important attribute here is the Message Path it needs to be set to the folder that the UP Deck server is running from.

Note

On Linux you may see libobs.so: cannot open shared object file: No such file or directory, you will need to link libobs.so and libobs.so.1 (or libobs.so.1) in this case

Message Path

The message path is used by both OBS and the UP Deck Server to communicate with each other using files at this path. The path on the server side can not be modified.

You can quickly find the path by double clicking on the UP Deck Server body while its running and save the Settings page, this will copy the path to your clipboard.

If you still can’t find the message path it will vary depending on your operating system

Known Problems:

  • It’s been reported that paths that contain extended characters may not work, this is likely due to the version of lua built into OBS as it may not support characters beyond the standard ascii table.

  • If you run OBS as an administrator on Windows, you may find it necessary to run UP Deck as an administrator as well. (UP Deck generally does not need to be run as Administrator)

Windows

Open the windows menu and type in:

%appdata%\UPDeck\

Then copy and paste the resolved path from explorer into the Message Path (it should look like C:\Users\YOURUSERNAME\AppData\Roaming\UPDeck)

macOS

On macOS you can type into a shell:

open "~/Library/Application Support/LOVE/UPDeck/"

And copy and paste the resolved path from finder (it should look like /Users/user/Library/Application Support/LOVE/UPDeck/)

Linux

On linux you can echo the resolved path:

$ echo "${HOME}/.local/share/love/UPDeck"

Then copy and paste the resolved path into the Message Path (it should look like /home/username/.local/share/love/UPDeck)

More Reading

You can read more on the Up Deck website for info around getting familiar with the Apps: