openFrameworks
openFrameworks is a C++ toolkit for creative coding. If you are new to OF, welcome!
- Grab the Nightly Release (to avoid submodule cloning)
- Setup guides for different Platforms
- Join Our Slack
- Discuss on the Forum
- Follow OF on Mastodon
Build status
- The master branch contains the newest, most recently updated code. This code is packaged and available for download in the “Nightly Builds” section of openframeworks.cc/download.
- The stable branch contains the code corresponding to the last stable openFrameworks release. This stable code is packaged and available for download at openframeworks.cc/download.
Platform | Master branch | Stable branch |
---|---|---|
Windows MSYS2 | ||
Windows Visual Studio | ||
Linux 64 & Arm | ||
Emscripten | ||
macos | ||
iOS & tvOS |
Developers
To grab a copy of openFrameworks for your platform, check the download page on the main site.
If you are working with the Git repository, the stable
branch of the OF repository corresponds to the most recent release, with a few important differences:
- The release includes a simple openFrameworks project generator.
- This GitHub repository contains code and libs for all the platforms, but the releases are done on a per-platform basis.
- This GitHub repository has no project files for the different examples. They are generated automatically for each release using a tool in
apps/projectGenerator/
. - There are no external dependencies in this repository, you can download them using the download_libs.sh script for each platform in the particular platform folder inside scripts.
If you want to work with the openFrameworks GitHub repository, you need to download the external dependencies and you should use the project generator to create project files for all the code in examples/
. To generate the project files with the project generator enable the ‘Advanced Options’ in the settings tab, then use ‘Update Multiple’ to update the projects for the examples/
folder path in the repo.
To set up the project generator submodule within the OF repo, use the command git submodule init
then git submodule update
whilst inside the openFrameworks repo.
For more info on working with the Project Generator, for per-platform readmes, and more information, see the documentation.
Versioning
openFrameworks uses Semantic Versioning, although strict adherence will only come into effect at version 1.0.0.