Welcome

This guide will walk you through setting up UEFS on your machine.

Installing UEFS

On Windows, you can install UEFS using Chocolatey with the following command in an Administrator Command Prompt:

choco install --pre -y uefs

On macOS, you can install UEFS with the following command. You will be prompted for your password, as this script runs sudo to install the UEFS service:

curl -L -o - https://src.redpoint.games/redpointgames/uefs/-/raw/main/macos/install.sh | bash -

This will install the command line tool uefs and the UEFS background service.

Installing Dokany on Windows

It's recommended that you install Dokany on Windows. This will allow UEFS to fetch package data on-demand as files are accessed inside mounts, with near native performance. Since you don't need to wait for the package to download, you can access files and launch Unreal Engine instantly without waiting for the full package to download.

On our own build servers, this also reduced the disk space required for Unreal Engine 5.0 builds from 107GB (the full package size) down to just 1.29GB (the data that Unreal Engine was actually accessing for the build). Thus not only does Dokany allow you to instantly launch Unreal Engine, it can also free up to 95% of the disk space that would otherwise be needed for an Unreal Engine install.

Upgrading UEFS

On Windows, run choco upgrade --pre -y uefs to upgrade UEFS.

On macOS, run the installation script again.

Building from source

You can also build UEFS from source code by cloning it from GitLab.

After cloning the repository, you can build UEFS in Visual Studio 2022. You'll need the .NET workload installed.