Extension

From FreeCAD Documentation
Revision as of 13:03, 12 June 2022 by David69 (talk | contribs) (Created page with "=== Ateliers en C++ ===")

Introduction

Dans FreeCAD et dans cette documentation, un addon est un composant qui ne fait pas partie de l'installation de base mais peut être ajouté au système par certaines méthodes.

Différents types

Il existe environ trois types d'extensions:

  • Macros: petit bout de code en Python qui fournit un nouvel outil ou une nouvelle fonctionnalité dans un seul fichier se terminant par .FCMacro.
  • Ateliers: collections de fichiers Python qui fournissent des Gui Commands (outils) centrés autour d'un sujet particulier, par exemple, des outils pour concevoir des armoires ou des outils pour travailler avec l'architecture, ou des outils pour concevoir des bateaux, etc. Ces ateliers définissent généralement de nouvelles barres d'outils où des commandes sont placées sous forme de boutons.
  • Kits de préférence : kits de préférences d'utilisateurs. introduit dans la version 0.20

Installation

La méthode recommandée pour installer des addons est d'utiliser le Gestionnaire d'Addon.

Mais pour les macros et les ateliers, une installation manuelle est également possible :

Informations pour les développeurs

Si vous avez développé une macro ou un atelier, et que vous souhaitez qu'il soit inclus dans le gestionnaire d'addons, lisez comment faire sur les pages : (FreeCAD-addons et FreeCAD-macros). Si vous ajoutez votre macro à la page Liste des macros, il n'y a rien d'autre à faire, elle sera automatiquement récupérée par le gestionnaire d'addons.

Ateliers en Python

Pour les ateliers en Python, vous n'avez pas besoin d'une approbation spécifique pour que votre atelier soit ajouté au gestionnaire d'addons. De plus, comme votre addon ne fait pas partie du code source de FreeCAD, vous pouvez choisir la licence qui vous convient. Si vous demandez que votre atelier soit ajouté à la liste par défaut du gestionnaire d'addons (nous n'ajouterons aucun nouvel atelier sans une demande de ses auteurs), soit en le demandant sur le forum, soit en ouvrant un problème sur le dépôt FreeCAD-addons, votre code restera sur votre propre dépôt git, nous l'ajouterons simplement comme un sous-module au dépôt FreeCAD-addons. Bien sûr, avant d'ajouter votre atelier, nous y jetterons un coup d'œil et nous nous assurerons qu'il n'y a rien de potentiellement problématique. Pour plus de détails sur la structuration de votre addon, y compris des informations sur les métadonnées utilisées par le gestionnaire d'addons, voir Création d'atelier.

Ateliers en C++

If you develop a workbench in C++, it cannot be run directly by users and must be compiled first. You then have two options, either you provide precompiled versions of your workbench yourself, for the different operating systems, or you should request to have your code merged into the FreeCAD source code. For that, you should use the LGPL license (or a fully compatible license like MIT or BSD), and you must present your new tools to the community in the FreeCAD forum for review. Once your code has been tested and approved, you should fork the FreeCAD repository, if not done yet, create a new branch, push your code to it, and open a pull request so that your branch is merged into the main repository.