Rewired Editor

Automatic - Rewired updates automatically in the selected update loops.

Manual - Update manually by calling ReInput.Update. All automatic updating will be disabled.

Updates input in one or more game loops.
Selecting Multiple will update input in each loop chosen. Each loop is updated and tracked independently so all input calls will work in either loop. Select multiple if you need to be able to get input, for example, from both Update and FixedUpdate.

Updates input in the FixedUpdate loop. If you try to get input from the FixedUpdate loop without enabling this, you will miss some input data. Ex: GetButtonDown and GetKeyDown will not always return correctly.

Updates input in the OnGUI loop. Only necessary if you need GetButtonDown to work within the Unity GUI.

WARNING: Enabling this will cause a 300-500 byte memory allocation per frame due to the way OnGUI works. This will contribute to garbage collection overhead.

If enabled, keyboard keys will map to their physical location on a US 101-key keyboard regardless of the keyboard layout being used (AZERTY for exampe). This is useful for making a locale-independent input layout. Example: WASD to move. If enabled, the KeyCode returned for a key will match the US 101-key layout, and glyphs and help text will display incorrect information to the user. For example, the A key on a AZERTY keyboard is located where the Q key is on a US 101-key keyboard, and the KeyCode returned for the A key will be KeyCode.Q. Changing this setting will modify it project-wide in the Unity Input Manager settings.

It is recommended to disable this option. See this for more information.

Force Unity Input to be the input source. This will disable all external input sources such as Raw Input, Direct Input, XInput, and native OSX.

WARNING: Unity Input does not allow hot-plugging on some platforms. If you need hot-plugging, do not check this box.

Ignores input if the application is not in focus. This setting has no effect on some platforms.

NOTE: Disabling this does not guarantee that input will be processed when the application is out of focus. Whether input is received by the application or not is dependent on A) the input device type B) the current platform C) the input source(s) being used.

The primary input source for the Windows Standalone platform.

Raw Input - Use Raw Input for the input source. Note: Raw Input carries significant advantages over Direct Input such as better Bluetooth controller support, support for more elements on certain controllers, better controller recognition, etc. Does not require any extra libraries. Windows Control Panel joystick calibration does not affect joystick axes.

XInput - Use XInput for the input source. This will use XInput only. All non-XInput compatible controllers will be non-functional. To support both XInput and non-XInput controllers, use Raw Input or Direct Input instead and enable the Use XInput option. Supports XBox Controller 2-motor vibration, independent trigger values, but only supports 4 XInput-compatible controllers at once. Installation of DirectX end-user runtimes is required on Windows XP.

Windows Gaming Input - Use Windows.Gaming.Input for the input source. This will use Windows.Gaming.Input only for controllers. All non-WindowsGamingInput compatible controllers will be non-functional. At the present time, only Gamepads are supported. To support all controller types, use Raw Input or Direct Input instead and enable the Use Windows Gaming Input option. Supports XBox Controller 4-motor vibration, independent trigger values, and supports more than 4 XInput-compatible controllers at once. (Requires Windows 10, October 2018 Update version 1809 (10.0.17763.0) or greater. Will fall back to other input sources on older versions of Windows.)

Direct Input - Use Direct Input for the input source. Installation of DirectX end-user runtimes may be required for Direct Input support. Windows Control Panel joystick calibration settings affect joystick axes.

SDL2 - Use SDL2 for the input source. This option requires the SDL2 runtime library to be installed. Note: SDL2 does not support as many devices as other native input sources.

Unity Input - Use Unity fallback input.

On Windows, use Windows.Gaming.Input for compatible devices. Devices not compatible with Windows Gaming Input will be handled by the primary input source. Supports XBox Controller 4-motor vibration, independent trigger values, and supports more than 4 XInput-compatible controllers at once.

(Requires Windows 10, October 2018 Update version 1809 (10.0.17763.0) or greater. Will fall back to other input sources on older versions of Windows.)

If both Use XInput and Use Windows Gaming Input are enabled, if Windows Gaming Input is unavalable on the system, XInput will be used as the fallback input source for compatible devices. Otherwise, the primary input source will be used as the fallback input source.

(Only available when Input Source is set to Raw Input or Direct Input.)

On Windows, use XInput for compatible devices. Devices not compatible with XInput will be handled by the primary input source. Supports XBox Controller 2-motor vibration, independent trigger values, but only supports 4 XInput-compatible controllers at once. Installation of DirectX end-user runtimes is required on Windows XP.

If both Use XInput and Use Windows Gaming Input are enabled, if Windows Gaming Input is unavalable on the system, XInput will be used as the fallback input source for compatible devices. Otherwise, the primary input source will be used as the fallback input source.

(Only available when Input Source is set to Raw Input, Direct Input, or Windows Gaming Input.)

The joystick refresh rate in frames per second. Set this to a higher value if you need higher precision input timing at high frame rates such as for a music beat game. Higher values result in higher CPU usage. Note that setting this to a very high value when the game is running at a low frame rate will not result in higher precision input.

This settings only applies to input sources that use a separate thread to poll for joystick input values (currently Direct Input, XInput, and Windows Gaming Input). This setting does not apply to event-based input sources such as Raw Input.

Use native libraries to handle the mouse. Enabling this will eliminate certain bugs associated with Unity's mouse handling.

(Only available when Input Source is set to Raw Input or Direct Input.)

Use native libraries to handle keyboard input.

(Only available when Input Source is set to Raw Input or Direct Input.)

Enable low-level enhanced support for certain devices. If enhanced support is available for a particular device, this will enable device-specific features such as vibration / force feedback, lights, gyroscopes, accelerometers, touchpads, etc.

(Only available when Input Source is set to Raw Input.)

The primary input source for the OSX Standalone platform.

Native - Use native input for the input source. This provides the best device support.

Game Controller - Use Apple Game Controller framework for the input source. This provides support only for devices supported by the Game Controller framework. This may not include all devices supported by the Native input source.

SDL2 - Use SDL2 for the input source. May be required for Steam Streaming and Steam Controller support in OSX. This option requires the SDL2 runtime library to be installed. Note: SDL2 does not support as many devices as other native input sources.

Unity Input - Use Unity fallback input.

Use the Apple Game Controller Framework for compatible devices.

(Only available when Input Source is set to Native.)

If this option is enabled, joysticks will be assigned to Rewired Players based on the native player id assigned by the system. This option ensures that the joystick will match to the correct Rewired Player when auto-assigned. This option overrides some other joystick auto-assignment settings. More than one joystick will be assigned to a Player if multiple joysticks are found for that system player id.

NOTE: This option only applies to devices handled by the Apple Game Controller Framework. It does not apply to HID devices handled by IO Kit or any other input source.

Enable low-level enhanced support for certain devices. If enhanced support is available for a particular device, this will enable device-specific features such as vibration / force feedback, lights, gyroscopes, accelerometers, touchpads, etc.

(Only available when Input Source is set to Native.)

The primary input source for the Linux Standalone platform.

Native - Use native input for the input source. This provides the best device support.

SDL2 - Use SDL2 for the input source. May be required for Steam Streaming and Steam Controller support in Linux. This option requires the SDL2 runtime library to be installed. Note: SDL2 does not support as many devices as other native input sources.

Unity Input - Use Unity fallback input.

Enable low-level enhanced support for certain devices. If enhanced support is available for a particular device, this will enable device-specific features such as vibration / force feedback, lights, gyroscopes, accelerometers, touchpads, etc.

Enhanced Device Support on Linux requires UDEV rules to be set up by the end-user. See this for more information.

(Only available when Input Source is set to Native.)

The primary input source for the Windows 10 Universal platform.

Native - Use native input for the input source. This provides the best device support.

Unity Input - Use Unity fallback input.

Use Windows.Gaming.Input.Gamepad for compatible devices. Also enables special features for compatible devices such as vibration.

(Only available when Input Source is set to Native.)

This allows support for older gamepads, gamepads made for Android, flight controllers, racing wheels, etc. In order to use this feature, you must add support for HID gamepads and joysticks to the app manifest file. Please see the Special Platform Support -> Windows 10 Universal documentation for details.

(Only available when Input Source is set to Native.)

Treat all unrecognized controllers as gamepads using the standardized Android gamepad layout. All recognized controllers will be treated normally.

Warning: While most Android gamepads conform to this layout, there are exceptions. Addtionally, with this option enabled, all unrecognized non-gamepad joystick devices used will be limited to only the set of elements available on a gamepad. If your game needs to support devices other than Android gamepads, disable this option.

This option only applies to the Android platform.

The primary input source for the Xbox One platform.

Native - Use native input for the input source. This provides the best device support.

Unity Input - Use Unity fallback input.

Ignores input if the application is not in focus. This setting has no effect on some platforms.

NOTE: Disabling this does not guarantee that input will be processed when the application is out of focus. Whether input is received by the application or not is dependent on A) the input device type B) the current platform C) the input source(s) being used.

The default calculation type for joystick axis dead zones.

Radial: X and Y are combined and the dead zone is calculated on the length of the vector. This allows smooth sweeping in a circular motion. This is the best choice for most games.

Axial: X and Y axes are calculated independently. Use this if your game requires more precise 4-directional movement (ie: some platformers, chess games, etc.)

This setting only applies to joysticks on recognized controllers.

The default calculation type for joystick axis sensitivity.

Radial: X and Y are combined and the sensitivity is calculated on the length of the vector.

Axial: X and Y axes are calculated independently.

This setting only applies to joysticks on recognized controllers.

Determines how axis sensitivity will be calculated by default.

Multiplier: Value is multiplied by sensitivity.

Power: Value is raised to a power.
As power nears 0, sensitivity of the axis closer to the zero/center position increases, while sensitivty closer the max position decreases.
As power increases past 1, sensitivity of the axis closer to the zero/center position decreases, while sensitivity close to the max position increases.

Curve: Value is multiplied by a point on a curve.

Determines how Actions bound keys that are also used in key combinations behave. Example: Ctrl is bound to Action1 and Ctrl + W is bound to Action 2. When Ctrl is pressed, Action1 activates until W is also pressed. This enum defines how the underlying Action1 bound to Ctrl will behave when H is pressed and when H is released. When Ctrl + H is pressed, the key combination overrides Action1 and it returns a value of False.

None: All key combination override handling is disabled for all keys including modifier and primary keys. Even if a key combination includes a key that is already bound to an Action, both the Action bound to the key combination and the Action bound to the individual key will return true when pressed. Example: W is bound to Action1. Cntl + W is bound to Action2. When Cntl + W is pressed, both Action1 and Action2 return true.

Pause: An Action bound to a modifier key that is a member of a key combination will return False for the duration that the key combination is active. When any key of the overriding key combination is released, the Action bound to the modifier key will no longer be overridden and return a True value if the key is still pressed.

Cancel: An Action bound to a modifier key that is a member of a key combination will return False until the key is released and pressed again. The Action of the member key is canceled by the key combination override.

Overlap: An Action bound to a modifier key that is a member of a key combination will return True as long as the key is held and will not have its value overridden by the key combination unless the modifier key matches the primary key of the key combination. Actions bound to each modifier key in the key combination will return value along with the Action bound to the key combination. Example: Cntl is bound to Action1. Cntl + W is bound to Action2. When Cntl + W is pressed, both Action1 and Action2 return true. Note that this does not apply to the primary key of a key combination. In the previous example, an Action bound to W alone does not return true when Cntl + W is pressed. This also does not apply to key combinations themselves. Key combinations can be overridden by other key combinations that have more modifiers. Example: Cntl + W is bound to Action1. Cntl + Shift + W is bound to Action2. When Cntl + Shift + W is pressed, Action2 returns true, but Action1 returns false. If a key combination is overridden by another key combination that has more modifiers, the overridden key combination will return false until all constiutent keys are released and pressed again.

If enabled, input will be allowed when any Scene View has focus. This option will have no effect when native input is not used as the input source for a device.

Note: Due to the limitated information available from the Unity Editor about the current state of focus, when this option is enabled, input will still be processed when the Unity Editor is not in focus on OSX and Linux.

Includes the Action Category name in the Actions list.

If enabled, a separate class will be created for each Action Category and Action constants will be generated inside these classes.

If disabled, includes the Action Category in the name of each constant. The Action Category name will preceed the Action name for the final const name.

Example: public const int Default_Jump = 1;

Otherwise, the Action name alone will be used.

Example: public const int Jump = 1;

Export keys for all objects in the Rewired Input Manager and Controller Data Files to a JSON file.

You can export keys to a JSON file, then provide a localized string for each key you want translated. Remove any keys for which you do not provide a localized value to save memory and CPU usage during lookups.

Speed (units/sec) that the axis value falls toward 0. This only affects axis values generated by button and key presses.

Speed to move toward an axis value of 1.0 in units/sec. This only affects axis values generated by button and key presses.

Affects how mouse X/Y axes contribute to the value.

Mouse Axis - Value range that depends on speed of movement. The value can and does exceed +/- 1.0 by a large amount. This value is the same value returned by Unity's Input.GetAxis when axis type is set to Mouse Movement. Mouse Sensitivity is multiplied by the axis value.

Digital Axis - Any mouse movement returns a value from -1.0 to 1.0 and is smoothed by the digital axis filters. This makes mouse movement behave like a button or key press.

ScreenPositionDelta - A value from -1.0 to 1.0 that represents the distance moved across the screen over the update cycle. The value is normalized based on the width and height of the screen. A movement across the entire screen distance in one update cycle will return +/- 1.0.

Speed - A value based on the speed the mouse is moved across the screen. Speed is calculated from the mouse movement delta / delta time. The returned value can exceed +/- 1.0.

(If Mouse XY Axis Mode = MouseAxis)
Mouse X/Y axes are multiplied by this value.

(If Mouse XY Axis Mode = ScreenPositionDelta or Speed)
Determines how the screen position delta (and therefore speed) is calculated for mouse X/Y axes. An equvalent mouse movement on X and Y will yield a different result for delta X and delta Y if the screen width and height are not equal.

If you need the delta consistent between X and Y movement, change this to ScreenWidth or ScreenHeight and the delta will be calculated based on only one dimension.

Note that the returned value may exceed +/- 1.0 if set to a value other than Normal.

Affects how mouse axes other than X/Y contribute to the value. This affects the mouse wheel axis.

Mouse Axis - Value range goes beyond -1 to 1 depending on speed of movement. This value is the same value returned by Unity's Input.GetAxis when axis type is set to Mouse Movement. Mouse Other Axis Sensitivity is multiplied by the axis value.

Digital Axis - Any movement returns -1 to 1 and is smoothed by digital axes values. Mouse movement behaves like a button or keyboard key press. Mouse sensitivity does not affect this mode. Instead, all Digital Axis filters are applied.

Time in seconds after a short press is registered after which it will expire and no longer return true for any button events. For example: If you want the press to expire 2 seconds after the press first registers true, set this value to 2. This is useful, for example, if you want short and long presses to be mutually exclusive.

[0 = Never expires]

Time in seconds after a long press is registered after which it will expire and no longer return true for any button events. For example: If you want the press to expire 2 seconds after the press first registers true, set this value to 2.

[0 = Never expires]

Determines what map categories to check against for assignment conflicts when the user is mapping a control to a map in this category.

True = check maps in all categories.
False = specify which categories to check against.

The source id of the Custom Controller.

Note: This does not correspond to the unique id that will be assigned to the controller when it is instantiated, so it can't be used to get the instantiated controller. However, this can be used to instantiate a Custom Controller of this type manually via scripting.

Positive Key

What portion of the axis's range contributes to the value?

Full = Both positive and negative sides of the axis.
Positive = Only the positive side of the axis.
Negative = Only the negative side of the axis.

Determines how axis sensitivity will be calculated.

Multiplier: Value is multiplied by sensitivity.

Power: Value is raised to a power.
As power nears 0, sensitivity of the axis closer to the zero/center position increases, while sensitivty closer the max position decreases.
As power increases past 1, sensitivity of the axis closer to the zero/center position decreases, while sensitivity close to the max position increases.

Curve: Value is multiplied by a point on a curve.

The sensitivity value.

(Only available if Sensitivity Type is set to Multiplier or Power.)

The sensitivity curve.

(Only available if Sensitivity Type is set to Curve.)

What portion of the axis's range triggers the assigned action?

Full = Both positive and negative sides of the axis trigger the action.
Positive = Only the positive side of the axis triggers the action.
Negative = Only the negative side of the axis triggers the action.

A modifier key that must be held for this action to return true. The order of multiple modifier key presses makes no difference.

NOTE: Many modifier key combos do not work correctly in the Unity editor because the key combos are already mapped to Unity functions.

A modifier key that must be held for this action to return true. The order of multiple modifier key presses makes no difference.

A modifier key that must be held for this action to return true. The order of multiple modifier key presses makes no difference.

What portion of the axis's range triggers the assigned action?

Full = Both positive and negative sides of the axis trigger the action.
Positive = Only the positive side of the axis triggers the action.
Negative = Only the negative side of the axis triggers the action.

What portion of the axis's range triggers the assigned action?

Full = Both positive and negative sides of the axis trigger the action.
Positive = Only the positive side of the axis triggers the action.
Negative = Only the negative side of the axis triggers the action.

Determines selection method used to find the devices the entry applies to.

Available options:

• Controller Type - Selects all Controllers that match a specific ControllerType.
• Controller Template Type - Selects all Controllers that match a specific Controller Template type.
  
• Hardware Type - Selects all Controllers that match a specific hardware type guid and/or hardware identifier.

The Controller Type the entry applies to.

The Controller Template type this entry applies to.

The hardware type of the Controller this entry applies to. This targets all Controllers that match a specific recognized hardware type such as all Xbox 360 controllers.

This is only displayed if Controller Selector is set to Hardware Type.

The hardware identifier of the Controller this entry applies to.This targets all Controllers that match a specific unrecognized hardware type such as for a Joystick that has no controller definition built into Rewired. This value can be obtained from Controller.hardwareIdentifier at runtime. If Controller is set to Unknown Controller and this value is blank, it will match all Unknown Controllers.

This is only displayed if Controller Selector is set to Hardware Type.

Determines selection method used to find the devices the entry applies to.

Available options:

• All - Selects all Controllers.
• Controller Type - Selects all Controllers that match a specific ControllerType.
• Controller Template Type - Selects all Controllers that match a specific Controller Template type.
  
• Hardware Type - Selects all Controllers that match a specific hardware type guid and/or hardware identifier.

The Controller Type the entry applies to.

The Controller Template type this entry applies to.

The hardware type of the Controller this entry applies to. This targets all Controllers that match a specific recognized hardware type such as all Xbox 360 controllers.

This is only displayed if Controller Selector is set to Hardware Type.

The hardware identifier of the Controller this entry applies to.This targets all Controllers that match a specific unrecognized hardware type such as for a Joystick that has no controller definition built into Rewired. This value can be obtained from Controller.hardwareIdentifier at runtime. If Controller is set to Unknown Controller and this value is blank, it will match all Unknown Controllers.

This is only displayed if Controller Selector is set to Hardware Type.