Skip to main content

A collection of Invoke tasks that manage Shattered Pixel Dungeon game data.

Project description

Shattered Pixel Dungeon Invoke Utility

License: AGPL v3 pytest

SpdIU is a collection of Invoke tasks that manage Shattered Pixel Dungeon game data.

It's a library of tricks to make your SPD CLI experience as comfortable as the rest of your awesome terminal!

  • Run common tasks out of the box from your console
  • Hook up your own Python tasks, leveraging the spdiu library

Documentation

What does it do?

Save and Load the game

SpdIU keeps a directory of save slots, containing copies of the game's full data folder.

  • siu save and load are all the commands you need to save-scum your way to 9-challenge
  • Safety backups give you a chance to un-wreck your save if you fat-finger it

Check for updates or download older versions

On github releases, just pick your version.

Create an issue if you know of an SPD fork hosted elsewhere, and we'll try to enable that platform, too!

Install flavors and remixes

With just a bit of configuration, you can use SpdIU to download any of the SPD forks available in the wild!

Display Profile and Game data

Get overviews of every single thing stored in your save data.

Cheat like it's 1989

Βless your next run with one out of a selection of care packages, or downright edit in that upgraded armor you wanted.

It's your game, after all!

Changelog

The project uses Semantic Versioning and roughly tries to abide with Keep a Changelog 1.1.0.

[Unrelased]

...and currently a work in progress.

  • Full pytest coverage on the current collections
    • slots
    • get (hrm)
    • display
    • cheats
  • A bit of logo n stuff
  • Game entity summaries
  • Better templates for tasks and config
  • More doc

[0.0.1] 2025-12-26

ho ho ho: first release

Added

  • The s[pd]iu executable, customized wrapper for inv[oke]
  • The SpdIU task collections:
    • slots manages saved states
    • display allows inspecting game data
    • get downloads and installs the game or forks
    • cheats identifies consumables, edits gold and energy, sets bones
  • tasks.py deployment allows custom user tasks per game
  • spdiu.yaml local config allows customizing every single bit of state
  • pre-commit: ruff lint and format, whitespace fixes, REUSE
  • pytest: Smoke test, classes and low level functions covered

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spdiu-0.1.0.tar.gz (36.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

spdiu-0.1.0-py3-none-any.whl (43.5 kB view details)

Uploaded Python 3

File details

Details for the file spdiu-0.1.0.tar.gz.

File metadata

  • Download URL: spdiu-0.1.0.tar.gz
  • Upload date:
  • Size: 36.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for spdiu-0.1.0.tar.gz
Algorithm Hash digest
SHA256 898489295abae715ff2256afa32b6f1d3d903c73f455bc377b0f63dc6e7df61f
MD5 47cc378f41eec69352e8d6e19425684c
BLAKE2b-256 2a43506840cc6a5781694e3f073d922800c15486001661d1c2e04b6543902528

See more details on using hashes here.

File details

Details for the file spdiu-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: spdiu-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 43.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.18 {"installer":{"name":"uv","version":"0.9.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for spdiu-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6a280af1c281bca40dbc77898a8829c10e68a039aefcf4f0e7b9c3b5baa12308
MD5 a39c1a2cbdc9037b241cac286967de51
BLAKE2b-256 8533af2cf8c03e65bb7d80fb9b5d7a8e135c6a181054b4880021025f5d89b439

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page