A realtime visual programming language for interactive media.
These instructions are for building Vuo Base, Vuo Compiler, Vuo Renderer, Vuo Runtime, Vuo Editor, and the built-in Vuo Nodes and Types from source code.
Vuo's source code is available so you can learn about how Vuo works, play with it, and maybe even help develop Vuo.
You do not need to build Vuo from source if you want to:
Vuo uses the Qt Framework's translation system in its source code, and POEditor to manage translations online. Sign up here to help translate Vuo: https://poeditor.com/join/project/KJuvGOpptm
Install a recent version of Xcode.
Launch Xcode and accept the license agreement.
Install Command Line Tools for Xcode:
Install Homebrew:
ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go/install)"
brew doctor
Review the results of brew doctor
and fix any problems it finds, then install the dependencies:
cd
to the Vuo source code folder.brew bundle
pip3 install --user conan==1.59.0
conan
was just installed to the shell's command search path:
python3 -c 'import site; print(site.getuserbase())'
/bin
to get the directory containing conan
(e.g. /Users/me/Library/Python/3.10/bin
).~/.zshrc
, ~/.profile
, or similar, add that directory to your shell's PATH
variable.cd
to the Vuo source code folder.mkdir build
cd build
conan config install https://vuo.org/sites/default/files/conan-macos.zip
WARN: Remotes registry file missing, creating default one
— that's OK.conan config install https://vuo.org/sites/default/files/conan-linux.zip
conan install ..
To build the user manual (PDF, HTML, or MacHelp variants), install TeX from https://www.tug.org/mactex/ .
To be able to run TestBuildSystem
, install Behat following the instructions on https://docs.behat.org/en/latest/quick_start.html#installation. Add its directory to your shell's PATH
variable.
Install Qt Creator.
Launch Qt Creator.
~/.conan
, then navigate to data/qt/<latest version>/vuo/stable/package/<package id>/bin/qmake
Vuo trunk
*.h,*.hh,*.c,*.cc,*.m,*.mm,*.md,*.glsl,*.vs,*.fs,*.qml,*.ui,*.qrc,*.txt,*.cmake,*.feature,*.php
*/.git/*,*/build/*
build
CMakeLists.txt
-j8
(or however many cores your processor has)CLICOLOR_FORCE
to 1
**/build/**
As an alternative to using Qt Creator (above), you can build from the command line.
First, generate the makefiles:
mkdir build
cd build
cmake ..
Build:
make -j8
Run Vuo Editor:
make go
…or open the build/bin
folder in Finder and double-click Vuo.app
.
Run the command-line tools:
bin/vuo-compile --help
bin/vuo-link --help
bin/vuo-debug --help
Optionally, build and run the tests:
make -j8 VuoTest
# Consider adding this alias to your ~/.bashrc :
alias ctest='ctest -j8 --output-on-failure --progress'
ctest # Run all tests (takes a few hours)
ctest -N # List the names of all tests
ctest -R … # Run tests whose name matches the specified regex (case-sensitive)
ctest -R vuo.math.keep.average # Run tests for a node
ctest -R VuoAnchor # Run tests for a type
ctest -R PlayBluesOrgan # Run tests for an example composition
ctest -R TestModules.testType:VuoAnchor # Run a single test datum
Optionally, build the documentation:
cmake .. -DVUO_DOCUMENTATION=ON
make -j8 VuoManualPDF_en_highContrast # Build the manual as a PDF
make -j8 VuoManualHTML # Build the manual as HTML
make -j8 VuoManualMacHelp # Build the manual as a MacHelp Book
make -j8 VuoDoxygen # Build the SDK documentation
Vuo's build system includes some shortcuts to make development more efficient.
Allows you to make changes to VuoBase and VuoCompiler without rebuilding all nodes and types (but you're responsible for keeping track of whether nodes and types need to be rebuilt). Saves several minutes per edit-compile-test cycle.
cmake .. -DVUO_COMPILER_DEVELOPER=ON
cmake .. -DVUO_COMPILER_DEVELOPER=OFF
Allows you to make changes to nodes, types, and libraries without rebuilding the Vuo.framework cache. Saves about 30 seconds per edit-compile-test cycle (but compositions take longer to start up initially).
cmake .. -DVUO_NODE_DEVELOPER=ON
cmake .. -DVUO_NODE_DEVELOPER=OFF