Skip to content

Latest commit

 

History

History
174 lines (101 loc) · 5.15 KB

BUILD_MACOS.md

File metadata and controls

174 lines (101 loc) · 5.15 KB

Building Tivoli for macOS

This build guide has only been tested for M1 machines where we purposefully cross-compile to x86_64 Intel because Qt5 and a couple other libraries are hard to get for arm64 right now.

It might also be worth mentioning that we link OpenGL to Mesa 3D instead (inc. Zink and MoltenVK) to translate OpenGL 4.1 calls into Metal API. However, this is all part of the build pipeline so don't worry.

Step 1. Installing dependencies

Download and install these programs:

  • macOS 12 Monterey

    We're only testing with an up to date OS. Might not work immediately otherwise.

  • Latest Xcode

    Available from the App Store

  • Homebrew package manager: https://brew.sh

    Once installed, open the terminal and run:

    brew install cmake pkg-config python node ninja
pip3 install mako # needed for mesa

Step 2. Configuring environment variables

You can set these however you like. We recommend you write a helper shell script but that's not necessary.

  • For Vcpkg

    CMake will automatically download Vcpkg to compile required dependencies for compiling Tivoli.

    It will use the directory: ~/tivoli/vcpkg

    This folder will get big! It's possible to change it by setting a variable:

    export TIVOLI_VCPKG_BASE=~/path/to/vcpkg

  • For Qt

    CMake will also download a custom version of Qt which is required.

    It will use the directory: ~/tivoli/qt

    It will also get big! Use this environment variable to change it:

    export TIVOLI_QT_BASE=~/path/to/qt

  • Developer or production build

    By default, it will create a developer build.

    Set these environment variables for a production build:

    export RELEASE_TYPE=PRODUCTION

    export STABLE_BUILD=1

    export RELEASE_NUMBER=1.2.3 which is unnecessary

Step 3. Cloning and preparing

Open the terminal and git clone interface

git clone https://git.tivolicloud.com/tivolicloud/interface
cd interface

You can use the main branch (default) or checkout to the latest tag

git tag
git checkout tags/???

Once you're checked out on the right version

mkdir build
cd build

cmake -GNinja ..
# or if you're planning to use Xcode which is untested
cmake -GXcode ..

CMake will now download dependencies including Qt and prepare build files.

Please wait. It will take a while... It really will!

Step 4. Making a Build

  • Using the terminal

    Open the terminal

    cd /path/to/tivoli/interface/build

cmake --build . --target interface --config RelWithDebInfo

    Some available targets are: interface, domain-server, assignment-client

  • Using Xcode

    Open interface\build\hifi.xcodeproj.

    It will ask if you want to Autocreate Schemes. Click yes.

    Next to the play and stop button (top left), you'll find a target icon with name next to it. Click that and type/select: interface.

    Click the target icon with name next to it again and you'll find at the bottom: Edit Scheme.

    In the scheme config popup, set the Build Configuration from Debug to RelWithDebInfo and click close.

    Click the play button and it will start building.

Step 5. Running interface

You can run interface using the launcher: https://tivolicloud.com/download

In the launcher under Settings, enable Developer settings. Then in the new menu, set Interface dir to /path/to/interface/build/interface/RelWithDebInfo (or without RelWithDebInfo if it's not there) which should contain interface executable

If you want to run Tivoli without the launcher, run:

interface --tokens [current access token]

You can find your access token in the launcher's developer menu. Please don't share it and keep it safe!

When debugging, you'll likely have to open Tivoli without the launcher.

Troubleshooting

If your build fails, you could ask around on our Discord for help.

Deleting the build folder and trying again may help.