Vostok-Save-Manager 2.0.0__py3-none-any.whl

VSM/backup.py

@@ -0,0 +1,29 @@
+from shutil import copy
+from pathlib import Path
+from VSM.util import json_read as jr
+import os
+from datetime import datetime
+import json
+
+def backup():
+
+    line = "1"
+
+    backup_path = jr()['backup_path']
+    game_data_path = jr()['game_data_path']
+
+    backup_time = datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
+
+    backup_path = os.path.join(backup_path, backup_time)
+
+    os.makedirs(backup_path, exist_ok=True)
+
+#Defines the ".tres" suffix. I shouldn't need to do this but its the only way this shit will work.
+    suffix = ".tres"
+
+#I think this is converting game_data_dir to a path instead of a string. IDK becuase when I removed it, everything fucking broke
+    work_dir = Path(game_data_path) 
+
+    for file_name in work_dir.rglob(f"*{suffix}"):
+        copy(file_name, backup_path)
+    print('Backup successful!')

VSM/load.py

@@ -0,0 +1,38 @@
+from VSM.backup import backup
+from VSM.util import json_read as jr
+from shutil import move
+from shutil import copy
+from pathlib import Path
+import json
+from datetime import datetime
+import os
+
+def load():
+
+    while True:
+        save_to_load = input("What save would you like to load?: ")
+
+        print("Backing up current save...")
+
+        backup()
+
+        save_path = jr()['save_path']
+        game_data_path = jr()['game_data_path']
+
+
+        save_name_path = os.path.join(save_path, save_to_load)
+        save_dir_check = Path(save_name_path)
+
+        if save_dir_check.exists():
+
+            suffix = ".tres"
+
+            work_dir = Path(save_name_path) 
+
+            for file_name in work_dir.rglob(f"*{suffix}"):
+                copy(file_name, game_data_path)
+            
+            break
+        print("Please input a valid save file.")
+        
+    print('Load successful! Returning to main menu...')

VSM/main.py

@@ -0,0 +1,26 @@
+from VSM.load import load
+from VSM.save import save
+from VSM.setup import setup
+
+def launch():
+    while True:
+
+        mode = input("What you like to do?: Load, Save, Setup, Exit: ")
+
+        if mode.lower() == "setup":
+            print("Loading setup module...")
+            setup()
+
+        elif mode.lower() == "save":
+            print ("loading save module...")
+            save()
+
+        elif mode.lower() == "load":
+            print("loading load module...")
+            load()
+
+        elif mode.lower() == "exit":
+            print("exiting...")
+            exit()
+        else:
+            print("Please input a proper option")

VSM/save.py

@@ -0,0 +1,88 @@
+#This takes a snapshot of the save files and saves them.
+from shutil import copy
+from pathlib import Path
+from VSM.util import jsonl_read as jlr, check_paths, json_read as jr
+import os
+import json
+import time
+import datetime
+import math
+from platformdirs import user_config_path
+
+jsonl_path = user_config_path('Vostok Save Manager', 'Manhattan Cafe') / 'Time.jsonl'
+
+def check_time():
+
+    scum_time_value = float(jr()['scum_time'])
+    last_load_time = jlr()
+    till_next_load = float(last_load_time) + scum_time_value
+
+    time_now = time.time()
+
+    if time_now >= till_next_load:
+        can_move = 'yes'
+        
+    else:
+        can_move = 'no'
+    return can_move
+        
+
+
+def save():
+
+    save_path = jr()['save_path']
+    game_data_path = jr()['game_data_path']
+    scume_time_value = jr()['scum_time']
+
+    print('Checking last save time...')
+
+    if check_time() == 'no':
+
+        time_of_save = jlr()
+
+        save_time_add = time_of_save + float(scume_time_value)
+
+        time_now = time.time()
+
+        till_next_load = math.ceil(save_time_add - time_now)
+        
+        readable_time = datetime.timedelta(seconds=till_next_load)
+
+        print('You have', readable_time, "left. Please wait until saving again" )
+        return()
+    
+    elif check_time() == 'yes':
+
+        print('You can save!')
+        
+        pass
+    
+    else:
+        print("ERROR: can_move not defined")
+        return()
+
+
+    save_name = input("Please input a name: ")
+
+    print('Saving...')
+
+    save_name_path = os.path.join(save_path, save_name)
+
+
+    os.makedirs(save_name_path, exist_ok=True)
+
+#Defines the ".tres" suffix. I shouldn't need to do this but its the only way this shit will work.
+    suffix = ".tres"
+
+#I think this is converting game_data_dir to a path instead of a string. IDK becuase when I removed it, everything fucking broke
+    work_dir =  Path(game_data_path) 
+
+    for tres_file in work_dir.rglob(f"*{suffix}"):
+        copy(tres_file, save_name_path)
+    
+    time_of_save = time.time() 
+
+    with open(jsonl_path, "w") as file:
+        json.dump(time_of_save, file)
+
+    print('Succesfully saved!')

VSM/setup.py

@@ -0,0 +1,93 @@
+import json
+from VSM.util import check_paths, json_read as jr
+from pathlib import Path
+from platformdirs import user_config_path
+
+def setup():
+
+    json_path = user_config_path('Vostok Save Manager', 'Manhattan Cafe') / 'Data.json'
+    def write():
+        print('Writing to config...')
+
+        data_to_write = {"game_data_path": game_data_path,
+                "save_path": save_path,
+                "backup_path": backup_path,
+                "scum_time": scum_time}
+        with open(json_path, 'w') as file:
+            json.dump(data_to_write, file, indent=2)
+        print("Write successful! Returning to main menu...")
+    check_paths()
+
+    backup_path_json = jr()['backup_path']
+    save_path_json = jr()['save_path']
+    game_data_path_json = jr()['game_data_path']
+    scum_time_json = jr()['scum_time']
+
+    while True:
+
+        game_data_path = input("Input the directory your save files are in. If you already did this type 'No': ")
+        game_data_path_check = Path(game_data_path)
+
+        if game_data_path.lower() == "no":
+
+            game_data_path = game_data_path_json
+
+            break
+
+        if game_data_path_check.exists():
+
+            break
+
+        print("Please input a proper path or option. Ensure your path does not have any qoutes or special characters")
+
+    while True:
+
+        save_path = input("Input the directory you want the files to be saved in: Default (recomended): ")
+        save_path_check = Path(save_path)
+
+        if save_path.lower() == "default":
+
+            save_path = save_path_json
+
+            break
+
+        if save_path_check.exists():
+
+            break
+        print("Please input a proper path or option. Ensure your path does not have any qoutes or special characters")
+
+    while True:
+
+        backup_path = input("Input the backup directory. This is used to backup your current save files before loading: Default (recomended): ")
+        backup_path_check = Path(backup_path)
+
+        if backup_path.lower() == "default":
+
+            backup_path = backup_path_json
+
+            break
+
+        if backup_path_check.exists():
+
+             break
+        print("Please input a proper path or option. Ensure your path does not have any qoutes or special characters")
+
+    while True:
+        scum_time = input("The application uses an anti-save-scum feature prevents abusing the save feature. Please input a the ammount of time you want between saves in secconds: Default: 5400 (1.5 hours): ")
+
+        if scum_time.lower() == "default":
+
+            scum_time = scum_time_json
+
+            break
+        else:
+
+            try:
+                is_valid = float(scum_time)
+                break
+
+            except ValueError:
+                print("Input must be an integer, float (number with or without decimal) or 'default'")
+
+
+    write()

VSM/util.py

@@ -0,0 +1,78 @@
+import json
+from pathlib import Path
+from platformdirs import user_data_path, user_config_path
+
+
+author_name = 'Manhattan Cafe'
+project_name = 'Vostok Save Manager'
+json_name = 'Data.json'
+jsonl_name = 'Time.jsonl'
+save_path_name = 'Saves'
+backup_path_name = 'Backups'
+
+def check_paths():
+    data_path = user_data_path(project_name, author_name)
+    config_path = user_config_path(project_name, author_name)
+    saves_path = data_path / Path(save_path_name)
+    backup_path = data_path / Path(backup_path_name)
+    json_path = config_path / Path(json_name)
+    jsonl_path =  config_path / Path(jsonl_name)
+
+    print("Checking default path directories...")
+    if not saves_path.exists() and not backup_path.exists():
+        print('Directoris do not exist. Creating...')
+
+        saves_path.mkdir(parents=True, exist_ok=True)
+        backup_path.mkdir(parents=True, exist_ok=True)
+        print("Directories created successfully!")
+    else:
+        print('Directories already exist, nothing to do')
+        pass
+
+    print('Checking if config exists...')
+    if json_path.exists():
+        print('Config already exists, nothing to do')
+        pass
+    else:
+        print('Config does not exist. Creating with defaults...')
+        
+        config_path.mkdir(parents=True, exist_ok=True)
+        
+        default_json = {"game_data_path": "null",
+                        "save_path": str(saves_path),
+                        "backup_path": str(backup_path),
+                        "scum_time": "5400"}
+        with open(json_path, "w") as file:
+            json.dump(default_json, file, indent=2)
+        print('Config created succesfully!')
+
+    print('Checking if time file exists...')
+    if jsonl_path.exists():
+        print('File exists, nothing to do')
+        exit
+    else:
+        print('File does not exist, Creating with defaults...')
+        config_path.mkdir(parents=True, exist_ok=True)
+        
+        default_jsonl = "0"
+        with open(jsonl_path, "w") as file:
+            json.dump(default_jsonl, file)
+        print('File created succesfully!')
+    print("Check finished succesfully")
+    
+
+def json_read():
+
+    json_path = user_config_path(project_name, author_name) / json_name
+
+    with open(json_path, "r") as file:
+        json_data = json.load(file)
+    return json_data
+
+def jsonl_read():
+
+    jsonl_path = user_config_path(project_name, author_name) / jsonl_name
+
+    with open(jsonl_path, "r") as file:
+        jsonl_data = json.load(file)
+    return jsonl_data

vostok_save_manager-2.0.0.dist-info/METADATA

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: Vostok-Save-Manager
+Version: 2.0.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: platformdirs>=1.0.0
+
+# VSM: An open source, dead simple save manager for Road to Vostok
+
+## WARNINGS. Read before you use
+- I am not responsible for any lost progress and saves, I encourage you to back up your files first
+- I encourage you not to abuse this. The game is supposed to be hardcore, so only use this when you genuinely need it.
+- DO NOT TRY TO USE THIS WHILE THE GAME IS RUNNING. I have not tested what will happen, but my assumption is nothing good.
+
+## Note on macOS
+This application is a python project, is installed from pypi and automatically detects the operating system. There is no reason this should not work on mac, but I do not own a mac so I can not confirm it. 
+
+# Installation
+
+## Dependencies
+Requires python 3.10 (havn't verified if it works on older versions) or newer
+Requires pipx. For windows users, you can _technically_ use standard pip since windows allows you to install packages directly to global, but pipx is better and is a requirment on linux.
+
+## Linux
+
+1. Use pipx to install the package 
+```shell
+pipx install vostok-save-manager
+```
+2. You should automatically get access to the command ```VSM```. This is the command to launch the "main menu" 
+3. After you type ```VSM``` you should see in your terminal ```What you like to do?: Load, Save, Setup, Exit: ```. Type ```setup``` to continue the setup
+4. You will be asked where the game data is located. This is not the game installation folder as Road to Vostok puts its game data in a different location than its installation
+5. You will be asked where you want your saved files to be stored. The recomended is ```default``` since it automatically creates a default directory.
+6. You will be asked where you want your backuped up save  files to be stored. The recomended is ```default``` since it automatically creates a default directory.
+7. You will be asked how much time you want before you can save again. The default time is 5400 secconds, which is 1 hour and 30 minutes. You can change this to whatever you want, but it must be input as secconds and as an interger (whole number) or float (number with decimal).
+8. The setup is now done.
+
+## Windows
+
+1. Use pipx to install the package 
+```shell
+pipx install vostok-save-manager
+```
+Or since windows doesn't strictly require packages be in a virtual environment
+```shell
+pip install vostok-save-manager
+```
+But pipx is recomended
+
+2. You should automatically get access to the command ```VSM```. This is the command to launch the "main menu". If you get an error along the lines of "VSM is not recognized as command" run
+```shell
+pipx ensurepath
+```
+and try again.
+
+3. After you type ```VSM``` you should see in your terminal ```What you like to do?: Load, Save, Setup, Exit: ```. Type ```setup``` to continue the setup
+4. You will be asked where the game data is located. This is not the game installation folder as Road to Vostok puts its game data in a different location than its installation
+5. You will be asked where you want your saved files to be stored. The recomended is ```default``` since it automatically creates a default directory.
+6. You will be asked where you want your backuped up save  files to be stored. The recomended is ```default``` since it automatically creates a default directory.
+7. You will be asked how much time you want before you can save again. The default time is 5400 secconds, which is 1 hour and 30 minutes. You can change this to whatever you want, but it must be input as secconds and as an interger (whole number) or float (number with decimal).
+8. The setup is now done.
+
+# How to use
+ 
+## How to save
+1. On the main menu type "Save."
+2. You will be prompted to name the save. This can be anything.
+3. After you input your save, the game will automatically copy and store the current save files in your game directory. No backup is needed since it is not moving or replacing anything.
+4. If you input the name of an already existing save it WILL overwrite it.
+5. You have now saved your game.
+
+## How to load
+1. On the main menu type "Load."
+2. You will be prompted to give the name of a save. This has to be EXACT and is case sensitive.
+3. The application automatically backs up the save files currently in your game data directory.
+4. You have now loaded a save.
+
+# Things to add
+- A GUI
+
+# Credits
+
+Purchase Road to Vostok on [Steam.](https://store.steampowered.com/app/1963610/Road_to_Vostok/)

vostok_save_manager-2.0.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+VSM/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+VSM/backup.py,sha256=9G4ti_eLWwql7nB4zZqdHSSRHx1gR-cKKnTJBSoiRGU,855
+VSM/load.py,sha256=wGbFus7cb9cgdZnThG3TBAXtWgnEfrxzQ6xvDMH6hBw,953
+VSM/main.py,sha256=8quk0qd_IiqeBXZcA_X6V6GXhKuPWQ2Xb9j0NUHk_p8,668
+VSM/save.py,sha256=CQp7Kc4kFMJMzeVrur2o3rqxJVFZHvMGulTWE2Xk-QM,2214
+VSM/setup.py,sha256=1qo9Ak972I4eKVMZbihI4-nwzJTpxmzau85IU0vGrek,2907
+VSM/util.py,sha256=nHgC48mhWddUsLl08cDFOf3uBM32Fst7pqKfvpyfsuE,2577
+vostok_save_manager-2.0.0.dist-info/METADATA,sha256=Ym4pS6eO3JF3wG4QAKIypw_IIReRq4s-WZW6WqhvbBA,4621
+vostok_save_manager-2.0.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+vostok_save_manager-2.0.0.dist-info/entry_points.txt,sha256=tiQgMySHEuMcOclVt3UbJylAxsdKmRWsvImWLSsscnw,40
+vostok_save_manager-2.0.0.dist-info/top_level.txt,sha256=vsWYOH8-pi6GT39L9kAJqlTUj4CIobkGaDhafpTKx-Q,4
+vostok_save_manager-2.0.0.dist-info/RECORD,,

vostok_save_manager-2.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

vostok_save_manager-2.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+VSM = VSM.main:launch

vostok_save_manager-2.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+VSM