Quickstart

Getting the App

Step 1: Install Node.js and Git

Freedeck is built on Node.js and Git. You need to download and install them to your computer before using Freedeck.

Step 2: Download the App

Step 3: Run the App

Run the app! Double click it from your downloads folder or wherever it is.

Windows may give you a SmartScreen popup. This is because Freedeck is not signed, as that costs money.

Here’s full clarification on what certain terms mean.

The "App" is the native Windows app that allows for system control and auto updates.

The "Companion" is the desktop application that opens on your computer that lets you edit the configuration.

The "Server" is the underlying data processor that handles the tile database

The "Client" is your phone, or any other connected device that is just a viewer/interactor of the tiles.

Now we’ll finally install the Freedeck application in its entirety. From here, names become less ambiguous.

Step 3: Install Freedeck

From here, you can press Install.

Step 4: Launch Freedeck

Now that you have Freedeck installed, press Launch Freedeck!

You’re now ready to use Freedeck and explore the interface to discover what it has to offer!

Learn about how you can add OBS, WaveLink, MyInstants, or just about anything to Freedeck!

Personalize your Freedeck by picking any theme you like!

Download community-created plugins and themes!

Check out the Freedeck HTTP API!

Need help? Make a GitHub issue or join our Discord.