Difference between revisions of "Installing more workbenches"

From FreeCAD Documentation
Jump to navigation Jump to search
(Removed macOS specific info about finding the Mod folder. Added general info instead.)
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<languages/>
 
<languages/>
 +
{{TOCright}}
 
<translate>
 
<translate>
 +
 
== Introduction == <!--T:13-->
 
== Introduction == <!--T:13-->
  
Line 13: Line 15:
 
<!--T:2-->
 
<!--T:2-->
 
Workbenches are nothing more than collections of files that are placed in a folder. This folder is usually compressed into a zip archive. On installation, this folder is simply uncompressed and copied to
 
Workbenches are nothing more than collections of files that are placed in a folder. This folder is usually compressed into a zip archive. On installation, this folder is simply uncompressed and copied to
 +
 
</translate>
 
</translate>
 
{{Code|code=
 
{{Code|code=
Line 18: Line 21:
 
}}
 
}}
 
<translate>
 
<translate>
 +
 
<!--T:10-->
 
<!--T:10-->
 
where {{incode|$ROOT_DIR}} is a top level directory searched by FreeCAD on startup. This is essentially what the [[Std_AddonMgr|Addon Manager]] does.
 
where {{incode|$ROOT_DIR}} is a top level directory searched by FreeCAD on startup. This is essentially what the [[Std_AddonMgr|Addon Manager]] does.
Line 41: Line 45:
  
 
<!--T:6-->
 
<!--T:6-->
Copy the workbench folder into {{incode|$USER_DIR/Mod/}}, where {{incode|$USER_DIR}} is the FreeCAD directory for a particular {{incode|username}}. Enter {incode|App.getUserAppDataDir()}} in the [[Python_console|Python console]] to identify your {{incode|$USER_DIR}} directory.
+
Copy the workbench folder into {{incode|$USER_DIR/Mod/}}, where {{incode|$USER_DIR}} is the FreeCAD directory for a particular {{incode|username}} (you can find the latter by typing {{incode|App.getUserAppDataDir()}} in the [[Python_console|Python console]]).
 
* On Linux it is usually {{incode|/home/username/.local/share/FreeCAD/Mod/}} ({{VersionPlus|0.20}}) or {{incode|/home/username/.FreeCAD/Mod/}} ({{VersionMinus|0.19}}).
 
* On Linux it is usually {{incode|/home/username/.local/share/FreeCAD/Mod/}} ({{VersionPlus|0.20}}) or {{incode|/home/username/.FreeCAD/Mod/}} ({{VersionMinus|0.19}}).
 
* On Windows it is {{incode|%APPDATA%\FreeCAD\Mod\}}, which is usually {{incode|C:\Users\username\Appdata\Roaming\FreeCAD\Mod\}}
 
* On Windows it is {{incode|%APPDATA%\FreeCAD\Mod\}}, which is usually {{incode|C:\Users\username\Appdata\Roaming\FreeCAD\Mod\}}
Line 53: Line 57:
 
<!--T:12-->
 
<!--T:12-->
 
See also a detailed description in the page [[How_to_install_additional_workbenches|how to install additional workbenches]].
 
See also a detailed description in the page [[How_to_install_additional_workbenches|how to install additional workbenches]].
 +
  
 
</translate>
 
</translate>
 
{{Powerdocnavi{{#translation:}}}}
 
{{Powerdocnavi{{#translation:}}}}
 
[[Category:Developer Documentation{{#translation:}}]]
 
[[Category:Developer Documentation{{#translation:}}]]
{{clear}}
 

Latest revision as of 10:57, 23 June 2022

Other languages:
Deutsch • ‎English • ‎Türkçe • ‎español • ‎français • ‎italiano • ‎polski • ‎română • ‎svenska • ‎русский

Introduction

Since v0.17 it is easy to add external workbenches by using the Addon Manager. A regular user doesn't need to do more than use this tool.

Keep reading for more information regarding installation of workbenches.

General description

Workbenches are nothing more than collections of files that are placed in a folder. This folder is usually compressed into a zip archive. On installation, this folder is simply uncompressed and copied to

$ROOT_DIR/Mod/

where $ROOT_DIR is a top level directory searched by FreeCAD on startup. This is essentially what the Addon Manager does.

The Mod/ directories are scanned every time FreeCAD is started, and the available workbenches are automatically added.

Installing system-wide

Workbenches installed in this way will be available to all users. Depending on your system, you might need administrator privileges to access the installation directory.

Copy the workbench folder into $INSTALL_DIR/Mod/, where $INSTALL_DIR is the FreeCAD installation directory.

  • On Linux it is usually /usr/share/freecad/Mod/
  • On Windows it is usually C:\Program Files\FreeCAD\Mod\
  • On macOS it is usually /Applications/FreeCAD/Mod/

Installing for a single user

Workbenches installed in this way will be available only to one user, but will not require any administrator privileges.

Copy the workbench folder into $USER_DIR/Mod/, where $USER_DIR is the FreeCAD directory for a particular username (you can find the latter by typing App.getUserAppDataDir() in the Python console).

  • On Linux it is usually /home/username/.local/share/FreeCAD/Mod/ (version 0.20 and above) or /home/username/.FreeCAD/Mod/ (version 0.19 and below).
  • On Windows it is %APPDATA%\FreeCAD\Mod\, which is usually C:\Users\username\Appdata\Roaming\FreeCAD\Mod\
  • On macOS it is usually /Users/username/Library/Preferences/FreeCAD/Mod/.

Additional information

Additional information on how to create a custom workbench can be found in the Power users hub and the Developer hub.

See also a detailed description in the page how to install additional workbenches.