---
title: "Install and build"
---

> Documentation Index
> Fetch the complete documentation index at: https://openarkstudio.github.io/ark/llms.txt
> Use this file to discover all available pages before exploring further.

# Install and build

ark requires CMake 3.21+, Ninja, a C++20 compiler and the dependencies selected by its vcpkg manifest. Use Visual Studio 2022 Developer PowerShell on Windows, or a compatible Clang/GCC toolchain on macOS/Linux.

1. **Clone and initialize dependencies**

   ```sh
   git clone https://github.com/OpenArkStudio/ark.git
   cd ark
   git submodule update --init --recursive
   ```
2. **Configure the application build**

   Install vcpkg and set the `VCPKG_ROOT` environment variable to that checkout. Select Boost for the network dependency.

   On macOS/Linux, use a POSIX shell:

   ```sh
   cmake -S . -B app-build -G Ninja \
     -DCMAKE_TOOLCHAIN_FILE="$VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake" \
     -DVCPKG_MANIFEST_FEATURES="application;boost" \
     -DASIO_STANDALONE=OFF -DCMAKE_BUILD_TYPE=Release
   ```

   On Windows, use Visual Studio 2022 Developer PowerShell:

   ```powershell
   cmake -S . -B app-build -G Ninja `
     "-DCMAKE_TOOLCHAIN_FILE=$env:VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake" `
     "-DVCPKG_MANIFEST_FEATURES=application;boost" `
     -DASIO_STANDALONE=OFF -DCMAKE_BUILD_TYPE=Release
   ```
3. **Build**

   ```sh
   cmake --build app-build --parallel 2
   ```

   Multi-configuration generators also need `--config Release`. This command writes executables, plugins and static archives to `app-build/bin/`. Use a separate CMake directory for each Release, Debug or sanitizer build. The [quick start](/ark/get-started/quick-start) shows how to copy the selected binaries into a runtime directory. The [build options](/ark/reference/build-options) control applications, examples and tests.

For a smaller correctness build, follow [network regression tests](/ark/networking#build-and-run-the-network-tests). Run the provided scripts under `build/` only after checking their application and deployment configuration.

Source: https://openarkstudio.github.io/ark/get-started/installation/index.mdx