Erweiterung

From FreeCAD Documentation
Revision as of 11:00, 12 June 2022 by FuzzyBot (talk | contribs) (Updating to match new version of source page)

Einführung

In FreeCAD und dieser Dokumentation ist eine Erweiterung eine beliebige Komponente, die nicht Teil der Basisinstallation ist, die aber dem System durch bestimmte Methoden hinzugefügt werden kann.

Verschiedene Typen

Es gibt zwei Arten von Erweiterungen:

  • Makros: kurze Schnipsel von Python Code, der ein neues Werkzeug oder eine neue Funktionalität in einer einzigen Datei mit der Endung .FCMacro bereitstellt.
  • Modul: eine einzelne Python Quelldatei oder eine Sammlung von Python Dateien, die die Software in irgendeiner Weise erweitert. Module definieren nicht notwendigerweise einen grafischen "Arbeitsbereich", können aber eine unterstützende Funktion bieten, z.B. eine Bibliothek, die die Konvertierung von Formaten durchführt, oder Code, der die grafische Oberfläche modifiziert.
  • Arbeitsbereiche: Sammlungen von Python Dateien, die verwandte Gui Befehle (Werkzeuge), die sich auf ein bestimmtes Thema konzentrieren, z.B. Werkzeuge für den Entwurf von Schränken oder Werkzeuge für die Arbeit mit Architektur oder Werkzeuge für den Entwurf von Booten usw. Diese Arbeitsbereiche definieren normalerweise neue Werkzeugleisten, in denen Befehle als Schaltflächen platziert werden.

Installation

Beginnend mit FreeCAD 0.17 ist der empfohlene Weg zur Installation von Erweiterungen mit dem Erweiterungsverwalter.

Trotzdem ist manuelle Installation weiterhin möglich.

Information for developers

If you have developed a macro or workbench, and want to see it included in the Addon manager, read how to do so on the repository pages: (FreeCAD-addons and FreeCAD-macros). If you add your macro to the Macros recipes page, there is nothing else to do, it will automatically be picked up by the Addon manager.

Python workbenches

For Python workbenches, you don't need any specific approval to have your workbench added to the Addon Manager. In addition, because your Addon is outside the FreeCAD source code, you can choose the license you want. If you request for your workbench to be added to the Addon Manager's default list (we will not add any new workbench without a request from its authors), either by asking so on the forum or by opening an issue on the FreeCAD-addons repository, your code will stay on your own git repository, we will just add it as a submodule to the FreeCAD-addons repository. Of course, before adding your workbench, we will take a look at it and make sure there is nothing potentially problematic with it. For more details about structuring your Addon, including information about metadata used by the Addon Manager, see Workbench creation.

C++ workbenches

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.