TBWinPE/RE Builder Settings
This tutorial covers the options and settings available in the TBWinPE/RE Builder program which is used to create the TBWinRE and TBWinPE boot media as well as update the installed Windows Recovery Environment (WinRE).
When TBWinPE/RE Builder is run for the first time it will import any existing TBWinPE.cmd or TBWinRE.cmd script settings found in the same folder. Saved settings will be imported if they were enabled for the script.
Program settings can be accessed by either clicking the Settings button on the Project Type screen or from the File menu.
General program options for TBWinPE/RE Builder.
Skip license step if license format appears valid: Enable this option to skip the wizard step asking for the Image for Windows license information if format of the imported or previously entered information appears valid.
Ignore warnings when checking requirements: Enable this option to ignore warnings issued when checking the build requirements. The wizard will automatically proceed to the next step. When disabled you will need to click Next to continue when there are warnings.
Allow MakeDisk to use USB drives larger than 64GB: By default, MakeDisk will not display USB drives larger than 64GB. Enable this option to allow their use. Important: Be extra careful to select the correct drive.
Download and include USB 3 drivers in Windows 7 RE/PE builds: Enable this option to have TBWinPE/RE Builder download commonly used USB 3 drivers for use in Windows 7 based builds (Windows 7 WinRE and Windows 7 AIK). If this option is disabled, you will not be prompted to download the drivers and they will not be included in the build (even if they were previously downloaded).
Skip installed WinRE status check: Enable to check the installed WinRE status and content when supported. Status shows if normal WinRE or TBWinRE and version of Image for Windows that's included. Note: Details may not be available in WIM files created using older versions of TBWinPE/RE Builder or TBWinPE.cmd/TBWinRE.cmd scripts. Requires Windows 8 or later.
These options are specific to booting a WIM file and apply to booting the WIM using the GUI (these options will not be used for /bootwim command line operations).
Prompt for restart: Will prompt to restart the system after the system has been configured to boot the selected WIM file.
Force restart: Forces the system to restart. This may cause data loss if you have unsaved files.
Ignore drive type: Ignores the drive type (allow unsupported drive types).
Match Windows drive letters: Attempts to match the Windows drive letter assignments during initialization after booting the WIM. Note that some drives, especially non-fixed types, may still be assigned different letters. Additionally, some drives may not be assigned if the Windows partition is not accessible after booting (e.g. encrypted) and may require manually assigning letters. This option requires a TBWinRE/PE WIM configured to use TBLauncher v1.21+ (TBLauncher is used by default in these builds).
Use DISM API if supported: Enable to use the DISM API on supported systems (Windows 7 or higher). Using the API usually reduces the build time. Functionality is the same whether enabled or disabled.
Use installed DISM: When this option is enabled the installed version of DISM will be used instead of the DISM included with the WinPE AIK/ADK files. This option only affects TBWinPE builds (TBWinRE always uses the installed DISM) and may be helpful in cases where a TBWinRE build can be created successfully, but there are DISM issues or errors when trying to create a TBWinPE build.
Use x64 DISM: Will use the x64 (64-bit) version of DISM instead of the x86 (32-bit version) on supported systems. Use of the DISM API will be disabled when this option is enabled. This option may be helpful in cases where a successful build can be created using the TBWinRE.cmd (or TBWinPE.cmd) script, but there are DISM issues or errors when trying to create a build with TBWinPE/RE Builder.
Force unsigned drivers: Enable to allow unsigned drivers to be added to builds.
Save log in build folder (DISM.log): Enable to save the DISM log output to the DISM.log file in the build folder (the DISM log output will not be saved to the default log used by Windows). For example, if the log is requested by support this option can be used to obtain it for a single build without needing to extract the desired entries from the default log. If this option is disabled the log entries will be saved to the default log.
Reset (clear) log on startup: Enable to clear the DISM log file when the program is started. This option applies only to the DISM.log file in the build folder (the default Windows DISM log file will not be reset). If this option is disabled the new log entries will be appended.
Create log file: Enable to have the program create the TBWinPE.log file.
Reset (clear) log when program starts: Enable to clear the log file when the program is started. If this option is disabled the new log entries will be appended.
To edit the TBWinPE.ini file directly click the Edit TBWinPE.ini link. The Settings dialog will close and the file will be opened in Notepad. If you would like the Settings dialog to reopen after closing Notepad, hold the Shift button down when you click the link.
Configure paths to the TeraByte programs, the Windows AIK/ADK source for TBWinPE builds, and the WinRE source for TBWinRE builds.
In most cases, it's not necessary to specify the installation paths. However, if a program (or source) is not automatically found or if you wish to specify a different location you can do so here. An example would be if you have the files from multiple AIK/ADK installations on the computer without them being installed.
TeraByte OS Deployment Tool Suite (TBOSDT): The TBOSDT version detected will be shown. If you are using the "Professional for BootIt" version you may need to enter your license details on the BootIt tab.
Windows AIK or ADK (TBWinPE only): The Windows AIK/ADK source detected will be shown. Leave blank to use the default/installation path. If you type in a path you can check it by clicking the Check path link.
WinRE Source (TBWinRE only): The WinRE source version will be shown (if found) as well as the current source selection (installed or user selected WIM). You can click the View details link to view the WIM details for the currently selected source. Using the installed source is recommended as that is usually the most current and offers the best support. However, if the installed WinRE wasn't found or a different version is required, you can browse and select an alternate WIM to use. You can also search the system for the WIM by selecting the File menu and then the Search for WinRE... item. Any WIM selected will be checked and warnings or errors will be displayed.
Important: When using an alternate WIM, depending on the version and architecture (both for Windows and the WIM), some files may not be available. If you create this type of build it is recommended to verify it boots properly and the functionality you require is supported.
By default, the boot files to use are automatically selected by the program. However, if there are booting issues, you can use the Boot files option to select an alternative. In situations where the selected boot files are missing or would be invalid, the program will select from the available valid files.
Pause build before unmounting WIM file: Enabling this option will pause the script after the TeraByte modifications have completed, but before the WIM file has been unmounted. This allows the user to browse the mount sub-folder to verify the contents or to add content to the build.
Use startnet.cmd to control program startup: Use this option to make the build use the startnet.cmd file to control program startup instead of the default (winpeshl.ini). The Command Prompt window will be the shell instead of TBLauncher. You can click the Edit link to edit the file. The startnet.cmd file used is saved in the config folder.
Enable "Press any key..." prompt when booting disc: This option only applies to TBWinPE builds. When enabled, this option will cause the TBWinPE CD to prompt the user to press an key before booting (just like the Windows installer CD/DVD does). If a key isn't pressed within a few seconds, the computer will boot normally from the hard drive.
Add drivers from "Drivers" folder: Enable this option to include any drivers in the Drivers folder. If disabled, drivers in the Drivers folder will not be included in the build.
Add installed storage and network drivers: Enable to add installed storage and network drivers to the build. (Some standard drivers will be skipped.) Using this option may allow you to avoid needing to manually place the necessary drivers into the "Drivers" folder. In some cases, the installed drivers may not be supported in the WinPE/RE environments and may still need to be added manually. Note that the build being created should be the same as the version of Windows (e.g. creating a TBWinRE build, creating a TBWinPE build using Windows 10 ADK on Windows 10, etc.).
Optimize WIM file: Enable this option to optimize/repack the build's WIM file after it's created. This can result in a reduced size if the source WIM file has been previously modified.
You can select one of the standard resolutions or enter any ChgRes parameters directly. Note that only 32bpp resolutions are supported on Windows 8 or higher. The default is to use 1024x768 (it's recommended to use 1024x768 or higher).
Important: Be aware that supported resolutions when booted into WinPE differ from those in Windows. Some systems may only support a very limited number of resolutions (UEFI systems often support only one) and some systems may not actually support all resolutions listed. Before specifying an alternate resolution you can verify the resolution you want to use is valid in WinPE by testing it with TBLauncher or ChgRes while booted to TBWinPE or TBWinRE (running ChgRes without any options will display usage information).
The screen DPI can be set to use the default, 96, 120, 144, or 192. This can be helpful when using FHD/QHD/QFHD displays that are not automatically detected correctly.
Select the desired time zone from the list.
Export Wi-Fi profiles: Enable to export the Wi-Profiles on the system for use in the build. The profiles contain the required information to connect to a specific Wi-Fi network. Only profiles that are currently connected or those that have been previously connected and are still retained by the system will be exported. Be aware that advanced/enterprise profile types may not be supported or function correctly in the TBWinRE environment.
If you wish to manually include a profile, export it to an .xml file, place it into the build's folder, and name it to comply with the following mask: Wi-Fi*.xml (e.g. Wi-Fi-Profile1.xml). This can be helpful when you need to include profiles that are not on the system creating the build. Profiles can be exported using an Administrator Command Prompt by running the following command (substitute the correct profile name for ProfileName): netsh wlan export profile name="ProfileName" key=clear
Note: Wi-Fi options and features are only supported in Windows 10 TBWinRE builds (using the latest version of Windows 10 is recommended for best support). Additionally, the appropriate driver for the Wi-Fi device used will need to be in included in the build. Some drivers are included by default, but many are not (again, using the latest version of Windows 10 is recommended for the most current built-in drivers). If using the option to include installed drivers doesn't work, you will need to manually add the drivers to the build. Some devices may not have drivers that install and function properly in the WinRE environment.
Export profile passwords as clear text: Select this option to export the profiles using a clear text password. This allows the profile to connect without needing to prompt for the password. If this option is not used the profile will be exported with an encrypted password, which will be cleared during Wi-Fi initialization.
Auto-connect connected profile(s) during Wi-Fi initialization: When enabled, TBLauncher's Wi-Fi initialization will attempt to connect to the exported profile(s) that were connected at the time the build was created. Profiles are available to connect manually regardless of this option's state.
Pointer speed: Select the desired point speed from the allowable range.
Enhance pointer precision: Select to enable enhanced precision and acceleration.
Switch primary and secondary buttons: Select to swap the mouse buttons.
Note: These options correspond to the standard Windows mouse settings and may not apply to all pointer devices. Pointer speed may be different in TBWinPE/RE than in Windows even with same setting. These settings are also available from TBLauncher's Tools menu (Mouse Settings...) and can be adjusted after booting.
Use this option to install a language pack. You can enter the language pack name or use the drop-down to select one. Note that a valid AIK/ADK source path must be specified for the list to be populated. The selected language pack will be installed and set as the default. This option only applies to TBWinPE builds.
Use this option to set the input locale to an alternate value. The locale selected must be supported by the current language pack being used.
Custom initialization, run and build scripts.
These scripts can be enabled in the build to more easily handle custom build, initialization and automation tasks. InitScript and RunScript are run from TBLauncher on start-up and provide an alternative to using the startnet.cmd script. Note: Custom builds using startnet.cmd that do not run TBLauncher can still use these scripts by calling them directly from startnet.cmd.
To use any of these scripts, enable the associated option. Click the Edit links to edit the files (these files are saved in the config folder). The InitScript and RunScript files will be copied into the \Windows\System32 folder of the build (X:\Windows\System32 when booted).
This script will be run before TBLauncher is displayed and just prior to whichever program is configured to auto-launch (e.g. Image for Windows). Note: If this script must not be run until after the standard WinPE initialization has completed, make sure to disable the TBLauncher Run initialization programs in the background option.
This script will be run on start-up (immediately after InitScript.cmd, if used) and will take the place of whichever program was configured to auto-launch (e.g. Image for Windows). Note: Custom builds using autorun.cmd will need to call it directly from RunScript.cmd to use it since it will not be run automatically (e.g. call %TBDrive%\TBData\autorun.cmd).
This script will be run during the build process, allowing custom build operations to be automated. When this option is enabled you can select to have the Command Prompt window hidden while the script runs by enabling the Hide Window option (commands that require user interaction should not be used in the script if the window is hidden as there will be no way to respond). If you select to hide the window you can also select to have the script output logged by enabling the Log output option. For an example of using BuildScript and details on the available environment variables, please see the following KB article: Adding Programs to TBWinPE/RE Builds.
Configuration options for TBLauncher.
This option controls which program is automatically launched when TBLauncher runs. Valid modes are:
WinPE - Image for Windows will be run. This is the default.
WinRE - The System Recovery Options program is run, if found. Otherwise, Image for Windows.
IFW - Image for Windows is run using the parameters specified. This mode is useful if you want to configure the build to auto-run Image for Windows and perform a specific task (e.g. create a backup or restore an image). Note: Starting with TBLauncher v1.17, environment variables specified in the parameters will be expanded.
Run WinPE initialization: When enabled, TBLauncher runs the WinPE initialization program (wpeinit) on startup. When disabled, you can run it manually from TBLauncher's File menu, if necessary. Disabling this option can speed up startup.
Run network initialization: When enabled, TBLauncher runs the network initialization on startup. When disabled, you can run it manually from TBLauncher's File menu, if necessary. This needs to be run if network access is required. Disabling this option can speed up startup.
Run Wi-Fi initialization: When enabled, TBLauncher runs Wi-Fi initialization on startup. This is only supported in Windows 10 TBWinRE builds. If the build option to auto-connect connected profiles was enabled, TBLauncher will attempt to connect the applicable profile(s). If the profile password was not exported as clear text you will be prompted for it when the connection is attempted. Note: There may be a delay of up to two minutes (more usually around one minute) during the initialization and first connection attempt.
Exported profiles are available via TBLauncher's Tools menu if you need to reconnect or switch to a different profile. Running the initialization again, if necessary, can be done from TBLauncher's File menu (connected profiles will be disconnected during this process).
Disable firewall: Enable this option to disable the Windows firewall. This is required to use multicasting with Image for Windows.
Run initialization programs in the background: Enable this option to make TBLauncher run the initialization programs in the background instead of waiting for them to finish before running Image for Windows or the System Recovery Options program. Depending on the system, there may still be a delay before Image for Windows or the System Recovery Options program is run. For example, if you have Image for Windows set to run automatically and it requires network access, you would want to disable this option so the network would be available when Image for Windows runs.
Search for TBWinRE/PE boot media drive after booting: When enabled, TBLauncher will search for the TBWinRE/TBWinPE boot media drive after booting. If found, the following applies:
The %TBDrive% environment variable will be set to the drive letter of the boot media and can be used in scripts, menu items, etc.
If the \TBData\TBLauncher.ini file exists on the drive it will be used instead of the built-in INI file. Note that the initialization options in the replacement file won't be used since initialization has already occurred. However, the Mode option and menu items will be used.
If the \TBData\autorun.cmd file exists on the drive it will be run, overriding the Mode setting. This allows easy configuration and use of an auto-run script without needing to recreate the build. Click Edit autorun.cmd to edit the file. Important: Care should be taken when using an auto-run script. Depending on the script, having it run on the wrong system or when not applicable may have undesirable consequences.
Starting with TBWinPE/RE Builder v1.15 and TBLauncher v1.17, each build is assigned a unique Build ID (a GUID, by default) and this ID is matched when searching for the boot media. Previously, it was recommended to have only one TBWinRE/TBWinPE boot media connected to the system (the one being booted) when using this option since searching would stop when the first match is found. This is still recommended if booting when multiple drives using the same ID are connected. If you need to revert to the old searching method you can add the MatchBuildID=0 option to the [Options] section of TBLauncher.ini. If you would like to specify a custom Build ID value you can add the BuildID option to the [Options] section of TBWinPE.ini (e.g. BuildID=Office 2018-09). Note that the Build ID value is case sensitive.
Searching for the boot media drive may slow down TBLauncher start-up by a few seconds due to time required by WinPE to initialize connected devices. If necessary, you can specify the maximum number of seconds (up to 20) to search for the boot drive (the default is 8 seconds). If the search time is not long enough the drive may not be found or it may only be found sporadically.
The actual boot drive will not be able to be found when booting to a boot file (TBWinRE.bin or TBWinPE.bin). This is because it no longer exists as a drive by the time the search takes place. However, if other matching TBWinRE/TBWinPE boot media is connected it will be found. For example, if you boot to a boot file and have your matching customized TBWinRE UFD connected it will be found and the TBLauncher.ini and autorun.cmd on it will be used.
Search for updated versions of the TeraByte programs: Enable to search for updated versions of the TeraByte programs. After booting, if enabled, TBLauncher will search the specified build paths and the default installation paths for the TeraByte programs (Image for Windows, TBIView, TBIMount, and TBOSDT). If a newer version is found it will be used instead of the version included in the build (user will be asked first if that option is selected). Important: It is recommended to update the boot media when you update Image for Windows. If you rely on this option and the drive containing the updated versions is not accessible (e.g. blank, corrupted, etc.) the search will fail and you may not be able to access your backups using the older version included in the build. Note: This search can be performed manually from the Tools menu of TBLauncher.
Run Narrator: Runs the Narrator accessibility program on startup. This is only supported in TBWinRE builds based on Windows 10 1703 or later. Narrator can also be run from TBLauncher's Tools menu or by using the standard Windows shortcut (Ctrl+WinKey+Enter).
Run On-Screen Keyboard: Runs the On-Screen Keyboard accessibility program on startup. This is only supported in TBWinRE and requires Windows 8.x/10. The On-Screen Keyboard can also be run from TBLauncher's Tools menu.
Create log file: Creates TBLauncher log file (log file is not created if TBLauncher is run in normal Windows).
Always on top: Keeps the TBLauncher window on top of other Windows. It is recommended to enable this option.
Open on mouse over: Opens TBLauncher when mouse is moved over its closed state window (no need to click on window). Note: Enabling this option will also enable Always on top.
Close on mouse leave: Closes TBLauncher when mouse leaves its open state window. Note: This option only applies when Open on mouse over is enabled.
The default delay before closing is 1.5 seconds. However, TBLauncher will still close normally when another window is clicked on or made active, regardless of the delay. If necessary, the delay can be adjusted by setting a value for MouseLeaveDelay in the [Options] section of TBLauncher.ini. Valid values are 1 to 40, each adding 250ms (default is 6). For example, if you need a 3 second delay you would use MouseLeaveDelay=12.
Transparency when closed: Allows the TBLauncher window to be transparent when closed (inactive). This can be helpful on smaller screens where output from other programs would normally be hidden by TBLauncher. Default is no transparency (slider all the way to the left).
Style: Sets the style used for the TBLauncher window. Selecting Small will make TBLauncher close to a much smaller window.
Manually edit TBLauncher.ini
To edit the TBLauncher.ini file directly click the Edit TBLauncher.ini link. The program will refresh the options after Notepad is closed.
Custom Menu Items
Menu entries can be added by manually editing the TBLauncher.ini file (saved in the config folder). Update the ItemCount variable (in the [Menu] section) and add a section for the new item (e.g. [Menu_Item_11]). Specify the Name, Path, WorkingDir (if applicable), Parameters (if applicable), and the Icon index value (usually 0). You can also use a custom icon by specifying the path to the file (supported file types: .ico, .exe, .dll). Note that, while specified, the icon index value is not applicable to .ico files. Examples:
Environment strings will be expanded (e.g. %ProgramFiles%). Please note that X: is the drive letter assigned to the booted WinPE ram drive (if you need to hard code it).
If the Search for TBWinRE/PE boot media drive after booting (FindBootDrive) option is used you can also use the %TBDrive% environment variable in the menu item paths to specify the boot media. This allows adding portable apps to the drive when the letter is unknown until booted.
For examples, please refer to the existing menu items in the file. There are also examples in the KB article Adding Programs to TBWinPE/RE Builds.
Enter your BootIt Collection or BootIt Bare Metal product key. This is used when TBOSDT Pro for BootIt is included in the build. If the name or product key is missing or not valid you may be prompted for it when you run TBOSDT.
Note that you only need to enter one license. For example, if you have purchased the BootIt Collection enter that license and leave the BootIt Bare Metal fields blank.
If you are not including TBOSDT Pro for BootIt you can leave these fields blank.
If the Warn if TBOSDT Pro for BootIt is included in build and license appears invalid option is not enabled the program will not warn if the license appears invalid when checking the build requirements.