Installing more workbenches: Difference between revisions

From FreeCAD Documentation
(translate)
No edit summary
 
(28 intermediate revisions by 8 users not shown)
Line 1: Line 1:
<languages/>
{{TOCright}}
<translate>
<translate>
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.


== Introduction == <!--T:13-->
Extra workbenches are delivered in a folder, that must simply be copied into one of FreeCAD's '''Mod''' directory. The Mod directories are scanned everytime FreeCAD is started and the availible workbenches automatically added. There are two ways of installing:


<!--T:14-->
===Installing system-wide===
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.
Extra workbenches, or modules, can be installed inside your FreeCAD installation directory, so they will be availible to all users. Depending on your system, you might need administrator or superuser privileges to access the FreeCAD installation directory.


<!--T:15-->
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'''
Keep reading for more information regarding installation of workbenches.


== General description == <!--T:1-->
===Installing user-wide===
Workbenches installed that way will be availible only to you, and not to the other users of your system. But it will not require any administrator or superuser privileges.


<!--T:2-->
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".
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=
$ROOT_DIR/Mod/
}}
<translate>


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


<!--T:11-->
Extra information about how to create a custom workbench can be found on the [[Developer hub]] and on the [[Power users hub]].
The {{incode|Mod/}} directories are scanned every time FreeCAD is started, and the available workbenches are automatically added.

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

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

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

<!--T:6-->
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 Windows it is {{incode|%APPDATA%\FreeCAD\Mod\}}, which is usually {{incode|C:\Users\username\Appdata\Roaming\FreeCAD\Mod\}}
* On macOS it is usually {{incode|/Users/username/Library/Preferences/FreeCAD/Mod/}}.

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

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


[[Category:Developer]]
[[Category:Poweruser_Documentation]]


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

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.