Skip to content

Building ARToolKit

Thorsten Bux edited this page Dec 5, 2017 · 6 revisions

If you have been supplied with pre-built ARToolKit binaries, you will not need to build ARToolKit from source. The instructions below apply only to users who wish to modify the internals of ARToolKit. Source code and project files are supplied for all of ARToolKit. This allows you to not only see how the toolkit works, but also to modify its operation should you so wish.

Building on Linux

Building on Windows

Required Software / Source Packages

External dependencies for building ARToolKit from source include all the dependencies for building your own ARToolKit-based applications (as listed on page Installing ARToolKit) but also additional dependencies required to build the utilities and libraries. Where ARToolKit libraries require external DLLs, these are generally supplied with ARToolKit. Exceptions are listed below.

A supported compiler/IDE

Mac OS X:

Xcode tools v5.1.1 under Mac OS X 10.9 or later is required. Xcode 6 under Mac OS X 10.10 is recommended. These may be obtained free from Apple.

OpenGL

Mac OS X: OpenGL is part of your OS X system.

libjpeg

Windows/Mac OS X: libjpeg headers and libraries are supplied with ARToolKit.

GLUT

Required to build libARgsub and the utilities and examples. Note: libARgsub_lite provides equivalent functionality to libARgsub without requiring GLUT.

Windows: GLUT 3.7.6 is included with ARToolKit.

Mac OS X: included in OS.

Video capture libraries

Mac OS X: QuickTime v6.4 or later is required, and is included in all versions of Mac OS X > 10.3. For systems with QuickTime 7 or later, QTKit is also used.

OpenSceneGraph (OSG)

For details see OSG

Mac OS X: ARToolKit supplies binaries of OSG 3.2.2 ARToolKit uses the Setting an Environment Variable OSG_ROOT to find your OpenSceneGraph installation:

  • Mac OS X: OSG_ROOT=/Library/Frameworks

Compiling ARToolKit

Mac OS X

Open the ARToolKit5.xcodeproj, found inside the Xcode folder. The configure step (which creates AR/config.h) will be run automatically during the build process. If you wish to override the defaults, you may manually edit AR/config.h after this. Select a target to build. The default target builds the complete toolkit with the exception of the OpenVRML and OSG-dependent projects, which can be manually selected and built.

Post-Compilation Steps

Verifying the Compilation

ARToolKit includes a variety of examples demonstrating ARToolKit programming techniques. After compiling, the executables for these applications can be found in the bin directory inside your ARToolKit directory. Running the simpleLight example is one of the most straight-forward ways to test that your ARToolKit installation is functioning correctly. An explanation of simpleLight, including how to run it, and its source code can be found on the page simpleLite - The First Example Application to Look At. More detailed information about the techniques demonstrated in each example can be found on the page simpleLite - The First Example Application to Look At.

Mac OS X: Bundled applications are generated for the examples. The utilities are generated as command-line tools. Both can be run in the Finder (with output in Console) or from within Xcode or a Terminal window.

Setting up the ARTOOLKIT5_ROOT environment variable