Skip to main content

A command line tool for saving snapshots of game saves

Project description

Quicksave

Quicksave is a command line tool for saving snapshots of game saves. It helps gamers create and manage backup snapshots of their game save files, with support for both local backups and AWS S3 cloud storage.

Features

  • Register any game's save directory for easy backup
  • Create snapshots of game saves with timestamps and optional tags
  • Support for both local and S3 cloud storage backups
  • Simple command line interface

Installation

Quicksave requires Python 3.13 or later.

pip install quicksave-tool

Usage

Basic Commands

# Show version
quicksave --version

# Register a new game
quicksave register "Game Name" --save-dir "/path/to/game/saves" --backup-dir "/path/to/backups"

# Create a snapshot
quicksave save "Game Name"

# Create a snapshot with a tag
quicksave save "Game Name" --tag "before_boss_fight"

# List registered games
quicksave list

# List game backups
quicksave show "Game Name"

Command Reference

Register a game

quicksave register GAME -s SAVE_DIR -b BACKUP_DIR [-a ALIAS]

Update a game configuration

quicksave update GAME [-s SAVE_DIR] [-b BACKUP_DIR] [-a ALIAS] [-r REMOVE_ALIAS]

Remove a game

quicksave deregister GAME

Create a save snapshot

quicksave save GAME [-t TAG] [-b BACKUP_DIR]

List registered games

quicksave list [-v]

Show game snapshots

quicksave show GAME [-b BACKUP_DIR]

Development

Setup Development Environment

  1. Clone the repository
git clone https://github.com/mathiasstaricka/quicksave.git
cd quicksave
  1. Set up virtual environment, install, and run
uv run quicksave

Running Tests

uv run pytest

License

This project is licensed under the MIT License - see the LICENSE file for details.

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

quicksave_tool-0.1.1.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

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

quicksave_tool-0.1.1-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

Details for the file quicksave_tool-0.1.1.tar.gz.

File metadata

  • Download URL: quicksave_tool-0.1.1.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.12

File hashes

Hashes for quicksave_tool-0.1.1.tar.gz
Algorithm Hash digest
SHA256 b51e912a1d6536485bb44af1cfa52fedc10d73907195843d48184b7f83e13c7e
MD5 f4c680e1e6d54c364e28d8205d6f5e13
BLAKE2b-256 aebb5df56be601dc535e2347161b4f8cf84fab9040ea52b09e58be6148a962fc

See more details on using hashes here.

File details

Details for the file quicksave_tool-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for quicksave_tool-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 db6a92d40ed98fc3b75bc6b2eeb33eff8f1990a4a66aeaefd241060cd67ba2e2
MD5 2aceb360f259d5427f514fa1195423ba
BLAKE2b-256 19ea9b6d54fc1a3ed16f186bf00430536bfe3a22d00114305292b94640bac64d

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