Installing more workbenches: Difference between revisions

From FreeCAD Documentation
(Reworded the information. Added second level sections, instead of third level.)
No edit summary
 
(23 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{TOCright}}
<translate>
<translate>

<!--T:1-->
== Introduction == <!--T:13-->
== Description ==

It is easy to add [[external workbenches]] to FreeCAD.
<!--T:14-->
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 delivered 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>
{{Code|code=
{{Code|code=
$ROOT_DIR/Mod/
$ROOT_DIR/Mod/
}}
}}
<translate>


<!--T:10-->
where {{incode|$ROOT_DIR}} is a top level directory searched by FreeCAD on startup, for example
where {{incode|$ROOT_DIR}} is a top level directory searched by FreeCAD on startup. This is essentially what the [[Std_AddonMgr|Addon Manager]] does.
{{Code|code=
/usr/share/freecad/Mod/External_Workbench
}}


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

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


<!--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 macOS 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.
<!--T:17-->
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}} (you can find the latter by typing {{incode|App.getUserAppDataDir()}} in the [[Python_console|Python console]]).
* 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/.local/share/FreeCAD/Mod/}} ({{VersionPlus|0.20}}) or {{incode|/home/username/.FreeCAD/Mod/}} ({{VersionMinus|0.19}}).
* On Windows it will probably be {{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 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 macOS it is usually {{incode|/Users/username/Library/Preferences/FreeCAD/Mod/}}.


== Additional information == <!--T:9-->
== 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]].
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 [[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:}}}}
{{clear}}
[[Category:Developer Documentation{{#translation:}}]]

Latest revision as of 10:57, 23 June 2022

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.