Skip to content

SirBob01/Dynamo-Engine

Repository files navigation

Dynamo Engine

Linux Build


Dynamo is a C++ game engine powered by Vulkan.

Features

  • Native support for an optimized ECS architecture in designing game objects
  • A simplified Scene management system
  • Rendering engine powered by the Vulkan API
  • An audio engine that supports multiple playback tracks and raw PCM data manipulation
  • ... and more!

These features allow it to be used as a framework for general multimedia applications.

For a more in-depth look at the engine's components, visit the wiki.

Rationale

I built this because I've always wanted to understand how game engines worked under the hood. This is mostly a learning exercise, but I also use it for my personal projects because of its flexibility and reusability.

Dependencies

To use Dynamo, the compiler must support at least C++17.

Dynamo uses a number of submodules that can be installed by running git submodule update --init

Running Demos

The engine comes with demo programs to test core features of the engine. To compile them, cmake must be installed. Go to the /demos/build directory, then run:

  • cmake .. -G BUILD_GENERATOR
  • make

Replace BUILD_GENERATOR with the generator applicable to your development environment. This assumes that all the dependency requirements are satisfied.

Running Tests

Similar to the demos, the tests need to be built. Go to the /tests/build/ directory then run:

  • cmake .. -G BUILD_GENERATOR
  • make
  • ctest --verbose

Contributing

Anyone is welcome to open a pull request! State the issue being solved and explain the solution precisely. Just ensure that the new code adheres to the style of the codebase.

For high-level suggestions on improving the engine, open an issue so we can have a discussion.

License

Code and documentation Copyright (c) 2019-2022 Keith Leonardo

Code released under the MIT License.