Installation & Project Setup
Get Modularity up and running on your system. This guide covers prerequisites, building from source, and creating your first project.
Prerequisites
- • C++20 compiler — GCC 11+, Clang 14+, or MSVC 2022+
- • CMake 3.20+
- • Git
- • GPU with OpenGL 4.5+ support
Building on Linux
Terminal BASH
1
# Clone the repository
2
git clone https://github.com/shockinteractive/modularity.git
3
cd modularity
4
5
# Create build directory
6
mkdir build && cd build
7
8
# Configure and build
9
cmake .. -DCMAKE_BUILD_TYPE=Release
10
make -j$(nproc)
11
12
# Run the editor
13
./ModularityEditor
Building on Windows
Command Prompt BAT
1
# Clone the repository
2
git clone https://github.com/shockinteractive/modularity.git
3
cd modularity
4
5
# Create build directory
6
mkdir build
7
cd build
8
9
# Configure with Visual Studio
10
cmake .. -G "Visual Studio 17 2022"
11
12
# Build from command line or open .sln in Visual Studio
13
cmake --build . --config Release
Project Structure
After creating a new project, you'll have this structure:
Project Structure TEXT
1
ProjectName/
2
├─ Assets/
3
│ ├─ Scenes/
4
│ ├─ Scripts/
5
│ │ ├─ Runtime/
6
│ │ └─ Editor/
7
│ ├─ Models/
8
│ ├─ Shaders/
9
│ └─ Materials/
10
├─ Library/ (aka CacheLibrary)
11
│ ├─ CompiledScripts/
12
│ ├─ InstalledPackages/
13
│ ├─ ScriptTemp/
14
│ └─ Temp/
15
├─ ProjectUserSettings/
16
│ ├─ ProjectLayout/
17
│ ├─ ScriptSettings/
18
│ └─ UserPrefs/ (optional)
19
├─ packages.modu
20
├─ project.modu
21
└─ scripts.modu
Next Steps
Once you have Modularity running:
- 1. Explore the Engine Layout to understand the editor interface
- 2. Configure your Scripts.modu file for compilation
- 3. Follow the C++ Scripting Quickstart to create your first script