Configuration#

The Playbook configuration, contained inside playbook.conf, specifies numerous properties for a given Playbook. This includes properties like the name, creator, and version of the Playbook.

Structure#

The playbook.conf file must be formatted as XML. See the below example as a formatting guide.

<?xml version="1.0" encoding="utf-8"?>
<Playbook>
    <Name>Example PB</Name>
    <Username>Testing Inc.</Username>
    <ShortDescription>Official Example Playbook for Windows 11</ShortDescription>
    <Title>Windows 11 Example Playbook</Title>
    <Description>This Playbook will test your installation&#xD;&#xA;&#xD;&#xA;The testing process makes heavy alterations to your installation.</Description>
    <Details>Official Example Playbook for Windows 11. Testing your system.</Details>
    <Version>0.1</Version>
    <UniqueId>UNIQUE ID</UniqueId>
    <SupportedBuilds>
        <string>22000</string>
        <string>22621</string>
    </SupportedBuilds>
    <Requirements>
        <Requirement>Internet</Requirement>
        <Requirement>NoPendingUpdates</Requirement>
        <Requirement>DefenderDisabled</Requirement>
        <Requirement>NoAntivirus</Requirement>
    </Requirements>
    <ProgressText>Reticulating splines, improving the user interface experience, installing replacement apps, and testing the system.</ProgressText>
    <Git>https://git.example.com/TestingInc/Example-PB</Git>
</Playbook>

Required Properties#

Paramater	Description	Type
`Name`	Name of the Playbook.	string
`Username`	Username for the Playbook, displayed in various locations.	string
`UniqueId`	A unique UUIDv4 (GUID) identifier	GUID
`ShortDescription`	Used in the Playbooks side-bar.	string
`Title`	Used for the primary pages.	string
`Description`	Used in the first introductory page for the Playbook.	string
`Details`	Used in the updates window description box.	string
`Version`	Version of the Playbook. Must be in one of the following formats: `1` `0.1` `0.0.1`	string

Optional Properties#

Paramater	Description	Type
`SupportedBuilds`	Builds supported by the Playbook.	integer array
`FeaturePages`	Feature pages to be included in a Playbook.	FeaturePage array. See Custom Features
`Requirements`	Requirements necessary for the Playbook.	requirement array. See Requirements.
`ProductCode`	Product code for the Playbook, used for verification with the AME Wizard.	integer
`ProgressText`	Used in the progress window.	string
`Git`	Used for fetching updates, as well as, if verified, a clickable Git button in the updates window.	string
`Website`	If the Playbook is verified, this is used for the verification dropdown button.	string
`DonateLink`	If the Playbook is verified, this is used for Donate button in the updates window.	string
`InstallGuide`	Optionally used in conjunction with the `FreshInstall` requirement to specify a custom Windows installation documentation web page.	string
`PasswordReplace`	Specifies the password to replace Microsoft accounts with after converting them to local accounts.	string
`UseKernelDriver`	Specifies whether or not to use the kernel driver for higher privileges, unnecessary in most cases.	bool