Improvements to the main project and the GUI

.gitignore

@@ -0,0 +1,163 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Other
+config.json

README.md

@@ -40,8 +40,8 @@ To fix this bug, we've made a script that takes the GUID of the player on the ne
 
 Dependencies:
 - Python >=3.10
-- Install [Palworld Save Tools v0.17.1](https://github.com/cheahjs/palworld-save-tools) with `python -m pip install palworld-save-tools==0.17.1`
 - Clone the repository with `git clone https://github.com/xNul/palworld-host-save-fix`
+- Install the python packages with `pip install -r requirements.txt`
 
 Using the GUI:
 - Open Command Prompt in the folder

gui.py

@@ -2,9 +2,9 @@
 import os
 import subprocess
 import tkinter as tk
-from tkinter import filedialog, ttk
 
 from fix_host_save import sav_to_json
+from tkinter import filedialog, ttk
 
 guid_cache = {}
 config_file = 'config.json'
@@ -19,7 +19,7 @@ def browse_folder(entry):
         update_guid_dropdowns()
 
 def update_guid_dropdowns():
-    folder_path = entry_save.get()
+    folder_path = ent_save_folder.get()
     players_folder = os.path.join(folder_path, 'Players')
     if os.path.exists(players_folder) and os.path.isdir(players_folder):
         # List all files and remove the '.sav' extension.
@@ -28,54 +28,66 @@ def update_guid_dropdowns():
             for f in os.listdir(players_folder)
             if os.path.isfile(os.path.join(players_folder, f)) and f.endswith('.sav')
         ]
-        
+
         global guid_cache
-        if file_names != list(guid_cache.keys()):
+        if set(file_names) != set(guid_cache.keys()):
             level_json = sav_to_json(folder_path + '/Level.sav')
-            usernames = [
-                find_guid_info(level_json, guid)
-                for guid in file_names
-            ]
-            guid_cache = dict(zip(file_names, usernames))
-        else:
-            usernames = list(guid_cache.values())
-
-        if not combo_new_guid.get() in usernames:
-            combo_new_guid.set('')
-        if not combo_old_guid.get() in usernames:
-            combo_old_guid.set('')
-        combo_new_guid['values'] = usernames
-        combo_old_guid['values'] = usernames
-
-def find_guid_info(level_json, guid):
-    guid_formatted = '{}-{}-{}-{}-{}'.format(guid[:8], guid[8:12], guid[12:16], guid[16:20], guid[20:]).lower()
-
+            guid_cache = find_player_info(level_json, file_names)
+
+        usernames = list(guid_cache.values())
+        if not cmb_new_guid.get() in usernames:
+            cmb_new_guid.set('')
+
+        if not cmb_old_guid.get() in usernames:
+            cmb_old_guid.set('')
+
+        cmb_new_guid['values'] = usernames
+        cmb_old_guid['values'] = usernames
+
+def find_player_info(level_json, filename_guids):
+    player_info = {}
     character_save_parameter_map = level_json['properties']['worldSaveData']['value']['CharacterSaveParameterMap']['value']
+    guid_data = {
+        '{}-{}-{}-{}-{}'.format(guid[:8], guid[8:12], guid[12:16], guid[16:20], guid[20:]).lower():str(guid)
+        for guid in filename_guids
+    }
+
     for i in range(len(character_save_parameter_map)):
-        candidate_guid_formatted = character_save_parameter_map[i]['key']['PlayerUId']['value']
+        player_uid = character_save_parameter_map[i]['key']['PlayerUId']['value']
         save_parameter = character_save_parameter_map[i]['value']['RawData']['value']['object']['SaveParameter']['value']
-        if guid_formatted == candidate_guid_formatted and 'IsPlayer' in save_parameter and save_parameter['IsPlayer']['value'] == True:
-            return save_parameter['NickName']['value'] + ' (Lvl. ' + (str(save_parameter['Level']['value']) if 'Level' in save_parameter else '0') + ')'
+
+        if player_uid in guid_data.keys() and 'IsPlayer' in save_parameter and save_parameter['IsPlayer']['value'] == True:
+            nickname = save_parameter['NickName']['value']
+            level = str(save_parameter['Level']['value']) if 'Level' in save_parameter else '0'
+
+            formatted_player_guid = str(player_uid)
+            filename_guid = guid_data.pop(formatted_player_guid)
+
+            player_info[filename_guid] = f'{nickname} (Lvl. {level})'
 
-    return ''
+    player_info = dict(sorted(player_info.items(), key=lambda item: str(item[1]).lower()))
+    player_info.update({
+        filename_guid:formatted_guid
+        for formatted_guid, filename_guid in guid_data.items()
+    })
+
+    return player_info
 
 def run_command():
-    save_path = entry_save.get()
-    new_guid = list(guid_cache.keys())[combo_new_guid.current()]
-    old_guid = list(guid_cache.keys())[combo_old_guid.current()]
+    save_path = ent_save_folder.get()
+    new_guid = list(guid_cache.keys())[cmb_new_guid.current()]
+    old_guid = list(guid_cache.keys())[cmb_old_guid.current()]
     guild_fix = guild_fix_var.get()
 
-    command = (
-        f'python fix_host_save.py "{save_path}" {new_guid.replace(".sav", "")} {old_guid.replace(".sav", "")} {guild_fix}'
-    )
+    command = f'python fix_host_save.py "{save_path}" {new_guid.replace(".sav", "")} {old_guid.replace(".sav", "")} {guild_fix}'
     subprocess.run(command, shell=True)
     update_guid_dropdowns()
 
 def save_config():
     config = {
-        'save_path': entry_save.get(),
-        'new_guid': combo_new_guid.get(),
-        'old_guid': combo_old_guid.get(),
+        'save_path': ent_save_folder.get(),
+        'new_guid': cmb_new_guid.get(),
+        'old_guid': cmb_old_guid.get(),
         'guild_fix': guild_fix_var.get(),
     }
     with open(config_file, 'w') as f:
@@ -88,43 +100,50 @@ def load_config():
     if os.path.exists(config_file):
         with open(config_file, 'r') as f:
             config = json.load(f)
-            entry_save.insert(0, config.get('save_path', ''))
+            ent_save_folder.insert(0, config.get('save_path', ''))
             update_guid_dropdowns()
-            combo_new_guid.set(config.get('new_guid', ''))
-            combo_old_guid.set(config.get('old_guid', ''))
+            cmb_new_guid.set(config.get('new_guid', ''))
+            cmb_old_guid.set(config.get('old_guid', ''))
             guild_fix_var.set(config.get('guild_fix', ''))
 
 app = tk.Tk()
+app.geometry('350x250')
+app.resizable(False, False) 
 app.title('Fix Host Save Command GUI')
 
 # Save folder path.
 tk.Label(app, text='Path to save folder:').pack()
-entry_save = tk.Entry(app, width=50)
-entry_save.pack()
-entry_save.bind('<KeyRelease>', on_entry_change)
-button_browse_save = tk.Button(
-    app, text='Browse', command=lambda: browse_folder(entry_save)
+
+ent_save_folder = tk.Entry(app, width=50)
+ent_save_folder.pack()
+ent_save_folder.bind('<KeyRelease>', on_entry_change)
+
+btn_browse_folder = tk.Button(
+    app, text='Browse', command=lambda: browse_folder(ent_save_folder)
 )
-button_browse_save.pack()
+btn_browse_folder.pack(pady=(0, 10))
 
 # New GUID selection.
 tk.Label(app, text='The new character to overwrite:').pack()
-combo_new_guid = ttk.Combobox(app, postcommand=update_guid_dropdowns)
-combo_new_guid.pack()
+
+cmb_new_guid = ttk.Combobox(app, postcommand=update_guid_dropdowns, width=40)
+cmb_new_guid.pack(pady=(0, 10))
 
 # Old GUID selection.
 tk.Label(app, text='The old character to fix/keep:').pack()
-combo_old_guid = ttk.Combobox(app, postcommand=update_guid_dropdowns)
-combo_old_guid.pack()
+
+cmb_old_guid = ttk.Combobox(app, postcommand=update_guid_dropdowns, width=40)
+cmb_old_guid.pack(pady=(0, 10))
 
 # Guild fix selection.
 guild_fix_var = tk.BooleanVar()
-cb_guild_fix = tk.Checkbutton(app, text='Guild fix', variable=guild_fix_var, height=2)
-cb_guild_fix.pack()
+
+chk_guild_fix = tk.Checkbutton(app, text='Guild fix', variable=guild_fix_var, height=2)
+chk_guild_fix.pack()
 
 # Run command button.
-run_button = tk.Button(app, text='Run Command', command=run_command)
-run_button.pack()
+btn_run_command = tk.Button(app, text='Run command', command=run_command)
+btn_run_command.pack()
 
 load_config()