openFrameworks README

The project's README from github.com/openframeworks/openFrameworks. As one markdown file: README.md.

openFrameworks

openFrameworks is a C++ toolkit for creative coding. If you are new to OF, welcome!

Build status

Platform Master branch Stable branch
Windows MSYS2 Build status Build status
Windows Visual Studio Build status Build status
Linux 64 & Arm Linux Build Status Linux Build Status
Emscripten Emscripten Build Status Emscripten Build Status
macos macos Build Status macos Build Status
iOS & tvOS iOS tvOS Build Status iOS tvOS Build Status

folder structure

This release of OF comes with several folders:

docs has some documentation around OF usage, per platform things to consider, etc. You should definitely take a look in there; for example, if you are on OSX, read the osx.md. apps and examples are where projects go -- examples contains a variety of projects that show you how to use OF, and apps is where your own projects will go. libs contains the libraries that OF uses, including the openframeworks core itself. addons are for additional functionality that's not part of the core. export is for DLLs and dylibs that need to be put in each compiled project. The scripts folder has the templates and small scripts for automating OF per platform. project generator is a GUI based tool for making new projects - this folder is only there in packaged releases.

One idea that's important is that OF releases are designed to be self-contained. You can put them anywhere on your hard drive, but it's not possible to mix different releases of OF together, so please keep each release (0.8.0, 0.8.1) separate. Projects may generally work from release to release, but this is not guaranteed. Because OF is self-contained, there's extensive use of local file paths (ie, ../../../) throughout OF. It's important to be aware of how directories are structured. A common error is to take a project and move it so that it's a level below or above where it used to be compared to the root of OF. This means that links such as ../../../libs will break.

Get involved

The openframeworks forum:

http://forum.openframeworks.cc/

is a warm and friendly place. Please ask or answer a question. The most important part of this project is that it's a community, more than just a tool, so please join us! Also, this is free software, and we learn so much about what is hard, what doesn't make sense, what is useful, etc. The most basic questions are acceptable here! Don't worry, just join the conversation. Learning in OF is social, it's hard to do it alone, but together we can get far!

Our GitHub site is active:

https://github.com/openframeworks/openFrameworks

if you have bugs or feature requests, consider opening an issue. If you are a developer and want to help, pull requests are warmly welcome. Please read the contributing guide for guidelines:

https://github.com/openframeworks/openFrameworks/blob/master/CONTRIBUTING.md

We also have a developer's mailing list, which is useful for discussing issues around the development and future of OF.

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:

  1. The release includes a simple openFrameworks project generator.
  2. This GitHub repository contains code and libs for all the platforms, but the releases are done on a per-platform basis.
  3. This GitHub repository has no project files for the different examples. They are generated automatically for each release using a tool in apps/projectGenerator/.
  4. 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.

openFrameworks (openframeworks/openFrameworks)

Searching Database…

10.4K ·GitHub
OpenFrameworks
What is this?It's a community-developed, cross-platform toolkit for creative coding in C++ — you use it to build interactive graphics, audio, video and computer-vision projects.
So is it a library I link into my own project, or something bigger?It's a self-contained toolkit you build inside: a download ships the openFrameworks core, third-party libs, addons and example projects, and your own apps go in its apps folder.
How do I get it running?Download the stable release (or nightly) for your OS from openframeworks.cc/download, follow the per-platform setup guide in the docs folder, then build one of the bundled examples.
Any gotchas before I start?Releases can't be mixed, and projects reach the toolkit through relative paths like ../../../libs — move a project up or down a level inside the OF folder and its links break.
Do I need to be an experienced C++ developer to use it?You write C++, so some coding background helps — but the project is built around its community: bundled examples to learn from and a forum where even the most basic questions are welcome.
Which platforms can it target?Windows (MSYS2 or Visual Studio), macOS, Linux 64-bit and Arm (Raspberry Pi), iOS, tvOS and Android, plus Emscripten builds that run in the browser.
Can I use it in my own projects for free?The README calls it free software but doesn't name a specific license; GitHub lists the license as non-standard.
How do I start my own project?Use the project generator — a GUI tool bundled with packaged releases that creates the project files for your platform. Your own projects live in the apps folder, next to the examples.
Can I work straight from the GitHub repo instead of a release?Yes, but it needs prep: the repo has no external dependencies — each platform folder in scripts has a downloadlibs.sh for those — and no project files for the examples; those are generated for each release.
What kinds of projects is it good for?Interactive media work: OpenGL graphics, audio, video and computer vision (OpenCV is among its libraries), from desktop apps to iOS and Android to browser builds via Emscripten.
What are similar projects?SFML, bgfx, xbmc, Infinite, vlc, kivy, assimp, opencv
Which topics is it in?emscripten, osx, opencv, multimedia, creative-coding, opengl, computer-graphics, raspberry-pi, graphics, audio, video, cpp
Creator
openframeworks
Size
2.1 GB
Stars
10.4K
Updated
CommitOct 13ReleasenightlyOct 13
Age
16y
Commits · 90 Days