This article covers several methods to add programs, scripts, and other files to the Image for Windows TBWinPE\/RE boot media using TBWinPE\/RE Builder. <\/p>\r\n
If you are unfamiliar with the process of creating the TBWinPE\/RE boot media, you may find it helpful to create a standard build before attempting a custom build. Tutorials for creating the TBWinPE\/RE boot media can be found in the following how-to articles:<\/p>\r\n
\r\nCreating a TeraByte Recovery Environment, WinRE Boot Disc, or UFD Containing Image for Windows (TBWinRE)<\/a><\/p>\r\n
Creating a TeraByte WinPE Boot Disc Containing Image for Windows (TBWinPE)<\/a><\/p>\r\n <\/blockquote>\r\n
Note:<\/strong> Adding programs and files can also be done using the TBWinPE.cmd and TBWinRE.cmd scripts. However, those scripts are now obsolete and TBWinPE\/RE Builder should be used instead.<\/p>\r\n
<\/p>\r\n
Requirements & Considerations<\/strong><\/font><\/p>\r\n
\r\n
- The program being added must run in the standard WinPE\/RE environment, which is very limited compared to normal Windows. Many programs many not run at all or have missing\/broken features due to lack of support. If you are unsure if the program you wish to add will run in WinPE\/RE you can try it using Method 1 (below) before creating a custom build that includes it.
\r\n
\r\n <\/li>\r\n- The program must be the correct architecture for the build. If creating a 64-bit (x64) build, the program being added must be 64-bit. If creating a 32-bit (x86) build, the program being added must be 32-bit. Some programs may only be available as 32-bit versions and since almost all current Windows installations are 64-bit this means that most TBWinRE builds would also be 64-bit. In this case, if you require a 32-bit (x86) build you will need to create a TBWinPE build using an older Windows 10 ADK.
\r\n
\r\n <\/li>\r\n- When adding scripts, the normal types are CMD and TBS (assuming TBOSDT Pro is also included in the build). Other types of scripts may not be supported in the WinPE\/RE environment. For example, you might include a backup-win11.cmd script which runs Image for Windows and backs up your Windows 11 installation.
\r\n
\r\n <\/li>\r\n- In the methods below, a USB flash drive (UFD) is used for the boot media as it offers more flexibility than read-only media (e.g., CD\/DVD). Rewritable media, such as a UFD, is recommended when first creating, configuring, and testing the build even if it will eventually be put on read-only media when finalized.
\r\n
\r\n <\/li>\r\n- TBWinRE files are automatically installed with Image for Windows on Windows 7 or later. However, when creating a customized build, you may find copying the files to an alternate folder with standard user-level permissions will make the process easier. If creating multiple custom builds it may be beneficial to place each one in a separate folder. Using an alternate folder also gives you control over when the build files are updated since updating Image for Windows won't replace them. In the examples below, the TBWinRE files are located in C:\TBWinRE.
\r\n
\r\n <\/li>\r\n- While both plugins and the BuildScript option can be used to include programs, scripts, and other files, using a plugin provides more features, options, and flexiblity than BuildScript. Creating a plugin is a simple process and usually only requires a few lines of code to include a simple program or script. In addition to the example shown in this article, you can refer to the following for more information on using plugins:
\r\n TBWinPE\/RE Builder Settings | Plugins<\/a>
\r\n Plugins Manual (PDF)<\/a>
\r\n
\r\n <\/li>\r\n- The methods shown in this article are basic examples -- custom builds are not limited to these particular scenarios.<\/li>\r\n <\/ul>\r\n
<\/p>\r\n
Contents<\/strong><\/font><\/p>\r\n
\r\nMethod 1 - Standard Build with Program on UFD<\/a><\/p>\r\n
Method 2 - Custom Build with Program on UFD (using BuildScript)<\/a><\/p>\r\n
Method 3 - Custom Build with Program Included in Build (using BuildScript)<\/a><\/p>\r\n
Method 4 - Custom Build with Program Included in Build (using a Plugin)<\/a><\/p>\r\n
Appendix<\/a><\/p>\r\n
<\/p>\r\n <\/blockquote>\r\n
Method 1 - Standard Build with Program on UFD<\/strong><\/font><\/span><\/p>\r\n
This method provides an easy way to manually add a program to the boot media.\r\n <\/p>
\r\n
- Create the TBWinPE\/RE build normally and save it to a UFD.<\/li>\r\n
- Create a folder on the UFD to hold the program files.<\/li>\r\n
- Copy the program files into the folder.<\/li>\r\n
- Boot to the UFD.<\/li>\r\n
- Browse to the program on the UFD and run it. This can be done directly from TBLauncher (File<\/em> | Run<\/em>) or you can open a Command Prompt and run it from there.<\/li>\r\n <\/ol>\r\n
Alternatively, when just testing if the program will run from TBWinPE\/RE you could skip copying the program files to the UFD and instead run the program directly from a local drive (e.g., a folder on your Windows partition or data partition). <\/p>\r\n
Note:<\/strong> When using this method any files copied to the UFD will be lost when the UFD is updated to a new build using MakeDisk. To avoid this, update the UFD using TBWinPE\/RE Builder or by manually by copying the contents of the new build's ISO folder to the root folder of the UFD (replacing existing files) instead of running MakeDisk. Refer to the following KB article for more details: Manually Updating the TBWinPE\/RE Boot Media<\/a><\/p>\r\n
<\/p>\r\n
Method 2 - Custom Build with Program on UFD (using BuildScript)<\/strong><\/font><\/span><\/p>\r\n
This method is similar to Method 1, but with several enhancements:\r\n <\/p>
\r\n
- Program is added to TBLauncher's menu, which can optionally be tweaked\/configured without recreating the build.<\/li>\r\n
- Program files can be updated simply by copying the files to the UFD (recreating the build isn't necessary).<\/li>\r\n
- Program files can optionally be updated automatically when a new build is created.<\/li>\r\n <\/ul>\r\n
Instructions:\r\n <\/p>
\r\n
- Copy the files for the program being added to a sub-folder in the ISO<\/font> folder of the TBWinRE folder. The ISO folder won't exist if a build hasn't previously been created. If necessary, create the ISO folder before creating the folder for the program. C:\TBWinRE\ISO\CustomProg<\/font> is used here with the program consisting of program.exe<\/font> and supporting files.
\r\n
\r\n <\/li>\r\n- Add the program to the TBLauncher menu:
\r\n
\r\n\r\n
- Run TBWinPE\/RE Builder and go into Settings<\/strong>. Select the TBLauncher<\/strong> tab. Click the Edit TBLauncher.ini<\/strong> link at the bottom of the window. This will open the file in Notepad.
\r\n
\r\n <\/li>\r\n- Scroll through the file and locate the [Menu]<\/font> section. A new menu entry will be added so increment the ItemCount<\/font> value. In this example, there are already 10 menu items so the new one will be 11.
\r\n
\r\n [Menu]\r\n ItemCount=11<\/strong><\/font>
\r\n
\r\n <\/li>\r\n- Scroll to the end of the file and add the menu entry for the program being added.
\r\n[Menu_Item_11]\r\n Name=Custom Program
\r\n Path=%TBDrive%\CustomProg\program.exe
\r\n WorkingDir=
\r\n Parameters=
\r\n Icon=0<\/strong><\/font>
\r\n
\r\n Keeping the program name short is recommended due to limited space in the menu. If the program requires a working directory or parameters you can set those as well.\r\n
\r\n
\r\n By default, the icon is retrieved from the program file. With TBLauncher 1.15+ you can use a custom icon by specifying the path to the file (supported file types: .ico, .exe, .dll). If the icon file is not found or there is an error the icon from the program will be used. For example:
\r\n
\r\n Icon=0,%TBDrive%\CustomProg\program.ico<\/strong><\/font>
\r\n
\r\n Note:<\/strong> The icon index value is specified (0, above), but is not applicable to .ico files. <\/p>\r\n <\/li>\r\n- Save TBLauncher.ini and close Notepad.
\r\n
\r\n <\/li>\r\n- Enable the Search for TBWinRE\/PE boot media drive after booting<\/strong> option. This will locate the UFD once it's booted and set the %TBDrive%<\/strong> environment variable used for the menu item.
\r\n
\r\n <\/li>\r\n- Click OK<\/strong> to close Settings.
\r\n
\r\n <\/li>\r\n <\/ol>\r\n <\/li>\r\n- [Optional]<\/em><\/strong> Copy the TBLauncher.ini file from the build's config<\/font> folder to the ISO\TBData<\/font> folder. This allows changes to the menu items (descriptions, paths, etc.) to be made by editing the file in the boot media's TBData folder (no need to recreate the build). In this example, you would copy C:\TBWinRE\config\TBLauncher.ini<\/font> to C:\TBWinRE\ISO\TBData<\/font>. Keep in mind that if you edit the original file you will also need to update the copy (this could be scripted if you want it to happen automatically). If changes are made to the file on the boot media and you don't want them lost when recreating the media, copy the modified file to the build's ISO\TBData folder.
\r\n
\r\n Note:<\/strong> The TBLauncher Search for TBWinRE\/PE boot media drive after booting<\/strong> option must be enabled in the build for this feature to function (see Step 2e). For boot media that has already been created with this option enabled, the feature can be used by simply copying the TBLauncher.ini file to the TBData folder on the boot media.
\r\n
\r\n <\/li>\r\n- [Optional]<\/em><\/strong> Configure the BuildScript to copy the program files to the ISO\CustomProg<\/font> folder. This allows the files to automatically be copied into the build each time it's created. For example, if the program files have been updated in the source location the build would include those updated files.
\r\n
\r\n\r\n
- Open Settings<\/strong>. Select the Scripts<\/strong> tab.
\r\n
\r\n <\/li>\r\n- Enable the Use BuildScript.cmd<\/strong> option.
\r\n
\r\n <\/li>\r\n- Click the Edit<\/strong> link next to the BuildScript option. If the script file doesn't already exist you will be prompted to create it. The script will open in Notepad for editing. Add the commands necessary to copy the program files from their source location to the ISO\CustomProg<\/font> folder. In this example, the source folder is F:\CustomProgSource<\/font>. The script will first create the sub-folder in the ISO folder (in case it doesn't exist) and then copy all the files from the source folder to the new program folder.
\r\n
\r\n :: Add script commands after this line
\r\n md "%TBWinPE_BuildPath%\ISO\CustomProg" 2> nul
\r\n copy "F:\CustomProgSource\*.*" "%TBWinPE_BuildPath%\ISO\CustomProg"<\/strong><\/font>
\r\n
\r\n <\/li>\r\n- If configuring Step 3, you could have the script automatically copy the TBLauncher.ini file from the build's config folder to the ISO\TBData folder.
\r\n
\r\n :: Copy TBLauncher.ini to TBData
\r\n copy "%TBWinPE_ConfigPath%\TBLauncher.ini" "%TBWinPE_BuildPath%\ISO\TBData"<\/strong><\/font>
\r\n
\r\n <\/li>\r\n- Save BuildScript.cmd and close Notepad.
\r\n
\r\n <\/li>\r\n- Click OK<\/strong> to close Settings.
\r\n
\r\n <\/li>\r\n <\/ol>\r\n <\/li>\r\n- Finish creating the build normally and use MakeDisk to create the boot media on a UFD.
\r\n
\r\n <\/li>\r\n- Boot the UFD and verify the custom program shows up in the TBLauncher menu and runs properly. If any tweaks\/corrections are required, edit the relevant files on the UFD and reboot to test. When finalized, update the affected build files with the revised versions so the next build will use them.<\/li>\r\n <\/ol>\r\n
<\/p>\r\n
Method 3 - Custom Build with Program Included in Build (using BuildScript)<\/strong><\/font><\/span><\/p>\r\n
This method is similar to Method 2, but with several major differences:\r\n <\/p>
\r\n
- Program is added to TBLauncher's menu, but modifying the menu requires recreating the build.<\/li>\r\n
- Program is included in the build (packed in the WIM file) and will exist on the WinPE RAM disk (drive X:) when booted.<\/li>\r\n
- Updating Program files requires recreating the build.<\/li>\r\n <\/ul>\r\n
Instructions:\r\n <\/p>
\r\n
- Make note of the folder containing the program files that will be added to the build. F:\CustomProgSource<\/font> is used here with the program consisting of program.exe<\/font> and supporting files.
\r\n
\r\n <\/li>\r\n- Add the program to the TBLauncher menu:
\r\n
\r\n\r\n
- Run TBWinPE\/RE Builder and go into Settings<\/strong>. Select the TBLauncher<\/strong> tab. Click the Edit TBLauncher.ini<\/strong> link at the bottom of the window. This will open the file in Notepad.
\r\n
\r\n <\/li>\r\n- Scroll through the file and locate the [Menu]<\/font> section. A new menu entry will be added so increment the ItemCount<\/font> value. In this example, there are already 10 menu items so the new one will be 11.
\r\n
\r\n [Menu]\r\n ItemCount=11<\/strong><\/font>
\r\n
\r\n <\/li>\r\n- Scroll to the end of the file and add the menu entry for the program being added.
\r\n[Menu_Item_11]\r\n Name=Custom Program
\r\n Path=%ProgramFiles%\CustomProg\program.exe
\r\n WorkingDir=
\r\n Parameters=
\r\n Icon=0<\/strong><\/font>
\r\n
\r\n Keeping the program name short is recommended due to limited space in the menu. If the program requires a working directory or parameters you can set those as well.\r\n
\r\n
\r\n Since the drive letter of the booted RAM drive is known (X:) you could specify it instead of the %ProgramFiles% environment variable. For example:
\r\n
\r\n Path=X:\Program Files\CustomProg\program.exe<\/strong><\/font>\r\n
\r\n
\r\n By default, the icon is retrieved from the program file. With TBLauncher 1.15+ you can use a custom icon by specifying the path to the file (supported file types: .ico, .exe, .dll). If the icon file is not found or there is an error the icon from the program will be used. For example:
\r\n
\r\n Icon=0,%ProgramFiles%\CustomProg\custom.ico<\/strong><\/font>
\r\n
\r\n Note:<\/strong> The icon index value is specified (0, above), but is not applicable to .ico files.\r\n <\/p>\r\n <\/li>\r\n- Save TBLauncher.ini and close Notepad.
\r\n
\r\n <\/li>\r\n <\/ol>\r\n <\/li>\r\n- Configure the BuildScript to copy the program files to the mount\Program Files\CustomProg<\/font> folder.
\r\n
\r\n\r\n
- While still in Settings<\/strong>, select the Scripts<\/strong> tab.
\r\n
\r\n <\/li>\r\n- Enable the Use BuildScript.cmd<\/strong> option.
\r\n
\r\n <\/li>\r\n- Click the Edit<\/strong> link next to the BuildScript option. If the script file doesn't already exist you will be prompted to create it. The script will open in Notepad for editing. Add the commands necessary to copy the program files from their source location to the mount\Program Files\CustomProg<\/font> folder. In this example, the source folder is F:\CustomProgSource<\/font>. The script will first create the CustomProg<\/font> sub-folder and then copy all the files from the source folder to the new program folder.
\r\n
\r\n :: Add script commands after this line
\r\n md "%TBWinPE_MountPath%\Program Files\CustomProg" 2> nul
\r\n copy "F:\CustomProgSource\*.*" "%TBWinPE_MountPath%\Program Files\CustomProg"<\/strong><\/font>
\r\n
\r\n <\/li>\r\n- Save BuildScript.cmd and close Notepad.
\r\n
\r\n <\/li>\r\n- Click OK<\/strong> to close Settings.
\r\n
\r\n <\/li>\r\n <\/ol>\r\n <\/li>\r\n- Finish creating the build normally and use MakeDisk to create the boot media on a UFD.
\r\n
\r\n <\/li>\r\n- Boot the UFD and verify the custom program shows up in the TBLauncher menu and runs properly. If any tweaks\/corrections are required, edit the relevant files and recreate the build and boot media.<\/li>\r\n <\/ol>\r\n
<\/p>\r\n
Method 4 - Custom Build with Program Included in Build (using a Plugin)<\/strong><\/font><\/span><\/p>\r\n
This method is similar to Method 3, but uses a plugin to add the program to the build.<\/p>\r\n
Instructions: <\/p>\r\n
\r\n
- Make note of the folder containing the program files that will be added to the build. F:\CustomProgSource<\/font> is used here with the program consisting of program.exe<\/font> and supporting files.
\r\n
\r\n <\/li>\r\n- Create new plugin for adding the program:
\r\n
\r\n\r\n
- Run TBWinPE\/RE Builder and go into Settings<\/strong>. Select the Plugins<\/strong> tab. More information on the Plugins tab can be found in the tutorial<\/a>.
\r\n
\r\n <\/li>\r\n- Click the Create plugin<\/strong> button. This will open the Create Plugin dialog.
\r\n
\r\n <\/li>\r\n- In the Details section, fill in the Plugin Name, Author, and Description fields as desired.
\r\n
\r\n <\/li>\r\n- In the Plugin File field, enter the filename for the plugin (e.g., addprog) or click the Browse...<\/strong> button and create a new sub-folder for the plugin. By default, new plugins will be saved in the build's Plugins folder. However, if the plugin will consist of multiple files, having it in its own sub-folder is recommended.
\r\n
\r\n <\/li>\r\n- In the Support Options section, enable the desired build modes, build types, and architectures that will be supported. At the very least, make sure the ones you need for your particular build are enabled. These settings can always be changed later by editing the plugin file.
\r\n
\r\n <\/li>\r\n- Click the Create<\/strong> button to create the plugin and return to the Plugins tab.
\r\n
\r\n <\/li>\r\n <\/ol>\r\n <\/li>\r\n- Back on the Plugins<\/strong> tab, select (highlight) the new plugin in the list and then click the Edit plugin<\/strong> button. The plugin file will open in Notepad.
\r\n
\r\n <\/li>\r\n- Add the code to the plugin that will add your program:
\r\n
\r\n\r\n
- Scroll to the [Code]<\/strong> section and the sub Process<\/strong> line (this is at the end of the file). The new code will be placed in the Process<\/strong> subroutine (between the sub Process<\/strong> and end sub<\/strong> lines).
\r\n
\r\n <\/li>\r\n- Edit the subroutine code to be as shown below, adjusting the folders and filenames to be correct for the program being added. Lines that start with \/\/<\/strong><\/font> are comments.
\r\n
\r\n sub Process
\r\n log "Adding Custom Program to build..."
\r\n \/\/ create folder for program files\r\n
\r\n FolderCreate "@tbMountPath@\Program Files\CustomProg"
\r\n \/\/ copy program files from source location\r\n
\r\n FileCopy "F:\CustomProgSource\*.*" "@tbMountPath@\Program Files\CustomProg"
\r\n \/\/ add program to TBLauncher's menu
\r\n MenuItem "Custom Program" "X:\Program Files\CustomProg\program.exe"
\r\n end sub\r\n <\/strong><\/font>
\r\n
\r\n Note:<\/strong> The FolderCopy<\/strong><\/font> <\/strong>command could also be used to copy the program's folder and sub-folders into the build. This example simply copies all the files from the specified folder.
\r\n
\r\n <\/li>\r\n- When the changes are complete, save the file and close Notepad.
\r\n
\r\n <\/li>\r\n <\/ol>\r\n <\/li>\r\n- In General Options, enable the Include plugins in build<\/strong> option. If using Developer Mode to test the plugin, also enable the Enable Developer Mode (DevMode)<\/strong> option.
\r\n
\r\n <\/li>\r\n- In the plugins list, enable your new plugin.
\r\n
\r\n <\/li>\r\n- Click OK<\/strong> to save and close Settings.
\r\n
\r\n <\/li>\r\n- Finish creating the build normally and use MakeDisk to create the boot media on a UFD.
\r\n
\r\n <\/li>\r\n- Boot the UFD and verify the custom program shows up in the TBLauncher menu and runs properly. If any tweaks\/corrections are required, edit the relevant files and recreate the build and boot media.<\/li>\r\n <\/ol>\r\n
The plugin example above covers the basics. Additional code could be added to do error checking, set up configuration options (such as the source path), and much more.<\/p>\r\n
<\/p>\r\n
\r\nAppendix<\/font><\/strong><\/p>\r\n
Custom Build Tips<\/strong><\/font><\/p>\r\n
\r\n
- You can change the order of the items shown in the TBLauncher menu by changing the item number for the entry. For example, if you want your custom program to be the first menu item, use Menu_Item_1 for its section and renumber the other items (Image for Windows becomes Menu_Item_2, etc.).
\r\n
\r\n <\/li>\r\n- Use the Pause build before unmounting WIM file<\/strong> option (on Build Options<\/em> tab in Settings<\/em>) to verify the changes are correct in the build before it's unmounted. If necessary, you can tweak things before continuing. If browsing or working in the mount<\/font> folder be sure to browse out of it, etc. before continuing so Windows doesn't prevent the unmount from succeeding.
\r\n
\r\n <\/li>\r\n- When using a plugin, enable Developer Mode<\/strong> to allow pausing the build after the plugin runs so it can be edited, tested, and rerun, if necessary. Refer to the Plugins Manual (PDF)<\/a> for details on using Developer Mode.
\r\n
\r\n <\/li>\r\n- Several example plugins are available for download on the Plugins tab. These, and the other plugins, can be examined to see how programs and files can be added to builds.
\r\n <\/li>\r\n <\/ul>\r\nUsing Build Variables (Plugins)<\/font><\/strong><\/p>\r\n
\r\nTBWinPE\/RE Builder provides many built-in variables for use in plugins. Several are listed below:<\/p>\r\n
tbArch<\/strong>: The architecture of the build being created (x86<\/strong>, AMD64, ARM64<\/strong>).
\r\n tbx64<\/strong>: Will be 64<\/strong> if creating a 64-bit build. Empty string for 32-bit.
\r\n tbBuildPath<\/strong>: Complete path to project folder.
\r\n tbConfigPath<\/strong>: Complete path to project's config<\/font> folder.
\r\n tbMountPath<\/strong>: Complete path to project's mount<\/font> folder.
\r\n tbPluginPath<\/strong>: Complete path to plugin's folder.
\r\n tbMode<\/strong>: Build mode (TBWinPE<\/strong>, TBWinRE<\/strong>).
\r\n tbRegDefault<\/strong>: Default user registry hive mount path.
\r\n tbRegSoftware<\/strong>: Software registry hive mount path.
\r\n tbRegSystem<\/strong>: System registry hive mount path.<\/p>\r\n<\/blockquote>\r\nUsing Build Environment Variables (BuildScript)<\/font><\/strong><\/p>\r\n
\r\nTBWinPE\/RE Builder assigns several environment variables for use in BuildScript.cmd:<\/p>\r\n
TBWinPE_Arch<\/strong>: The architecture of the build being created (x86<\/strong>, AMD64<\/strong>).
\r\n TBWinPE_x64<\/strong>: Will be assigned 64<\/strong> if creating a 64-bit build. Unassigned for 32-bit.
\r\n TBWinPE_BuildPath<\/strong>: Complete path to project folder.
\r\n TBWinPE_ConfigPath<\/strong>: Complete path to project's config<\/font> folder.
\r\n TBWinPE_MountPath<\/strong>: Complete path to project's mount<\/font> folder.
\r\n TBWinPE_Mode<\/strong>: Build mode (TBWinPE<\/strong>, TBWinRE<\/strong>).