# overload
**Repository Path**: mirrors/overload
## Basic Information
- **Project Name**: overload
- **Description**: Overload 是一种替代游戏引擎，受行业标准的启发，由 Benjamin VIRANIN、Max BRUN 和 Adrien GIVRY 发起
- **Primary Language**: C/C++
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://www.oschina.net/p/overload
- **GVP Project**: No
## Statistics
- **Stars**: 14
- **Forks**: 7
- **Created**: 2021-09-15
- **Last Updated**: 2025-11-22
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## 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** – Inspired by other commercial engines, so you feel right at home.
- 🧊 **Simplicity** – Minimalistic by design, avoiding unnecessary complexity.
- 💭 **Pragmatic Design** – Features are carefully considered and deeply integrated.
- 📄 **Documentation** – Scripting API and documented source-code.
- 🤝 **Community-Driven** – Welcoming contributions and feedback from all developers.
- ⚙️ **Modern C++20** – Leveraging the power and safety of up-to-date C++ features.
# 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!
# Documentation
Check-out Overload's [documentation](https://github.com/Overload-Technologies/Overload/wiki) to find **sample projects**, **tutorials** & the **scripting API**!
# Getting Started
Before running Overload, we highly recommend [downloading one of Overload's sample projects](https://github.com/Overload-Technologies/Overload/wiki/Sample-Projects)!
## Pre-Built Binaries
In a rush? [Get the latest release](https://github.com/Overload-Technologies/Overload/releases)!
## Building From Sources
### Windows (MSVC)
```powershell
git clone https://github.com/Overload-Technologies/Overload
cd Overload
.\gen_proj.bat vs2022 # generate project files for Visual Studio 2022
.\Overload.sln # Open the solution in Visual Studio
```
> [!note]
> Officially supported actions for `gen_proj.bat` are: `vs2022` (default), `gmake`, `codelite`.
> Refer to [premake's website](https://premake.github.io/docs/Using-Premake) for more information.
### Linux (Clang)
```bash
git clone https://github.com/Overload-Technologies/Overload
cd Overload
./gen_proj.sh gmake # generate project files for Makefile
make -j$(nproc) # build the project using all available CPU cores
```
> [!note]
> Officially supported actions for `gen_proj.sh` are: `gmake` (default), `codelite`.
> Refer to [premake's website](https://premake.github.io/docs/Using-Premake) for more information.
# Architecture
Overload is divided into 11 modules: 9 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.
- `OvDebug`: Logging and assertions.
- `OvTools`: Serialization, file system, platform, events, clock, and more.
- `OvMaths`: Vectors, matrices, quaternions, transforms.
- `OvAudio`: Audio engine, built around [SoLoud](https://github.com/jarikomppa/soloud).
- `OvPhysics`: Physics engine, built around [Bullet3](https://github.com/bulletphysics/bullet3).
- `OvRendering`: Fully agnostic rendering engine (HAL), with OpenGL implementation using [GLAD](https://github.com/Dav1dde/glad).
- `OvWindowing`: Handles inputs and windows using [GLFW](https://github.com/glfw/glfw).
- `OvUI`: Widget-based UI, leveraging [ImGui](https://github.com/ocornut/imgui) under the hood.
- `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:
- [GLAD](https://github.com/Dav1dde/glad) (OpengGL Graphics API)
- [GLFW](https://github.com/glfw/glfw) (Windowing and inputs)
- [Assimp](https://github.com/assimp/assimp) (3D model loader)
- [Bullet3](https://github.com/bulletphysics/bullet3) (Physics)
- [SoLoud](https://github.com/jarikomppa/soloud) (Audio)
- [Tinyxml2](https://github.com/leethomason/tinyxml2) (XML serializer)
- [Sol3](https://github.com/ThePhD/sol2) (Lua binding)
- [ImGui](https://github.com/ocornut/imgui) (GUI)
- [Premake5](https://github.com/premake/premake-core) (Project generation)
# 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).
# Minimum Requirements
| | |
|-|-|
| **RAM** | 1GB |
| **OS** | Windows 7 & Linux |
| **GPU** | Graphics card supporting OpenGL 4.5 |
| **CPU** | x86_64 |
# Screenshots
