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
- Clone the repository
git clone https://github.com/mathiasstaricka/quicksave.git
cd quicksave
- 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file quicksave_tool-0.1.0.tar.gz.
File metadata
- Download URL: quicksave_tool-0.1.0.tar.gz
- Upload date:
- Size: 13.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.7.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4af36bb0a92b89d32c73d3b32ccb1c70a72221c6533ce320b449b7ce611165a0
|
|
| MD5 |
2929a7cc7670a4c2e0391485ab05914d
|
|
| BLAKE2b-256 |
8f776b4b3710a0d1936ed1205f710c7c9c37b7dab119fcaf8b15c3e2cd054d4a
|
File details
Details for the file quicksave_tool-0.1.0-py3-none-any.whl.
File metadata
- Download URL: quicksave_tool-0.1.0-py3-none-any.whl
- Upload date:
- Size: 11.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.7.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
02c4d106a1615c7e4b2690ed13607ff2263120d870cb2a905cb026563a719b76
|
|
| MD5 |
8ccd1cde47eb6bf7ecba3db5dcbb07fe
|
|
| BLAKE2b-256 |
70014a56ca13bcbea234e0b03c174d674e11b461eeead6f2b9c3debdd82026fe
|