Skip to content

quickstart.mdx

Latest commit

 

History

History
82 lines (66 loc) · 2.68 KB

quickstart.mdx

File metadata and controls

82 lines (66 loc) · 2.68 KB
title Quickstart
description Start using Freedeck in minutes.
icon rocket

Getting the App

Freedeck is built on [Node.js](https://nodejs.org/en) and [Git](https://git-scm.com/downloads). You need to download and install them to your computer before using Freedeck. To actually use Freedeck, you need the App. [You can download the latest version by clicking here.](https://github.com/Freedeck/app/releases/latest/download/Freedeck.exe) Run the app\! Double click it from your downloads folder or wherever it is. 
<Warning>
  Windows may give you a SmartScreen popup. _This is because Freedeck is not signed, as that costs money._
</Warning>

Here's full clarification on what certain terms mean.

```text App 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.

Installing Freedeck

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

![installer.png](/images/installer.png) From here, you can press Install. Now that you have Freedeck installed, press Launch Freedeck\! ![installed.png](/images/installed.png)

Next steps

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](https://github.com/Freedeck) or join our [Discord](https://discord.gg/7gWrgyt7Aa).