Running from source

This page assumes that you are familiar with C#/.NET development.

Download and install Git. This is currently required to provide detailed versioning data for telemetry.

Download and extract the latest source code (or fork and clone if you're comfortable with using Git). Set Eddi as the starting project. This will build and run just fine, except that to optionally use Frontier's Companion API ("cAPI") you will need to take some additional steps.

It is perfectly fine to omit the following steps and do without the cAPI.

To use the cAPI you will need to visit the Frontier authentication website, login with your Frontier credentials and register a "Developer App". It is important that you provide a unique app name (so not "EDDI") and homepage (so not "https://github.com/EDCD/EDDI/"). The scope you want is "auth capi".

Please carefully read the Terms & Conditions because you are entering into a binding legal agreement that includes strict restrictions about disclosure of your API Credentials. This is why we cannot publish the API Credentials that we were given for the main release of EDDI.

Now that you have your client ID and secret, you will need to record them under strong encryption. I use 1Password but many other options are available. Only the client ID is needed for the PKCE authentication protocol.

From the top level, do git update-index --skip-worktree CompanionAppService/ClientId.cs to ensure that you don't accidentally commit future changes. Now replace the null in that file with the client ID you were given as a string literal.

You should now be all set.