Share via

How to use the Remote Windows Game Development Tools

Important

The Xbox PC Toolbox app is in preview. To learn more, contact your Microsoft representative.

Set up your development device

  1. On your device, download and install the Xbox PC Toolbox from the Microsoft Store on Windows.

  2. Open the app. Select Set as development device, then choose Continue.

  3. Select Install Tools to add the required components for your environment.

    Note

    By selecting Install Tools you accept the Terms of Agreement. To review the terms, select the link on the installation screen.

    Xbox PC Toolbox app setup pre-requisites installation screen

  4. After installation, choose the network adapter for the secure channel. If your system has one adapter, it’s selected automatically.

  5. Add a strong passphrase to protect your SSH key. Save the passphrase securely.

  6. Select Confirm to start the device configuration process.

  7. When configuration is complete, you’ll see the device workspace screen.

Set up your remote target device

Note

The setup steps for both devices are the same except:

  • Step 2: Select Set as remote iteration device instead
  • Step 5: You don't create SSH keys or add a passphrase on the target device.

Follow the same steps as for the development device up to Step 6, with the adjustments above.

Pair your devices

  1. On the remote target device: In the workspace, select Pair this device to start pairing.

    Pair this device

  2. On the target device: Select Start Pairing. The app generates a pin and displays connection details. Note these details for setup and testing the connection.

    Remote device connection details

    Note

    You have 2 minutes to input the pin on the development PC before it expires.

  3. On the development device: On the device workspace screen select Pair device. This opens the pairing screen to input the connection information obtained from the remote iteration device. Enter the alias, IP address or device name, username, and pin. Select Confirm.

    Pairing a new device

  4. On the remote target device: When pairing succeeds, select Return Home to go back to the workspace. The device is ready for secure remote connections.

    Pairing successful

  5. On the development device: To finalize setup, accept the SSH fingerprint. The app opens a terminal and asks if you want to continue. Type yes and press Enter.

    Accept SSH fingerprint

    Note

    After connecting, type exit and press Enter to close the window. Closing with the X button might cause known issues.

  6. On the development device When the connection test finishes, a success screen confirms your devices are securely paired. Select Return.

Use Xbox PC Device Manager (XDM)

Xbox PC Device Manager (XDM) is a PowerShell module installed during setup. It creates secure, encrypted communication between development PCs and remote devices. XDM manages device acquisition, OpenSSH configuration, trust, and enables remote command execution with device state management.

Start an interactive session

On your development PC, go to the device workspace in Xbox PC Toolbox. Find the card for the device you want to connect to and select Connect.

Connect Device Workspace screen

This starts an interactive session with the remote device in a command-line terminal. Commands you run here execute on the remote device.

Provision remote iteration tools

wdRemote and wdEndpoint are command-line utilities for incrementally deploying, launching and terminating games on remote Windows devices after you set up a secure connection with Xbox PC Toolbox. Both standalone executables installed during pairing.

  • wdRemote.exe: Runs on the development PC and sends commands.
  • wdEndpoint.exe: Runs on target device and executes commands.

Use wdRemote

Open a command-line terminal on your development PC to run wdRemote commands.

Deploy a game

When you specify paths for remote machines, use paths relative to the gameroot directory. The game root directory is C:\%ProgramData%\Microsoft GDK\wdEndpoint\gameroot on the target device.

# Syntax
wdRemote /action:deploy /device:<computername or ip address> /source:<source_directory> /destination:<destination_directory_under_gameroot>

# Example
wdRemote /action:deploy /device:mypc1 /source:c:\game /destination:gamedir

Launch a game

# Syntax  
wdRemote /action:launch /device:<computername or ip address> /path:<remote_path_to_exe_within_gameroot>

# Example
wdRemote /action:launch /device:mypc1 /path:gamedir\game.exe

Terminate a game

# Syntax
wdRemote /action:terminate /device:<computername or ip address> /processid:<game_process_id>

# Example
wdRemote /action:terminate /device:mypc1 /processid:1234

Send feedback

From the Xbox PC Toolbox title bar, select Send Feedback. Then select Report a Problem.

alt text

When reporting issues, include:

  • Operating System version (Windows 10/11 build)
  • PowerShell version ($PSVersionTable) for Xbox Device Management PowerShell Module issues
  • Network configuration (Wi-Fi/Ethernet, corporate/home)
  • Error messages (exact text)
  • Steps to reproduce
  • Which tool was being used (Xbox PC Toolbox, Xbox Device Management PowerShell Module, wdRemote, or wdEndpoint)
  • Preview version you're using
  • Last updated on