DEVICECONFIG XML PROPERTIES

The DeviceConfig.xml file is used to determine how different device profiles will be displayed within the UI. Each device input package should only ever have one of these files, and it must always be named "DeviceConfig" for the simulation to recognize it.

 

This file is created automatically for you when you use The Input Device Editor, and a such, this page is provided purely for reference and all edition of the file should be done using the editor to ensure that it is set up correctly. Please see the following page for more information on how to do this:

• Device Profiles

 

The DeviceConfig.xml file has the following schematic structure:

<?xml version= "1.0" encoding= "utf-8" ?>
<DeviceConfig>
    <!-- List Of Devices -->
    <Device [attributes] />
    <Device [attributes] />
    ...
    <!-- List Of Devices And Associated Icons-->
    <Device [attributes] >
        <MergeIcons [attibutes]/>
        <MergeIcons [attibutes]/>
        ...
    </Device>
    ...
</DeviceConfig>

 

 

<DeviceConfig>

This is a container element where you will place one or more <Device> sub-elements. This element has no attributes.

 

 

<Device>

This element is a sub-element of <DeviceConfig> and is used to setup a specific device definition for use in the simulation UI. If the device has no icons then the element is self-closing, otherwise it will have one or more <MergeIcons> sub-elements. Note that if the device is Keyboard or Mouse then you cannot use the <MergeIcons> sub-element as these inputs will always use the default UI icons.

 

It can have the following attributes:

 

Attribute	Description	Type	Required
ProductID	This is the product ID for the device being defined. The ID should be formatted as a hexadecimal value, prefixed by "0x". You can find the product ID from the Input Device Editor. For example, if the Product ID is 767 you would have: ProductID="0x02FF"	String	Yes
Platform	This sets the platform(s) that the device can be used on. If the device can be used on all platforms, this attribute can be omitted, otherwise you can use one of the following strings to limit the device to that platform: "PC" "XBOX" "PS5"	String	No
CompositeID	This is the composite ID for the device being defined, expressed as an integer. You can find the composite ID from the Input Device Editor.	Integer	No
DisplayName	This is the name of the device that will be displayed in the UI.	String	Yes
TextureFolder	This is the relative path to the texture folder where the required images and optional icons can be found. Each device requires a unique folder which should be named the same as the Input Configuration XML file.	String	Yes
Priority	This sets the priority in the UI for the device profile, expressed as an integer, where a lower value will represent a higher priority in the UI list. If this attribute is not included, then the default priority is 0.	Integer	No

 

 

<MergeIcons>

This is a sub-element of <Device> and is used to define one or more icons that can be used to represent a button, axis or slider on the device being defined. The icons to be used should be placed within the folder defined in the <Device> attributes.

 

It can have the following attributes:

 

Attribute	Description	Type	Required
SourceIcons	A combination of "keys" which represent specific in-sim actions. These "keys" will be bound to the target icon and localised text. See the Device Keys section for more information. For multiple keys, they should be concatenated using & symbol, for example: SourceIcons="R-STICK LEFT&R-STICK RIGHT"	String	Yes
TargetIcon	This is the name of the SVG file that should be linked to the source icon key. The name is given without the file extension, for example, the file R-STICK_1.svg would be given as: TargetIcon="R-STICK_1"	String	Yes
TargetTT	This is a localisable string that describes the action/icon, for example: TT:INPUT.GAMEPAD.ANALOGLEFT Note that if you do not have a *.loc file or have not localised the inputs, then you can leave this blank.	String	Yes

 

Report An Issue