new workflow

.github/workflows/main.yml

@@ -1,4 +1,4 @@
-name: Package exe with PyInstaller
+name: Compile with Nuitka
 
 on:
   push:
@@ -7,30 +7,46 @@ on:
     branches: [ main ]
 
 jobs:
-  # build_linux:
-  #   runs-on: ubuntu-20.04
-  #   steps:
-  #   - uses: actions/checkout@v3
-  #   - name: PyInstaller Linux
-  #     uses: JackMcKew/pyinstaller-action-linux@0.1.4
-  #     with:
-  #       path: .
-  #   - name: Make file executable
-  #     run: sudo chmod +x dist/linux/FinalBIGv2
-  #   - uses: actions/upload-artifact@v3
-  #     with:
-  #       name: FinalBIGv2 - Linux
-  #       path: dist/linux/
-
-  build_windows:
-    runs-on: ubuntu-latest
+  build:
+    strategy:
+      matrix:
+        os: [macos-latest, ubuntu-latest, windows-latest]
+
+    runs-on: ${{ matrix.os }}
+
     steps:
-    - uses: actions/checkout@v3
-    - name: PyInstaller Windows
-      uses: JackMcKew/pyinstaller-action-windows@v0.1.2
-      with:
-        path: .
-    - uses: actions/upload-artifact@v3
-      with:
-        name: FinalBIGv2 - Windows
-        path: dist/
+      - name: Check-out repository
+        uses: actions/checkout@v3
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+          architecture: 'x64'
+          cache: 'pip'
+          cache-dependency-path: |
+            **/requirements*.txt
+
+      - name: Install Dependencies
+        run: |
+          pip install -r requirements.txt
+
+      - name: Build Executable
+        uses: Nuitka/Nuitka-Action@main
+        with:
+          nuitka-version: main
+          script-name: src/main.py
+          onefile: true
+          enable-plugins: pyqt6
+          include-data-dir: src/=.
+          windows-icon-from-ico: src/icon.ico
+          output-file: FinalBIGv2
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ runner.os }} Build
+          path: |
+            build/FinalBIGv2/*.exe
+            build/FinalBIGv2/*.bin
+            build/FinalBIGv2/*.app/**/*

.gitignore

@@ -128,3 +128,5 @@ tools/__edain_data.big
 
 clean_up.py
 /ffmpeg
+/main.*
+min_example.py

README.md

@@ -19,6 +19,7 @@ A PyQt GUI intended to supplant the outdated FinalBIG program in the manipulatin
 * Right click menu for ease of access in the file list
 * User settings for persistent customisation
 * Open files in your default applications or use the internal editor
+* Auto-compile by Github
 * And many more in the future!
 
 At this very early stage I am mostly looking for feedback so if you have any thoughts feel free to open a ticket or find me on discord @Necro#6714. I can usually be found on quite a few BFME/SAGE servers.
@@ -27,23 +28,25 @@ At this very early stage I am mostly looking for feedback so if you have any tho
 ![Demo of the GUI](resources/demo_dark.png)
 
 
-## How to download
+## How to use
 A new build is compiled directly from the source everytime a commit is pushed to the repository, you can download it from the [build menu](https://github.com/ClementJ18/finalBIGv2/actions/workflows/main.yml?query=branch%3Amain).
 
 There is also a public download that's semi-regularly updated in case you don't have a GitHub account: https://www.moddb.com/downloads/finalbigv2
 
+### Running the repository
+Don't trust the exe or it doesn't work? No problem
+1. Download and install python: https://www.python.org/downloads/release/python-31011/
+2. Download the repository as a zip and extract it to a folder
+3. Open a terminal and navigate to the folder with `cd PATH` where PATH is the path of the folder
+3. Install the dependencies with `python -m pip install -r requirements.txt`
+4. Run the application with `python src/main.py`
+
 ## Current Limitations
 * Syntax Highlighting gets kinda weird with non-ASCII characters, you can reset it by turning it off and on
 * Audio files are currently not supported until I find a way to bundle ffmpeg
-* Auto-compile for Linux does not work
 * The LUA and XML editor don't switch to dark mode
 * Line number color of currently open editors does not adapt properly when switching dark/light mode (fix by re-opening tabs)
 
-## To-do
-* Reduce lag from previewing large files (partially solved by preview setting)
-* W3D preview
-* Map preview
-
 ## Demo
 Search entire archive for text