15 releases

0.3.6 Jun 17, 2024
0.3.5 May 12, 2024
0.3.3 Apr 30, 2024
0.2.3 Apr 4, 2024
0.0.0 Sep 4, 2023

#1058 in Hardware support

45 downloads per month

MIT/Apache

200KB
4.5K SLoC

Playdate Tool

Cross-platform CLI-tool for interaction with Playdate device and simulator.

Can do for you:

  • operate with multiple devices simultaneously
    • find connected devices, filter by mode, state, serial-number
    • send commands
    • read from devices
    • mount as drive (mass storage usb)
    • unmount
    • install pdx (playdate package)
    • run pdx (optionally with install pdx before run)
  • operate with simulator
    • run pdx
    • read output from sim.

Tested on following platforms:

  • MacOs
  • Linux
  • Windows

Prerequisites

To build playdate-tool you're need:

  1. Rust nightly toolchain
  2. Linux only:
  1. Windows only:
  • powershell (used as fallback)
  1. Playdate SDK with simulator
    • Ensure that env var PLAYDATE_SDK_PATH points to the SDK root. This is optional, but good move to help the tool to find SDK, and also useful if you have more then one version of SDK.

Installation

cargo install playdate-tool

Also with optional feature eject, windows only:

cargo install playdate-tool --feature=eject

Usage

pdtool --help
Help output example
Usage: pdtool [OPTIONS] <COMMAND>

Commands:
  list     Print list of connected active Playdate devices
  mount    Mount a Playdate device if specified, otherwise mount all Playdates as possible
  unmount  Unmount a Playdate device if specified, otherwise unmount all mounted Playdates
  install  Install given package to device if specified, otherwise use all devices as possible
  run      Install and run given package on the specified device or simulator
  read     Connect to device and proxy output to stdout
  send     Send command to specified device
  help     Print this message or the help of the given subcommand(s)

Options:
      --format <FORMAT>  Standard output format [default: human] [possible values: human, json]
  -h, --help             Print help
  -V, --version          Print version

This software is not sponsored or supported by Panic.

Dependencies

~21–58MB
~850K SLoC