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

General program options for TBWinPE/RE Builder.

Options

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).

Log

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.

DISM

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.

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.

Program Paths

Paths to the TeraByte programs and the Windows AIK/ADK.

In most cases, it's not necessary to specify the installation paths. However, if a program 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.

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.

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.

Build Options

Options

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.

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.

Screen

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.

Time Zone

Select the desired time zone from the list.

Language

Language Pack

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.

Input Locale

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.

Scripts

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).

InitScript.cmd

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.

RunScript.cmd

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).

BuildScript

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.

TBLauncher

Configuration options for TBLauncher.

Mode

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).

Startup

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.

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.

Options

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 custom scripts or menu items.

  • 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.

It's recommended to have only one TBWinRE/TBWinPE boot media connected to the system (the one being booted) when using this option since searching stops when the first match is found. Using this option will usually slow down TBLauncher start-up by 6-10 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 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 TBWinRE/TBWinPE boot media is connected it will be found. For example, if you boot to a boot file and have your 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.

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_10]). Specify the Name, Path, WorkingDir (if applicable), Parameters (if applicable), and the Icon index value (usually 0). Environment strings will be expanded (e.g. %ProgramFiles%). Please note that X: is the drive letter normally 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.

BootIt

BootIt Bare Metal License

Enter your 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 will be prompted for it when you run TBOSDT.

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.