_images/portal_splash_dark.png _images/portal_splash_light.png

Welcome to the Portal Framework - a modular C++23 game engine framework designed for high-performance, data-oriented game development.

Important

Note that Portal Framework is still in early development!
Most of the features are subject to change. To see the roadmap and the status of the project, see Development Status.
Additionally, the documentation is still incomplete and subject to change, all incomplete secions are marked with ⚠️

_images/engine_test_preview.png

First Steps

Learn how to get started with Portal Engine or browse the documentation for more in-depth information.

Introduction 💡

An overview of Portal Framework, its design, architecture and goals.

Introduction
Getting Started 🚀

Install Portal Engine and create you first project.

Getting Started
Concepts 🛠️

Deep-dive explanations of Portal Engine’s design and architecture.

Concepts
How-To Guides 🎯

Task-oriented recipes for common problems.

How-To Guides ⚠️

Modules

Portal Engine is organized into independent modules:

Core

Logging, math, jobs, utilities.

Core Module ⚠️
Application

Application lifecycle, module system.

Application Module ⚠️
Engine

Renderer, scene graph, resources.

Engine Module ⚠️
Input

Keyboard, mouse, gamepad.

Input Module ⚠️
Networking

Client-server communication.

Networking Module ⚠️
Serialization

Binary serialization, save/load.

Serialization Module ⚠️