Skip to content

Update Macros documentation and External Workbenches with new addons #333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
hikali123456789 wants to merge 1 commit into
base: main
Choose a base branch
from
+229 −27
Draft

Update Macros documentation and External Workbenches with new addons #333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
171 changes: 148 additions & 23 deletions wiki/External_workbenches.wikitext
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@
|IconR=
}}

<!--T:180-->
{{VeryImportantMessage|This page is obsolete. Check the [https://www.freecad.org/addons.php Addons] page instead.}}

</translate>
{{TOCright}}
<translate>
Expand All @@ -29,6 +26,47 @@ Workbenches marked with [[File:AddonManager.svg|24px]] can be installed from the
<!--T:49-->
Workbenches marked with [[File:Edit_Cancel.svg|24px]] are not recommended for recent versions of FreeCAD. They are obsolete, unmaintained, superseded by a newer workbench, or maybe they don't work with Python 3 or with Qt5. In most cases they should be avoided.

== Installing external workbenches == <!--T:181-->

=== Via the Addon Manager === <!--T:182-->

<!--T:183-->
The easiest way to install external workbenches is through the built-in [[Std_AddonMgr|Addon Manager]]. To access it, go to {{MenuCommand|Edit | Preferences | Addon Manager}} (or {{MenuCommand|Tools | Addon Manager}} in some versions). The Addon Manager downloads the [https://github.com/FreeCAD/Addons/blob/main/Data/Index.json Addons Index] from the official FreeCAD repository and displays a list of available addons. Simply select the workbenches you want and click {{Button|Install}}.

<!--T:184-->
The Addon Manager handles downloading, updating, and removing addons automatically. It places addons in your user [[FreeCAD_user_data_location|Mod]] directory, keeping them separate from the core FreeCAD installation.

=== Manual installation from GitHub === <!--T:185-->

<!--T:186-->
If an addon is not available through the Addon Manager, or if you want to install a development version, you can install it manually:

<!--T:187-->
# Find the addon's GitHub (or other Git hosting) repository URL.
# Clone or download the repository as a ZIP file.
# Extract the contents to your [[FreeCAD_user_data_location|Mod]] directory. The addon should be placed in a subfolder, for example {{FileName|Mod/WorkbenchName/}}.
# Restart FreeCAD. The workbench should appear in the workbench selector dropdown.

<!--T:188-->
Make sure the addon's folder contains a valid {{FileName|InitGui.py}} file, which is required for FreeCAD to recognize it as a workbench.

== The Addons Index == <!--T:189-->

<!--T:190-->
The [https://github.com/FreeCAD/Addons official Addons repository] maintains an [https://github.com/FreeCAD/Addons/blob/main/Data/Index.json Index] file that lists all addons available for installation through the Addon Manager. Each addon entry includes its repository URL, supported branch, and compatibility information.

=== Curated vs non-curated addons === <!--T:191-->

<!--T:192-->
Addons in the Index are classified into two categories:

<!--T:193-->
* '''Curated addons''': These have been reviewed by the FreeCAD community and meet basic quality standards. They are shown by default in the Addon Manager and are generally recommended for most users. Curated addons are expected to be actively maintained and compatible with recent versions of FreeCAD.
* '''Non-curated addons''': These are also listed in the Index but have not undergone the same level of review. They may be experimental, new, or maintained by a single developer. They can be found by searching in the Addon Manager but are not displayed by default.

<!--T:194-->
For addon developers, the [https://github.com/FreeCAD/Addon-Academy Addon Academy] provides guides and best practices for creating, packaging, and publishing FreeCAD addons.

== Assembly workbenches == <!--T:68-->

<!--T:29-->
Expand Down Expand Up @@ -97,9 +135,9 @@ The table below is organized in topics, but can be reorder by clicking any of th
|[[File:AddonManager.svg|24px]]
|

<!--T:73-->
<!--T:74-->
|-
|[[File:Dodo.svg|32px]]
|[[File:Dodo.svg|32px]]
|[[Dodo_Workbench|Dodo]]
|Architecture and construction
|It provides tools to create frames (trusses, beams) and pipelines (tubes, elbows, flanges), and query those objects.
Expand All @@ -111,7 +149,7 @@ This is the new version of [[Flamingo_Workbench|Flamingo]], intended for Python

<!--T:74-->
|-
|[[File:Flamingo.svg|32px]]
|[[File:Flamingo.svg|32px]]
|[[Flamingo_Workbench|Flamingo]]
|Architecture and construction
|It provides tools to create frames (trusses, beams) and pipelines (tubes, elbows, flanges), and query those objects.
Expand All @@ -123,7 +161,7 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt

<!--T:169-->
|-
|[[File:FrameForge.svg|32px]]
|[[File:FrameForge.svg|32px]]
|[[FrameForge_Workbench|FrameForge]]
|Architecture and construction
|FrameForge is dedicated to creating Frames and Beams, and apply operations (miter cuts, trim cuts) to these profiles.
Expand Down Expand Up @@ -297,6 +335,28 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|[[File:AddonManager.svg|24px]]
|

<!--T:195-->
|-
|[[File:Assembly4_workbench_icon.svg|32px]]
|[https://github.com/leoheck/FreeCAD_Assembly4.1 Assembly4.1]
|Assembly
|A community-friendly fork of the original [[Assembly4_Workbench|Assembly4]] repository. It continues development with community contributions, bug fixes, and improvements while maintaining compatibility with the Assembly4 workflow.
|leoheck
|https://github.com/leoheck/FreeCAD_Assembly4.1
|[[File:AddonManager.svg|24px]]
|

<!--T:196-->
|-
|[[File:CamScripts_workbench_icon.svg|32px]]
|[https://github.com/spanner888/CamScripts CamScripts]
|CAM and manufacturing
|CAM scripts and tools for manufacturing workflows. It provides utilities to assist with computer-aided manufacturing tasks in FreeCAD.
|spanner888
|https://github.com/spanner888/CamScripts
|[[File:AddonManager.svg|24px]]
|

<!--T:37-->
|-
|
Expand All @@ -308,6 +368,28 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|[[File:AddonManager.svg|24px]]
|[[File:Edit_Cancel.svg|24px]]

<!--T:197-->
|-
|[[File:Behave-Dark-Colors_workbench_icon.svg|32px]]
|[https://github.com/Chrismettal/FreeCAD-Behave-Dark-Preference-Pack Behave-Dark-Colors]
|Customization
|A dark theme preference pack for FreeCAD that provides a consistent dark color scheme across the interface, including panels, toolbars, and editors.
|Chrismettal
|https://github.com/Chrismettal/FreeCAD-Behave-Dark-Preference-Pack
|[[File:AddonManager.svg|24px]]
|

<!--T:198-->
|-
|[[File:Catppuccin_workbench_icon.svg|32px]]
|[https://github.com/cnvuls/CatppuccinTheme Catppuccin]
|Customization
|A soothing pastel theme for FreeCAD, based on the popular [https://github.com/catppuccin/catppuccin Catppuccin] color palette. It provides multiple flavor variants (Latte, Frapp茅, Macchiato, Mocha) for a comfortable editing experience.
|cnvuls
|https://github.com/cnvuls/CatppuccinTheme
|[[File:AddonManager.svg|24px]]
|

<!--T:84-->
|-
|
Expand All @@ -330,6 +412,17 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|[[File:AddonManager.svg|24px]]
|[[File:Edit_Cancel.svg|24px]]

<!--T:199-->
|-
|[[File:Dracula_workbench_icon.svg|32px]]
|[https://github.com/dracula/freecad Dracula]
|Customization
|A dark theme for FreeCAD based on the popular [https://draculatheme.com/ Dracula] color scheme. It provides a clean, modern dark interface with carefully chosen colors for syntax highlighting and UI elements.
|Dracula Theme contributors
|https://github.com/dracula/freecad
|[[File:AddonManager.svg|24px]]
|

<!--T:86-->
|-
|
Expand Down Expand Up @@ -393,7 +486,6 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|It is a small extension to keep the toolbars in their locations. Since FreeCAD 0.17 this extension is obsolete, as the functionality is included natively in FreeCAD.
|triplus
|https://github.com/triplus/PersistentToolbars
|[[File:AddonManager.svg|24px]]
||[[File:Edit_Cancel.svg|24px]]

<!--T:92-->
Expand Down Expand Up @@ -506,6 +598,17 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|[[File:AddonManager.svg|24px]]
|

<!--T:200-->
|-
|[[File:BillOfMaterials_workbench_icon.svg|32px]]
|[https://github.com/APEbbers/BillOfMaterials-WB BillOfMaterials]
|Drawing and documentation
|Generates Bill of Materials (BOM) from FreeCAD documents. It extracts part information such as name, material, quantity, and other custom properties, and exports them in various formats for manufacturing and procurement workflows.
|APEbbers
|https://github.com/APEbbers/BillOfMaterials-WB
|[[File:AddonManager.svg|24px]]
|

<!--T:175-->
|-
|[[File:Templater_workbench_icon.svg|32px]]
Expand Down Expand Up @@ -622,7 +725,7 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|[https://github.com/URJCMakerGroup/MakerWorkbench Maker Workbench]
|Engineering
|The Maker Workbench is composed of a mechatronic components system and an optic components system. The user can modify these components to customize their own system.
|David Muñoz
|David Mu帽oz
|https://github.com/URJCMakerGroup/MakerWorkbench
|[[File:AddonManager.svg|24px]]
|
Expand All @@ -644,7 +747,7 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|[[Pyrate_Workbench|Pyrate]]
|Engineering
|It is used to design optical lenses. The project aims to provide an optical raytracer for isotropic, homogeneous anisotropic and inhomogeneous isotropic GRIN media.
|mess42, joha2
|mess42, joha2
|https://github.com/mess42/pyrate
|[[File:AddonManager.svg|24px]]
|
Expand Down Expand Up @@ -677,7 +780,7 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|[[Ship_Workbench|Ship]]
|Engineering
|It is used to create structures that are common to ships. It currently is seeking a maintainer.
|Jose Luis Cercós Pita
|Jose Luis Cerc贸s Pita
|https://github.com/FreeCAD/freecad.ship
|[[File:AddonManager.svg|24px]]
|[[File:Edit_Cancel.svg|24px]]
Expand All @@ -686,13 +789,24 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|-
|[[File:CADExchanger_workbench_icon.svg|32px]]
|[https://github.com/yorikvanhavre/CADExchanger CADExchanger]
|Information and data
|Import and export
|It is an extension that allows FreeCAD to import and export file formats supported by the commercial "CAD Exchanger" application, such as Rhino 3dm or ACIS sat, and mesh formats like OBJ and STL.
|yorikvanhavre
|https://github.com/yorikvanhavre/CADExchanger
|[[File:AddonManager.svg|24px]]
|

<!--T:201-->
|-
|[[File:Alternate_OpenSCAD_workbench_icon.svg|32px]]
|[https://github.com/KeithSloan/OpenSCAD_Alt_Import Alternate OpenSCAD]
|Import and export
|An alternative OpenSCAD file importer for FreeCAD. It provides improved import capabilities for OpenSCAD (.scad) files, allowing users to bring OpenSCAD models into FreeCAD for further editing and manipulation.
|KeithSloan
|https://github.com/KeithSloan/OpenSCAD_Alt_Import
|[[File:AddonManager.svg|24px]]
|

<!--T:178-->
|-
|[[File:DataManager_workbench_icon.svg|32px]]
Expand Down Expand Up @@ -742,7 +856,7 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|[[File:ImportNURBS_workbench_icon.png|32px]]
|[https://github.com/KeithSloan/ImportNURBS ImportNURBS]
|Information and data
|A workbench to add support for importing 3dm files using open rhino3dm library Noteː This workbench is still under development
|A workbench to add support for importing 3dm files using open rhino3dm library Note: This workbench is still under development
|keithsloan52
|https://github.com/KeithSloan/ImportNURBS
|[[File:AddonManager.svg|24px]]
Expand Down Expand Up @@ -776,7 +890,7 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|[https://github.com/FreeCAD/freecad.plot Plot]
|Information and data
|It is a layer on top of the Matplotlib Python module to graph mathematical functions and vectors of points.
|Jose Luis Cercós Pita
|Jose Luis Cerc贸s Pita
|https://github.com/FreeCAD/freecad.plot
|[[File:AddonManager.svg|24px]]
|
Expand Down Expand Up @@ -863,9 +977,9 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|[[File:Cadquery_module_workbench_icon.svg|32px]]
|[[CadQuery_Workbench|CadQuery]]
|Parts
|It allows users to design parametric 3D CAD models defined by the [https://dcowden.github.io/cadquery/ CadQuery CAD scripting API]. It includes a full-featured editor with auto-completion, syntax highlighting, line numbering, and code folding. Example scripts are included. Script variables can be edited dynamically through the use of a parameter dialog. This workbench also includes [https://github.com/cqparts/cqparts cqparts], which is a library that adds support for parts and assemblies with constraints on top of CadQuery.
|jmwright
|https://github.com/jmwright/cadquery-freecad-module
|It allows users to design parametric 3D CAD models defined by the [https://cadquery.readthedocs.io/ CadQuery CAD scripting API]. It includes a full-featured editor with auto-completion, syntax highlighting, line numbering, and code folding. Example scripts are included. Script variables can be edited dynamically through the use of a parameter dialog. This workbench also includes [https://github.com/cqparts/cqparts cqparts], which is a library that adds support for parts and assemblies with constraints on top of CadQuery.
|CadQuery contributors
|https://github.com/CadQuery/cadquery-freecad-workbench
|[[File:AddonManager.svg|24px]]
|

Expand All @@ -875,7 +989,7 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|[[Fasteners_Workbench|Fasteners]]
|Parts
|It is a workbench that provides various fasteners, screws, bolts, nuts, etc., to attach to your model complying with ISO standards.
|Ulrich Bramar (@ulrich1a) and Shai Seger (@shais)
|Ulrich Bramar (@ulrich1a) and Shai Seger (@shais)
|https://github.com/shaise/FreeCAD_FastenersWB
|[[File:AddonManager.svg|24px]]
|
Expand Down Expand Up @@ -1172,7 +1286,7 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|[[Curves_Workbench|Curves]]
|Shapes
|It is a collection of tools to create and edit NURBS curves and surfaces.
|tomate44 (Chris_G)
|tomate44 (Chris_G)
|https://github.com/tomate44/CurvesWB
|[[File:AddonManager.svg|24px]]
|
Expand Down Expand Up @@ -1282,7 +1396,7 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|[https://github.com/luzpaz/SlopedPlanesMacro SlopedPlanesMacro]
|Shapes
|It allows you to build figures controlling the slopes of the faces of objects.
|Damian Caceres Moreno
|Damian Caceres Moreno
|https://github.com/luzpaz/SlopedPlanesMacro
|[[File:AddonManager.svg|24px]]
|
Expand Down Expand Up @@ -1326,7 +1440,7 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|[[EM_Workbench|EM]]
|Simulation
|It provides a graphical interface for different solvers by [http://www.fastfieldsolvers.com FastFieldSolvers]. At present it supports the 3D magneto-quasistatic impedance solver FastHenry. Support for the 3D electrostatic capacitance solver FasterCap is ongoing.
|FastFieldSolvers S.R.L.
|FastFieldSolvers S.R.L.
|https://github.com/ediloren/EM-Workbench-for-FreeCAD
|[[File:AddonManager.svg|24px]]
|
Expand All @@ -1348,7 +1462,7 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|[[FEMbyGEN_Workbench|FEMbyGEN]]
|Simulation
|It provides a simple interface to choose the best solution by showing the structural behavior of your designs on screen for parametric analysis and multiple loading situations.
|Serdar Ince, Ögeday Yavuz, Rahul Jhuree
|Serdar Ince, 脰geday Yavuz, Rahul Jhuree
|https://github.com/Serince/FEMbyGEN
|[[File:AddonManager.svg|24px]]
|
Expand All @@ -1364,6 +1478,17 @@ This is the old version of [[Dodo_Workbench|Dodo]], intended for Python 2 and Qt
|[[File:AddonManager.svg|24px]]
|

<!--T:202-->
|-
|[[File:Channels_workbench_icon.svg|32px]]
|[https://github.com/mnesarco/Channels Channels]
|Design and modeling
|A workbench for creating channel profiles and related structural shapes. It provides tools for generating parametric channel cross-sections commonly used in structural engineering and steel construction.
|mnesarco
|https://github.com/mnesarco/Channels
|[[File:AddonManager.svg|24px]]
|

<!--T:154-->
|}

Expand All @@ -1385,4 +1510,4 @@ See the wiki page for more information [[Translating_an_external_workbench|Trans
{{Userdocnavi{{#translation:}}}}
[[Category:Addons{{#translation:}}]]
[[Category:External_Workbenches{{#translation:}}|*]]
__STATICREDIRECT__
__STATICREDIRECT__
Loading