chiark / gitweb /
plugins: Support user configuration of default values
[cura.git] / resources / quickprint / README
1 Global print profiles are defined here. The format is :
2 option_*.ini
3 Material/material.ini
4 Material/option_*.ini
5 Material/Profile/profile.ini
6
7 All options must have 'option_' as prefix in their filename, and any subdirectory with a material.ini file in it will be considered a material. In that material directory, any option files will be specific to that material and any subdirectory with a profile.ini file will be considered a material profile (high quality, low quality, high strength, High clarity, etc..).
8
9 These global options and profiles will apply to all machines. For a machine specific quickprint settings, you need a directory with the machine_type as name and then the same format of files as above.
10 Those new machine specific materials and options will only override global materials and options if they are similarly named, so it can be used to add a single material for a machine without duplicating all of the global options and materials. In order to override a material or an option, the directory name (or filename for options) must match.
11
12 For example :
13 option_support.ini
14 option_brim.ini
15 ABS/material.ini
16 ABS/Low/profile.ini
17 ABS/High/profile.ini
18 my_machine_type/PLA/material.ini
19 my_machine_type/PLA/Normal/profile.ini
20
21 This would cause 'my_machine_type' typed machines to have both ABS (with Low and High quality) and PLA (with Normal quality only) materials, as well as support and brim options, while every other machine will only get the ABS material with both optins.
22 If the machine needs to override the ABS material, you can simply add a file :
23 my_machine_type/ABS/material.ini
24 to override the ABS setting, where you can either control the content of the material.ini, or add new options, or override global options for that specific material, or add new or override existing quality settings for ABS.
25
26 The profile.ini and material.ini files can contain 3 sections : [info], [profile] and [alterations] in which the [profile] and [alterations] sections contain respectively profile and alteration settings for printing, while the [info] section can contain the following keys :
27 name = string -> The name of the profile to show in the UI
28 disabled = true/false -> Disables this profile. Can be used to override a quality or material and disable it entirely. Default is False
29 always_visible = true/false -> If set to True and the profile.ini belongs to the single quality of a material, or to the single material of a machine, it will allow the quality or material to always be visible in the UI. Otherwise, the material or quality section will be hidden from the UI. Default is True
30 order = int -> The order to show this material or quality in the UI. Default is 999
31 profile_file = Relative path to a file which will be used for fetching the [profile] and [alterations] sections. In that case, the [profile] and [alterations] sections in the material.ini or profile.ini file are ignored
32
33 Profile options are applied in the following order : Material -> Quality -> Options. This allows you to group common settings for materials or to have options override everything else.
34
35 The quickprint profiles are searched for in the ~/.Cura/quickprint directory first, allowing users to override their machines quickprint settings.
36
37
38
39
40 Importing profiles will require:
41 Adding an [info] section
42 Renamed into profile.ini and move inside a High-speed directory
43 Create ABS/High/profile.ini, ABS/Low/profile.ini, ABS/Normal/profile.ini and ABS/Ulti/profile.ini files created, with their profile.ini only containing [info] disabled = true, so you would override and disable the global quickprint settings
44
45 Example:
46 lulzbot_TAZ_4_FlexyDuallyV2/ABS/profile.ini <-- only needs to contain an [info] section with 'name = ABS' and 'order = 0'
47 lulzbot_TAZ_4_FlexyDuallyV2/ABS/High-speed/profile.ini <-- copy that file into it, add a [info] section with name = High Speed