Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/FreeCAD/FreeCAD-addons

A convenient gathering of useful and well-developed FreeCAD plugins made by the community.
https://github.com/FreeCAD/FreeCAD-addons

addons addons-installer freecad freecad-addons workbench

Last synced: 5 days ago
JSON representation

A convenient gathering of useful and well-developed FreeCAD plugins made by the community.

Awesome Lists containing this project

README 

        
# FreeCAD Addons Repository ![AddonManager-Logo][AddonManager]



This repository is a collection of useful additional workbenches and modules for FreeCAD made by its community members, conveniently available for seamless integration in to the application itself.



**Important Notes:**  

1. Since **these Addons are not part of the official FreeCAD package and not supported by the FreeCAD team**, although this list is curated and maintained by the FreeCAD team, you should **read the information provided on each of the addons page before installing any of them, to make sure you know what you are installing**. 



2. **Bug reports and feature requests should be made directly on each addon page.** Any reports opened in this repository should be related directly to the Addon Manager itself.



3. The commit number indicated in the github tree above is not considered by the Addons Manager. **What is installed or updated is always the latest *HEAD* of the specified branch of each addon**. If no branch is specified in the .gitmodules file, "master" is assumed.



[AddonManager]: icons/AddonManager.svg



### Addon Descriptions



For a description of each Addon you can either:

* within FreeCAD use the Addon Manager to scroll between all available Addon/External Workbenches. 

* click on each individually linked Addons in this repository to read their README files. 



### Installing



***Important Note: As of FreeCAD v0.17.9940 the Addon Manager was finally implemented in to FreeCAD. It can be accessed from within the Tools → 'Addon Manager' dropdown menu. For earlier versions (≤v0.16), please see the [Deprecated Installation Methods](#deprecated-installation-methods) section***.



#### 1. Builtin Addon Manager



The recommended way is using the built-in Addon Manager that installs 3rd party workbenches, addons, and macros. Access it via ***Tools → Addon Manager***:



![freecad-0.17-addon_manager-screenshot](https://user-images.githubusercontent.com/4140247/37867768-2eb7db20-2f73-11e8-83fb-8868995ba49d.png)



#### 2. Manual install



For any reason the first option is not available, then manual installation is always possible. Github provides users to '[Clone or download](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository)' each of the addons listed in this repository. They can be downloaded by:

* navigating to the specific addon repository 

* clicking the green 'Clone or download' → Download ZIP' buttons found in the top right of each addon page  

OR

* Using `git clone `  

Most of the addons must either be placed in your user's `FreeCAD/Mod` folder, or in the Macros folder. Refer to the instructions on each addon page. 



**Note**: Your user's FreeCAD folder location is obtained by typing in FreeCAD's python console: `FreeCAD.ConfigGet("UserAppData")`while the Macros folder location is indicated in the dialog opened from *Macro -> Macros...* dropdown menu.



### Adding your workbench to the collection



Have you made an interesting workbench or module that we are not aware of? Tell us on the [FreeCAD forum](http://forum.freecadweb.org) so we can add it here!



To submit your workbench to the repository

1. Announce your Workbench on the FreeCAD Forums

2. Create a dedicated page for your workbench on the FreeCAD wiki (don't forget to add `[[Category:Addons]]` to it) + add it to https://freecadweb.org/wiki/External_workbenches

4. Tag (AKA 'label') your Github repo with the following: `freecad`, `addons`, and `workbench`  

5. Make sure you have a simple SVG logo of your workbench (no larger than 10kb) that can be used to represent it in the Addon Manager dialog.

6. Please structure the README.md file in a way that makes it easy to understand while reading from the Addon Manager dialog. Example: [SheetMetal Workbench](https://github.com/shaise/FreeCAD_SheetMetal/blob/master/README.md)  

   **Note the use of:** screenshots, screencasts, mentioning of Licence, Changelog etc... 

7. Ensure that your Addon includes a `package.xml` [metadata file](https://wiki.freecadweb.org/Package_Metadata), and that that file includes an icon, repository url, and readme url. The readme url should be a direct link to the HTML-rendered README.md file (e.g. https://github.com/shaise/FreeCAD_SheetMetal/blob/master/README.md)

8. Submit a Pull Request to this repository adding your Addon to the `.gitmodules` file. Supported git hosts are [GitHub](https://github.com/), [Gitlab](https://about.gitlab.com/), [Framagit](https://framagit.org/public/projects), [salsa.debian.org](https://salsa.debian.org/public), and [Codeberg](https://codeberg.org/).

9. Create a new ticket, linked to the PR, following [this template](https://github.com/FreeCAD/FreeCAD-addons/issues/new?assignees=&labels=New+WB%2FAddon+%3Apackage%3A&projects=&template=add-a-new-workbench-addon-to-this-repo.md&title=%5BNew+Addon%2FWorkbench%5D)



### Translating External Workbenches



For wider usage of external workbenches, we recommend that workbench developers integrate the ability to [translate their workbench(es)](https://www.freecadweb.org/wiki/Translating_an_external_workbench). FreeCAD uses a 3rd-party crowdsource translation service called [Crowdin](https://crowdin.com/project/freecad). There are some [automated scripts](https://www.freecadweb.org/wiki/Crowdin_Scripts) that we use to push and pull translations from Crowdin via their API. Developers are invited to help improve these scripts so as to include their own workbenches in the process. Further discussion on [this forum thread](https://forum.freecadweb.org/viewtopic.php?f=10&t=36413). 



### Addon Manager Source Code



Source code for the Addon Manager lives in FreeCAD master [`FreeCAD/src/Mod/AddonManager/`](https://github.com/FreeCAD/FreeCAD/tree/master/src/Mod/AddonManager).



### Deprecated Installation Methods



  Before FreeCAD v. 0.17.9940 the methods below were utilized to automate the installation of workbenches and macros. This sections is being kept for historical purposes.



  

#### 1. Using the installer macro



The installer macro can be launched from inside FreeCAD, and will download and install any of the addons above automatically. To install the installer macro:



1. Download [addons_installer.FCMacro](https://raw.githubusercontent.com/FreeCAD/FreeCAD-addons/da3cb72c54f94430e9afd8200b48f4f2f6ac7c8c/addons_installer.FCMacro)

2. Place the downloaded macro in your **FreeCAD Macros folder**. The FreeCAD Macros folder location is indicated in menu **Macros -> Macros -> User macros location**:

![the execute macro dialog](http://www.freecadweb.org/wiki/images/1/1e/Macro_installer_01.jpg)

3. Restart FreeCAD. The addons installer will now be listed in menu **Macro -> Macros** and can be launched by selecting it then clicking the **Execute** button:



![the addons installer](http://www.freecadweb.org/wiki/images/c/c6/Macro_installer_02.jpg)



#### 2. Using the "pluginloader" addon



The plugin loader is a much more elaborate way to install and manage additional content for freecad. Install it with the method above, or following the instructions on the [pluginloader page](https://github.com/microelly2/freecad-pluginloader).