Test SolAR

We provide you a bundle to test our samples code. It’s just a .zip file including SolAR’s .so and executable binaries.

Table 1. Available Samples

Natural Image Marker


Fiducial Marker






Print the marker included in .zip file to use it during the test.

Install development environment

The SolAR framework uses a dedicated pipeline for linking and compiling code as well as internal tools for third party downloads that should make your job a lot easier. As you will see later, the SolAR framework is based on QMake originally created by the Qt Company, but compliant with most IDE.

Install your IDE

QT Creator

As SolAR is using QMake file to setup the projects, we highly recomment to install Qt Creator. Moreover, you will have access to wizards which will help you create new SolAR modules, components and pipelines.

Download the latest version of QTCreator on the following link: QT installer download

When downloaded, right clik on the Qt installer.run file, select properties, Permissions, and check Authorize execution of the file. Then, run your installer.

Create a Qt account if not already done, select where you want to install Qt.
You don’t need to install Qt SDK, just the Qt Creator. So just check the following components:

  • Qt x.x.x (last version proposed)

    • With Desktop gcc 64-bit

    • Android (if you want to build SolAR for Android)

  • Developer and Designer Tools

and start the installation.

Install dependencies

For downloading dependencies, the SolAR framework uses the meta dependencies management tool Remaken supporting Conan, VCPKG and its native C++ packaging structure based on pkg-config description files.

Install Remaken

  • Open a terminal and install curl, git, build-essential, pkg-config and cmake package: sudo apt-get install curl git build-essential pkg-config cmake -y

  • If Homebrew is not installed on your machine, you can use the following script to install it: Homebrew installer. Homebrew is used to install the last release of Remaken.

  • Log out and then log in to add brew eval modification to your ${HOME}/.profile

  • Use the following script to install and configure Remaken: Remaken installer. By default, Remaken installer will also install Conan which will be used afterwards. Try remaken --help, conan -h, and cmake -h commands in a terminal to check installation.

  • Create Qmake building rules in your ${HOME}./remaken/rules folder by running the following command:

remaken init

Use Remaken

Remaken uses a file called packagedependencies.txt to describe which depedencies to install, in which version, where to install them, and where to download them.

A global packagedepedencies.txt is available in the parent GIT repository SolAR, and can be downloaded on the following link: packagedependencies.txt

Copy this file where you want on your computer, open a terminal in the folder where you have copied the packagedependencies.txt file, and run remaken with the following command:

remaken install --cpp-std 17 -b gcc packagedependencies.txt

This command will install all SolAR dependencies in release mode in your ${HOME}/.remaken/packages folder. To download the dependencies in debug mode, run the following command:

remaken install --cpp-std 17 -b gcc -c debug packagedependencies.txt

This is done, all your dependencies are downloaded and ready to use !

Some of the module will download and build third parties using Conan which requires CMake (minimum version 3.10)

Build SolAR

Clone SolAR

SolAR is made up of a multitude of projects (SolAR Framework, SolAR pipeline manager, modules, samples, etc.). To help you, we have created a parent repository with sub-modules regrouping all source codes of SolAR. You can clone it from the following url: https://github.com/SolarFramework/SolAR.git

No space in the path of the folder where you are cloning SolAR !
git clone https://github.com/SolarFramework/SolAR.git

Do not forget to install and update recursively the submodules:

cd SolAR
git submodule update --init --recursive

If you want to move all submodules on Master, launch the following command

git submodule foreach git pull origin master

If you do not want to download all the source codes of SolAR, you can have a look to the different repositories available on Github on the Community/Git page.

Build on Qt Creator

Open the Qt project of your choice, for instance a sample. Check by clicking on the Projects tab, and then on the Manage Kits…​ button that your Qt x.x.x GCC 64 bit kit is well configured

In your project build settings of your kit, for each configuration (release and debug), add argument install_deps to the Builds Steps > Make step of your kit to copy compiled module output and its dependencies in ${HOME}/.remaken/packages (recommended for any SolAR module and applications such as samples and tests). If you just want to copy the compiled project without its dependencies, replace the make argument install_deps by install (recommended for the SolAR framework, the pipeline manager, the wrapper and any SolAR pipeline).
Add install argurment
Figure 1. Add install_deps argument

Just run qmake, and build your project.