GitOfHolding.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-

"""
GitOfHolding:
============

Creates a backup of the options and savegames from the games specified down below (see "mapping").
The currently supported games are:
- Baldur's Gate: Enhanced Edition
    -> The Black Pits
- Baldur's Gate II: Enhanced Edition
- Icewind Dale: Enhanced Edition
"""

import os
import pathlib
import shutil


# Constants to user profile and the actual data directory
HOME: str = os.environ["USERPROFILE"]
DATA: str = os.path.normpath(os.path.join(pathlib.Path(__file__).parent.resolve(), "data"))

# Mapping of game to savegame folder
KEY_TITLE = "title"
KEY_SAVEGAMES = "savegames"
KEY_OPTIONS = "options"

mapping: list[dict[str, str]] = [
    {
        KEY_TITLE:      "Baldur's Gate: Enhanced Edition",
        KEY_SAVEGAMES:  os.path.normpath(
            os.path.join(HOME, "Documents\\Baldur's Gate - Enhanced Edition\\save")
        ),
        KEY_OPTIONS:    os.path.normpath(
            os.path.join(HOME, "Documents\\Baldur's Gate - Enhanced Edition\\Baldur.lua")
        )
    },
    {
        KEY_TITLE:      "Baldur's Gate: Enhanced Edition (The Black Pits)",
        KEY_SAVEGAMES:  os.path.normpath(
            os.path.join(HOME, "Documents\\Baldur's Gate - Enhanced Edition\\bpsave")
        ),
        KEY_OPTIONS:    os.path.normpath(
            os.path.join(HOME, "Documents\\Baldur's Gate - Enhanced Edition\\Baldur.lua")
        )
    },
    {
        KEY_TITLE:      "Baldur's Gate II: Enhanced Edition",
        KEY_SAVEGAMES:  os.path.normpath(
            os.path.join(HOME, "Documents\\Baldur's Gate II - Enhanced Edition\\save")
        ),
        KEY_OPTIONS:    os.path.normpath(
            os.path.join(HOME, "Documents\\Baldur's Gate - Enhanced Edition\\Baldur.lua")
        )
    },
    {
        KEY_TITLE:      "Icewind Dale: Enhanced Edition",
        KEY_SAVEGAMES:  os.path.normpath(
            os.path.join(HOME, "Documents\\Icewind Dale - Enhanced Edition\\save")
        ),
        KEY_OPTIONS:    os.path.normpath(
            os.path.join(HOME, "Documents\\Baldur's Gate - Enhanced Edition\\Baldur.lua")
        )
    }
]


"""
Main method called when script / executable is running
"""
if __name__ == "__main__":
    for game in mapping:
        # i) if no options found the game was not played yet therefore also no savegames available
        if not os.path.exists(game[KEY_OPTIONS]):
            print(f"{game[KEY_TITLE]} -> no options available, maybe game not installed!")
            continue

        # ii) backup options
        print(f"{game[KEY_TITLE]} -> options found, therefore backing them up!")

        saved_files: str = os.path.join(
            DATA, game[KEY_TITLE].replace(":", " -")
        )
        if os.path.exists(saved_files):
            shutil.rmtree(saved_files)
        
        os.mkdir(saved_files)
        
        shutil.copy(
            game[KEY_OPTIONS],
            os.path.join(saved_files, game[KEY_OPTIONS].split("\\")[-1])
        )

        print(f"{game[KEY_TITLE]} -> options fully backed up!")

        # iii) if no savegames found the game was not played yet
        if not os.path.exists(game[KEY_SAVEGAMES]) or len(os.listdir(game[KEY_SAVEGAMES])) < 1:
            print(f"{game[KEY_TITLE]} -> no savegames available, maybe game not played yet!")
            continue

        # iv) backup savegames
        print(f"{game[KEY_TITLE]} -> savegames found, therefore backing them up!")
        
        for element in os.listdir(game[KEY_SAVEGAMES]):
            element_path = os.path.join(game[KEY_SAVEGAMES], element)
            if (os.path.isdir(element_path)):
                shutil.copytree(element_path, os.path.join(saved_files, element))
            else:
                shutil.copy(element_path, os.path.join(saved_files, element))
        
        print(f"{game[KEY_TITLE]} -> savegames fully backed up!")