Addon: Difference between revisions

Latest revision as of 18:10, 18 November 2022

Other languages:

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 preferences. 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:

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.

See also:

User documentation

Getting started
Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate

Help: Tutorials, Video tutorials
Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web

Addons: Addon Manager, External workbenches, Scripting and macros

Hubs: User hub, Power users hub, Developer hub

@@ Line 1: / Line 1: @@
 <languages/>
+{{TOCright}}
 <translate>
@@ Line 5: / Line 6: @@
 <!--T:2-->
-In FreeCAD and in this documentation, an [[addon|addon]] is any component that is not part of the base FreeCAD installation, but that can be added to the system by certain methods.
+In FreeCAD and in this documentation, an [[addon|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 == <!--T:11-->
 <!--T:3-->
-There are two types of addons.
+There are three types of addons:
-* [[Macros]]: short snippets of [[Python]] code that provide a new tool or functionality.
+* [[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.
-* [[External workbenches]]: collections of tools programmed in Python or C++ that extend FreeCAD in an important way.
+* [[Preference_Packs|Preference Packs]]: distributable collections of user preferences. {{Version|0.20}}
-<!--T:4-->
-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, the entire directory may be distributed as a new workbench.
-<!--T:5-->
-In other words, macros and workbenches are essentially the same thing, pieces of code that extend the base installation. Macros are usually short utilities focused on a single task, while workbenches are collections of organized tools and graphical interfaces to perform related tasks.
-<!--T:6-->
-If a workbench is sufficiently developed and is well documented, it may be included as one of the base [[workbenches]] in FreeCAD.
 == Installation == <!--T:7-->
 <!--T:8-->
-Starting from FreeCAD 0.17, the recommended way to install addons is with the [[Addon Manager]].
+The recommended way to install addons is with the [[File:Std_AddonMgr.svg|24px]] [[Std_AddonMgr|Addon Manager]].
 <!--T:9-->
-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]]
-* [[Installing more workbenches]]
+* [[Installing_more_workbenches|Installing more workbenches]]
+== Information for developers == <!--T:13-->
+<!--T:14-->
+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: ([https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] and [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros]). If you add your macro to the [[Macros_recipes|Macros recipes]] page, there is nothing else to do, it will automatically be picked up by the Addon manager.
+<!--T:19-->
+See also:
+* [[Workbench_creation#Distribution|Distribution of a Python workbench]]
+* [[Workbench_creation#Distribution_2|Distribution of a C++ workbench]]
 </translate>