Std AddonMgr: Difference between revisions

From FreeCAD Documentation
No edit summary
m (update to 0.20)
Line 33: Line 33:
<translate>
<translate>
<!--T:4-->
<!--T:4-->
{{Caption|The v0.19.x Addon manager dialog box}}
{{Caption|The v0.20 Addon manager dialog box}}


==Usage== <!--T:5-->
==Usage== <!--T:5-->

Revision as of 10:56, 16 June 2022

Other languages:

Std AddonMgr

Menu location
Tools → Addon manager
Workbenches
All
Default shortcut
None
Introduced in version
0.17
See also
External workbenches, Macros

Description

The Std AddonMgr command opens the Addon manager. With the Addon manager you can install and manage external workbenches and macros provided by the FreeCAD community. The available workbenches and macros are taken from two repositories, FreeCAD-addons and FreeCAD-macros, and from the Macros recipes page.

Due to changes to the GitHub platform in the year 2020 the Addon manager no longer works if you use FreeCAD version 0.17 or earlier. You need to upgrade to version 0.18.5 or a recent 0.19 version. Alternatively you can install addons manually, see Notes below.

File:Std AddonMgr dialog.png

The v0.20 Addon manager dialog box

Usage

  1. Select the Tools → Addon manager option from the menu.
  2. If you are using the Addon manager for the first time, a dialog box will open warning you that the addons in the Addon manager are not officially part of FreeCAD. Press the OK button to confirm and continue.
  3. The Addon manager dialog box opens. For more information see Options.
  4. The Update all button does not work at this time.
  5. Press the Close button to close the dialog box.
  6. If you have installed or updated a workbench a new dialog box will open informing you that you have to restart FreeCAD for the changes to take effect.

Options

The Addon manager dialog box has two tabs on the left, one listing the available workbenches and the other listing the available macros. The information panel on the right will display the homepage of the selected addon.

Uninstall

  1. Select an installed addon on the Workbenches tab or the Macros tab.
  2. Press the Uninstall selected button.

Install/update

  1. Select an addon on the Workbenches tab or the Macros tab.
  2. Press the Install/update selected button.
  3. If you want to add a macro to a custom toolbar then don't forget to manually download the icon image file, if available, by clicking on the link on the homepage in the information panel. See Interface Customization.
  4. To change the position of an addon workbench in the Workbench selector list see Interface Customization.

Configuration

  1. Press the Configure... button.
  2. The Addon manager options dialog box opens.
  3. Optionally check the Automatically check for updates at start (requires GitPython) checkbox.
  4. Optionally add repositories to the Custom repositories list. Addons from these repositories will be added on the Workbenches tab or the Macros tab.
  5. Optionally choose proxy settings.
  6. Press the OK button or the Cancel button to close the dialog box.

Notes

  • The use of addons is not restricted to the FreeCAD version they were installed from. You will also be able to use them in any other FreeCAD version, supported by the addon, that you may have on your system.
  • The addons available in the Addon manager are not part of the official FreeCAD program and are not supported by the core FreeCAD development team. You should read the provided information carefully to make sure you know what you are installing.
  • Bug reports and feature requests should be made directly to the creator of the addon by visiting the indicated website. Many addon developers are regular users of the FreeCAD forum, and can also be contacted there.
  • If the GitPython package is installed on your computer the Addon manager will make use of it, making downloads faster.
  • You can also install addons manually. See How to install additional workbenches and How to install macros.

Information for developers

See Addon.

Changes coming in FreeCAD 0.20

The Addon Manager saw a major revision in 0.20, most notably adding support for modern SSL standards, but also undergoing a visual refresh and some added user-interface features. The preferences for Addon Manager can be found in the Preferences Editor.

File:AddonManager relnotes 0.20.png
  1. "Condensed" and "Expanded" views available. "Expanded" view is shown here.
  2. Three different types of addons are now supported: Workbenches, Macros, and Preference Packs. You can choose to show just one type, or all of them in a single list.
  3. The list can be limited to show just installed packages, just packages with available updates, or just packages that are not yet installed.
  4. The list can be filtered, searching for a keyword in the title, description, and tags (description and tags must be specified by the addon developer in their addon's metadata). The filter can even be a regular expression, for fine-grained control of the exact search term.
  5. The expanded view shows available version information, description, maintainer information, and installation version information, for packages that provide a Package_Metadata file (or for macros with embedded metadata).
  6. Metadata and icons are cached locally, with a variable cache update frequency set in the user preferences.
  7. Update checks may be set up to be automatic, or done manually via a button click. Configured in user preferences.
Std Base
User documentation
Retrieved from "http://wiki.freecad.org/index.php?title=Std_AddonMgr&oldid=1154882"