Installing more workbenches: Difference between revisions
Renatorivo (talk | contribs) No edit summary |
(Reworded the information. Added second level sections, instead of third level.) |
||
Line 2: | Line 2: | ||
<translate> |
<translate> |
||
<!--T:1--> |
<!--T:1--> |
||
== Description == |
|||
Outside the standard workbenches that are bundled with every FreeCAD installation, it is very easy to add other workbenches that extend FreeCAD functionality. At the moment, since FreeCAD is very young, there is almost no other workbench availible. But FreeCAD has been made extensible right from the start, so adding new workbenches is very easy, and in the future several new workbench should appear. |
|||
It is easy to add [[external workbenches]] to FreeCAD. |
|||
<!--T:2--> |
<!--T:2--> |
||
Workbenches are delivered in a folder that must be simply copied into |
|||
{{Code|code= |
|||
$ROOT_DIR/Mod/ |
|||
}} |
|||
where {{incode|$ROOT_DIR}} is a top level directory searched by FreeCAD on startup, for example |
|||
⚫ | |||
{{Code|code= |
|||
⚫ | |||
/usr/share/freecad/Mod/External_Workbench |
|||
}} |
|||
The {{incode|Mod/}} directories are scanned every time FreeCAD is started, and the available workbenches are automatically added. |
|||
⚫ | |||
⚫ | |||
<!--T:4--> |
<!--T:4--> |
||
Copy the workbench folder into {{incode|$INSTALL_DIR/Mod/}}, where {{incode|$INSTALL_DIR}} is the FreeCAD installation directory. |
|||
Copy or move the folder containing your workbench to the "Mod" directory that lies inside your FreeCAD installation directory. On Windows, it will probably be something like '''C:\Program Files\FreeCAD\Mod''', on Debian-based systems something like '''/usr/lib/FreeCAD/Mod''' |
|||
* On Linux it will probably be {{incode|/usr/share/freecad/Mod}} |
|||
* On Windows it will probably be {{incode|C:\Program Files\FreeCAD\Mod}} |
|||
* On Mac OSX it will probably be {{incode|/Applications/FreeCAD/Mod}} |
|||
== |
== Installing for a single user == <!--T:5--> |
||
Workbenches installed |
Workbenches installed this way will be available only to one user, but will not require any administrator privileges. |
||
<!--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}}. |
|||
Copy or move the folder containing your workbench to the "Mod" directory that lies inside your FreeCAD user directory. On Windows, it will be something like '''C:\Users\your_user_name\Application Data\FreeCAD\Mod''', on Linux systems it will be '''~/.FreeCAD/Mod''' where ~ is your user's home directory. On Mac OSX the "Mod" directory should be '''~/Library/Preferences/FreeCAD/Mod'''. One way to get to the FreeCAD preferences directory on Mac is to use the Finder menu item Go->Go to Folder... and then enter "~/Library/Preferences/FreeCAD". |
|||
* On Linux it will probably be {{incode|~/.FreeCAD/Mod}}, where {{incode|~}} expands to the user's home directory, for example, {{incode|/home/username/.FreeCAD/Mod}} |
|||
* On Windows it will probably be {{incode|C:\Users\username\Application Data\FreeCAD\Mod}} |
|||
* On Mac OSX it will probably be {{incode|~/Library/Preferences/FreeCAD/Mod}}. One way to get to the preferences directory is to use the "Finder" menu item {{MenuCommand|Go → Go to Folder}}, and then enter {{incode|~/Library/Preferences/FreeCAD}}. |
|||
== Additional information == <!--T:9--> |
|||
<!--T:7--> |
<!--T:7--> |
||
Additional information on how to create a custom workbench can be found on the [[Power users hub]] and the [[Developer hub]]. |
|||
⚫ | |||
===Tutorials=== <!--T:9--> |
|||
⚫ | |||
<!--T:8--> |
<!--T:8--> |
Revision as of 08:22, 5 December 2018
Description
It is easy to add external workbenches to FreeCAD.
Workbenches are delivered in a folder that must be simply copied into
$ROOT_DIR/Mod/
where $ROOT_DIR
is a top level directory searched by FreeCAD on startup, for example
/usr/share/freecad/Mod/External_Workbench
The Mod/
directories are scanned every time FreeCAD is started, and the available workbenches are automatically added.
Installing system-wide
Workbenches installed in the FreeCAD installation directory will be available to all users. Depending on your system, you might need administrator privileges to access this installation directory.
Copy the workbench folder into $INSTALL_DIR/Mod/
, where $INSTALL_DIR
is the FreeCAD installation directory.
- On Linux it will probably be
/usr/share/freecad/Mod
- On Windows it will probably be
C:\Program Files\FreeCAD\Mod
- On Mac OSX it will probably be
/Applications/FreeCAD/Mod
Installing for a single user
Workbenches installed 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
.
- On Linux it will probably be
~/.FreeCAD/Mod
, where~
expands to the user's home directory, for example,/home/username/.FreeCAD/Mod
- On Windows it will probably be
C:\Users\username\Application Data\FreeCAD\Mod
- On Mac OSX it will probably be
~/Library/Preferences/FreeCAD/Mod
. One way to get to the preferences directory is to use the "Finder" menu item Go → Go to Folder, and then enter~/Library/Preferences/FreeCAD
.
Additional information
Additional information on how to create a custom workbench can be found on the Power users hub and the Developer hub.
See also How to install additional workbenches.