scratch-io 0.1.0

A command-line tool for managing, downloading, and launching games from itch.io
Documentation

🎮 scratch-io

scratch-io is a command-line tool for managing, downloading, and launching games from itch.io.

✨ Features

  • 🔑 Authentication with the itch.io API
  • 📥 Game download with automatic extraction
  • 🗃️ Management of installed games (list, move, delete, import)
  • 🚀 Game launch with smart heuristics to find the correct executable
  • 🗂️ Support for collections and game keys
  • 🖼️ Automatic cover art download

⚡ Build

Requires Rust and cargo:

git clone https://github.com/Vidi0/scratch-io.git
cd scratch-io
cargo build --release

The binary will be placed in target/release/scratch-io.

🚀 Usage

Authenticate with your itch.io API key:

scratch-io auth YOUR_API_KEY

Download a game by its upload ID:

scratch-io download 123456

List installed games:

scratch-io installed

Launch an installed game:

scratch-io launch 123456 GAME_PLATFORM

See all options with:

scratch-io --help

🛠️ Environment variables

  • SCRATCH_API_KEY: itch.io API key
  • SCRATCH_CONFIG_FILE: Custom path for the configuration file

📚 References

📝 TODO / Roadmap

  • Integration with Heroic Games Launcher:
    This project was designed with the intention of being integrated into Heroic Games Launcher.
    Note: Integration is not currently implemented.