Skip to content

Build Setup

WireWhiz edited this page Aug 13, 2022 · 7 revisions

Hi there! If you're reading this you must want to help us work on Brane Engine. Happy to have you!

Setting up

"Download it and then fix bugs until it works"

Prerequisites

It's recommended to install a python interpreter, as well as the LunarG Vulkan SDK.
https://www.python.org/downloads/
https://www.lunarg.com/vulkan-sdk/

Downloading

To clone the project, first, navigate the git bash to the directory that you want to put the project in, and then run these commands:

git clone https://github.com/WireWhiz/BraneEngine/
cd BraneEngine
git submodule update --init --recursive

This will download the project and external libraries.

Building

Currently, we use CMake as a build system so most modern IDEs will be able to detect that and configure themselves automatically.

Visual Studio

To generate a visual studio project, just run setup-vs.bat, then you should be able to open BraneEngine.sln file in the freshly vs-proj directory

Clone this wiki locally