Tools, documentation, and reference implementation of a Max Package built using the Min-API.
This package is EXPERIMENTAL. Changes, including changes that break existing code, can happen at any time as we undertake continued development. USE AT YOUR OWN RISK.
There are two layers of material included in the Min-DevKit package.
min-devkitis an example package following current best-practices for package creation.
min-apiis a folder within the devkit containing all of the support files you will need to compile an external object written in modern C++. This folder you will include in your own package's source folder.
min-libcontains building blocks, helper classes, and unit generators that may be useful in authoring C++ code for audio, video, and data processing.
To build the externals in this package you will need some form of compiler support on your system.
- On the Mac this means Xcode 9 or later (you can get from the App Store for free).
- On Windows this means Visual Studio 2017 (you can download a free version from Microsoft). The installer for Visual Studio 2017 offers an option to install Git, which you should choose to do.
You will also need to install a recent version of CMake.
- Clone the Min-DevKit from Github (or download from inside of Max using the Package Manager). If you clone it from Github, you should clone it into Max's Packages folder. If you clone it elsewhere you will need to make an alias to it in your Packages folder. The Packages folder can be found inside of your Max 8 folder which is inside of your user's Documents folder.
- In the Terminal or Console app of your choice, change directories (cd) into the Min-Devkit folder you cloned/installed in step 0.
mkdir buildto create a folder with your various build files
cd buildto put yourself into that folder
- Now you can generate the projects for your choosen build environment:
cmake -G Xcode ..
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.
You can run
cmake --help to get a list of the options available. Assuming some version of Visual Studio 2017, the commands to generate the projects 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
On the command like you can run all unit tests using Cmake:
- on debug builds:
ctest -C Debug .
- on release builds:
ctest -C Release .
Or you can run an individual test, which is simply a command line program:
- mac example:
- win example:
Or you can run them 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 two different services, both of which are free and very easy to set up if your project is hosted publicly on Github.
- Mac: go to http://travis-ci.org and sign up. If your repository follows the same model as Min-DevKit, you can copy
.travis.ymldirectly with no changes. Now every push to your repository will trigger an automatic build for the Mac with Travis CI.
- Windows: go to http://appveyor.com and sign up. If your repository follows the same model as Min-DevKit, you can copy
appveyor.ymldirectly with no changes. Now every push to your repository will trigger automatic builds for both 32 and 64-bit Windows with Appveyor.
Fetching your builds
- Windows: On Appveyor it is simple. You go to the latest build, choose the "Platform" and then look under the "Artifacts" tab.
- Mac: Travis CI does not host your build files for you like Appveyor. Instead, you need to configure a place for Travis to upload your builds. This is most easily done by signing up for a free Amazon Web Services account.
The builds from Travis for this package can be found on this S3-hosted page.
To setup your own page:
- Sign up for a free AWS account as mentioned above
- Create a "bucket" for your Travis builds
- Add the correct info to your
.travis.ymlfile for your S3 bucket as described in the Travis S3 Documentation.
- At this point, builds should go from Travis to a folder in your S3 bucket.
- To access the build, you can log in to your S3 account and download it. Alternatively you may want to make your builds publically available. If you wish to do the later, read on...
- upload the files from this folder's
source/min-api/max-api/sitefolder to your S3 bucket's root folder. For more information on the content of these files, please visit the Github page for the S3 Bucket Listing Code.
- As described on the above Github page, you will need to set the permissions for your bucket such that "Everyone" has both
- Min Documentation Hub For guides, references, and resources
- Min Wiki For additional topics, advanced configuration, and user submissions
- How to Create a New Package
- How to Create a New Object
- How to Contribute to Min
- How to Update the underlying Max API
Contributors / Acknowledgements
For support, please use the developer forums at: http://cycling74.com/forums/