DirkEngine

Welcome to the DirkEngine project! an opensource game engine to help me and any contributors learn about the fascinating technologies that go into game development. This project is just a hobby so don't expect LTS or any kind of production ready system (this could change in the future if this repository gets enough traction). Any contribution/feedback is greatly appreciated!

Important

Don't forget to check out the contribution guidelines and the code of conduct of this project.

Build

Important

The DirkEngine uses a custom build system. This build system is only available on Linux. Feel free to add compatibility with another platform.

Important

On Linux, the DirkEngine only supports wayland compositors. Adding X11 compatibility is not planned.

Prerequisits

1. The gcc compiler toolchain (we use g++).
2. The Go compiler.
3. GUN Make.
4. The Vulkan SDK that we use for the renderer backend. You can follow this tutorial for SDK instalation. The lib dir of the SDK should be in LD_LIBRARY_PATH or any other environment variable specified in build tool config.
5. If on Linux, xkbcommon in LD_LIBRARY_PATH or any other environment variable specified in build tool config.
6. If on Linux, wayland-client needs to be available in LD_LIBRARY_PATH or any other environment variable specified in build tool config.

Building the project

Run make build to build or make to build and run. Binaries will be located in the Engine/Binaries directory.

Roadmap

You can check out the dedicated Github Project to understand the current direction of development.

Contact

If you would like to contact me privately for reasons related to the DirkEngine (such as any security issues), send me an email at dirkengine@piquel.fr.

License

This project is licensed under the GPLv3 license.