Introduction to FreeCAD Addons Repository
The FreeCAD Addons Repository is a vibrant collection of workbenches and modules developed by the community for FreeCAD, an open-source 3D CAD modeler. These addons are designed to enhance the functionality of FreeCAD, providing users with a wider array of tools for designing and modeling.
Important Considerations
-
Community-Driven: It's essential to note that these addons are not officially part of FreeCAD nor are they supported by the FreeCAD development team. Therefore, users should carefully review details on each addon's page to understand what they are installing.
-
Feedback and Issues: Any bugs or feature requests should be directed to the specific addon's page, rather than the main repository. The repository itself is maintained primarily for the Addon Manager tool.
-
Installation Specifics: The Addons Manager always installs the latest version from the specific branch, generally defaulting to the "master" branch unless otherwise specified.
Exploring Addons
To explore the various addons available:
- Use the Addon Manager within FreeCAD to browse through external workbenches.
- Visit individual repository pages for detailed descriptions and README files.
Installation Methods
Builtin Addon Manager
Starting with FreeCAD version 0.17.9940, the Addon Manager is integrated directly into FreeCAD. Accessible under the "Tools" menu as "Addon Manager", this method is straightforward for installing third-party workbenches, addons, and macros.
Manual Installation
If the Addon Manager is not available:
- Use GitHub to "Clone or download" each addon.
- Navigate to the specific addon repository and download the .zip file or use
git clone. - Place the addons in the appropriate FreeCAD "Mod" or "Macros" folder as instructed in each addon's page.
Contributing Your Own Workbench
Developers who wish to add their workbenches or modules to the collection can do so by:
- Announcing their workbench on the FreeCAD forums.
- Creating a page on the FreeCAD wiki and tagging the respective GitHub repository.
- Ensuring they have a small SVG logo for their workbench.
- Structuring README files for clarity and submitting a pull request to add to the repository.
- Following the detailed submission guidelines to complete the process.
Translating Workbenches
To increase the accessibility of workbenches, developers are encouraged to facilitate translations. The FreeCAD community uses Crowdin for translations, with scripts available for developers to integrate their workbenches into this process.
Addon Manager Source Code
The source code for the Addon Manager is available within the FreeCAD master branch at FreeCAD/src/Mod/AddonManager/.
Historical Installation Methods
Prior to version 0.17.9940, there were different methods for automating the installation of workbenches and macros. These are maintained for archival purposes but are no longer recommended for use with newer versions of FreeCAD.
By providing this robust repository, FreeCAD continues to expand its utility and adaptability for users, supported actively by its passionate community.