Touch Adaptation Kit Editor Extension for Visual Studio Code

Learn more about Touch on Xbox

The TAK Editor helps you create and manage touch adaptation bundles, provides a live preview of layouts during development, enhanced bundle correctness verification, and more tools to help you get started on your journey to create touch experiences on Xbox. On top of that, it is a cross-platform tool allowing you to use it wherever you like to work (Windows, macOS, or Linux).

This extension builds on the existing capabilities of the Touch Adaptation Kit Command Line Tool (TAK CLI) by integrating them with VS Code. In fact, the extension requires the TAK CLI to function.

Requirements

Touch Adaptation Kit Command Line Tool (TAK CLI)
- Windows
- Mac

Quick Start

Set the TAK CLI path.
Open a folder/workspace in which you'd like to create touch adaptation bundles.
Check out the TAK Editor extension documentation to learn more!
Create touch experiences!
- Create a new bundle
- Create layouts for existing bundles
- Live preview layouts during development and customize the preview panel
- View bundle verification issues
- Pack a bundle for submission to your Microsoft Account Representative
Send us feedback (suggestions, bug reports) on how to improve this product.

Commands

Most of the functionalities of the extension are accessed through commands that the extension contributes to VS Code.

You can execute commands in VS Code through the Command Palette (Ctrl+Shift+P or Cmd+Shift+P by default).

💡 All of the extension's command names are prefixed with Touch Adaptation Kit. You can get a full list of the extensions commands by searching for this prefix in the command palette.

Command	Description
`Set TAK Command Line Tool (TAK CLI) path`	[Required] Allows you to point the extension to the TAK CLI.
`Create new Bundle`	Creates a new unpacked touch adaptation bundle within an open workspace in VS Code, optionally including starting template layouts. Use this to get started!
`Create new layout for existing bundle`	Creates a new layout in an existing bundle. Cannot be run if there are no bundles in the folder/workspace. It can also be pre-populated with a template, or blank.
`Pack Bundle`	Verify and pack a touch adaptation bundle into a `.takx` file that is ready for submission to your Microsoft Account Representative.
`Set preview background`	Customize the background of the touch controls live preview using a static color, image file, or image URL. Useful for assessing the visual appeal of the touch controls overlay against a background that resembles your game. 💡 Only available when the live preview is open. It can also be accessed through the preview settings ⚙️ button in the live preview header.
`Open preview settings`	Open live preview settings. The preview settings can also be opened using the ⚙️ button in the tab's header. 💡 Only available if the live preview is visible.
`Open preview to the side`	Use this to re-open the live preview if you have closed it after it was automatically created. 💡 Only available when the live preview is closed and a bundle's file is open in the VS Code editor. It can also be accessed using the 🔍 button in the tab's header for the file.
`Show Logs`	Display any of the extension's output channels that contain diagnostic logs. These channels can contain useful information for troubleshooting and submitting feedback to us. ⚠️ Output channels can contain personal information like file paths on your system. Please be mindful of this when sending us your logs in feedback and redact information as appropriate.
`Send feedback email`	Launches your default email client with a draft email to send to us that includes some environment information as well as instructions for sending bug reports. 💚 We welcome your feedback, suggestions, and bug reports to help us improve the product.
`View NOTICE file`	Displays license information for third party components that have been used in this software.

Have a suggestion or found a bug?

You can use the Send feedback email command to send us an email that contains the description of your issue, optionally including logs from the extension that can help with resolving bugs quicker.

Alternatively, you can go to VS Code Help > Report Issue. In the popup UI, make sure to select "An extension" from the dropdown for "File on" and select "Touch Adaptation Kit Editor" for the extension dropdown. Submitting this form will automatically generate a new issue on our GitHub.

Telemetry

This extension collects usage data and sends it to Microsoft to help improve our products and services. Collection of telemetry is controlled via the same setting provided by Visual Studio Code: "telemetry.telemetryLevel". Learn more about Telemetry in VS Code.

License

By downloading and using the Touch Adaptation Kit Editor extension for Visual Studio Code, you agree to the product's license terms and privacy statement.