An electron framework to communicate with an X32. The project exists as a mono repo to provide a re-usable framework to many apps. Several apps live within the repo; currently this includes (or will include), X32 OSC WorkBench, MuteSync, MeterBridge and GetStarted.
The non-web libraries are now using the contextBridge which means the code base should somewhat be suitable for production builds.
The task board for the project can be found here.
The code base is based on Electron Forge.
Last installed with node v20.11.0. Requires python 3.6.0 and C/C++ compiler (Windows build tools or xCode) as there are packages that need to be recompiled with node-gyp. The project should auto compile native modules with the right headers when npm install is run.
Older revisions were based on React-TypeScript-Electron sample with Create React App and Electron Builder. and ran with node 16.17.0
You should be able to just install this project normally
npm install
then the project can be run in develop mode with
npm start
Note: if you are on Lunix or Raspberry Pi you will need to comment out new MakerSquirrel({}), in forge.config.ts to avoid the build hanging due to a bug where Electron Forge tries to load a Windows exe.
This project uses Electron Forge as a base and as such you should be able to build this project by following the documentation.
- Building on Linux hangs due to trying to load a Windows Binary. (See Note in install instructions for a workaround).
- The app looses connection on subscriptions/messages when the app moves to the background.
- Versions older than commit 0a7a558 will only run in node 16.
- The question dialogue can crash the app due to a missing try/catch.
- Calling Disconnect before Connect causes the mixers connection state to be corrupted. This issue was present on slower systems.