Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ta-david-yu/dyengine

Just a 2D hobby game engine written in C++. The project is still in an early stage but is actively under development. See the trello board for more upcoming features & progress.
https://github.com/ta-david-yu/dyengine

entity-component-system game game-development game-engine gamedev opengl sdl sdl2

Last synced: 3 months ago
JSON representation

Just a 2D hobby game engine written in C++. The project is still in an early stage but is actively under development. See the trello board for more upcoming features & progress.

Awesome Lists containing this project

README

        

![DYE_logo_outlined](https://user-images.githubusercontent.com/8101387/219255174-fdb29aa7-6c08-42ca-9365-a86e0d774d94.png)
# DYEngine
DYEngine is a WIP 2D game engine (with the possibility of 3D rendering).

## Modules
DYEngine is divided into 2 sub-project modules:
* **DYEngine**: The core of the game engine. It includes everything you need to make a code-only game.
* **DYEditor**: It provides the ECS object model using entt & an editor on top of that for editting scenes & entities. It comes with a code generation tool for generating type information of user-defined components & systems for editor type registry. The module is still in an very early stage.

## Environment Setup
### Not really a guide, just how I normally use this engine. Most of the following tools come with CLion as bundles
- **IDE**: CLion (CMake 3.17+)
- **Tested Compilers**:
- GNU 11.2.0 (MinGW)
- MSVC 19.34.31937.0
- Clang 15.0.1 (MSVC compatible)

Right now I am using CLion to configure & build the project.
In order to support multiple compilers, I had to include two versions of SDL2: MinGW & MSVC versions, which I downloaded from [SDL2 repository](https://github.com/libsdl-org/SDL/releases).
I did some reorganizations to the SDL2 folders so whether you use MinGW or MSVC (both cl.exe and clang-cl.exe) to compile, the build system will still be able to find the correct version of library to link.

## Library Dependencies (included in the project)
### DYEngine
- **SDL2** (2.26.5)
- **glad**
- **glm**
- **stb_image**
- **Dear ImGui**
- **ImGuizmo**
- **raudio**
### DYEditor
- **EnTT**: use as the main object model in DYEngine. I might implement my own ECS framework if time allows it.
- **tomlplusplus**: most of the custom text-based files in DYEditor will be stored as toml (i.e. scene/level files, asset meta files).
### DYEditor Code Generator
- **fmt**: for easier and more efficient source code generation process. Will replace it with c++ std::format library once it's widely supported by different compilers.
### Pending (to include/included but not used)
- **OpenAL-Soft**: Alternative for 3D audio. Need more research.

## Showcase
The project is still in a very early stage, but I am constantly working on it.
Here are some videos that might help you get the "feel" of DYEngine:

**DYEngine & Editor Feature Highlights 2023**
This video includes some of the features of DYEngine & DYEditor.
[![Watch the video](https://img.youtube.com/vi/ZrwCcynemSA/maxresdefault.jpg)](https://youtu.be/ZrwCcynemSA)

**Main Battle Turtle**
I made the game with two of my friends (Anton Sagel & Trey Ramm) during 2023 CGL Turtle Game Jam.
It's a really good opportunity to test out the game engine.
[![Watch the video](https://img.youtube.com/vi/CldpJoQgW-Q/maxresdefault.jpg)](https://youtu.be/CldpJoQgW-Q)

**DYE Tech Demo**
I've also made a small tech demo game collection with DYEngine, which you could check it out here - [DYE-Tech-Demo](https://github.com/ta-david-yu/DYE-Tech-Demo).
**Warning**: the code was made within 1 week (I was crunching on it for the goal of showcasing it at our end-of-semester showcase party), so it is very dirty/unorganized.
[![Watch the video](https://img.youtube.com/vi/0tD2ZouCuN4/maxresdefault.jpg)](https://youtu.be/0tD2ZouCuN4)

## Resources
It wouldn't have been possible to implement this project without the help of the internet!
Here are some resources that I use to make it happen! The list is non-exhaustive of course:
* **Hazel engine**: https://github.com/TheCherno/Hazel
* **Halley engine**: https://github.com/amzeratul/halley
* ...and a lot more to be added.