TAK CLI v11.28.0

TAK CLI Release Notes

Fixed

• Fixed a bug where specifying the --no-verify option with the serve command would still verify.

TAK CLI v11.25.0

TAK CLI Release Notes

Added

• TAK CLI builds for macOS are now shipped separately for both Intel chipsets (x64) as well as Apple Silicon (arm64). Previously, they were only shipped for Intel x64.
• Added a new verification rule that ensures layout names are not invalid.

TAK CLI v11.3.0

TAK CLI Release Notes

Added

• Introduced an applicationId field in the AppData file. This field is resettable with the --reset-appId global option.

Fixed

• Dependency package updates and security fixes

TAK CLI v11.18.0

TAK CLI Release Notes

Fixed

• Fixed an issue where the outdated app data file would not update to the latest version.
• Fixed the verify command so that help message is displayed if the required --takx argument is not given.

TAK CLI v11.16.0

TAK CLI Release Notes

Added

• TAK CLI telemetry events are now forwarded along to the language client (e.g., TAK Editor) for submission.

Fixed

• Update ImageSharp dependency version for security fix

TAK CLI v11.12.0

TAK CLI Release Notes

Added

• Added the ability to make changes to the takxconfig.json when serving a loose bundle and those changes be displayed in real time without needing to restart the serve opperation.
• Telemetry Collection: To continually improve our product and address user pain points, we have introduced optional diagnostic telemetry collection. This feature provides valuable insights that aid in product enhancement. For users who prefer not to share this data, telemetry collection can be easily disabled via the settings command.
• settings Command: A new settings command is introduced to allow users to apply persistent settings for the application. The --telemetry-level setting is now available, allowing users to control the extent of telemetry collected. By default, it is set to all, but can be adjusted to error or off according to user preferences.
• Output the payload of telemetry when using a debug verbosity level.

Fixed

• Fixed an issue where an empty appData.json file would result in the application crashing silently. Now it will be replaced with a new appData file and the user will be warned.
• Fixed an issue where multiple instances of the TAK CLI running at the same time could cause a corruption in the Application Data file.
• Fixed an issue where the Application Data file would be written to disk even before the license for the product was accepted. Now the file is only written to disk after the license is accepted for the first time.
• Fixed an issue where the user was unable to accept the license of the product using the --accept-license option with the notice command.

TAK CLI v11.0.0

TAK CLI Release Notes

First public release of TAK CLI 🎉. This is the same tool that is available in the GDK. Please use this version (check out the download links below) for optimal integration with the Touch Adaptation Kit Editor Extension for VS Code.

Added

• [Breaking Change] End User License Agreement (EULA) acceptance requirement for all commands (except notice, version and license commands)
• license command which allows user to view and accept the EULA
• --accept-license global option to accept the EULA automatically when running a command. This is useful for automation scenarios where user interaction is not possible.

Changed

• Updated ImageSharpCompare from v2.1.6 to v2.1.7

v4.0 Layout and Context

This change brings in 4.0 layout and context schemas as well as provides support for localized schema contents for layouts, context files, and takxconfig.json

v4.0 Layout

Added

Localization

Schema examples, documentation, and Intellisense is now localized into Japanese, Korean, and Chinese. In order to use this functionality, simply replace the $schema property in your layout with a localized version.

{
-  "$schema": "https://raw.githubusercontent.com/microsoft/xbox-game-streaming-tools/main/touch-adaptation-kit/schemas/layout/v4.0/layout.json",
+  "$schema": "https://raw.githubusercontent.com/microsoft/xbox-game-streaming-tools/main/touch-adaptation-kit/schemas/ja-JP/layout/v4.0/layout.json",
...

Changed

Provide significantly improved documentation and Intellisense

All schema items have been enhanced to have a clear title, description, and examples to guide creating touch layouts. Examples generally include a minimal version, a complete version, and an example using schema references where possible.

[BREAKING] Restrict schema values to reasonable defaults.

Many schema items allowed invalid values to be supplied (like negative values for a control's scale property). The majority of these cases have been identified and removed. If a schema depended on these values in the past, they must be updated when moving to version 4.0 though these values were likely not being correctly handled anyway.

[DEPRECATED] InputCurve, Input Curve Range, Center Wheel

These items were not well defined, clear to consumers, or worked well on all devices / screen sizes. These items are now deprecated and will be removed in a future version. Deprecated items will provide warnings in an IDE like Visual Studio Code but will not, currently, prevent a bundle being packed.

Increased schema reference ($ref) support

Since layout / context version 3.0 selective fields in the touch bundle can be specified as a $ref for code reuse and to enable dynamic touch layout state via the xgamestreamingupdatetouchcontrolsstateonclient API. In v4.0, the places where these references can be used has been enhanced to allow greater customization (like enabling / disabling sensor controls, change dpad deadzones, and more).

⚠️Please note that all dynamic state values MUST maintain a valid layout. In order to ensure compatibility, use the xgamestreaminggettouchbundleversion to know which bundle is loaded and provide appropriate values.

v1 TakxConfig

Changed

Several bug fixes in the schema. Some of these bugs were allowing additional properties or invalid values. This was never intentional and no takxconfig.json should be relying on this functionality.

v3.5 Layout and v1 takxconfig.json

v3.5 Layout

Added

• Add ability to use a sprite sheet to specify custom assets. This allows creators to pack multiple assets into a single .png file to save on space and possibly reuse existing art assets.

{
  "type": "asset",
  "value": "spritesheetfilename/assetname"
}

v1 takxconfig.json

This is a new 'project' file that allows consumers of the command line tooling for the touch adaptation kit to have consistent and configurable results. Creators can easily check this file into source code to share bundle pack / serve settings and reduce complexity on the command line. A very simple takxconfig can be seen below.

{
  "$schema": "https://raw.githubusercontent.com/microsoft/xbox-game-streaming-tools/main/touch-adaptation-kit/schemas/takxconfig/v1/takxconfig.json",
  "layouts": {
    "path": "./layouts"
  },
  "assets": {
    "path": "./assets"
  },
  "context": {
    "path": "./context.json"
  },
  "version": "1.0.0.0"

v3.4.1 Layout Release

v3.4.1 Layout

Added

• Add ability to use the full size of the control when specifying custom assets. Previously certain control areas like the faceImage were restricted a much smaller asset area. Now, images can use the full space for more creative freedom. Note that is not directly a schema feature, but that the validation rules for packing a bundle have been updated to allow this.
• Allow the blank control type to be used within the sensors container in layers. This allows sensor controls to be conditionally turned off in a layer by applying a blank control over top of the base sensor.

Fixed

• Several linting issues with schema conformance to the draft specification. No behavior was changed but this should provide better support in tooling that interprets the schemas like vscode intellisense.
• Moved branches and schema identifiers to use the main branch on github following the move to make this the primary branch.