Installation & Project Setup

Modularity is built from source using CMake. On both Windows and Linux,

If you'd like to install a Pre-Built version of Modularity, you can do so with the link below

https://git.shockinteractive.xyz/Shock-Interactive-LLC/Modularity/releases

the build.bat / build.sh scripts run CMake for you (recommended), but you can also run CMake manually.

---

Requirements

• Git

• CMake (required)

• C++ compiler toolchain

  • Windows: Visual Studio / MSVC Build Tools

  • Linux: g++ or clang++

• VSCode (recommended, optional)

Package Installation

---

Fedora/Red Hat

sudo dnf install -y \
    zlib-devel \
    cmake \
    gcc-c++ \
    libX11-devel \
    libXrandr-devel \
    libXinerama-devel \
    libXcursor-devel \
    libXi-devel \
    mesa-libGL-devel \
    mesa-libEGL-devel \
    libXxf86vm-devel \
    wayland-devel \
    libdecor-devel
    
    echo "(optional but recommended) sudo dnf install -y ccache"

---

Debian/Ubuntu

sudo apt install -y \
    cmake \
    build-essential \
    zlib1g-dev \
    libx11-dev \
    libxrandr-dev \
    libxinerama-dev \
    libxcursor-dev \
    libxi-dev \
    libgl1-mesa-dev \
    libegl1-mesa-dev \
    libwayland-dev
    echo "as said before, it's optional but recommended) sudo dnf install -y ccache"

---

Arch/Pacman based systems

sudo pacman -S --needed \
    cmake \
    base-devel \
    zlib \
    libx11 \
    libxrandr \
    libxinerama \
    libxcursor \
    libxi \
    mesa \
    wayland
    echo "as said before, it's optional but recommended) sudo pacman -S --needed ccache"

---

Windows

Visual Studio (Recommended)

Required Version: Visual Studio 2026

Workloads:

• Desktop development with C++

Components:

1. MSVC v143

2. Windows 10/11 SDK

3. CMake tools for Windows

Optional:

• choco install sccache

Clone the repository

git clone https://github.com/Shock-Interactive/Modularity.git
cd Modularity

---

Build (Recommended)

Windows

build.bat

Linux

./build.sh

These scripts typically:

• create/update a build directory

• Install any github references to ThirdParty resources

• run cmake to generate build files

• build the editor/runtime

---

Build (Manual CMake)

Windows (Visual Studio generator example)

git submodule update --init --recursive

if exist build rmdir /s /q build
mkdir build
cd build
cmake -G "Visual Studio 18 2026" -A x64 ..
make --build . --config Release -- /m
xcopy /e /i /y "..\Resources" "Resources\" >nul
copy /Y Resources\imgui.ini .

Linux

git submodule update --init --recursive
rm -rf build/
mkdir -p build
cd build
cmake ..
cmake --build . -- -j"$(nproc)"
cp -r ../Resources .
cp Resources/imgui.ini .
ln -sf build/compile_commands.json compile_commands.json

---

Running the Editor

After building, run the compiled Modularity editor binary from your build output directly located in the Modularity folder.

---

Projects

A Modularity project typically includes:

• Scripts/ for runtime-compiled C++ scripts

• Scenes/ for loading scenes

• Models/ for loading models

• Scripts.modu for script build settings (auto-created if missing)

Open or Create a project through the editor’s Project Manager, or point the editor at a project directory.

---

Some Troubleshooting Steps:

If CMake isn't found

• Install CMake and make sure it’s on PATH

If the Compiler Isn't found

• Windows: install Visual Studio Build Tools (MSVC)

• Linux: install your distro’s C++ toolchain packages