Private Preference Packs: Difference between revisions

From FreeCAD Documentation
(Quick overview of using custom repo's for preference packs)
(Removed Tutorials_navi)
 
(26 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages/>
<translate>
<translate>
==Overview==<!--T:1-->


<!--T:2-->
<!--T:1-->
{{TutorialInfo
Private Preference Packs can be added by adding custom github repositories to the Addon Manager. This allows testing or simply private usage.
|Topic=Custom Repositories
|Level=Intermediate/Advanced
|Author=drmacro
|FCVersion=1.0 or above
|Files=[TBD]
}}


==Setup Custom Repositories== <!--T:3-->
==Overview== <!--T:2-->

<!--T:3-->
Private [[Preference_Packs|preference packs]] can be added by adding custom github repositories to the [[Std_AddonMgr|Addon manager]]. This allows testing or simply private usage.


<!--T:4-->
<!--T:4-->
See also [[Preference_Packs|Preference Packs]].
Begin by setting custom repositories in the Edit>Preferences Addon Manager dialog.


==Add custom repository== <!--T:5-->
[[File:Preferences_AM.png|400px|thumb|frame|left|Preferences Addon Manager Dialog]]

==Add Custom Repository==<!--T:5-->


<!--T:6-->
<!--T:6-->
Begin by adding a custom repository. Go to {{MenuCommand|Edit → Preferences → Addon manager options}} and click the {{Button|+}} button to open the {{MenuCommand|Custom repository}} dialog.
[[File:Preferences AM addrepo.png|400px|thumb|frame|left|Custom repository add button]]


</translate>
==Custom Repository Dialog==
[[File:Preferences_AM_addrepo.png|400px]]
<translate>


===Custom repository dialog=== <!--T:7-->

<!--T:8-->
Enter the URL of the github repository and the branch.

</translate>
[[File:Preferences_AM_customrepo.png]]
<translate>

<!--T:9-->
In this example I have added:

<!--T:10-->
https://github.com/macdroid53/ZolkoBase

<!--T:11-->
Click {{Button|OK}} when complete.

===Preferences with custom repository added=== <!--T:12-->

</translate>
[[File:Preferences_AM_after.png|400px]]
<translate>

<!--T:13-->
Click {{Button|OK}} when complete.

==Custom preference pack in Addon manager== <!--T:14-->

<!--T:15-->
The custom pack can now be installed using {{MenuCommand|Tools → Addon manager}}.

</translate>
[[File:PreferencePack_in_AM.png|400px]]
<translate>


==Apply the preference pack== <!--T:16-->


<!--T:17-->
Once installed go to {{MenuCommand|Edit → Preferences → General}}, find the preference pack, and click {{Button|Apply}}.
Follow any instructions offered.


</translate>
</translate>
[[File:PeferencesPP_apply.png|400px]]

Latest revision as of 13:27, 14 April 2023

Other languages:
Tutorial
Topic
Custom Repositories
Level
Intermediate/Advanced
Time to complete
Not provided
Authors
drmacro
FreeCAD version
1.0 or above
Example files
[TBD]
See also
None

Overview

Private preference packs can be added by adding custom github repositories to the Addon manager. This allows testing or simply private usage.

See also Preference Packs.

Add custom repository

Begin by adding a custom repository. Go to Edit → Preferences → Addon manager options and click the + button to open the Custom repository dialog.

Custom repository dialog

Enter the URL of the github repository and the branch.

In this example I have added:

https://github.com/macdroid53/ZolkoBase

Click OK when complete.

Preferences with custom repository added

Click OK when complete.

Custom preference pack in Addon manager

The custom pack can now be installed using Tools → Addon manager.

Apply the preference pack

Once installed go to Edit → Preferences → General, find the preference pack, and click Apply. Follow any instructions offered.