~/openengine
0 0
$ cat docs/getting-started/quickstart.md
# build and run the engine

Building the Engine

Windows

bash 
# Clone and navigate
git clone <repo-url>
cd OpenEngine

# Generate Visual Studio 2022 build files (recommended)
cmake -B build -G "Visual Studio 17 2022" -A x64

# Build
cmake --build build --config Debug
tip

For Visual Studio 2019, use -G "Visual Studio 16 2019" -A x64.

Linux/macOS (C++ only)

bash 
# Ninja (recommended)
cmake -S . -B build \
  -G Ninja \
  -DCMAKE_BUILD_TYPE=Debug \
  -DBUILD_EXAMPLES=ON \
  -DBUILD_TESTING=ON \
  -DENABLE_SCRIPTING=OFF

# Build
cmake --build build -- -j$(nproc)        # Linux
cmake --build build -- -j$(sysctl -n hw.ncpu)  # macOS

For macOS with scripting + Editor, see the macOS guide.

Build Outputs

build/
├── bin/Debug/
│   ├── Apps/
│   │   └── Editor/Editor.exe     # Editor
│   └── Tests/                     # Test executables
└── lib/Debug/
    └── Engine.lib                 # Engine library

On Linux/macOS with single-config generators, binaries land directly under build/bin/ (no Debug/ subfolder).

Running Tests

bash 
cd build
.\bin\Debug\OpenEngine.exe

The executable runs integration tests covering the asset system, C# scripting, hot-reloading, and C++/C# interop.

info

Expected output includes asset discovery logs, CoreCLR initialization, and hot-reload test setup. The engine then enters a 60 FPS main loop for 15 seconds before exiting.

Running Examples

Copy example game files from Examples/ into Assets/Scripts/, then build and run:

bash 
copy Examples\SpaceShooter\SpaceShooter.cs Assets\Scripts\
cmake --build build --config Debug
.\build\bin\Debug\OpenEngine.exe

Available examples include Space Shooter, Platformer, RPG, and a comprehensive Game Demo.

Next Steps

← Previous 📥Prerequisites & Setup Next → 🔨Build System
enesfrar