Visualisation for MARSH

Named in this order so not everything starts with the same word

Development

This repository uses Git Submodules, to get all the code you need to run either:

git clone --recurse-submodules <address of this repository>
# Or at any later point
git submodule update --init --recursive

Using Godot v4.4 beta3 (expect it to change often until 4.4 is released) Install SCons with pipx install scons. You will need a C++ compiler, you might have one already on Linux, see below for Windows, otherwise in Godot documentation.

For updating MAVLink generator, you additionally pip install future. It is recommended to install any packages in a virtual environment, for example:

python3 -m venv venv
source venv/bin/activate
pip install future

Some files are generated, run the following commands on first setup and when dependencies change:

godot --dump-extension-api  # after updating Godot
python update_mavlink.py    # after updating MAVLink dialect
python update_addons.py     # after changing any addon submodules
scons compile_commands      # after modifying SConstruct

Windows setup

The most convenient way of getting a C++ compiler is via the LLVM-MinGW project (by the way, it optimizes the binary more). Download the llvm-mingw-...-msvcrt-x86_64.zip from the Releases page. Unzip the archive to some location you like, and add its bin folder to Path using the "Edit environment variables for your account" program.

Build

To build the GDExtension binary run SCons in the repository root, the default arguments have been added to the file.

scons

When building for Windows with MinGW-LLVM, you need to select this compiler:

scons platform=windows use_mingw=yes use_llvm=yes