Building from source code

PreviousDownloading and installing the software NextConnecting a drone to the software

Last updated 10 months ago

Building from source code

To ensure a smooth development experience, follow the steps below to set up your development environment:

3.1 Prerequisites:

Operating System: This project is compatible with Windows, macOS, and Linux.
IDE (Integrated Development Environment): We recommend using or as your IDE for C# development. Make sure to install the necessary extensions and plugins for a better development experience.
If you are using you should install plugin to be able working with axaml files using a preview.
If you are using you should install plugin to be able working with axaml files using a preview.

3.2 .NET Installation:

This project is built using , the latests version of the .NET platform. We recommend installing .NET 8.0 by following the instructions provided on the official .
```
# Check your current .NET version
dotnet --version
```

3.3 Version Control:

If you haven't already, install a version control system such as to track changes and collaborate with other developers.

3.4 Clone the Repository:

Clone the project repository to your local machine using the following command:
```
git clone https://github.com/asv-soft/asv-drones.git
```

3.5 Restore Dependencies:

Navigate to the platform project directory and restore the required dependencies. There is 3 possible platform directories to build and debug our app: Asv.Drones.Gui.Desktop, Asv.Drones.Gui.Android, Asv.Drones.Gui.iOS. For example we will use Asv.Drones.Gui.Desktop platform, so you have to execute the following command:
```
cd asv-drones/src/Asv.Drones.Gui.Desktop
dotnet workload restore
dotnet workload repair
```

3.6 Build and Run:

After restore you have to build the project to ensure that everything is set up correctly, and if it's not - try to restore workloads again:
```
dotnet build
```
Run the project:
```
dotnet run
```

Congratulations! Your development environment is now set up, and you are ready to start contributing to the project. If you encounter any issues during the setup process, refer to the project's documentation or reach out to the development team for assistance.

Building for Android

To build applications for Android, additional setup is required for JDK and Android SDK installation. Follow the instructions below based on your operating system.

Navigate to the platform project directory and restore the required dependencies:

cd asv-drones/src/Asv.Drones.Gui.Android
dotnet workload restore
dotnet workload repair

Windows

Install the .NET MAUI Check tool to verify your environment is ready for .NET MAUI development:
```
dotnet tool install -g Redth.Net.Maui.Check
maui-check
```
For Android SDK managing we recommend to install Android Studio.
Using Android Studio's SDK Manager, download Android 13.0 (Tiramisu) and API level 33. It's highly recommended to create an Android Virtual Device (AVD) with these settings, preferably with tablet configurations for better testing experience.

Build the project for Android:

dotnet build -t:Run -f net7.0-android /p:AndroidSdkDirectory=${AndroidSdkPath}

The ${AndroidSdkPath} should be replaced with the actual path to your Android SDK installation.

Linux

Install Android Studio to manage Android SDKs:
```
sudo snap install android-studio --classic
```
Install OpenJDK 11:
```
sudo apt install openjdk-11-jdk
```
Using Android Studio's SDK Manager, download Android 13.0 (Tiramisu) and API level 33. It's highly recommended to create an Android Virtual Device (AVD) with these settings, preferably with tablet configurations for better testing experience.

Build the project for Android:

dotnet build -f net7.0-android /p:AndroidSdkDirectory=${AndroidSdkPath}

The ${AndroidSdkPath} should be replaced with the actual path to your Android SDK installation.

macOS

Install Android Studio:
```
brew install --cask android-studio
```
Install JDK through Homebrew or any preferred method:
```
brew install openjdk
```
Using Android Studio's SDK Manager, download Android 13.0 (Tiramisu) and API level 33. It's highly recommended to create an Android Virtual Device (AVD) with these settings, preferably with tablet configurations for better testing experience.
Build the project for Android, specifying the Android SDK directory:
```
dotnet build -f net7.0-android /p:AndroidSdkDirectory=${AndroidSdkPath}
```

The ${AndroidSdkPath} should be replaced with the actual path to your Android SDK installation.

Additional Notes

If you want to run application after build you should start your previously created AVD and wait until it's startup processes are complete. Then you have to execute following command:
```
dotnet run -f net7.0-android /p:AndroidSdkDirectory=${AndroidSdkPath}
```
The ${AndroidSdkPath} should be replaced with the actual path to your Android SDK installation.

Windows environment setup example

Ubuntu environment setup example

macOS environment setup example

PreviousDownloading and installing the software NextConnecting a drone to the software

Last updated 10 months ago

To ensure a smooth development experience, follow the steps below to set up your development environment:

3.1 Prerequisites:

Operating System: This project is compatible with Windows, macOS, and Linux.
IDE (Integrated Development Environment): We recommend using or as your IDE for C# development. Make sure to install the necessary extensions and plugins for a better development experience.
If you are using you should install plugin to be able working with axaml files using a preview.
If you are using you should install plugin to be able working with axaml files using a preview.

3.2 .NET Installation:

This project is built using , the latests version of the .NET platform. We recommend installing .NET 8.0 by following the instructions provided on the official .
```
# Check your current .NET version
dotnet --version
```

3.3 Version Control:

If you haven't already, install a version control system such as to track changes and collaborate with other developers.

3.4 Clone the Repository:

Clone the project repository to your local machine using the following command:
```
git clone https://github.com/asv-soft/asv-drones.git
```

3.5 Restore Dependencies:

Navigate to the platform project directory and restore the required dependencies. There is 3 possible platform directories to build and debug our app: Asv.Drones.Gui.Desktop, Asv.Drones.Gui.Android, Asv.Drones.Gui.iOS. For example we will use Asv.Drones.Gui.Desktop platform, so you have to execute the following command:
```
cd asv-drones/src/Asv.Drones.Gui.Desktop
dotnet workload restore
dotnet workload repair
```

3.6 Build and Run:

After restore you have to build the project to ensure that everything is set up correctly, and if it's not - try to restore workloads again:
```
dotnet build
```
Run the project:
```
dotnet run
```

Building for Android

To build applications for Android, additional setup is required for JDK and Android SDK installation. Follow the instructions below based on your operating system.

Navigate to the platform project directory and restore the required dependencies:

cd asv-drones/src/Asv.Drones.Gui.Android
dotnet workload restore
dotnet workload repair

Windows

Install the .NET MAUI Check tool to verify your environment is ready for .NET MAUI development:
```
dotnet tool install -g Redth.Net.Maui.Check
maui-check
```
For Android SDK managing we recommend to install Android Studio.
Using Android Studio's SDK Manager, download Android 13.0 (Tiramisu) and API level 33. It's highly recommended to create an Android Virtual Device (AVD) with these settings, preferably with tablet configurations for better testing experience.

Build the project for Android:

dotnet build -t:Run -f net7.0-android /p:AndroidSdkDirectory=${AndroidSdkPath}

The ${AndroidSdkPath} should be replaced with the actual path to your Android SDK installation.

Linux

Install Android Studio to manage Android SDKs:
```
sudo snap install android-studio --classic
```
Install OpenJDK 11:
```
sudo apt install openjdk-11-jdk
```
Using Android Studio's SDK Manager, download Android 13.0 (Tiramisu) and API level 33. It's highly recommended to create an Android Virtual Device (AVD) with these settings, preferably with tablet configurations for better testing experience.

Build the project for Android:

dotnet build -f net7.0-android /p:AndroidSdkDirectory=${AndroidSdkPath}

The ${AndroidSdkPath} should be replaced with the actual path to your Android SDK installation.

macOS

Install Android Studio:
```
brew install --cask android-studio
```
Install JDK through Homebrew or any preferred method:
```
brew install openjdk
```
Using Android Studio's SDK Manager, download Android 13.0 (Tiramisu) and API level 33. It's highly recommended to create an Android Virtual Device (AVD) with these settings, preferably with tablet configurations for better testing experience.
Build the project for Android, specifying the Android SDK directory:
```
dotnet build -f net7.0-android /p:AndroidSdkDirectory=${AndroidSdkPath}
```

The ${AndroidSdkPath} should be replaced with the actual path to your Android SDK installation.

Additional Notes

If you want to run application after build you should start your previously created AVD and wait until it's startup processes are complete. Then you have to execute following command:
```
dotnet run -f net7.0-android /p:AndroidSdkDirectory=${AndroidSdkPath}
```
The ${AndroidSdkPath} should be replaced with the actual path to your Android SDK installation.