Installing Companion is super simple and should only take a few minutes! To start of, download the latest release or build from source (tutorial coming soon).

Windows

Extract the files inside \build\windows\Runner\release. In this folder you can see a file named Companion.msix, you should run this if you wish to install Companion on you PC, please check Installing with MSIX for instructions. Alternatively, you can just run Companion.exe to use Companion without having to install anything.

Installing with MSIX (Recommended)

Unfortunately, it isn't as easy as opening the file and installing it as we do not have a signed certificate (yet).

To install Companion, first right-click and click on Properties.

Then, navigate to Digital Signatures. You will see only one signature called Msix Testing, you will need to add this to the windows key-store. To do this, please double-click on the signature and click on View Certificate. Next, click on Install Certificate and then on Local System. Finally you'll need to select they key-store called Trusted Root Certification Authorities under Browse.

After completing those steps you should now be able to install Companion using the MSIX package.

Using the portable version

If you don't wish to install an untrusted certificate you can also simply save Comapnion.exe and all of the other files wherever you want and then create a desktop shortcut. Please note that the auto-update feature will not work!

MacOS

Extract the files inside \build\macos\Build\Products\Release. In this folder you can see two files named Companion.dmg, you should run this if you wish to install Companion on you Mac, please check Installing with DMG for instructions. Alternatively, you can just run Companion to use Companion without having to install anything.

Installing with DMG (Recommended)

To install Companion in your Mac simply open Companion.dmg and drag the Companion app to the Applications folder next to it. If you are updating the app you'll need to click Replace.

After doing this you should be able to see Companion in your Laucnhapd. However, if you try to open it you might get a message saying that "Companion" can't be opened because Apple cannot check it for malicious software. In order to fix this open System Preferences and click on Security and Privacy, where you'll see a message saying "Companion" was blocked from use because it is not from an identified developer, in order to complete the installation you will need to click Open Anyway and then Open in the popup.

Done! You should now be able to use companion normally!

Using the portable version

To use the portable version of Companion in your Mac simply locate Companion and drag the it wherever you want to store the app.

After doing this you should be able to open Companion. However, if you try to open it you might get a message saying that "Companion" can't be opened because Apple cannot check it for malicious software. In order to fix this open System Preferences and click on Security and Privacy, where you'll see a message saying "Companion" was blocked from use because it is not from an identified developer, in order to complete the installation you will need to click Open Anyway and then Open in the popup.

Linux

Coming soon!