Preference Packs: Difference between revisions

From FreeCAD Documentation
(wording, style etc.)
(→‎Distributing a pack: add interlink)
Line 14: Line 14:
=== Distributing a pack ===
=== Distributing a pack ===


Eventually packs will be distributed identically to Addon-Workbenches, through the [[Image:Std_AddonMgr.svg|24px|link=Std_AddonMgr]] [[Std_AddonMgr|Addon Manager]]. This feature is still under development. To install a pack manually, use git to clone the package repository into your FreeCAD data directory (the directory where your user.cfg file is located), in a subdirectory called "Preference Packs".
Eventually packs will be distributed identically to [[External_workbenches|External Workbenches]], through the [[Image:Std_AddonMgr.svg|24px|link=Std_AddonMgr]] [[Std_AddonMgr|Addon Manager]]. This feature is still under development. To install a pack manually, use git to clone the package repository into your FreeCAD data directory (the directory where your user.cfg file is located), in a subdirectory called "Preference Packs".

Revision as of 04:27, 27 November 2021

This page documents a new feature in the 0.20 development branch. It is not available in previous releases. This documentation is a work-in-progress, please help us by improving it!

A Preference Pack is a distributable collection of user preferences that can be installed as an add-on and applied as a single set. Any user parameter that can be set in the user.cfg file can be included in a Preference Pack. Applying a preference pack sets all of the variables in the supplied CFG file without modifying any other user settings. For example, these packs can be used to create "Themes" by bundling together a custom stylesheet along with a set of user preferences that sets the various colors and styles of items in FreeCAD that aren't controlled by stylesheet.

Applying an installed pack

To apply a Preference Pack, click the Apply button next to its name in the General tab of the Preferences editor.

Creating a new pack

Packs can be created by hand, or jump-started by using the Save new... button in the General tab of the Preferences editor.

Distributing a pack

Eventually packs will be distributed identically to External Workbenches, through the Addon Manager. This feature is still under development. To install a pack manually, use git to clone the package repository into your FreeCAD data directory (the directory where your user.cfg file is located), in a subdirectory called "Preference Packs".