Release 2024.1

README.md

@@ -62,7 +62,7 @@ We welcome contributions to the Helix-Blender Plugin! If you’d like to contrib
 
 ## License
 
-This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+This project is licensed under the GPL License. See the [LICENSE](LICENSE.txt) file for details.
 
 ## Support
 

build.md

@@ -0,0 +1,25 @@
+
+# Helix-Blender Plugin for DAM - Build Instructions
+
+To build the Helix-Blender plugin for DAM, follow these steps:
+
+1. Download the source code from the GitHub repository and unzip the source code archive.
+
+2. Open a terminal (macOS) or PowerShell (Windows), and navigate to the directory where the source code was unzipped by running the following command:
+   ```bash
+   cd /path/to/unzipped/source
+   ```
+
+3. Run the build command based on your operating system:
+   - For **macOS**, run:
+     ```bash
+     sh ./buildscripts/github_compile.sh
+     ```
+   - For **Windows**, run the following command in PowerShell as Administrator:
+     ```powershell
+     powershell -ExecutionPolicy Bypass -File .\buildscripts\github_compile.ps1
+     ```
+
+4. After the build succeeds, the final output will be generated in the same directory with the name `helix_blender_plugin.zip`.
+
+This zip file contains the built plugin and is ready for use.

buildscripts/github_compile.ps1

@@ -0,0 +1,49 @@
+$build = (Get-Location).Path
+
+$pluginsDir = "$build\helix_blender_plugin"
+
+if (Test-Path $pluginsDir) {
+    Remove-Item -Recurse -Force $pluginsDir
+}
+
+New-Item -ItemType Directory -Path $pluginsDir
+New-Item -ItemType Directory -Path "$pluginsDir\site_packages"
+
+Set-Location "$build\src\helix_blender_plugin\dam_app"
+
+if (Test-Path "venv") {
+    Remove-Item -Recurse -Force "venv"
+}
+
+New-Item -ItemType Directory -Path "venv"
+
+py -m venv venv
+& "$build\src\helix_blender_plugin\dam_app\venv\Scripts\Activate.ps1"
+
+python.exe -m pip install --upgrade pip
+python.exe -m pip install pyinstaller
+python.exe -m pip install -r requirements-win.txt
+
+pyinstaller PSWebView.py --name="HelixBlenderPlugin.exe" `
+                         --icon="icon/plugin_402x.ico" `
+                         --add-data="icon/*:icon" `
+                         --add-data="logs/config.xml:logs" `
+                         --onefile
+
+# The chmod command isn't relevant on Windows, as executable permissions work differently
+
+Copy-Item -Recurse -Force "venv\Lib\site-packages\psutil*" "$pluginsDir\site_packages"
+Copy-Item -Recurse -Force "dist\HelixBlenderPlugin.exe" $pluginsDir
+Copy-Item -Recurse -Force "logs" $pluginsDir
+Copy-Item -Recurse -Force "icon" $pluginsDir
+Copy-Item -Recurse -Force "..\*.py" $pluginsDir
+
+Remove-Item -Recurse -Force "venv", "build", "dist"
+
+deactivate
+
+Set-Location $build
+
+Compress-Archive -Path "$pluginsDir" -DestinationPath "helix_blender_plugin.zip" -Force
+
+Remove-Item -Recurse -Force $pluginsDir

buildscripts/github_compile.sh

@@ -0,0 +1,50 @@
+#!/bin/bash
+
+build=`pwd`
+
+pluginsDir=$build/helix_blender_plugin
+if [ -d $pluginsDir ]; then
+    rm -rf $pluginsDir
+fi
+mkdir -p $pluginsDir
+mkdir -p $pluginsDir/site_packages
+
+cd src/helix_blender_plugin/dam_app
+
+if [ -d "venv" ]; then
+    rm -rf "venv"
+fi
+
+mkdir -m 777 venv
+
+python3 -m venv venv
+source venv/bin/activate
+
+python3 -m pip install --upgrade pip
+python3 -m pip install pyinstaller
+python3 -m pip install -r requirements-mac.txt
+cp icon/plugin_402x.ico icon/plugin_402x.icns
+
+pyinstaller PSWebView.py --name="HelixBlenderPlugin" \
+                         --icon="icon/plugin_402x.icns" \
+                         --add-data="icon/*:icon" \
+                         --add-data="logs/config.xml:logs" \
+                         --onefile
+
+chmod +x dist/HelixBlenderPlugin
+
+cp -f -r venv/lib/python3*/site-packages/psutil* $pluginsDir/site_packages
+cp -f -r dist/HelixBlenderPlugin $pluginsDir/
+cp -f -r logs $pluginsDir/
+cp -f -r icon $pluginsDir/
+cp -f -r ../*.py $pluginsDir/
+
+rm -rf venv build dist
+
+deactivate
+
+cd $build
+
+zip -rq helix_blender_plugin.zip helix_blender_plugin
+
+rm -rf helix_blender_plugin

src/helix_blender_plugin/dam_app/requirements-mac.txt

@@ -0,0 +1,6 @@
+psutil==6.0.0
+PyQt5==5.15.11
+PyQt5-Qt5==5.15.15
+PyQt5_sip==12.15.0
+PyQtWebEngine==5.15.7
+PyQtWebEngine-Qt5==5.15.15