https://github.com/miguelibero/darmok

another C++ game engine
https://github.com/miguelibero/darmok

bgfx directx entity-component-system entt lua opengl videogames vulkan

Last synced: 2 months ago
JSON representation

another C++ game engine

Host: GitHub
URL: https://github.com/miguelibero/darmok
Owner: miguelibero
License: mit
Created: 2023-11-23T18:55:26.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-10-25T09:58:05.000Z (8 months ago)
Last Synced: 2024-10-25T10:49:04.144Z (8 months ago)
Topics: bgfx, directx, entity-component-system, entt, lua, opengl, videogames, vulkan
Language: C++
Homepage:
Size: 33.5 MB
Stars: 3
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- License: LICENSE

Awesome Lists containing this project

README

        darmok

====

![Dathon trying to explain the importance of Darmok](logo.png)

C++ game engine combining opensource libraries & tools that I like

currently using:

* [bgfx](https://github.com/bkaradzic/bgfx) as the renderer

* [CMake](https://cmake.org/) as the build system 

* [vcpkg](https://vcpkg.io) as the package manager

* [glm](https://github.com/g-truc/glm) for 3d math

* [EnTT](https://github.com/skypjack/entt) as the entity component system

* [assimp](https://github.com/assimp/assimp) for generic asset loading (not in runtime)

* [sol2](https://github.com/ThePhD/sol2) modern C++ bindings for lua

* [nlohmann-json](https://github.com/nlohmann/json) for parsing json

* [pugixml](https://pugixml.org/) for parsing xml

* [imgui](https://github.com/ocornut/imgui) for editor UI

* [RmlUI](https://github.com/mikke89/RmlUi) for ingame UI

* [ozz](https://github.com/guillaumeblanc/ozz-animation/) for 3d skeletal animations

* [cereal](https://uscilab.github.io/cereal/) for serialization

* [Jolt](https://github.com/jrouwe/JoltPhysics) for 3D physics

* [miniaudio](https://miniaud.io/) for audio

* [taskflow](https://github.com/taskflow/taskflow) for multithreading

* [tiny-process-lib](https://gitlab.com/eidheim/tiny-process-library) to run os processes

* [mikktspace](http://www.mikktspace.com/) - to calculate tangents

* [middleclass](https://github.com/kikito/middleclass) - small object orientation lua lib

planned to use:

* [tracy](https://github.com/wolfpld/tracy) for frame profiling

    (blocked because of [bgfx#3308](https://github.com/bkaradzic/bgfx/pull/3308)

    and the vcpkg bgfx build not having a profiler feature)

* [recast navigation](http://recastnav.com/) for pathfinding

* [BehaviorTree.CPP](https://www.behaviortree.dev/) for behavior trees

* [Box2D](https://box2d.org/) 2D physics

* [ldtk](https://ldtk.io/) for 2D level editor

* [spine](https://github.com/EsotericSoftware/spine-runtimes) for 2d skeletal animations

Trying to target the following platforms:

* desktop (windows, macos, linux)

* mobile (iOS, Android) (pending)

Some philosofical decisions (could be controversial)

* use modern C++ (20) patterns where possible

* use as much stl as possible (need to look into memory management at some point)

* no naked pointers

* throw exceptions for error handling

* try to keep the API similar to Unity3D (where it makes sense) so that it's easy to port game logic

**WARNING**: currently in early stages of development

## Frequently Asked Questions

* Will it have feature X?

> Depends on what I need. Anyone is welcome to fork and submit PRs.

## Current State

I'm still learning CMake, so if you see something that should be fixed please let me know.

### Working features

* bgfx window setup (GLFW on windows & linux)

* update logic methods with delta time

* renderer

    * point, directional & ambient lights

    * forward render

        * unlit, gui

        * basic phong

        * PBR metallic-roughness ()

    * cascaded shadow mapping

        * directional lights

    * camera culling (frustum & occlusion)

* entity component scene using entt

    * transform, camera

* sprites and spritesheets

* loading models using assimp (FBX, gltf, etc...)

* serializing models from assimp into binary using cereal

* lua scripting

    * lua debugging

    * coroutines similar to unity

* multiple UI options

    * imgui for tooling

    * RmlUI for ingame (support for multiple canvases)

* skeletal animations using ozz (reading from binary)

* 3d physics using jolt

    * rigidbodies

    * character controller

* tool to export asset folders 

    * shaders & vertex layouts

    * copy files

    * assimp to custom binary model format

    * ozz skeleton & animations

* dynamic font texture generation

* play sounds and music (wav & mp3)

#### Upcoming

* frame limiting

* more renderer features

    * bloom

    * other types of lights (with shadow mapping)

    * deferred, clustered

    * SSAO

* luajit support (maybe compile using importer)

* text improvements

    * finish all the TextRenderConfig options

    * dynamic distance field rendering with border support

* clipboard text support (UTF8)

* asset loading progress

* possible refactors

    * maybe replace Data for std::vector and DataView for std::span

    * loaders should return unique_ptr

    * move lua bindings to separate library?

    * C++ coroutines could be useful in some places

* more stuff serialization

    * binary texture atlas

    * material

* custom UI module (rmlui is nice but slow)

#### In the future

* more unit tests

* performance profiling

* 2d physics

* instancing

* 3d physics materials

* multithreaded updates ([Ubisoft](https://www.youtube.com/watch?v=X1T3IQ4N-3g))

* support multiple imgui app components with different transforms

* spine animations

* unify use of allocators everywhere

* progressive asset loaders

* lua debugging would be nice

* particle systems (maybe effekseer)

* more sound options (spatialization, effects)

* animation root motion 

* [openusd](https://github.com/PixarAnimationStudios/OpenUSD) scene format support

* a game editor would be a huge undergoing, but maybe using [wxWidgets](https://wxwidgets.org/)

## Interesting Related Projects

* [SuperNovaEngine](https://github.com/skaarj1989/SupernovaEngine) a very similar engine but much more advanced

* [Cluster](https://github.com/pezcode/Cluster) - PBR shaders for bgfx

* [dome engine](https://github.com/domeengine/dome) - minimalist engine with wren as the scripting language

* [RaZ engine](https://github.com/Razakhel/RaZ) - C++17 game engine

* [meshoptimizer](https://github.com/zeux/meshoptimizer)

* [forward+](https://www.3dgep.com/forward-plus/) - description of tiled forward renderer in DirectX 11

## Example code

```lua

function init()

    local program = Program.new(StandardProgramType.Forward)

    local scenes = app:add_component(SceneAppComponent)

    local scene = scenes.scene

    local camEntity = scene:create_entity()

    local camTrans = camEntity:add_component(Transform, { 0, 1, -1 })

    camTrans:look_at({ 0, 0, 0 })

    local cam = camEntity:add_component(Camera)

    cam:set_viewport_perspective(60, 0.3, 1000)

    cam:add_component(ForwardRenderer)

    cam:add_component(LightingRenderComponent)

    local lightEntity = scene:create_entity()

    lightEntity:add_component(AmbientLight, 0.2)

    lightEntity:add_component(Transform, { 1, 1, -1 })

    local light = lightEntity:add_component(PointLight, 2)

    light.radius = 5

    local mesh = MeshData.new_sphere():create_mesh(program.vertex_layout)

    scene:create_entity():add_component(Renderable, mesh, program, Color.green)

end

```

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/miguelibero/darmok

Awesome Lists containing this project

README