Mirrors/overte-JulianGro
3
0
Fork 0
mirror of https://github.com/JulianGro/overte.git synced 2025-04-21 22:43:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
overte-JulianGro/BUILD.md

5.1 KiB
Raw Permalink Blame History

General Build Information

Last Updated on 2025-03-17

OS Specific Build Guides

Dependencies

  • git: >= 1.6
  • CMake: 3.9 (or greater up to latest 3.x.x)
  • Conan: 2.x
  • Python: 3.6 or higher
  • Node.JS: >= 12.13.1 LTS
    • Used to build the server-console, JSDoc, and script console autocomplete.

Conan Dependencies

Most of our dependencies are automatically fetched and built using Conan. See the accompanying conanfile.py for a full list of direct dependencies.

CMake

Overte uses CMake to generate build files and project files for your platform.

Conan

Overte uses conan to download and build dependencies. Conan can be downloaded from here: https://conan.io/downloads

See the accompanying conanfile.py for a full list of direct dependencies.

Building the dependencies can be lengthy and the resulting files will be stored in your home directory. To move them to a different location, you can set the CONAN_HOME variable to any folder where you wish to install the dependencies.

Linux:

export CONAN_HOME=/path/to/directory

Windows:

set CONAN_HOME=/path/to/directory

Where /path/to/directory is the path to a directory where you wish the build files to get stored.

Generating Build Files

Possible Environment Variables

// The URL to post the dump to.
CMAKE_BACKTRACE_URL
// The identifying tag of the release.
CMAKE_BACKTRACE_TOKEN

// The release version, e.g., 2021.3.2.
RELEASE_NUMBER
// The build commit, e.g., use a Git hash for the most recent commit in the branch - fd6973b.
BUILD_NUMBER

// The type of release.
RELEASE_TYPE=PRODUCTION|PR|DEV

// The Interface will have a custom default home and startup location.
PRELOADED_STARTUP_LOCATION=Location/IP/URL
// The Interface will have a custom default script whitelist, comma separated, no spaces.
// This will also activate the whitelist on Interface's first run.
PRELOADED_SCRIPT_WHITELIST=ListOfEntries

// Code-signing environment variables must be set during runtime of CMake AND globally when the signing takes place.
HF_PFX_FILE=Path to certificate
HF_PFX_PASSPHRASE=Passphrase for certificate

// Determine the build type
PRODUCTION_BUILD=0|1
PR_BUILD=0|1
STABLE_BUILD=0|1

// Determine if to utilize testing or stable directory services URLs
USE_STABLE_GLOBAL_SERVICES=1
BUILD_GLOBAL_SERVICES=STABLE

Generate Files

conan install . -s build_type=Release -b missing -of build
cmake --preset conan-release

If CMake gives you the same error message repeatedly after the build fails, try removing CMakeCache.txt.

Finding Dependencies

The following applies for dependencies we do not grab via Conan.

You can point our CMake find modules to the correct version of dependencies by setting one of the three following variables to the location of the correct version of the dependency.

In the examples below the variable $NAME would be replaced by the name of the dependency in uppercase, and $name would be replaced by the name of the dependency in lowercase (ex: OPENSSL_ROOT_DIR, openssl).

  • $NAME_ROOT_DIR - pass this variable to Cmake with the -DNAME_ROOT_DIR= flag when running Cmake to generate build files
  • $NAME_ROOT_DIR - set this variable in your ENV
  • HIFI_LIB_DIR - set this variable in your ENV to your Overte lib folder, should contain a folder '$name'

Optional Components

Build Options

The following build options can be used when running CMake

  • BUILD_CLIENT
  • BUILD_SERVER
  • BUILD_TESTS
  • BUILD_TOOLS
  • CLIENT_ONLY // Will package only the Interface
  • SERVER_ONLY // Will package only the Server

Optimization build options

  • OVERTE_OPTIMIZE - This variable defaults to 1 if not set and enables compiler optimization flags on Linux and MacOS. Setting it to 0 will result in unoptimized build.
  • OVERTE_CPU_ARCHITECTURE - This variable contains architecture specific compiler flags which are used if OVERTE_OPTIMIZE is true. If it is not set, it defaults to -march=native -mtune=native, which helps yield more performance for locally used build, but for packaging it needs to be set to different value for portability, for example -msse3. Setting OVERTE_CPU_ARCHITECTURE to empty string will use default compiler settings and yield maximum compatibility.

Developer Build Options

  • USE_GLES
  • DISABLE_UI

Devices

You can support external input/output devices such as Leap Motion, MIDI, and more by adding each individual SDK in the visible building path. Refer to the readme file available in each device folder in interface/external/ for the detailed explanation of the requirements to use the device.