Releases | Screenshots | Features | Wiki | Contributing

What's Overload?

Overload is a free, open-source 3D game engine made in C++ with Lua as its scripting language.

Originally created in 2019 by Benjamin VIRANIN, Max BRUN, and Adrien GIVRY as a graduation project, it has since evolved into an community-driven initiative supported by dozens of contributors.

Overload pillars are:

• 🐣 Ease of use
• 📄 Documentation
• 🤝 Community
• ⚙️ Modern C++20 code

Features

• Lua scripting
• Game editor
• Physically-Based Rendering (PBR)
• Custom shaders support
• Windows game building
• Profiling tools
• Material editor
• Spatial audio
• Rigidbody physics
• And many more to come...

Check out our issues and pull requests to learn more about what's coming next!

Architecture

Overload is divided into 12 modules: 10 libraries (SDK), and 2 executables (Applications).

Overload SDK

The Overload SDK is the core of the engine. It is a set of libraries used by our applications: OvGame and OvEditor. We designed theses libraries with reusability in mind. They are highly modular and easy to extract from a game engine context.

• OvAnalytics: Code and hardware profiling
• OvDebug: Logging and assertions
• OvTools: Serialization, INI files, events, clock
• OvMaths: Vectors, matrices, quaternions, transforms
• OvAudio: Wraps irrKlang
• OvPhysics: Wraps Bullet3
• OvRendering: Rendering engine using OpenGL
• OvWindowing: GLFW and Windows API wrapper
• OvUI: Dear ImGui wrapped into an event-based and component-based UI system
• OvCore: Component-based scene system, scripting, and resource management

Overload Applications

Overload applications use the Overload SDK to operate.

• OvGame: A data-driven executable for any game built with Overload
• OvEditor: An editor for building your game

Dependencies

Overload depends on a few third-party libraries:

• OpenGL with GLEW (Graphics API)
• GLFW (Windowing and inputs)
• Assimp (3D model loader)
• Bullet3 (Physics)
• irrKlang (Audio)
• Tinyxml2 (XML serializer)
• Sol2 (Lua binding)
• ImGui (GUI)
• Premake5 (Project generation)

Getting started

Running Overload from a Release Build

Get started with Overload in no time by downloading one of our release builds. While this is the fastest way to get started, you might miss out on some cool features we're cooking up!

After downloading the archive, unzip it and run the Overload.exe executable file.

Building Overload from Sources

Quick Start (For Visual Studio 2022)

To start working with Overload quickly, clone the repository and run the OpenInVisualStudio.bat script. Project files will be automatically generated, and Visual Studio will open with the generated solution (Overload/Sources/Overload.sln).

# These 2 lines will clone Overload, generate project files, and open the Visual Studio solution.
git clone https://github.com/adriengivry/Overload
.\Overload\OpenInVisualStudio.bat

Generating Project Files (For Any IDE)

Note: This step is performed automatically when using OpenInVisualStudio.bat

Overload uses Premake5 to generate project files. To generate these files, execute the GenerateProjects.bat located in the Scripts/ folder.

By default, GenerateProjects.bat will generate project files for Visual Studio 2022.

If you'd like to use another IDE, you'll need to run GenerateProjects.bat from the command line:

.\Scripts\GenerateProjects.bat <ide_of_your_choice>

Please refer to Premake5's documentation to find supported IDEs.

⚠️ Some Premake5-supported IDEs might still not work with Overload.

Building From the Command Line (MSVC Only)

Note: Before building, make sure that you generated the Visual Studio solution.

If you'd like to build Overload directly from the command line (without opening Visual Studio), you can use the BuildAll.bat script located in Scripts/MSVC/. By default, BuildAll.bat will build the project in Debug mode, but you can choose the configuration you want by providing an argument:

.\Scripts\MSVC\BuildAll.bat Release

Tutorials & Scripting API

Learn how to create your own games using Overload by visiting our wiki.

Contributing

Overload is open to contributions of all kinds. Feel free to open issues (feature requests or bug reports) or submit pull requests.

If you'd like to contribute, please refer to our contribution guildelines.

Requirements

• RAM: 100MB
• OS: Windows 7
• GPU: Graphics card supporting OpenGL 4.3
• CPU: x64

Screenshots