Addon/en: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
Line 7: Line 7:
== Different types ==
== Different types ==


There are roughly three types of addons:
There are three types of addons:
* [[Macros|Macro]]: short snippet of [[Python|Python]] code that provides a new tool or functionality in a single file ending with {{incode|.FCMacro}}.
* [[Macros|Macros]]: short snippet of [[Python|Python]] code that provides a new tool or functionality in a single file ending with {{incode|.FCMacro}}.
* [[External_workbenches|Workbenches]]: collections of Python files that provide related [[Gui_Command|Gui Commands]] (tools) centered around a particular topic, for example, tools to design cabinets, or tools to work with architecture, or tools to design boats, etc. These workbenches usually define new toolbars where [[Gui_Command|commands]] are placed as buttons.
* Module: a single Python source file, or a collection of Python files, that extends the software in some way. Modules don't necessarily define a graphical "workbench" but may provide a supporting feature, for example, a library that performs conversion of formats, or code that modifies the graphical [[interface|interface]].
* [[Preference_Packs|Preference Packs]]: distributable collections of user preference. {{Version|0.20}}
* [[External_workbenches|Workbench]]: collections of Python files that provide related [[Gui_Command|Gui Commands]] (tools) centered around a particular topic, for example, tools to design cabinets, or tools to work with architecture, or tools to design boats, etc. These workbenches usually define new toolbars where [[Gui_Command|commands]] are placed as buttons.

Macros as installed under the user's {{incode|Macro/}} directory, while modules and workbenches are under the {{incode|Mod/}} directory.
{{Code|lang=bash|code=
$HOME/.FreeCAD/Macro/
$HOME/.FreeCAD/Mod/
}}

Macros usually start as a way to simplify or automate the task of drawing or editing a particular object. If many of these macros are collected inside a directory, and structure is provided to collect those tools, then the entire directory may be distributed as a workbench.

In other words, macros, modules, and workbenches are essentially the same thing, pieces of Python code that extend the base installation. Macros are usually short and focused on a single task, modules usually provide new functions or interfaces, and workbenches are collections of tools (buttons, menus) and graphical interfaces to perform related tasks.

If a workbench is sufficiently developed and is well documented, it may be included as one of the base [[workbenches|workbenches]] in FreeCAD.


== Installation ==
== Installation ==


Starting from FreeCAD 0.17, the recommended way to install addons is with the [[File:Std_AddonMgr.svg|24px]] [[Std_AddonMgr|Addon Manager]].
The recommended way to install addons is with the [[File:Std_AddonMgr.svg|24px]] [[Std_AddonMgr|Addon Manager]].


However, manual installation is still possible.
But for macros and workbenches manual installation is also possible:
* [[How_to_install_macros|How to install macros]]
* [[How_to_install_macros|How to install macros]]
* [[Installing_more_workbenches|Installing more workbenches]]
* [[Installing_more_workbenches|Installing more workbenches]]



{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}

Revision as of 08:50, 12 June 2022

Introduction

In FreeCAD and in this documentation, an addon is any component that is not part of the base installation, but that can be added to the system by certain methods.

Different types

There are three types of addons:

  • Macros: short snippet of Python code that provides a new tool or functionality in a single file ending with .FCMacro.
  • Workbenches: collections of Python files that provide related Gui Commands (tools) centered around a particular topic, for example, tools to design cabinets, or tools to work with architecture, or tools to design boats, etc. These workbenches usually define new toolbars where commands are placed as buttons.
  • Preference Packs: distributable collections of user preference. introduced in version 0.20

Installation

The recommended way to install addons is with the Addon Manager.

But for macros and workbenches manual installation is also possible: