| key=value ... | The name of one or more keys and, optionally, new values for the keys. A single xbconfig command line can contain multiple key-value pairs. The following tables show the allowed keys:
Audio
|
Key |
Description |
| AudioBitstreamFormat | Audio bitstream output setting. Possible values are 'DTS', 'DolbyDigital', or 'DolbyAtmos'. |
| HDMIAudio | The HDMI audio output setting. Possible values are 'Off', 'Stereo', '5.1', '7.1', or 'Bitstream'. |
| OpticalAudio | The Optical audio output setting. Possible values are 'Off', 'Stereo', or 'Bitstream'. |
Debugging
|
Key |
Description |
| ConsoleMode { Default | XboxOne | XboxOneS | XboxOneXRetail | XboxOneXDevkit | XboxOneXDevkit44 } | This setting allows developers to test their game against a range of hardware performance conditions. Default means the actual hardware. For example, on an Xbox One X devkit this is equivalent to XboxOneXDevkit |
| CrashDumpType | Specifies the type of devkit dumps to collect if a process crashes. The following table lists the allowed values:
|
Value |
Description |
|---|
| none | No local crash dumps are collected. |
| triage | Provides stack traces for all threads, OS handles active, thread information, and information on unloaded modules. Triage dumps are scrubbed of personally identifiable information. |
| mini | Includes data segments from all loaded modules, security token related data, thread information, information on the unloaded modules. Mini dumps are not scrubbed of personally identifiable information. |
| heap | Provides a full user mode crash dump of all the processes and memory running in the game OS. While this option provides the most information, it may take a few minutes to write out all of the data. |
|
| DebugMemoryMode | Assigns ownership to the two different regions of debug memory. The following table lists the allowed values:
|
Value |
Description |
|---|
| PIX | The 512 MB region is available to PIX. The 768 MB region is not available. |
| PIX_Tool | This is the default. The 512 MB region is available to PIX. |
| PIX_Title | The 512 MB region is available to PIX. The 768 MB region appears as extra memory in the title space. To the title it looks like they have 5.75 GB of memory. |
| PGI | The 512 MB region is available to PGI instead of PIX. The 768 MB region is not available. This value is used when optimizing a title using Profile Guided Optimization, see Profile Guided Optimization for Xbox One Titles for more information. |
| PGI_Tool | The 512 MB region is available to PGI instead of PIX. This value is used when optimizing a title using Profile Guided Optimization, see Profile Guided Optimization for Xbox One Titles for more information. |
| PGI_Title | The 512 MB region is available to PGI instead of PIX. The 768 MB region appears as extra memory in the title space. To the title it looks like they have 5.75 GB of memory. This value is used when optimizing a title using Profile Guided Optimization, see Profile Guided Optimization for Xbox One Titles for more information. |
|
| DebugNic {enable | disable} | Enable or disable the 2nd NIC on Xbox One X Devkits. |
| EnableEventLimitToast | When set to true, a toast alert notification will be triggered when the current running game produces game events at a rate greater than the Xbox's fixed event rate limit. When this setting is set to false, the toast notification will be disabled in this scenario. |
| EnableKernelDebugging | Prevents an exclusive app from being torn down after a crash, providing time to attach a kernel debugger. With EnableKernelDebugging set to false the exclusive app gets torn down after a short period of time. Value must be either 'true' or 'false'. |
| ErasGraphicsDriverMode {Default | TitleConfigured | Retail | Instrumented | Validated} | Setting to control the graphics driver mode for ERA games. |
| ExtraTitleMemory {size in MB} | The amount of additional memory (in MB) that is moved from the tooling memory (MEM_TOOL heap) to the default memory heap for your title during development. To use this memory, Profiling Mode must be on. See Configuring and Accessing Extra Memory during Development for more information.
 Note |
|---|
| Setting this value (or using the MEM_TOOL heap directly) reduces the amount of memory available to tools like PIX. We recommend leaving at least 512MB of memory for PIX. |
On Xbox One and Xbox One S the title memory size is always 5GB. The maximum value for ExtraTitleMemory is 1280 (MB). On Xbox One X the title memory size can be set to a value between 5GB to 9GB using mx:TitleMemory in your manifest, and so ExtraTitleMemory is a range based on your title memory size and whether your title is running on an Xbox One X Test kit or an Xbox One X Dev kit. Maximum ExtraTitleMemory value with 5GB of title memory:
- Xbox One: 1280
- Xbox One S: 1280
- Xbox One X Retail: 5376
- Xbox One X Devkit: 17664
Maximum ExtraTitleMemory value with 8GB of title memory:
- Xbox One X Retail: 1280
- Xbox One X Devkit: 14592
Maximum ExtraTitleMemory value with 9GB of title memory:
- Xbox One X Retail: 1280
- Xbox One X Devkit: 13568
|
| LegacyGpuPerformanceMode | Controls the GPU frequency on the Xbox One S. If set to True, GPU frequency is reduced to match the Xbox One value of 854MHz. If set to False the Xbox One S uses the console's default GPU frequency. This setting has no effect on the Xbox One console. |
| TitleCompatOverride {true|false} | Flag to override the title compatibility setting. Used with ExtraTitleMemory to override title memory allocation. |
| ToolingMemoryOverflow {true|false} | Flag to control whether PIX will use title memory or not. |
| ToolsLogLevel | Flag indicating the log level the devkit is in. Log files are stored for the Game OS in the TitleScratch\xtflogs directory and for the System OS in the SystemScratch\xtflogs directory. Value must be one of the following: Quiet: No logging occursDetailed: Log important messages.Verbose: Log all messages. |
| ProfilingMode | Flag indicating the devkit is in profiling mode. Set to 'On' to reserve memory to aid with profiling. Set to 'Off' to restore retail memory profile. Set to 'Legacy' to match ProfilingMode="On" behavior of the March 2014 XDK and earlier. |
Display
|
Key |
Description |
|---|
| AllowHDR | Flag used to enable High Dynamic Range (HDR) content on the Xbox One S if it is connected to a TV that supports HDR. This setting has no effect on the Xbox One console. Allowed values are true or false. |
| ColorDepth | The color depth setting of the display attached to the console. Valid values are 24, 30 and 36. The console must be rebooted for this setting to take effect. |
| ColorSpace | The color space setting of the display attached to the console. Valid values are RGBLimited and RGBFull. The console must be rebooted for this setting to take effect. |
| DisplayConnection | The connection override option of the display. These settings tell the console to ignore the TV's info, EDID, and enumerate all HDCP X.X features. Allowed values are auto, dvi, hdmi, hdmi2. |
| DisplayResolution | The resolution of the display attached to the console. Valid values are 1080p, 720p, and 640x480. The console must be rebooted for this setting to take effect. |
Kinect
|
Key |
Description |
|---|
| KinectSensorDisabled | Flag used to toggle whether the Kinect sensor should be disabled. |
| SimulateVersionSwitch | Flag used to toggle whether the console should force reloading the NUI pipeline on app focus changes. Value must be either 'true' or 'false'. |
Networking
|
Key |
Description |
|---|
| DisableForceGuest | Flag which determines whether or not the console forces file shares to use "guest" account access, which is blocked by some security policies. |
| DNSServer | The IP address of the DNS server. A primary and an optional secondary DNS can be set. To clear the address specify Clear. Valid values are Clear or primarydns[,secondary DNS]. |
| HostName | The network name of the console. The console must be rebooted for this setting to take effect. |
| HTTPProxyHost | The network name and port number of the HTTP proxy used by the console. The format for this value is url:portnumber. The console must be rebooted for this setting to take effect. |
| IPAddress | The IP address of the console. The address can be set manually by specifying a string in the format “IP Address, subnet mask, gateway”. You must set DNSServer at the same time. To obtain an IP address from DHCP specify Clear. |
| MacAddress | The mac address of the current network type. To reset the address specify Clear. Valid values are Clear or an address in the form ##-##-##-##-##-##. |
| NetworkAddressMode | A read-only setting that indicates whether the console's IP address is obtained automatically from DHCP or set manually. Values can be automatic or manual. |
| NetworkType | A read only setting that indicates whether the console is connected to the network via a wired or wireless connection. Values can be wired or wireless. |
| WirelessRadioSettings | The power settings of the wireless radios. Value must be either 'on','off', 'wlanoff' or 'accessoriesoff'. The 'on' and 'off' values turn both radios on or off respectively. The default setting is 'on'. |
Power
|
Key |
Description |
|---|
| AutoBoot | Controls whether the console boots when it receives power. This setting only works on consoles with a real-time clock. There is no way to programmatically determine whether an individual console has a real-time clock. However, you can do a manual test to determine whether your console has a real-time clock and will support the AutoBoot setting. While in devkit mode, pull the power cord from the console and then plug it back in and turn it back on. If the console boots into retail mode briefly and then reboots again and returns to devkit mode, the console does not support AutoBoot. If the console boots directly into devkit mode without going into retail mode first, the console supports AutoBoot. |
| DimTimeout | The number of minutes of inactivity before the console's screen dims. Value can be a number between 0 and 255, in increments of 5. A value of zero indicates the screen should never dim. The console must be rebooted for this setting to take effect. |
| IdleShutdownTimeout | The number of minutes of inactivity before the console powers down. Valid values are 60, 360, or 0 for never. |
| PowerMode | Gets or sets a value indicating whether the console is in connected standby or energy saving mode. Allowed values are InstantOn and EnergySaving. |
Storage
|
Key |
Description |
|---|
| DefaultStorageDevice {retail|development|Ext1-Ext7} | The default drive for deploying games. On an Xbox One X devkit, the development drive is the internal NVMe drive. On other consoles, the first external drive will be considered the development drive. Numbers 0 - 8 can also be specified to refer to these drives where 0 is the internal retail drive, 1 is the development drive, and 2-8 match the external drives. |
System
|
Key |
Description |
|---|
| AccessKey | AccessKey is a case-sensitive string you can use to restrict access to a console to only those people who know the access key. The key is specified as part of the console IP address or hostname when setting a default console using xbConnect, the /X parameter when using a command line tool or the address parameter of an XTF API function.
|
Note |
|---|
| AccessKey is intended to prevent people from inadvertently accessing your console - such as deploying applications, rebooting or updating. It is not intended as a feature to be used to secure sensitive intellectual property on a console and protect it from unauthorized access. |
The console must be rebooted for the key to take effect.Once the access key has been set, command line tools and XTF API functions will need to add a plus sign(+) followed by the key to the console address. For example to use xbconnect with a key, you would use the following syntax:
xbconnect <console IP address>+yourkey[/title]
Attempting to connect to a console without supplying its key will result in the following error message:
Access to this console is limited and requires
specifying the correct key to access. (0x8C11040B)
You must supply the correct key to access this console.
You can reset the key in the Developer Settings page on the console.
To clear an existing access key use xbconfig accesskey="" and reboot the console.
|
Note |
|---|
| The access key will be saved as part of the default console address when using xbconnect. |
|
| DevkitAllowACG {on|off} | Set to 'on' to enable arbitrary code generation in title process(es).
- On: Allow arbitrary code generation
- Off: Disable arbitrary code generation (default)
|
| DisableSelectiveSuspend | Allows you to disable selective suspend on external drives if it is affecting performance of the drive. Value must be either 'true' or 'false'. |
| EnableUnifiedScratch {true|false} |
Flag to enable virtualizing the Title Developer Scratch drive into the Game OS during title launch. This allows access to the scratch drive on the console from both the System OS and Game OS while a title is running (T:\TitleDeveloperStorage in the System OS, D: in the Game OS when a title is running). This replaces the default behavior of unmounting the drive from the System OS during title launch, and then remounting it when the title exits.
|
Note |
|---|
| If unified title scratch is enabled then ETW tracing of File IO from the D:\ drive in the Game OS, including PIX FileIO captures, will not provide data due to the virtualization of the file IO. |
|
| FastIterationMode {on|off} | Set to 'on' to enable Fast Iteration Mode for the ERA to increase launch speed.
- On: Fast ERA re-launch
- Off: Legacy ERA shutdown
|
| GeographicRegion | The country code for the region the console is in. GeographicRegion must be one of the following values:
|
| PixFastTransportMode {on|off} | Set to 'on' to enable PIX use of XTD |
| PreferredLanguages | The list of preferred language tags. For example: en-us;en-gb |
| SandboxId | The ID of the development sandbox to connect to. If an ID is provided as an argument, xbconfig sets the sandbox on the console. Using SandboxId= without providing an ID resets the sandbox ID to its default value. Using SandboxId with no ID and no equals sign displays the current sandbox ID on the console. The console must be rebooted for the sandbox ID change to take effect.
|
Note |
|---|
| SandboxId is case sensitive. |
|
| TimeZone | The time zone the console is in. TimeZone must be one of the following values:
- Dateline Standard Time
- Samoa Standard Time
- Hawaiian Standard Time
- Alaskan Standard Time
- Pacific Standard Time
- Mountain Standard Time
- Mexico Standard Time 2
- U.S. Mountain Standard Time
- Central Standard Time
- Canada Central Standard Time
- Mexico Standard Time
- Central America Standard Time
- Eastern Standard Time
- U.S. Eastern Standard Time
- S.A. Pacific Standard Time
- Atlantic Standard Time
- S.A. Western Standard Time
- Pacific S.A. Standard Time
- Central Brazilian Standard Time
- Paraguay Standard Time
- Newfoundland and Labrador Standard Time
- E. South America Standard Time
- Montevideo Standard Time
- S.A. Eastern Standard Time
- Greenland Standard Time
- Mid-Atlantic Standard Time
- Azores Standard Time
- Cabo Verde Standard Time
- GMT Standard Time
- Greenwich Standard Time
- Morocco Standard Time
- Central Europe Standard Time
- Central European Standard Time
- Romance Standard Time
- W. Europe Standard Time
- W. Central Africa Standard Time
- Namibia Standard Time
- E. Europe Standard Time
- Egypt Standard Time
- Jordan Standard Time
- Libya Standard Time
- Middle East Standard Time
- Syria Standard Time
- Turkey Standard Time
- FLE Standard Time
- GTB Standard Time
- Israel Standard Time
- South Africa Standard Time
- Russian Standard Time
- Kaliningrad Standard Time
- Arab Standard Time
- E. Africa Standard Time
- Arabic Standard Time
- Iran Standard Time
- Arabian Standard Time
- Caucasus Standard Time
- Azerbaijan Standard Time
- Georgian Standard Time
- Mauritius Standard Time
- Afghanistan Standard Time
- Ekaterinburg Standard Time
- West Asia Standard Time
- Pakistan Standard Time
- India Standard Time
- Nepal Standard Time
- Central Asia Standard Time
- Sri Lanka Standard Time
- N. Central Asia Standard Time
- Myanmar Standard Time
- S.E. Asia Standard Time
- North Asia Standard Time
- China Standard Time
- Singapore Standard Time
- Taipei Standard Time
- W. Australia Standard Time
- North Asia East Standard Time
- Korea Standard Time
- Tokyo Standard Time
- Yakutsk Standard Time
- A.U.S. Central Standard Time
- Cen. Australia Standard Time
- A.U.S. Eastern Standard Time
- E. Australia Standard Time
- Tasmania Standard Time
- Vladivostok Standard Time
- West Pacific Standard Time
- Central Pacific Standard Time
- Fiji Islands Standard Time
- New Zealand Standard Time
- UTC+12
- Tonga Standard Time
|
User
|
Key |
Description |
|---|
| DefaultUser | The default user to automatically sign in when the console boots. The user must have already been added to the console using xbUser or the Sign In app on the console. If you add the user using the Sign In app make sure you select the option to save the password. Value is user's email address in the form 'myemailaddress@xboxtest.com' Note that when you use this option, the user is signed in to the console and then immediately signed out. This is done to ensure that the user and password are present and valid on the console. If your app is running when this happens, your app sees events signaling that a user has signed in and then signed out. |
| DefaultUserPairing | The controller pairing option for the default user. Allowed values are none, gamepad, virtual, or anyphysical. Gamepad pairs to a physical gamepad. Virtual pairs to any virtual gamepad. Anyphysical pairs to the first physical controller (Gamepad, Wheel, Accessory) discovered. None causes the user to not be paired to a controller on startup. |
|