NEW: Support Xbox controllers over USB using native macOS support [ISXB-1547]

[vallerieknight-unity]

Description

Adds Xbox controller support back on macOS, now using macOS's new(ish) native support for Xbox controllers, rather than requiring usage of a 3rd party driver.

Testing status & QA

• New device in use, so no impact to existing cases where a user is successfully using the older controller support
• Added tests to cover new devices; tests green on local machine (currently running in Yamato)

Overall Product Risks

_Please rate the potential complexity and halo effect from low to high for the reviewers. Note down potential risks to specific Editor branches

• Complexity: Low: The only real difficulty was the change in bit mapping, and that we no longer need to invert axis
• Halo Effect: Low: This is a new device, and the description we get from macOS is unique such that it won't clash with our existing mappings

Comments to reviewers

• Discussed on Slack in #devs-input
• This is a new PR, now I have write access :D - previous PR was NEW: Support Xbox controllers over USB using native macOS support #2178, targeting a fork on my own account

Checklist

Before review:

• [ X ] Changelog entry added.
  • Explains the change in Changed, Fixed, Added sections.
  • For API change contains an example snippet and/or migration example.
  • JIRA ticket linked, example (case %%). If it is a private issue, just add the case ID without a link.
  • Jira port for the next release set as "Resolved".
• [ X ] Tests added/changed, if applicable.
  • Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
  • Performance tests.
  • Integration tests.
• [ X ] Docs for new/changed API's.
  • Xmldoc cross references are set correctly.
  • Added explanation how the API works.
  • Usage code examples added.
  • The manual is updated, if needed.

During merge:

• Commit message for squash-merge is prefixed with one of the list:
  • NEW: ___.
  • FIX: ___.
  • DOCS: ___.
  • CHANGE: ___.
  • RELEASE: 1.1.0-preview.3.

After merge:

• Create forward/backward port if needed. If you are blocked from creating a forward port now please add a task to ISX-1444.

[vallerieknight-unity]

(running formatter locally now :) )

[Pauliusd01]

Did not forget this one, will try to review it today/tomorrow

[Pauliusd01]

LGTM, checked that the controller is recognised and works correctly both in bluetooth/wired modes in Playmode, Player and the Input debugger. Also, double checked that nothing broke with the other controllers as well.

[codecov-github-com]

Codecov Report

All modified and coverable lines are covered by tests ✅

@@             Coverage Diff             @@
##           develop    #2179      +/-   ##
===========================================
+ Coverage    67.78%   67.80%   +0.01%     
===========================================
  Files          367      367              
  Lines        53505    53513       +8     
===========================================
+ Hits         36268    36282      +14     
+ Misses       17237    17231       -6     

Flag	Coverage Δ
mac_2021.3_pkg	5.41% <0.00%> (-0.01%)	⬇️
mac_2021.3_project	70.42% <100.00%> (+<0.01%)	⬆️
mac_2022.3_pkg	5.19% <0.00%> (-0.01%)	⬇️
mac_2022.3_project	65.29% <100.00%> (+<0.01%)	⬆️
mac_6000.0_pkg	5.20% <0.00%> (-0.01%)	⬇️
mac_6000.0_project	67.73% <100.00%> (+0.02%)	⬆️
mac_6000.1_pkg	5.20% <0.00%> (-0.01%)	⬇️
mac_6000.1_project	67.71% <100.00%> (+<0.01%)	⬆️
mac_6000.2_pkg	5.20% <0.00%> (-0.01%)	⬇️
mac_6000.2_project	67.71% <100.00%> (+<0.01%)	⬆️
mac_trunk_pkg	5.20% <0.00%> (-0.01%)	⬇️
mac_trunk_project	67.71% <100.00%> (+<0.01%)	⬆️
win_2021.3_pkg	5.42% <ø> (ø)
win_2021.3_project	70.49% <ø> (ø)
win_2022.3_pkg	5.20% <ø> (ø)
win_2022.3_project	65.37% <ø> (+<0.01%)	⬆️
win_6000.0_pkg	5.20% <ø> (ø)
win_6000.0_project	67.78% <ø> (ø)
win_6000.1_pkg	5.20% <ø> (ø)
win_6000.1_project	67.78% <ø> (-0.01%)	⬇️
win_6000.2_pkg	5.20% <ø> (ø)
win_6000.2_project	67.78% <ø> (ø)
win_trunk_pkg	5.20% <ø> (ø)
win_trunk_project	67.78% <ø> (-0.01%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
...system/InputSystem/Plugins/XInput/XInputSupport.cs	100.00% <100.00%> (ø)
...tem/InputSystem/Plugins/XInput/XboxGamepadMacOS.cs	73.68% <100.00%> (+5.94%)	⬆️

... and 1 file with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[vallerieknight-unity]

@Pauliusd01 thanks for the review! would you be able to hit the Merge button? I don't seem to have access...

[Pauliusd01]

@vallerieknight-unity Gave you access, should be able to merge now. But lets wait for a dev review as well @jfreire-unity

[vallerieknight-unity]

Oops! Missed that second review was still yellow...

[jfreire-unity]

Thank you for adding this, and I apologize for taking so long to approve it.
Meanwhile, I did try to test improvements to our Xbox situation on macOS, but I still did not have time to finish it. It's better to merge this now and remove our device state boilerplate later.

[vallerieknight-unity]

no worries, nothing to apologize for :) I'm on holiday for the next few days but will merge when I get back

[jfreire-unity]

@vallerieknight-unity I can probably merge once CI passes

[Pillmatic]

@vallerieknight-unity this is amazing. Thank you so much for that!

Any chance this is extended to DualSense, DualShock and Xbox controllers connected via Bluetooth to use native Apple APIs? We are waiting for years to get macOS fixes to be have controllers working again for macOS builds submitted to the Apple App Store (bug report: IN-30718).

[vallerieknight-unity]

@vallerieknight-unity this is amazing. Thank you so much for that!

Any chance this is extended to DualSense, DualShock and Xbox controllers connected via Bluetooth to use native Apple APIs? We are waiting for years to get macOS fixes to be have controllers working again for macOS builds submitted to the Apple App Store (bug report: IN-30718).

Hi @Pillmatic :) To clarify, this doesn't change the approach on macOS; we are still reading the raw HID data rather than using GCController. I did take a look at the bug—it looks like you're running up against App Sandbox. If you're using the App Sandbox capability (e.g., for App Store submission), you'll need to configure it to allow USB access. Important to note that this is not the same as adding the Game Controller capability.

If it's helpful, the following setup in Xcode is (classic developer phrase) working on my end with a Sony DualShock 4. Without the USB access in App Sandbox, controller support is non-functional.

If this doesn't solve the issue for you, please make a thread on Unity Discussions (https://discussions.unity.com) and link it here (if only so it's easier for other folks to find). Cheers!

[Pillmatic]

Hi,

Thanks for the info. Can confirm with the USB checkbox on controllers work on macOS TestFlight builds. Hope you still migrate to the Apple GameController framework for additional features (e.g., DualSense triggers, lightbar). But this already helps us a lot for internal testing and unblocks us from a potential macOS release.

Again, thanks for the support!