Skip to content
Per Olofsson edited this page Sep 15, 2017 · 14 revisions

Templates are used to save and load the current build configuration.

Template files can also be used on the command line and allows you to specify several advanced options to be used when building an image. The expected file extension is .adtmpl, but since they're actually property lists .plist is also allowed.

Options

TemplateFormat (string)

Currently 1.1.

SourcePath (string)

The path to an OS X installer or InstallESD image.

OutputPath (string)

Path to where the dmg should be created. Can use variables.

VolumeName (string, default=Macintosh HD)

Specify system volume name. Can use variables.

VolumeSize (integer, default=automatic)

Specify system volume size, in GB.

ApplyUpdates (boolean, default=no)

True means include packages from the update profile (only available if building with the latest point release).

AdditionalPackages (array of strings)

Paths to additional packages to include when building.

IncludeTemplates (array of strings)

Paths to templates that will be included, allowing you to nest templates e.g. to share a common set of base packages. Templates are included in order, and later inclusions override options in previously included templates, while the parent template overrides options in its children. Additional packages are appended to the list, while other options are overridden.

When a template file includes both IncludeTemplates and AdditionalPackages keys, the items within the IncludeTemplates will be installed first, followed by the AdditionalPackages.

If you're using relative paths, make sure they point to where you expect them to. They are relative to the current working directory when AutoDMG runs. This is useful if you're working on the command line, but if you use templates in the GUI it's probably safest to use absolute paths.

FinalizeAsrImagescan (boolean, default=yes)

Controls whether asr imagescan should be run on the image.

Filesystem (string, default=apfs)

The filesystem to use for 10.13+ images, apfs or hfs.

Variables

The following variables are available for use in OutputPath and VolumeName:

Variable Value
%OSNAME% Mac OS X
%OSVERSION% 10.9.3
%OSBUILD% 13D65
%DATE% 140515
%TIME% 100823

Sample Template

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
    <plist version="1.0">
    <dict>
    	<key>TemplateFormat</key>
    	<string>1.0</string>
    	<key>SourcePath</key>
    	<string>/Users/Shared/Sources/Install OS X Mavericks 10.9.3 13D65/Install OS X Mavericks.app</string>
    	<key>OutputPath</key>
    	<string>/Users/Shared/BaseImage-%OSVERSION%-%OSBUILD%.hfs.dmg</string>
    	<key>VolumeName</key>
    	<string>Macintosh HD</string>
    	<key>ApplyUpdates</key>
    	<true/>
    	<key>AdditionalPackages</key>
    	<array>
    		<string>/Users/Shared/CustomPackages/AppleSetupDone.pkg</string>
    		<string>/Users/Shared/CustomPackages/Absolute Manage LoginWindow/AMLoginWindow-1.7-20131004.pkg</string>
    	</array>
    	<key>IncludeTemplates</key>
    	<array>
    		<string>BaseSoftware.adtmpl</string>
    	</array>
    </dict>
    </plist>