TBDEngine (name subject to change)

A 3D game engine that aims to be convenient when developing {} genre of games, using Vulkan for rendering. We are also aiming for an OS-agnostic development experience. Meaning, regardless if you are on Windows, Linux, or even MacOS, you can contribute to the project.

Getting Started

GLM and GLFW is already taken care of by the CMake script CMakeLists.txt, so there is no need to download and install manually. What needs to be installed manullay by the developer is install Vulkan at this time. In the future, we will automate Vulkan installation as well.

Currently, this project uses the following versions:

• GLM Git Tag 0.9.9.8
• GLFW Git Tag 3.3.8
• Vulkan v1.3.296

In order to install Vulkan, please refer to the official LunarG webiste. Make sure the version is the same as the version listed above. Installing into the default paths and disregarding all optional packages should be sufficient, but you can experiment with the other packages.

Windows

Preferred IDEs to develop in Windows would be Visual Studio and CLion. We will discuss how to get you started in both.

Visual Studio

TODO

CLion

When you open up CLion, click on "Get from VCS", pull the repository located in GitHub. It should automatically open the project. Afterwards, find the CMakeLists.txt file in the root directory and a notification should pop up on the top right corner prompting you to press "fix". Press it and select "Load Project". Doing so will immediately begin the CMake script and build the project. Once it's finished, the green "play" button towards the top right should be clickable. Click on it, and the main executable TBDEngine should start.

Unix/Linux

Clone the repository and cd into the root directory of the project. If you are using WSL, run the following bash commands:

sudo apt install libxrandr-dev
sudo apt install libxinerama-dev
sudo apt install libxcursor-dev
sudo apt install libxi-dev

Afterwards, run the following bash commands:

mkdir build
cd build
cmake ..

Doing this configures CMake to build your project according to the specifications in the CMakeLists.txt located in the root directory. Once CMake is finished with its configurations, run the following command:

make -j8

This will compile all the files into binaries and finally generate the main executable TBDEngine. To start the executable, run the following command:

./TBDEngine

Contributors

• Ilter Ulutas
• kickdapie
• alejandro-d-garza
• Pooji20-dot
• Calvin Fun
• Josh Eury
• abzf227
• Roei Ben Porat
• Ethan Nguyen
• SwordMaster3341
• Owen House
• Camryn Graham
• uzairak12
• Arkan A