microsoft / xbox-game-streaming-tools Goto Github PK

This repository provides tools, schemas, and samples to empower game creators that are optimizing their games for Xbox game streaming.

To get started with Xbox game streaming you apply to the ID@Xbox program at http://www.xbox.com/en-us/Developers/id.

To learn more about optimizing your Xbox game for game streaming see the developer documentation.

• Touch Adaptation Kit Command Line Tool (TAK CLI) releases for Windows and MacOS.
• Schema representing the capabilities of the Touch Adaptation Kit that allows for your creation of custom touch layouts for your games.
• Sample touch adaptation layouts to get started.
• Scripts to assist in the development of touch adaptation layouts.

⚠️ The TAK CLI is governed by its own End User License Agreement that must be read and accepted before using the tool. This can be done using the CLI's license command.

The TAK CLI is a command line tool that allows you to create, validate, and package touch adaptation layouts for your games. It is available for Windows and MacOS and is publicly distributed as a standalone executable for through the releases page of this repository.

You can read more about the TAK CLI in the public documentation.

The CLI is also required for the core functionalities of the Touch Adaptation Kit Editor extension for VS Code. The extension provides a visual editing experience for touch adaptation bundles and is recommended as a starting point for creating touch experiences for Xbox game streaming.

💡 Note that newer versions of the TAK Editor extension may require a newer version of the TAK CLI. Please ensure that you are using the latest version of both tools.

You can read more about setting up the TAK Editor extension in the public documentation.

The TAK CLI can be installed on Windows using WinGet (documentation, download).

winget install Microsoft.Gaming.TAK.CLI

If you have already installed the TAK CLI through WinGet, you can upgrade to the latest version using the following command:

winget upgrade Microsoft.Gaming.TAK.CLI

Alternatively, you can download a single file executable (tak.exe) from the releases page of this repository. The binary can be used immediately from the command line.

Once the CLI executable is downloaded and the TAK Editor extension is installed in VS Code, you must provide its path to the extension, either through the VS Code settings, or by executing the "Set TAK CLI path" command from the command palette.

The TAK CLI can be installed on MacOS using Homebrew. If you have not installed Homebrew, you can do so by following the instructions on the Homebrew website.

brew install microsoft/xbox-game-creator-tools/tak-cli

If you have already installed the TAK CLI through Homebrew, you can upgrade to the latest version using the following command:

brew upgrade tak-cli

Alternatively, you can download a DMG file (tak-<version>.dmg) from the releases page of this repository. The file contains the CLI executable (tak) that can be extracted and used from the command line. This can either be done by double-clicking the DMG file and dragging the executable to a location of your choice, or by using the terminal to extract the executable.

hdiutil attach tak-<version>.dmg
cp /Volumes/tak/tak <destination directory>
hdiutil detach /Volumes/tak

Similar to the Windows installation, you must provide the path to the CLI executable to the TAK Editor extension in VS Code, either through the VS Code settings, or by executing the "Set TAK CLI path" command from the command palette.

This project welcomes contributions and suggestions. For more information see CONTRIBUTING.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.