From bff8a3a0159fa0b59a72965f19a3f9a5cd640bde Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Stephan=20Maih=C3=B6fer?= Date: Tue, 13 Aug 2024 09:26:12 +0200 Subject: [PATCH] update notes --- README.md | 24 +++++++++++------------- package-lock.json | 4 ++-- package.json | 6 ++---- src/package-lock.json | 4 ++-- update_electron.sh | 4 ++-- 5 files changed, 19 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 52f4dba..4d3eef6 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,15 @@ a simple offline player for [cables](https://cables.gl) patches using the electr can be used on different platforms (win, osx, linux) to use cables patches offline after importing them through daplaya. -# OSX NOTES!!! -apple introduced some security features that make it next to impossible to build these kind of apps at the moment, so -there is a few caveats when using this on OS X -* the executable is not signed, you will need to whitelist it on every machine you run it on (right click, "open" usually does that) - * we cannot sign this executable, as it's contents do change when downloading a patch, this is intended...sorry... - * there is no build for arm/m1-architecture, apple forbids running unsigned apps that are build for arm entirely, not even whitelisting is possible... -* once you downloaded the app, USE THE FINDER to move it basically anywhere else (like your desktop) before opening it - * apple puts downloaded apps into a random read-only directory UNTIL YOU MOVE IT USING FINDER, we need to write to the directory...sorry... +## CAVEATS MAC OS +- Apple introduced some security features that make it next to impossible to build these kind of apps at the moment, so there is a few caveats when using this on MacOS. +- The executable is not signed, you will need to whitelist it on every machine you run it on (right click, "open" usually does that). + - We cannot sign this executable, as it's contents do change when downloading a patch, this is intended...sorry... + - The build for arm/m1-architecture is even harder to run, apple forbids running unsigned apps that are build for arm entirely, not even whitelisting is possible...you may sign it on your own, though. +- Once you downloaded the app, USE THE FINDER to move it basically anywhere else (like your desktop) before opening it + - Apple puts downloaded apps into a random read-only directory UNTIL YOU MOVE IT USING FINDER, we need to write to the directory...sorry... +- There are ways to make the executable/app work on your mac: [on this website](https://appuals.com/damaged-app-cannot-be-opened-on-macos-error/) . We had success using the command line snippet: `sudo xattr -cr appName.app` + ## features: * import your patches by using patchid and apikey @@ -40,21 +41,18 @@ there is a few caveats when using this on OS X # development ## building -* building requires you have run `./update_electron.sh ` before +* building requires you have run `npm run update` or `./update_electron.sh ` before * `npm run clean`to clean up nodemodules and preimported patches and settings * `npm run build:linux` build linux app in build/linux-x64 * `npm run build:win` build linux app in build/win32-x64 * `npm run build:osx` build linux app in build/darwin-x64 +* build artefacts are in build/ ## releases * releases will try to update electron and build all three platforms as well as the corresponding zipfiles * this is usually done by github actions * `npm run package` -## dev -* for development, check out this repository, run `npm run build:` then `npm run start: -* no code "hotswap" (yet) - # LICENCE The MIT License (MIT) diff --git a/package-lock.json b/package-lock.json index 8973020..75af8a9 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "cables-daplaya-build-env", - "version": "0.2.0", + "version": "0.3.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "cables-daplaya-build-env", - "version": "0.2.0", + "version": "0.3.0", "license": "MIT" }, "src": { diff --git a/package.json b/package.json index baac279..794232f 100644 --- a/package.json +++ b/package.json @@ -14,11 +14,9 @@ ], "scripts": { "clean": "rm -rf node_modules/ && rm -rf src/node_modules/ && find src/patches/ -maxdepth 1 -mindepth 1 ! -name default ! -name .gitignore -exec rm -rf {} \\;", - "start:linux": "electron/linux-x64/electron src/main.js", - "start:win": "electron/win32-x64/electron src/main.js", - "start:osx": "electron/darwin-x64/electron src/main.js", + "update": "./update_electron.sh 20.0.0", "build:linux": "./build.sh linux-x64", - "build:osx": "./build.sh darwin-x64", + "build:osx": "./build.sh darwin-x64 && ./build.sh darwin-arm64", "build:win": "./build.sh win32-x64", "package": "./update_electron.sh 20.0.0 && ./build.sh win32-x64 zip && ./build.sh darwin-x64 zip && ./build.sh linux-x64 zip" } diff --git a/src/package-lock.json b/src/package-lock.json index 353b671..2f22c52 100644 --- a/src/package-lock.json +++ b/src/package-lock.json @@ -1,12 +1,12 @@ { "name": "cables-daplaya", - "version": "0.2.0", + "version": "0.3.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "cables-daplaya", - "version": "0.2.0", + "version": "0.3.0", "license": "MIT", "dependencies": { "adm-zip": "0.4.11" diff --git a/update_electron.sh b/update_electron.sh index 5714aae..90a43b3 100755 --- a/update_electron.sh +++ b/update_electron.sh @@ -2,7 +2,7 @@ set -euo pipefail electron_version=${1?missing electron version as first parameter}; -platforms=(linux-x64 darwin-x64 win32-x64); +platforms=(linux-x64 darwin-x64 darwin-arm64 win32-x64); download_and_unzip() { wget -q --show-progress https://github.com/electron/electron/releases/download/v${electron_version}/${1} && unzip -q ${1} && rm -f ${1} } @@ -26,4 +26,4 @@ for platform in "${platforms[@]}"; do zipname=electron-v${electron_version}-${platform}.zip download_and_unzip $zipname cd .. -done \ No newline at end of file +done