User Guide - XaviFortes/DeckSaves GitHub Wiki

๐Ÿ“š DeckSaves User Guide

Table of Contents

  1. Getting Started
  2. Game Management
  3. Synchronization
  4. Version Control
  5. Storage Management
  6. Best Practices

Getting Started

Understanding DeckSaves

DeckSaves is designed to solve the problem of managing game save files across multiple devices and protecting against save corruption or loss. Whether you're using a Steam Deck, gaming PC, or laptop, DeckSaves ensures your progress is always safe and synchronized.

Core Concepts

  • Games: Individual game configurations with their save file locations
  • Sync: The process of backing up and synchronizing save files
  • Versions: Historical snapshots of your save files that you can restore
  • Storage: Where your backup data is stored (local or cloud)

Interface Overview

DeckSaves has three main tabs:

  • Games: Manage your game library and perform sync operations
  • Storage: Configure where your backups are stored
  • Sync Status: Monitor ongoing operations and view logs

Game Management

Adding Games Automatically (Steam)

The easiest way to get started is by using Steam game detection:

  1. Click "Discover Steam Games"
  2. Wait for scan to complete - DeckSaves searches your Steam installation
  3. Review detected games - Check the list of found games and their save paths
  4. Select games to add - Choose which games you want to manage
  5. Click "Add Selected Games" - Import them into DeckSaves

Supported Steam Features:

  • Automatic save path detection for 500+ popular games
  • Steam Cloud save identification
  • Multiple save location detection
  • Steam Deck compatibility paths

Adding Games Manually

For non-Steam games or when automatic detection fails:

  1. Click "Add Game Manually"
  2. Fill in game information:
    • Game Name: A unique identifier (e.g., "Cyberpunk 2077")
    • Save Paths: Directories containing save files
  3. Configure save paths:
    • Click "Browse" to select directories
    • Add multiple paths if the game stores saves in different locations
    • Examples:
      • C:\Users\YourName\Documents\My Games\GameName\
      • /home/username/.local/share/gamename/
      • ~/Library/Application Support/GameName/
  4. Enable sync and click "Save"

Managing Existing Games

Once games are added, you can:

  • Enable/Disable sync using the toggle switch
  • Edit game settings by clicking the edit button
  • Remove games using the delete button
  • View sync history with the history button

Synchronization

Understanding Sync Types

Standard Sync (๐Ÿ”„)

  • Purpose: Basic backup without version history
  • Best for: Simple backup needs, games you play casually
  • What it does: Compares local and remote files, syncs the newest version
  • Storage: Overwrites existing backups

Versioned Sync (๐Ÿ•’)

  • Purpose: Advanced backup with complete version history
  • Best for: Important games, speedrunning, experimental gameplay
  • What it does: Creates a new version each time, preserving all history
  • Storage: Keeps multiple versions with timestamps

Smart Sync (๐Ÿ”„)

  • Purpose: Intelligent merging of local and cloud data
  • Best for: Setting up on new devices, resolving conflicts
  • What it does: Safely merges different versions without data loss
  • Storage: Combines local and remote versions intelligently

Performing Manual Syncs

Single Game Sync

  1. Find your game in the Games tab
  2. Choose sync type based on your needs:
    • Regular sync for basic backup
    • Versioned sync for important sessions
    • Smart sync for setup/conflict resolution
  3. Click the appropriate button
  4. Monitor progress in the status area
  5. Check results for success/error messages

Batch Operations

  • Sync All: Use the header "Sync All Games" button
  • Selective sync: Hold Ctrl/Cmd and click multiple games
  • Status monitoring: Watch progress for all operations

Automatic Sync (File Watching)

Enable automatic sync for seamless backup:

  1. Click the watch button (๐Ÿ‘๏ธ) next to a game
  2. DeckSaves monitors the save directories for changes
  3. Automatic sync triggers when files are modified
  4. Perfect for active gameplay - backup as you play

Watch Mode Features:

  • Real-time file monitoring
  • Batched sync to avoid spam
  • Intelligent change detection
  • Automatic conflict resolution

Version Control

Understanding Versions

Every versioned sync creates a snapshot of your entire save directory:

  • Timestamp: When the version was created
  • Unique ID: Technical identifier for the version
  • File Count: Number of files in the snapshot
  • Total Size: Storage space used
  • Pin Status: Whether the version is protected from cleanup

Viewing Version History

  1. Click "๐Ÿ“‹ History" next to any game
  2. Browse available versions sorted by date (newest first)
  3. View version details:
    • Creation timestamp
    • File information
    • Pin status
    • Storage size

Restoring Previous Versions

When you need to go back to an earlier save:

  1. Open version history for the game
  2. Find the version you want to restore to
  3. Click "โ†ฉ๏ธ Restore" next to that version
  4. Confirm the restoration - this will overwrite current saves
  5. Wait for completion - entire save directory is restored

Restoration Process:

  • Downloads the version archive
  • Extracts to your game's save directory
  • Replaces all current save files
  • Preserves the restored version in history

Pinning Important Versions

Protect crucial save points from automatic cleanup:

When to Pin:

  • Before boss fights or difficult sections
  • After major achievements or story milestones
  • Perfect run states for speedrunning
  • Experimental save points before trying new strategies
  • Completion saves at 100% progress

How to Pin:

  1. Open version history
  2. Find the important version
  3. Click the "๐Ÿ“Œ Pin" button
  4. Pinned versions show a solid pin icon
  5. Unpin by clicking the pin again

Pin Benefits:

  • Protected from automatic cleanup
  • Never deleted regardless of age
  • Easy identification in version list
  • Manual deletion requires unpinning first

Managing Storage Space

Automatic Cleanup

DeckSaves automatically manages old versions:

  • Age limit: Versions older than 30 days (configurable)
  • Count limit: Keep maximum 10 versions per game (configurable)
  • Pin protection: Pinned versions are never auto-deleted
  • Smart cleanup: Preserves important milestones

Manual Cleanup

Take control of your storage:

  1. Bulk cleanup: Click "๐Ÿงน Cleanup Old Versions" in any history view
  2. Individual deletion: Click "๐Ÿ—‘๏ธ Delete" next to specific versions
  3. Pin management: Unpin old versions you no longer need
  4. Storage monitoring: Check total usage in Storage tab

Safe Deletion Process:

  • Pinned versions cannot be deleted (must unpin first)
  • Confirmation required for all deletions
  • Cleanup operations are logged
  • No accidental data loss

Storage Management

Local Storage

Perfect for single-device setups or privacy-conscious users:

Configuration:

  • Default location: ~/.decksaves/
  • Custom location: Choose any directory with write access
  • Structure: Organized by game and version
  • Security: Standard filesystem permissions

Benefits:

  • No internet connection required
  • Complete privacy - data never leaves your device
  • Unlimited storage (limited by disk space)
  • Fast access and restore operations
  • No ongoing costs

Limitations:

  • Single device only (unless using shared network storage)
  • Manual transfer required for new devices
  • No automatic offsite backup

AWS S3 Storage

Ideal for multi-device synchronization and cloud backup:

Configuration:

  • Bucket: Your S3 bucket name (must exist)
  • Region: Choose closest region for best performance
  • Credentials: IAM Access Key and Secret Key
  • Security: Encrypted credential storage

Benefits:

  • Multi-device synchronization
  • Automatic cloud backup
  • Virtually unlimited storage
  • Access from anywhere with internet
  • Built-in redundancy and durability

Considerations:

  • Requires AWS account and S3 setup
  • Small costs based on storage and transfer
  • Internet connection required for sync
  • Slightly slower than local storage

Switching Storage Types

You can change storage types safely:

  1. Export configuration before switching
  2. Use Smart Sync to merge existing data
  3. Test with one game before full migration
  4. Verify all versions transferred correctly

Storage Security

DeckSaves protects your data:

  • Local encryption: AWS credentials encrypted with AES-256
  • Secure transfer: HTTPS for all S3 communications
  • No password storage: Game data not encrypted (standard file storage)
  • Access control: Respect filesystem permissions

Best Practices

Game Selection Strategy

  • Start small: Begin with 1-2 important games
  • Prioritize by value: Focus on games with significant progress
  • Consider play style: Versioned sync for experimental games
  • Regular sync: Standard sync for casual games

Version Management

  • Pin strategically: Don't pin every version, focus on milestones
  • Cleanup regularly: Review and remove old pins monthly
  • Use descriptive timing: Pin before major decisions
  • Balance storage: Monitor total storage usage

Sync Scheduling

  • Before gaming sessions: Sync before starting to play
  • After achievements: Create versions after major progress
  • Daily backup: At least one sync per gaming day
  • Multi-device: Sync before switching devices

Troubleshooting Prevention

  • Test configurations: Verify sync works before relying on it
  • Monitor status: Check sync status tab regularly
  • Backup configuration: Export settings occasionally
  • Keep credentials current: Update AWS keys when they expire

Performance Optimization

  • Reasonable save sizes: Be aware of large save files
  • Network timing: Sync during good internet connectivity
  • Local first: Consider local storage for frequently accessed games
  • Batch operations: Use "Sync All" instead of individual syncs

This user guide should help you get the most out of DeckSaves. For advanced features and technical details, see the Advanced Features Guide.