Merge pull request #150 from alvindimas05/main

Ryujinx Support for MacOS

Author: MaxLastBreath

.github/workflows/build-multiplatform.yml

@@ -25,6 +25,12 @@ jobs:
         - name: Linux
           os: ubuntu-20.04
           artifactsPath: ./src/dist/*.AppImage
+        - name: MacOS Intel
+          os: macos-latest-large
+          artifactsPath: ./src/dist/*.zip
+        - name: MacOS Silicon
+          os: macos-latest
+          artifactsPath: ./src/dist/*.zip
         - name: Windows_dir
           os: windows-latest
           artifactsPath: ./src/dist/*.zip
@@ -34,10 +40,10 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v3
-    - name: Set up Python 3.11
+    - name: Set up Python 3.12
       uses: actions/setup-python@v3
       with:
-        python-version: "3.11.5"
+        python-version: "3.12.0"
     - name: Install dependencies Linux
       if: startsWith(matrix.name, 'Linux' )
       run: |
@@ -48,16 +54,21 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install requests patool screeninfo packaging wmi GPUtil psutil pyinstaller https://github.com/MaxLastBreath/ttkbootstrapFIX/zipball/master
+    - name: Install dependencies MacOS
+      if: startsWith(matrix.name, 'MacOS' )
+      run: |
+        python -m pip install --upgrade pip
+        pip install requests patool screeninfo packaging wmi GPUtil psutil pyinstaller https://github.com/MaxLastBreath/ttkbootstrapFIX/zipball/master
     - name: Build ${{ matrix.name }}
       run: |
         cd ./src/
-        python ./compile_onedir.py --version ${{ inputs.tag }}
-      if: endsWith(matrix.name, 'dir')
+        python ./compile_onedir.py
+      if: ${{ endsWith(matrix.name, 'dir') || startsWith(matrix.name, 'MacOS') }}
     - name: Build ${{ matrix.name }}
       run: |
         cd ./src/
-        python ./compile.py --version ${{ inputs.tag }}
-      if: endsWith(matrix.name, 'dir') == false
+        python ./compile.py
+      if: ${{ !endsWith(matrix.name, 'dir') && !startsWith(matrix.name, 'MacOS') }}
     - name: Upload artifacts
       uses: actions/upload-artifact@v3
       with:

.gitignore

@@ -31,3 +31,4 @@ src/modules/logger.txt
 *.txt
 /src/dist
 /src/build
+venv

src/GUI/LOGO.icns

@@ -12,6 +12,10 @@ For Linux
 
 pyinstaller run.py --onefile --name TOTK_Mod_Manager --add-data "GUI:GUI" --hidden-import PIL --hidden-import PIL._tkinter_finder --hidden-import PIL._tkinter
 
+For MacOS
+
+pyinstaller run.py --onefile --name TOTK_Mod_Manager --add-data "GUI:GUI" --add-data "json.data:json.data" --windowed
+
 For Linux users aiming to generate Windows executable files or Windows users aiming to create Linux AppImage files, you can utilize the Docker image available for building purposes.
 
 Please refer to the following repository for guidance: https://github.com/batonogov/docker-pyinstaller

src/How to Compile.txt

@@ -2,8 +2,8 @@
 import subprocess
 import os
 from configuration.settings import *
-latest_version = Version.strip("manager-")
 
+latest_version = Version.strip("manager-")
 
 if __name__ == "__main__":
     if platform.system() == "Windows":
@@ -18,7 +18,7 @@
         ]
         subprocess.run(command, shell=True)
 
-    if platform.system() == "Linux":
+    elif platform.system() == "Linux":
         command = [
             "pyinstaller",
             "--onefile",
@@ -32,3 +32,21 @@
             "--hidden-import=ttkbootstrap"
         ]
         subprocess.run(command, check=True)
+    
+    elif platform.system() == "Darwin":
+        command = [
+            "pyinstaller",
+            "--onefile",
+            "--windowed",
+            "--noconfirm",
+            f"--name=TOTK Optimizer",
+            "run.py",
+            "--add-data", "GUI:GUI",
+            "--add-data", "json.data:json.data",
+            "--icon", "GUI/LOGO.icns",
+            "--hidden-import=PIL",
+            "--hidden-import=PIL._tkinter_finder",
+            "--hidden-import=ttkbootstrap",
+        ]
+        subprocess.run(command, check=True)
+        if os.path.exists("dist/TOTK Optimizer"): os.remove("dist/TOTK Optimizer")

src/compile.py

@@ -3,9 +3,14 @@
 import zipfile
 import os
 from configuration.settings import *
+import argparse
 
 latest_version = Version.strip("manager-")
 
+parser = argparse.ArgumentParser()
+parser.add_argument('-o', '--os')
+args = parser.parse_args()
+
 def create_zip(source_dir, dest_file):
     with zipfile.ZipFile(dest_file, 'w', zipfile.ZIP_DEFLATED) as zipf:
         for root, dirs, files in os.walk(source_dir):
@@ -15,6 +20,18 @@ def create_zip(source_dir, dest_file):
                 zip_path = os.path.join('TOTK Optimizer', relative_path)
                 zipf.write(file_path, zip_path)
 
+def delete_directory(folder):
+    for filename in os.listdir(folder):
+        file_path = os.path.join(folder, filename)
+        try:
+            if os.path.isfile(file_path) or os.path.islink(file_path):
+                os.unlink(file_path)
+            elif os.path.isdir(file_path):
+                shutil.rmtree(file_path)
+        except Exception as e:
+            print('Failed to delete %s. Reason: %s' % (file_path, e))
+    os.rmdir(folder)
+
 if __name__ == "__main__":
     if platform.system() == "Windows":
         command = [
@@ -27,7 +44,6 @@ def create_zip(source_dir, dest_file):
             "--icon", "GUI/LOGO.ico"
         ]
         subprocess.run(command, shell=True)
-        create_zip(f'dist/TOTK Optimizer {latest_version}', f'dist/TOTK_Optimizer_{latest_version}_Windows.zip')
     elif platform.system() == "Linux":
         command = [
             "pyinstaller",
@@ -42,4 +58,33 @@ def create_zip(source_dir, dest_file):
             "--hidden-import=ttkbootstrap"
         ]
         subprocess.run(command, check=True)
-        create_zip(f'dist/TOTK Optimizer {latest_version}', f'dist/TOTK_Optimizer_{latest_version}_Linux.zip')
+        create_zip(f'dist/TOTK Optimizer {latest_version}', f'dist/TOTK_Optimizer_{latest_version}_Linux.zip')
+
+    elif platform.system() == "Darwin":
+        command = [
+            "pyinstaller",
+            "--onefile",
+            "--windowed",
+            "--noconfirm",
+            f"--name=TOTK Optimizer",
+            "run.py",
+            "--add-data", "GUI:GUI",
+            "--add-data", "json.data:json.data",
+            "--icon", "GUI/LOGO.icns",
+            "--hidden-import=PIL",
+            "--hidden-import=PIL._tkinter_finder",
+            "--hidden-import=ttkbootstrap",
+        ]
+        subprocess.run(command, check=True)
+
+        processor = "Silicon"
+        if platform.processor() == "i386":
+            processor = "Intel"
+
+        os.mkdir('dist/archive')
+        os.rename('dist/TOTK Optimizer.app', 'dist/archive/TOTK Optimizer.app')
+        create_zip('dist/archive', f'dist/TOTK_Optimizer_{latest_version}_MacOS_{processor}.zip')
+
+        # Remove unnecessary files
+        if os.path.exists("dist/TOTK Optimizer"): os.remove("dist/TOTK Optimizer")
+        if os.path.exists("dist/archive"): delete_directory("dist/archive")

src/compile_onedir.py

@@ -12,6 +12,9 @@
 repo_url = 'https://api.github.com/repos/MaxLastBreath/TOTK-mods'
 localconfig = "TOTKOptimizer.ini"
 
+if platform.system() == "Darwin":
+    localconfig = os.path.join(macos_path, localconfig)
+
 # Read Config File.
 font = ""
 theme = ""

src/configuration/settings.py

@@ -36,6 +36,10 @@ def __init__(self, window):
         self.mode = config.get("Mode", "managermode", fallback="Legacy")
         self.all_pages = ["main", "extra", "randomizer"]
 
+        # Force to Ryujinx default
+        if platform.system() == "Darwin":
+            self.mode = "Ryujinx"
+
         # Set neccesary variables.
         self.Curr_Benchmark = None
         self.Legacydir = None
@@ -712,16 +716,20 @@ def Cheat_UI_elements(self, canvas):
         canvas.create_image(0, 0, anchor="nw", image=self.background_UI_Cheats, tags="overlay")
 
     def switchmode(self, command="true"):
+        
         if command == "true":
             if self.mode == "Legacy":
                 self.mode = "Ryujinx"
                 for canvas in self.all_canvas:
                     canvas.itemconfig("overlay-1", image=self.background_RyuBG)
                     canvas.itemconfig("information", text=f"{self.mode} TOTK Optimizer")
                     canvas.itemconfig("Legacy", state="hidden")
-                self.switch_text.set("Switch to Legacy")
+                if self.os_platform == "Darwin":
+                    self.switch_text.set("Only Ryujinx supported")
+                else:
+                    self.switch_text.set("Switch to Legacy")
                 return
-            elif self.mode == "Ryujinx":
+            elif self.mode == "Ryujinx" and self.os_platform != "Darwin":
                 self.mode = "Legacy"
                 for canvas in self.all_canvas:
                     canvas.itemconfig("overlay-1", image=self.background_LegacyBG)
@@ -736,7 +744,10 @@ def switchmode(self, command="true"):
                     canvas.itemconfig("overlay-1", image=self.background_RyuBG)
                     canvas.itemconfig("information", text=f"{self.mode} TOTK Optimizer")
                     canvas.itemconfig("Legacy", state="hidden")
-                self.switch_text.set("Switch to Legacy")
+                if self.os_platform == "Darwin":
+                    self.switch_text.set("Only Ryujinx supported")
+                else:
+                    self.switch_text.set("Switch to Legacy")
                 return
         elif command == "Mode":
             return self.mode

src/form.py

@@ -25,6 +25,7 @@ def checkpath(self, mode):
     if self.os_platform == "Linux":
         if mode == "Legacy":
             flatpak = os.path.join(home_directory, ".var", "app", "org.yuzu_emu.yuzu", "config", "yuzu")
+            flatpak_torzu = os.path.join(home_directory, ".var", "app", "onion.torzu_emu.torzu", "config", "yuzu")
             steamdeckdir = os.path.join(home_directory, ".config", "yuzu", "qt-config.ini")
 
             self.Globaldir = os.path.join(home_directory, ".local", "share", "yuzu")
@@ -45,6 +46,14 @@ def checkpath(self, mode):
                 new_path = os.path.dirname(os.path.dirname(flatpak))
                 self.Globaldir = os.path.join(new_path, "data", "yuzu")
 
+            # Check for flatpack version of Torzu
+            if os.path.exists(flatpak_torzu):
+                log.info("Detected a Legacy flatpack of Torzu!") 
+                self.configdir = os.path.join(flatpak_torzu, "qt-config.ini")
+                self.TOTKconfig = os.path.join(flatpak_torzu, "custom")
+                new_path = os.path.dirname(os.path.dirname(flatpak_torzu))
+                self.Globaldir = os.path.join(new_path, "data", "yuzu")
+
             config_parser = configparser.ConfigParser()
             config_parser.read(self.configdir, encoding="utf-8")
             self.nand_dir = os.path.normpath(config_parser.get('Data%20Storage', 'nand_directory', fallback=f'{self.Globaldir}/nand')).replace('"', "")
@@ -172,8 +181,21 @@ def checkpath(self, mode):
                 self.nand_dir = os.path.join(f"{self.Globaldir}", "bis", "user", "save")
                 self.load_dir = os.path.join(f"{self.Globaldir}", "mods", "contents", "0100f2C0115b6000")
                 self.sdmc_dir = os.path.join(f"{self.Globaldir}", "sdcard")
-                self.Legacydir = os.path.join(home_directory, "AppData", "Roaming", "Ryujinx", "mods", "contents", "0100f2C0115B6000")
+                self.Legacydir = self.load_dir
                 return
+    elif self.os_platform == "Darwin":
+        if mode == "Ryujinx":
+            self.Globaldir = os.path.join(home_directory, "Library", "Application Support", "Ryujinx")
+            self.configdir = None
+            self.TOTKconfig = None
+            self.ryujinx_config = os.path.join(self.Globaldir, "Config.json")
+            self.nand_dir = os.path.join(f"{self.Globaldir}", "bis", "user", "save")
+            self.sdmc_dir = os.path.join(f"{self.Globaldir}", "sdcard")
+            self.load_dir = os.path.join(f"{self.Globaldir}", "mods", "contents", "0100f2C0115B6000")
+            self.Legacydir = self.load_dir
+            return
+
+
     # Ensure the path exists.
     try:
         # attempt to create qt-config.ini directories in case they don't exist. Give error to warn user
@@ -196,6 +218,8 @@ def DetectOS(self, mode):
             else:
                 log.warning("qt-config.ini not found, the script will assume default appdata directories, "
                             "please reopen Legacy for consistency and make sure TOTK is present..!")
+    elif self.os_platform == "Darwin":
+        log.info("Detected a MacOS based SYSTEM!")
 
 def load_Legacy_path(self, config_file):
     if self.mode == "Legacy":

src/modules/checkpath.py

@@ -9,13 +9,23 @@
 from packaging.version import parse
 from modules.download import get_zip_list_and_dict
 from modules.logger import *
+from modules.macos import macos_path
 
 localconfig = "TOTKOptimizer.ini"
 ask_again = "Yes"
+
+if platform.system() == "Darwin":
+    localconfig = os.path.join(macos_path, localconfig)
+
 def load_json(name, url):
     global ask_again
     # Check if the .presets folder exists, if not, create it
     presets_folder = "json.data"
+
+    # Once again, set custom path for MacOS to avoid crash
+    if platform.system() == "Darwin":
+        presets_folder = os.path.join(macos_path, presets_folder)
+
     if not os.path.exists(presets_folder):
         os.makedirs(presets_folder)
 
@@ -69,6 +79,9 @@ def fetch_local_json(name):
     else:
         base_path = os.path.dirname(os.path.abspath(__file__))
         base_path = os.path.dirname(base_path)
+    
+    if platform.system() == "Darwin":
+        base_path = macos_path
 
     return os.path.join(base_path, f'json.data/{name}')
 
@@ -127,16 +140,21 @@ def load_values_from_json():
             "DFPS_dict": DFPS_dict
         }
         logging.info(f"Attempting to create api.json.")
-        if not os.path.exists("json.data"):
-            os.makedirs("json.data")
+        json_path = "json.data"
+
+        if platform.system() == "Darwin":
+            json_path = os.path.join(macos_path, json_path)
+
+        if not os.path.exists(json_path):
+            os.makedirs(json_path)
         try:
             logging.info(f"Creating api.json file..")
-            with open("json.data/api.json", "w", encoding="utf-8") as json_file:
+            with open(os.path.join(json_path, "api.json"), "w", encoding="utf-8") as json_file:
                 json.dump(api_json, json_file, indent=4)
         except PermissionError as e:
             logging.error(f"Permission error has been detected while "
                           f"creating api.json, attempting to delete api.json.")
-            shutil.rmtree("json.data/api.json")
+            shutil.rmtree(os.path.join(json_path, "api.json"))
         # Save Time.
         if not time_config.has_section("Time"):
             time_config["Time"] = {}

src/modules/json.py

@@ -3,18 +3,28 @@
 import platform
 import psutil
 import GPUtil
+import os
 from modules.scaling import *
-
+from modules.macos import macos_path
 
 def start_logger():
-    logging.basicConfig(filename="logger.txt",
+    filename = "logger.txt"
+
+    # Set custom path for MacOS to avoid crash
+    if platform.system() == "Darwin":
+        if not os.path.exists(macos_path):
+            os.makedirs(macos_path)
+        filename = os.path.join(macos_path, filename)
+
+    logging.basicConfig(filename=filename,
                         filemode='a',
                         format='TIME: %(asctime)s,%(msecs)d - %(name)s - %(levelname)s: %(message)s',
                         datefmt='%H:%M:%S',
                         level=logging.INFO)
     new_logger = logging.getLogger('LOGGER')
     logging.getLogger('LOGGER').addHandler(logging.StreamHandler(sys.stdout))
     return new_logger
+
 log = start_logger()
 
 try:

src/modules/logger.py

@@ -0,0 +1,4 @@
+import os
+
+home_directory = os.path.expanduser("~")
+macos_path = os.path.join(home_directory, ".totk-mods")