# Build Zen with the UE Linux toolchain

This folder contains scripts to build Zen using the UE Linux toolchain. This
can be used to output binaries that meet the VFX Reference Platform versions.

## Setup

Download the toolchain using `get_ue_toolchain.sh`:

```
$ scripts/ue_build_linux/get_ue_toolchain.sh
```

By default this downloads to `~/.ue-toolchain`. A custom path can be given as
the first argument, or via the `UE_TOOLCHAIN_DIR` environment variable.

This will download the required components from cdn.unrealengine.com and
structure them in such a way that they can be used by xmake when building Zen.

## Building

xmake automatically detects the toolchain at `~/.ue-toolchain`, so no extra
flags are needed:

```
$ xmake config -y -m debug
$ xmake build -y
```

To build a release bundle:

```
$ xmake config -y -m release
$ xmake bundle -y
```

The toolchain can also be selected explicitly with `--toolchain=ue-clang`, and
the SDK location can be overridden with `--sdk=<path>` (must be absolute) or
the `UE_TOOLCHAIN_DIR` environment variable.