How z1ni/xgp-save-extractor works
Main Components
• Main Script (main.py): The entry point that orchestrates the extraction process.
• Game Configuration (games.json): Contains the listing or parameters for supported games.
• File I/O Subsystem: Represents the mechanism that reads save files from disk and writes out ZIP files.
• External Services & Inputs/Outputs:
– Cloud Sync/Operating System: The project interacts with the Xbox cloud save sync and local file system.
– PyInstaller Build Pipeline: Highlight the build/deployment process that generates a one-file executable using PyInstaller (indicated by the GitHub Actions workflow in .github/workflows/pyinstaller.yml).
Relationships and Interactions
• A side pathway showing that the project’s CI/CD (GitHub Actions workflow with PyInstaller) builds the executable, bundling Python interpreter and scripts.
Architectural Patterns & Design Principles
• Although the project is relatively simple, you might conceptually label it with a “procedural flow” design. Emphasize the clear separation between configuration, core logic (extraction), and deployment/build steps.
• That the design leverages external tools (PyInstaller) and standard Python modules for file compression and I/O.
• Use of external resources/integrations (e.g., PCGamingWiki for save file location references, and cloud sync behavior via Xbox Game Pass).
What
• Clear labels for every component that you have identified (Main Script, Game Configuration, Save Extraction Logic, File I/O, External Services, CI/CD Pipeline).
• Annotations that briefly describe the purpose of each module/component (for instance, “Main Script: orchestrates the extraction of game saves”, “PyInstaller: wraps the project into a standalone executable”, etc.).