Installing more workbenches: Difference between revisions

From FreeCAD Documentation
m (Minor changes to the redaction)
(Changes in redaction)
Line 17: Line 17:


== Installing system-wide == <!--T:3-->
== Installing system-wide == <!--T:3-->
Workbenches installed this way will be available to all users. Depending on your system, you might need administrator privileges to access the installation directory.
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.


<!--T:4-->
<!--T:4-->
Copy the workbench folder into {{incode|$INSTALL_DIR/Mod/}}, where {{incode|$INSTALL_DIR}} is the FreeCAD installation directory.
Copy the workbench folder into {{incode|$INSTALL_DIR/Mod/}}, where {{incode|$INSTALL_DIR}} is the FreeCAD installation directory.
* On Linux it will probably be {{incode|/usr/share/freecad/Mod}}
* On Linux it is usually {{incode|/usr/share/freecad/Mod/}}
* On Windows it will probably be {{incode|C:\Program Files\FreeCAD\Mod}}
* On Windows it is usually {{incode|C:\Program Files\FreeCAD\Mod\}}
* On Mac OSX it will probably be {{incode|/Applications/FreeCAD/Mod}}
* On Mac OSX it is usually {{incode|/Applications/FreeCAD/Mod/}}


== Installing for a single user == <!--T:5-->
== Installing for a single user == <!--T:5-->
Workbenches installed this way will be available only to one user, but will not require any administrator privileges.
Workbenches installed in 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 the workbench folder into {{incode|$USER_DIR/Mod/}}, where {{incode|$USER_DIR}} is the FreeCAD directory for a particular {{incode|username}}.
* 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 Linux it is usually {{incode|/home/username/.FreeCAD/Mod/}}
* On Windows it will probably be {{incode|C:\Users\username\Application Data\FreeCAD\Mod}}
* On Windows it is usually {{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}}.
* On Mac OSX it is usually {{incode|/Users/username/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 entering {{incode|~/Library/Preferences/FreeCAD}}.


== Additional information == <!--T:9-->
== Additional information == <!--T:9-->

Revision as of 18:54, 5 December 2018

Description

It is easy to add external workbenches to FreeCAD.

Workbenches are contained 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.

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 Mac OSX 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.

  • On Linux it is usually /home/username/.FreeCAD/Mod/
  • On Windows it is usually C:\Users\username\Application Data\FreeCAD\Mod\
  • On Mac OSX it is usually /Users/username/Library/Preferences/FreeCAD/Mod/. One way to get to the preferences directory is to use the "Finder" menu item Go → Go to Folder, and entering ~/Library/Preferences/FreeCAD.

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.