https://github.com/overload-technologies/overload
3D game engine with lua scripting
https://github.com/overload-technologies/overload
3d-engine 3d-graphics c-plus-plus cpp game-editor game-engine gamedev graphics graphics-engine imgui lua opengl physically-based-rendering rendering-engine windows
Last synced: 8 days ago
JSON representation
3D game engine with lua scripting
- Host: GitHub
- URL: https://github.com/overload-technologies/overload
- Owner: Overload-Technologies
- License: mit
- Created: 2019-06-13T13:45:15.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-04T14:17:24.000Z (17 days ago)
- Last Synced: 2025-04-06T14:01:32.401Z (15 days ago)
- Topics: 3d-engine, 3d-graphics, c-plus-plus, cpp, game-editor, game-engine, gamedev, graphics, graphics-engine, imgui, lua, opengl, physically-based-rendering, rendering-engine, windows
- Language: C++
- Homepage: https://overloadengine.org/
- Size: 27.9 MB
- Stars: 2,139
- Watchers: 42
- Forks: 261
- Open Issues: 98
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
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](https://github.com/BenjaminViranin), [Max BRUN](https://github.com/maxbrundev), and [Adrien GIVRY](https://github.com/adriengivry) 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](https://github.com/Overload-Technologies/Overload/issues) and [pull requests](https://github.com/Overload-Technologies/Overload/pulls) 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](https://github.com/Overload-Technologies/Overload/releases). 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`).
```powershell
# These 2 lines will clone Overload, generate project files, and open the Visual Studio solution.
git clone https://github.com/Overload-Technologies/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:
```powershell
.\Scripts\GenerateProjects.bat
```
*Please refer to [Premake5's documentation](https://premake.github.io/docs/Using-Premake) 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:
```powershell
.\Scripts\MSVC\BuildAll.bat Release
```
## Tutorials & Scripting API
Learn how to create your own games using Overload by visiting our [wiki](https://github.com/Overload-Technologies/Overload/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](https://github.com/Overload-Technologies/Overload/blob/develop/CONTRIBUTING.md).
# Requirements
- **RAM:** 100MB
- **OS:** Windows 7
- **GPU:** Graphics card supporting OpenGL 4.5
- **CPU:** x64
# Screenshots
