Tools, documentation, and reference implementation of a Max Package built using the Min-API.
There are two layers of material included in the Min-DevKit package.
min-devkit
is an example package following current best-practices for package creation.To build the externals in this package you will need some form of compiler support on your system.
You will also need to install a recent version of CMake (version 3.19 or higher).
git clone https://github.com/Cycling74/min-devkit.git --recursive my-min-devkit
mkdir build
to create a folder with your various build filescd build
to put yourself into that folderRun cmake -G Xcode ..
Next run cmake --build .
or open the Xcode project from this "build" folder and use the GUI.
Note: you can add the -j4
option where "4" is the number of cores to use. This can help to speed up your builds, though sometimes the error output is interleaved in such a way as to make troubleshooting more difficult.
If you are running on a Mac M1 machine, you will likely see an error cannot be loaded due to system security policy
when loading your externals in Max. To resolve this, you can ad-hoc codesign your external with codesign --force --deep -s - myobject.mxo
.
You can run cmake --help
to get a list of the options available. Assuming some version of Visual Studio 2019, the commands to generate the projects will look like this:
cmake -G "Visual Studio 16 2019" ..
Or using Visual Studio 2017 it will look like this:
cmake -G "Visual Studio 15 2017 Win64" ..
Having generated the projects, you can now build by opening the .sln file in the build folder with the Visual Studio app (just double-click the .sln file) or you can build on the command line like this:
cmake --build . --config Release
The Min-DevKit was updated on August 5, 2021 to support Apple silion and unify base headers with the Max SDK. There may be some modifications required to existing projects in order to integrate this update. See the SDK 8.2 update readme or the Max 8.2 SDK Update Overview video for further details. For support with this update please use the Max developer forum.
On the command line you can run all unit tests using Cmake:
ctest -C Debug .
ctest -C Release .
Or you can run an individual test, which is simply a command line program:
cd ..
cd tests
./test_dcblocker_tilde -s
test_dcblocker_tilde.exe -s
Or you can run them with your IDE's debugger by selecting the "RUN_TESTS" target.
Continuous Integration (CI) is a process by which each code check-in is verified by an automated build and automated tests to allow developers to detect problems early and distribute software easily.
The Min-DevKit project models CI using Github Actions.
For support, please use the developer forums at: http://cycling74.com/forums/