Installing more workbenches: Difference between revisions

From FreeCAD Documentation
(Changes in redaction)
m (renamed to macOS)
(10 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>
<!--T:1-->
== Introduction == <!--T:13-->

== Description ==
<!--T:14-->
It is easy to add [[external workbenches]] to FreeCAD.
Since v0.17 it is easy to add [[external_workbenches|external workbenches]] by using the [[Std_AddonMgr|Addon Manager]]. A regular user doesn't need to do more than use this tool.

<!--T:15-->
Keep reading for more information regarding installation of workbenches.

== General description == <!--T:1-->


<!--T:2-->
<!--T:2-->
Workbenches are contained in a folder that must be simply copied into
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 12: Line 18:
}}
}}
<translate>
<translate>
<!--T:10-->
where {{incode|$ROOT_DIR}} is a top level directory searched by FreeCAD on startup.
where {{incode|$ROOT_DIR}} is a top level directory searched by FreeCAD on startup. This is essentially what the [[Std_AddonMgr|Addon Manager]] does.


<!--T:11-->
The {{incode|Mod/}} directories are scanned every time FreeCAD is started, and the available workbenches are automatically added.
The {{incode|Mod/}} directories are scanned every time FreeCAD is started, and the available workbenches are automatically added.


== Installing system-wide == <!--T:3-->
== Installing system-wide == <!--T:3-->

<!--T:16-->
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.
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.


Line 23: Line 33:
* On Linux it is usually {{incode|/usr/share/freecad/Mod/}}
* On Linux it is usually {{incode|/usr/share/freecad/Mod/}}
* On Windows it is usually {{incode|C:\Program Files\FreeCAD\Mod\}}
* On Windows it is usually {{incode|C:\Program Files\FreeCAD\Mod\}}
* On Mac OSX it is usually {{incode|/Applications/FreeCAD/Mod/}}
* On macOS it is usually {{incode|/Applications/FreeCAD/Mod/}}


== Installing for a single user == <!--T:5-->
== Installing for a single user == <!--T:5-->

<!--T:17-->
Workbenches installed in 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.


Line 31: Line 43:
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 is usually {{incode|/home/username/.FreeCAD/Mod/}}
* On Linux it is usually {{incode|/home/username/.FreeCAD/Mod/}}
* On Windows it is usually {{incode|C:\Users\username\Application Data\FreeCAD\Mod\}}
* On Windows it is {{incode|%APPDATA%\FreeCAD\Mod\}}, which is usually {{incode|C:\Users\''username''\Appdata\Roaming\FreeCAD\Mod\}}
* 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}}.
* On macOS 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-->


<!--T:7-->
<!--T:7-->
Additional information on how to create a custom workbench can be found in the [[Power users hub]] and the [[Developer hub]].
Additional information on how to create a custom workbench can be found in the [[Power users hub|Power users hub]] and the [[Developer hub|Developer hub]].


<!--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]].

<!--T:8-->
[[Category:Developer]]
[[Category:Poweruser_Documentation]]


</translate>
</translate>
{{Powerdocnavi{{#translation:}}}}
[[Category:Developer Documentation{{#translation:}}]]
{{clear}}
{{clear}}

Revision as of 13:18, 1 December 2020

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.

  • On Linux it is usually /home/username/.FreeCAD/Mod/
  • 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/. 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.