Index is a lightweight C++20 2D game engine mainly focused on performance and modularity.

Preview Images

Editor

Launcher

Getting Started

Clone with submodules:

git clone --recurse https://github.com/Ben-Scr/Index.git
cd Index

Then follow the steps for your platform. Re-run setup after pulling changes that touch dependencies, submodules, Premake files, or C# projects.

Windows (Visual Studio 2022)

Prerequisites: Visual Studio 2022 (MSVC v143 toolset + Windows SDK), .NET 9 SDK, Python 3.10+, and Git.

Generate the project files:

scripts\Setup.bat

Open Index.sln and build the configuration you want, or build from a Developer PowerShell:

msbuild Index.sln /m /p:Configuration=Release /p:Platform=x64

Linux (GNU Make)

Prerequisites: a C++20 compiler (GCC; Dawn's source build also needs Clang), GNU Make, Python 3.10+, Git, and the GLFW + X11 development packages.

Generate the makefiles:

chmod +x scripts/Setup.sh
./scripts/Setup.sh

Build:

make config=release -j"$(nproc)" Index-Engine Index-Runtime Index-Editor

Documentation

Guides for building games with Index live in Github-Docs/Documentation.

Built With

• WebGPU via Dawn — rendering (picks D3D12 / Vulkan / Metal at runtime)
• GLFW — windowing & input
• Box2D / Index-Physics — 2D physics
• EnTT — ECS
• Miniaudio — audio
• GLM / STB — math & image loading
• .NET 9 / hostfxr — C# scripting host