Skip to content

Freedeck/app

Repository files navigation

Freedeck App

NOT TO BE CONFUSED WITH THE ACTUAL FREEDECK APP

This is the all-in-one solution to installing and using Freedeck.

This app is an installer AND launcher all together! It will also eventually BE Handoff.

Made with Avalonia and .NET 8.0.

Screenshots

These may not be up-to-date as the UI continues to evolve.

Installation: Setup

Setup tab Setup tab, installing

Launch Tab

Launch tab Launch tab with Companion or Server Only showing

Settings Tab

Settings tab Settings tab, showing Companion settings

Handoff Plugin Download Request

Download request

Features

  • Simple user interface using Avalonia
  • Installs Freedeck
  • Handles the freedeck:// URL protocol
  • Can migrate from old launcher
  • Actually can handle other installation directories
  • Autoupdater is more refined
  • As a plus, the code is also so much better

Handoff - URL Protocol

You may see the original specs here, but they are totally different now.

The launcher must be at least running for these to work (right now). This will be changed later.
Any request looks like this:
freedeck://ACTION/Argument1/Argument2

Handoff: Downloading Plugins

To download any plugin using the App, you must specify:

  • the download command
  • the plugin ID
  • the plugin URL (URL encoded, ex: " " turns into "%20")
  • the plugin description
  • the repository's title

This is very easy to do, here's the scheme: freedeck://download/ID/URL/Description/RepositoryTitle

An example, using TextBG freedeck://download/TextBG/https%3A%2F%2Fcontent-dl.freedeck.app%2Fhosted%2FTextBG.Freedeck/Show%20any%20text%20on%20your%20Freedeck./freedeck.app

Handoff: Updating plugins

Updating uses the same idea as downloading them, except instead of download as the command, it's update.

An example, using TextBG freedeck://update/TextBG/https%3A%2F%2Fcontent-dl.freedeck.app%2Fhosted%2FTextBG.Freedeck/Show%20any%20text%20on%20your%20Freedeck./freedeck.app

Using

When the App becomes stable, it'll be what you download from freedeck.app. For now, it'll be only on GitHub releases.

Arguments

--protocol-register-admin - Registers the freedeck: protocol as an admin. This is not required, but you do need admin to run this action.

Building

To make a release-ready build, just run dotnet publish in your console. Or, if you like the GUI way (JetBrains Rider only), right click on the project, click Publish then "Freedeck New Release".

About

The Freedeck App is the all-in-one solution to installing and using Freedeck.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages