Prettify macOS dmg (#58)

* Prettify mac dmg isntaller

* Fix docs

* Update mscOS docs

Author: vvvar

.github/workflows/execute_merge_checks.yml

@@ -8,7 +8,7 @@ env:
   LV2_TARGET_NAME: PeakEater_LV2
   CLAP_TARGET_NAME: PeakEater_CLAP
   JUCE_REVISION: 4e68af7
-  VERSION: 0.5.0
+  VERSION: 0.5.1
   BUILD_ID: "${{ github.run_id }}.${{ github.run_number }}.${{ github.run_attempt }}"
 jobs:
   macos:

.github/workflows/publish_release_draft.yml

@@ -1,5 +1,5 @@
 name: Publish Release Draft
-run-name: Create release draft for v0.5.0
+run-name: Create release draft for v0.5.1
 on:
   push:
     branches:
@@ -12,9 +12,9 @@ env:
   LV2_TARGET_NAME: PeakEater_LV2
   CLAP_TARGET_NAME: PeakEater_CLAP
   JUCE_REVISION: 4e68af7
-  MACOS_RELEASE_NAME: PeakEater_v0.5.0_macOS
-  WINDOWS_RELEASE_NAME: PeakEater_v0.5.0_Windows
-  LINUX_RELEASE_NAME: PeakEater_v0.5.0_Linux
+  MACOS_RELEASE_NAME: PeakEater_v0.5.1_macOS
+  WINDOWS_RELEASE_NAME: PeakEater_v0.5.1_Windows
+  LINUX_RELEASE_NAME: PeakEater_v0.5.1_Linux
 jobs:
   macos:
     name: macOS
@@ -81,12 +81,12 @@ jobs:
           MACOS_APPLE_ID: ${{ secrets.MACOS_APPLE_ID }}
           MACOS_APPLE_PASSWORD: ${{ secrets.MACOS_APPLE_PASSWORD }}
           MACOS_APPLE_TEAM_ID: ${{ secrets.MACOS_APPLE_TEAM_ID }}
-        run: python ${{github.workspace}}/Scripts/Release/MacOS.py --release_type=${{env.BUILD_TYPE}} --sign_and_notarize=True --release_version=0.5.0
+        run: python ${{github.workspace}}/Scripts/Release/MacOS.py --release_type=${{env.BUILD_TYPE}} --sign_and_notarize=True --release_version=0.5.1
       - name: Upload Artifacts
         uses: actions/upload-artifact@v3
         with:
           name: ${{ env.MACOS_RELEASE_NAME }}
-          path: ${{github.workspace}}/build/release/PeakEater-0.5.0.dmg
+          path: ${{github.workspace}}/build/release/PeakEater-0.5.1.dmg
 
   windows:
     name: Windows
@@ -183,5 +183,5 @@ jobs:
           draft: true
           removeArtifacts: true
           makeLatest: true
-          tag: "v0.5.0"
+          tag: "v0.5.1"
           artifacts: "${{ env.MACOS_RELEASE_NAME }}.zip,${{ env.WINDOWS_RELEASE_NAME }}.zip,${{ env.LINUX_RELEASE_NAME }}.zip"

.gitignore

@@ -10,5 +10,8 @@
 # Python cache
 Scripts/Release/__pycache__
 
+# node
+node_modules
+
 # Various vscode logs
 /.vscode/*.log

CMakeLists.txt

@@ -1,5 +1,5 @@
 cmake_minimum_required(VERSION 3.15)
-project(PeakEater VERSION 0.5.0)
+project(PeakEater VERSION 0.5.1)
 set(CMAKE_CXX_STANDARD 20)
 
 add_subdirectory(Dependencies/JUCE)

README.md

@@ -101,7 +101,7 @@ Shows approximated RMS that was cut("Eaten") in last 2 seconds and current clipp
 
 ### Switchable scales
 
-<img src="Resources/screenshots/screenshot-switch-ticks.gif" alt="switch-db-level-scales" height="250"/>
+<img src="Resources/screenshots/screenshot-switch-ticks.gif" alt="switch-db-level-scales" width="400"/>
 
 Right click on Visualizer to switch between different scales.
 
@@ -171,7 +171,10 @@ You can use it on macOS, Windows or Linux.
 Supported formats are: VST3, AU, LV2, CLAP.
 Tested on: macOS 12.6.2
 
-Install plugin via **.dmg** file. copy plugin in format of choice into folder with your plugins.
+Install plugin via **.dmg** file. Drag plugin in format of choice into folder with your plugins.
+
+> **Note**<br />
+> Due to macOS restrictions, you cannot drag files into untrusted directories. Therefore, double click on directory shortcut, open it and drag it directly there.
 
 > **Note**<br />
 > VST3 directory is `/Library/Audio/Plug-ins/VST3`<br />

Scripts/Release/MacOS.py

@@ -6,6 +6,7 @@
 import utils
 import os
 import pathlib
+import shutil
 from dotenv import load_dotenv
 
 # Read env variables
@@ -77,8 +78,11 @@ def notarize(bin_path: str) -> None:
 
 utils.log_info("Creating DMG image...")
 release_dmg_path = f"{str(RELEASE_DIR_PATH)}/PeakEater-{args.release_version}.dmg"
+utils.exec_command("npm install -g appdmg")
+shutil.copyfile(
+    f"{os.path.dirname(__file__)}/configs/appdmg-config.json", f"{RELEASE_DIR_PATH}/appdmg-config.json")
 utils.exec_command(
-    f"hdiutil create -volname PeakEater-{args.release_version} -srcfolder {str(RELEASE_DIR_PATH)} -ov -format ULFO {release_dmg_path}")
+    f"appdmg {RELEASE_DIR_PATH}/appdmg-config.json {str(RELEASE_DIR_PATH)}/PeakEater-{args.release_version}.dmg")
 if args.sign_and_notarize:
     codesign(release_dmg_path)
     notarize(release_dmg_path)

Scripts/Release/configs/appdmg-config.json

@@ -1,6 +1,5 @@
 {
-  "title": "PeakEater v0.5.0",
-  "icon": "icon-mac.icns",
+  "title": "PeakEater",
   "format": "ULFO",
   "window": {
     "size": {

Scripts/Release/configs/inno-config.iss

@@ -1,6 +1,6 @@
 [Setup]
 AppName=PeakEater
-AppVersion=0.5.0
+AppVersion=0.5.1
 DefaultDirName={cf}
 DefaultGroupName=PeakEater
 OutputBaseFilename=PeakEater-windows

Scripts/Release/configs/wix-config.wxs

@@ -1,5 +1,5 @@
 <Wix xmlns="http://schemas.microsoft.com/wix/2006/wi">
-<Product Id="*" UpgradeCode="12345678-1111-2222-3333-666666666666" Name="PeakEater" Version="0.5.0.0" Manufacturer="T-Audio" Language="1033">
+<Product Id="*" UpgradeCode="12345678-1111-2222-3333-666666666666" Name="PeakEater" Version="0.5.1.0" Manufacturer="T-Audio" Language="1033">
     <Package InstallerVersion="200" InstallScope="perMachine" Compressed="yes" Comments="PeakEater is a free open-source VST3/AU waveshaper plugin"/>
     <MediaTemplate EmbedCab="yes" />