Difference between revisions of "Addon/en"

From FreeCAD Documentation
Jump to navigation Jump to search
(Updating to match new version of source page)
(Updating to match new version of source page)
Line 3: Line 3:
 
== Introduction ==
 
== Introduction ==
  
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.
  
There are two types of addons.
+
== Different types ==
* [[Macros]]: short snippets of [[Python]] code that provide a new tool or functionality.
 
* [[External workbenches]]: collections of tools programmed in Python or C++ that extend FreeCAD in an important way.
 
  
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.
+
There are roughly 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}}.
 +
* 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]].
 +
* [[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.
  
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.
+
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/
 +
}}
  
If a workbench is sufficiently developed and is well documented, it may be included as one of the base [[workbenches]] in FreeCAD.
+
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 [[Addon Manager]].
+
Starting from FreeCAD 0.17, the recommended way to install addons is with the [[Std_AddonMgr|Addon Manager]].
  
Manual installation is still possible.
+
However, manual installation is still possible.
* [[How to install macros]]
+
* [[How_to_install_macros|How to install macros]]
* [[Installing more workbenches]]
+
* [[Installing_more_workbenches|Installing more workbenches]]
  
[[Category:User Documentation{{#translation:}}]]
+
{{Userdocnavi{{#translation:}}}}
 
[[Category:Addons{{#translation:}}]]
 
[[Category:Addons{{#translation:}}]]

Revision as of 11:31, 15 May 2020

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎polski • ‎português do Brasil • ‎русский

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 roughly three types of addons:

  • Macro: short snippet of Python code that provides a new tool or functionality in a single file ending with .FCMacro.
  • 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.
  • Workbench: 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.

Macros as installed under the user's Macro/ directory, while modules and workbenches are under the Mod/ directory.

$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 in FreeCAD.

Installation

Starting from FreeCAD 0.17, the recommended way to install addons is with the Addon Manager.

However, manual installation is still possible.