Building Ocean

This document describes the general process to build Ocean. Platform-specific instructions are available in the sub-pages.

Prerequisites

Before building Ocean, ensure you have the following:

• Git: Required to clone the repository
• CMake 3.25 or higher: Build system generator (required for CMake preset support)
• A compatible C++ compiler for your target platform

Getting the Source Code

Clone the Ocean repository:

git clone https://github.com/facebookresearch/ocean.git
cd ocean

Build Overview

Ocean's build process generally follows these steps:

1. Build third-party dependencies - Ocean relies on several third-party libraries that need to be built first
2. Build Ocean - Build the Ocean libraries and applications using the provided build scripts

Each platform has specific requirements and build scripts. See the platform-specific sub-pages for detailed instructions:

• Android
• iOS
• Linux
• macOS
• Meta Quest
• Windows

tip

This documentation is also available on GitHub.