Générer

DataMorph fonctionne beaucoup avec CMake, donc tous les développeurs de plugin en auront forcément besoin.

Ce processus devrait fonctionner sur les platformes Windows, MacOS et Linux.

Configuration

La configuration se fait sur le terminal à l’aide de la commande :

cmake build --preset <config>

Notez que plusieurs types de pré-configuration peuvent être utilisés. On compte :

x64-release (le plus conseillé)
x64-debug
x86-release
x86-debug

Ainsi, les fichiers de génération CMake devraient être créés et un nouveau dossier “build” devrait apparaître dans le dossier de travail actuel du code.

Compilation

La compilation se fait sur le terminal à l’aide de la commande :

cmake --build build --preset <config>

Où <config> correspond à la pré-configuration choisie précédemment.

Installer le plugin

Maintenant que le plugin a été installé, vous pouvez chosir de déplacer les fichiers nécessaires vous-mêmes ou alors installer le plugin directement au niveau de l’exécutable avec CMake.

Installer avec CMake (conseillé)

Si le logiciel DataMorph est déjà installé, vous pouvez spécifier sa location dans la commande add_datamorph_plugin en spécifiant l’argument DATAMORPH_DIR. Si le dossier n’existe pas, ou que l’exécutable n’est pas présent dans ce dossier, alors CMake émettra un avertissement et ne génèrera pas la cible “install”. Assurez-vous que les fichiers CMake soient regénérés. Vous pouvez maintenant utiliser cette commande :

cmake --build build --target install

Si le plugin a été compilé avec succès, alors le plugin s’installera directement dans le dossier <DataMorph>/plugins et devrait fonctionner.

Installer manuellement

Cette étape n’est pas conseillée, et elle ne devrait pas être utilisée sauf en cas de problèmes de fonctionnement avec la commande “install” de CMake. Pour cela, vous devrez copier les fichiers suivants qui se trouvent dans <source>/build/<config> où <config> est la pré-configuration choisie précedemment :

plugin.yml : le fichier indiquant au logiciel des informations-clés, telles que le nom, la description, etc…
<plugin>.dmplug : le fichier nécessaire au fonctionnement-même du plugin.
Toutes les ressources utilisées, que ce soit les images, des fichiers de configuration ou autres.

Ensuite, accéder à l’emplacement de l’exécutable DataMorph, puis aller dans le dossier “plugins”. Une fois dedans, créer un dossier avec n’importe quel nom (garder le nom du plugin spécifié dans plugin.yml est conseillé) puis y coller tous les fichiers précédemment copiés.

Premiers pas