Skip to content

Latest commit

 

History

History
92 lines (88 loc) · 2.85 KB

build.md

File metadata and controls

92 lines (88 loc) · 2.85 KB
Raw

How to build Ottocento Engine

Ottocento Engine is available to build on Windows, Linux and MacOS. It uses premake5 to either build a solution on windows or a makefile for Linux and MacOS X. Generating the build is pretty straightforward.

Download the Source

git clone https://github.com/lknknm/vulkan-tutorial.git

Dependencies:

  • GLFW.
  • VulkanSDK.
  • GLM (OpenGL Mathematics).
  • GLSLC shader compiler.

How to build:

  • Download and Install Premake5 for either Linux, Windows or MacOS.

Windows

  • Download and Install VisualStudio 2022 (Community), JetBrains Rider, or any IDE that supports opening solution files for C++ projects.
  • Download and Install the VulkanSDK package.
  • Ottocento includes the binaries for the glfw-3.4.Win.64 version of GLFW. But if you want to link it with your own installation/binaries, you can check the latest version here.
  • In the project's root folder, run:
premake5 vs2022 --os=windows
  • Open the generated *.sln file with your IDE of choice to run it.

Linux

VulkanSDK

Download and Install the VulkanSDK Command-line utilities and run vkcubeon the terminal to confirm if your machine supports Vulkan:
sudo apt install vulkan-tools

or

sudo dnf install vulkan-tools

Download and install the Vulkan Loader so Vulkan can look up the functions in the driver at runtime:

sudo apt install libvulkan-dev

or

sudo dnf install vulkan-loader-devel

Download and install the Vulkan Validation layers and SPIR-V tools for debugging the project.

sudo apt install vulkan-validationlayers-dev spirv-tools

or

sudo dnf install mesa-vulkan-devel

Alternatively, you can run sudo pacman -S vulkan-devel on Arch-Linux to install all the aforementioned Vulkan packages at once.

GLFW

Install GLFW by running either:
sudo apt install libglfw3-dev

or

sudo dnf install glfw-devel

or

sudo pacman -S glfw-wayland # glfw-x11 for X11 users

GLM (Optional — This repository already contains the glm library linked in the project)

Install GLM by running either:
sudo apt install libglm-dev

or

sudo dnf install glm-devel

or

sudo pacman -S glm

Makefile

Finally, to generate the Makefile using premake5, in the project's root directory, run:

premake5 gmake --os=linux && make

Alternatively you can also generate the release build with:

make config=release

All set!

Now you are all set to Build, Run and Contribute to the Ottocento Engine!