Build from Source
The main project repository is at
exokitxr/exokit. You can clone it the regular way:
git clone https://github.com/exokitxr/exokit.git
Requirements: Node.js 12.2.0, Python 2, Visual Studio 2015 or 2017
Alternative requirements: Node.js 12.2.0, as administrator: npm install -g windows-build-tools
Requirements: Node.js 12.2.0, XCode
Requirements: Node.js 12.2.0
Linux additionally requires that you install some local dependencies. For
Ubuntu they are:
apt-get install -y \
build-essential wget python libglfw3-dev libglew-dev libfreetype6-dev libfontconfig1-dev uuid-dev libxcursor-dev libxinerama-dev libxi-dev libasound2-dev libexpat1-dev
Make sure to be using Node
v12.2.0. We recommend using nvm or nvm-windows for managing Node versions.
v12.2.0 is installed, all of the Exokit dependencies and native code can be build with
This section covers common errors when building the Exokit engine and their solutions.
There was a build failure that was ignored and
node_modules contains the failure. Wipe
node_modules and try to build again.
rm -rf node_modules
This means a prebuilt dependency did not extract. Clear your
rm -Rf node_modules and
npm install again.
- Exokit’s bindings code is a native module build using the
- Exokit downloads and uses several prebuilt dependencies. They have been pre-compiled for all supported architectures and uploaded to npm. They self-extract themselves based off detected architecture.
Exokit Engine is just a node module, so you can run it with node.
exokit git clone directory, do:
node . <site URL or file path>
You can use the regular Node debugging tools and gdb to debug Exokit Engine. See the debugging documentation for more information.
Please file an issue if you encounter any bugs. Pull Requests are very much welcome as well.