Skip to content

Latest commit

 

History

History
72 lines (62 loc) · 2.97 KB

BUILD.md

File metadata and controls

72 lines (62 loc) · 2.97 KB
Raw

Windows Build

  • Install Visual Studio 2022

  • Install cmake 3.27.1

  • Install vcpkg

  • Use vcpkg to install the following packages:

    • vcpkg install sdl2:x64-windows
    • vcpkg install glew:x64-windows
    • vcpkg install glm:x64-windows
    • vcpkg install libpng:x64-windows
    • vcpkg install nlohmann-json:x64-windows
    • vcpkg install tracy:x64-windows
    • vcpkg install openxr-loader:x64-windows

  • Use cmake to make the visual studio project:

    • mkdir build
    • cd build
    • cmake -DCMAKE_TOOLCHAIN_FILE="C:\path\to\vcpkg\scripts\buildsystems\vcpkg.cmake" ..

Use visual studio to open and build the project. Or build from the command line: cmake --build . --config=Release

Windows Shipping Builds

The SHIPPING cmake option is used to create a release version of splataplut. A post build step will copy all of the the data folders (font, shader, texture) into the build directory. And the resulting exe will use that copy. You can then zip up the folder and distrubute it to users.

  • To create a shipping build:
    • mkdir build
    • cd build
    • cmake -DSHIPPING=ON -DCMAKE_TOOLCHAIN_FILE="C:\path\to\vcpkg\scripts\buildsystems\vcpkg.cmake" ..
    • cmake --build . --config=Release

EXPERIMENTAL Linux Build (Ubuntu)

- `sudo apt-get install clang`
- `sudo apt-get install cmake`
- `sudo apt-get install freeglut3-dev`
- `sudo apt-get install libsdl2-dev`
- `sudo apt-get install libglew-dev`
- `sudo apt-get install libglm-dev`
- `sudo apt-get install libpng-dev`
- `sudo apt-get install nlohmann-json3-dev`
- `sudo apt-get install libopenxr-dev`
  • To create a shipping build:
    • mkdir build
    • cd build
    • cmake -DSHIPPING=ON ..
    • cmake --build . --config=Release

EXPERIMENTAL Meta Quest Build

NOTE: Although the quest build functions it is much to slow for most scenes. A Quest2 headset can only run a scene consisting of 25k splats.

  • Use vcpkg to install the following packages:
    • vcpkg install glm:arm64-android
    • vcpkg install libpng:arm64-android
    • vcpkg install nlohmann-json:arm64-android
  • Set the following environment var ANDROID_VCPKG_DIR to point to vcpkg/installed/arm64-android.
  • Download the Meta OpenXR Mobile SDK 59.0
  • Install Android Studio Bumble Bee, Patch 3 newer versions do not work with Meta OpenXR Mobile SDK 59.0. Follow this guide to setup Android Studio
  • Copy the ovr_openxr_mobile_sdk_59.0 dir into the meta-quest dir.
  • Copy the meta-quest/splatapult dir to ovr_openxr_mobile_sdk_59.0/XrSamples/splataplut
  • Open the ovr_openxr_mobile_sdk_59.0/XrSamples/splatapult in AndroidStudio.
  • Sync and Build