Skip to content

Latest commit

 

History

History
89 lines (65 loc) · 4.52 KB

BUILDING.md

File metadata and controls

89 lines (65 loc) · 4.52 KB
Raw

Building Exokit

Exokit is a node module. The core is written in Javascript, with native bindings to native functionality like OpenGL. It downloads prebuilt binaries for libraries, which are listed as dependenices.

Note: Using nvm makes it easy to manage multiple active node.js versions.

Build targets :

Windows

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

Procedure

  1. open Node.js command prompt
  2. git clone https://github.com/exokitxr/exokit.git
  3. run npm install

MacOS

Requirements: Node.js 12.2.0, XCode

Procedure

  1. open Terminal.app
  2. git clone https://github.com/exokitxr/exokit.git
  3. run npm install

Linux

Requirements: Node.js 12.2.0

Procedure

  1. open bash
  2. install dependencies: 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
  3. git clone https://github.com/exokitxr/exokit.git
  4. run npm install

Magic Leap

Requirements: Windows Subsystem for Linux, Ubuntu Bash, Node.js 11.15.0 for Windows, Python 2, Python 3

NOTE: Due to combined usage of Ubuntu and Windows tools, you must check out Exokit to somewhere reachable from both; the easiest way is to do your git clone inside Ubuntu bash, since for example Ubuntu can reach C:\exokit as /mnt/c/exokit. (included in instructions below)

Procedure (signed)

  1. download developer certificate and private key from https://creator.magicleap.com in Publish then Certificates
  2. place the renamed certificate in cert/app.cert and private key in cert/app.privkey
  3. download Magic Leap Package Manager from https://creator.magicleap.com
  4. install Magic Leap Lumin SDK
  5. open Ubuntu Bash on Windows
  6. cd /mnt/c/exokit
  7. git clone https://github.com/exokitxr/exokit.git
  8. install dependencies: sudo 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
  9. export MLSDK=/mnt/c/your_mlsdk_path_goes_here # fill this in e.g. export MLSDK=/mnt/c/Users/Name/MagicLeap/mlsdk/v0.20.0/
  10. run scripts/magicleap/build-ml.sh

Note that, unlike for other target platform you should not run npm install. If you do remove the node_modules/ directory and clean npm cache.

Procedure (unsigned)

  1. download Magic Leap Package Manager from https://creator.magicleap.com
  2. install Magic Leap Lumin SDK
  3. open Ubuntu Bash on Windows
  4. cd /mnt/c/exokit
  5. git clone https://github.com/exokitxr/exokit.git
  6. install dependencies: sudo 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
  7. export MLSDK=/mnt/c/your_mlsdk_path_goes_here # fill this in e.g. export MLSDK=/mnt/c/Users/Name/MagicLeap/mlsdk/v0.20.0/
  8. run scripts/magicleap/build-ml.sh --unsigned

Oculus Quest / Go

Requirements: Windows Subsystem for Linux, Ubuntu Bash, Node.js 11.15.0, Python 2, Python 3, Android SDK, Android NDK

Procedure (unsigned)

  1. open bash
  2. install dependencies: 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
  3. Install Android SDK / NDK and set up the $ANDROID_HOME environment variable
  4. git clone https://github.com/exokitxr/exokit.git
  5. cd exokit
  6. ./scripts/oculusmobile/build-android.sh
  7. ./scripts/oculusmobile/install-android.sh
  8. ./scripts/oculusmobile/run-android.sh

Notes:

  • If you're getting linking errors, try deleting node_modules and running the build script again
  • Make sure you have the ndk-bundle within your $ANDROID_HOME, you might need to create a symlink to a specific folder in the ndk directory if you're using Android Studio
  • The compiled APK is going to be inside ./app/build/outputs/apk/debug/app-debug.apk
  • You can run different files from the examples repo with this command: adb shell am start -n com.webmr.exokit/android.app.NativeActivity -e ARGS "'node /package /package/examples/NAME_HERE.html'"
  • You can kill the app if it's a black screen with this command: adb shell am force-stop com.webmr.exokit