/minitool

A command-line tool for interacting with devices running the minipad firmware!

Primary LanguageC#GNU General Public License v3.0GPL-3.0

minitool

License: GPL v3 Discord Downloads Latest Release

The command-line tool for the minipad, an RP2040-based 2-3-key keypad for the rhythm game osu!.

This tool is designed specifically to work with our open-source firmware,
which can be found in our GitHub repository here.

Note: Currently, only Windows is supported.

Usage

Made with ❤️ by Project Minipad

Usage

This command-line utility can be used either via the CMD or PowerShell, or by simply running the minitool.exe file. Below you can find a list of commands.
Note: 'port' is always referring to the port number, excluding the COM prefix. (e.g. 4 instead of COM4)

General syntax: minitool.exe <sub-command> <parameters...>

Command: devices
Description: Lists all connected minipad devices.
Example: minitool.exe devices

Command: info <port>
Description: Outputs the configuration of the minipad device.
Example: minitool.exe info 7

Command: boot <port>
Description: Sets the minipad device into bootloader mode.
Example: minitool.exe boot 4

Command: send <port> "<command>"
Description: Sends the specified command to the minipad device.
Example: minitool.exe send 9 "hkey.rt 1"

Command: visualize <port>
Description: Displays a commandline-based visualizer for the Hall Effect keys.
Example: minitool.exe visualize 14

Command: flash <port> <file>
Description: Flashes the specified firmware file (.UF2) to the minipad device.
Example: minitool.exe flash 11 firmware.uf2

Command: console <port>
Description: Opens a console for sending commands to the minipad device.
Example: minitool.exe console 6

You can also find a list of these commands by running the minitool.exe file.

A list of commands for the minipad firmware can be found here.