Onyx Engine

A 3D Cross-Platform Game Engine written in C++.

Build Requirements

• A C++ 17 Compiler
• CMake 3.14 or higher
• The latest version of the Vulkan SDK

External Library Dependencies

Build Instructions

• Clone the repository via Git

  git clone https://github.com/EwanBurnett/Onyx-Engine.git
  cd Onyx-Engine

Windows

Visual Studio with CMake (Recommended)

• Install Visual Studio 2022
• Install the C++ CMake tools for Windows package for Visual Studio 2022
• Open the project root directory in Visual Studio 2022.
  • Visual Studio will automatically generate the CMake Project files.
• Select the project you wish to build from the "Select Startup Item" menu, and your build configuration, then build.
  

Visual Studio

• Generate the CMake Project

  mkdir build && cd build
  cmake .. 

• Open the generated Visual Studio solution file build/Onyx-Engine.sln
• Build the project as normal.

Linux

• Generate the CMake Project

  mkdir build && cd build
  cmake ..

• Build via your platform's build system (e.g. Make)

  make

CMake Options

• Various features can be enabled/disabled through the use of CMake Options

Option	Description	Default Value
ONYX_BUILD_TESTS	Build the Unit Test project	OFF
ONYX_BUILD_TESTBED	Build the Development Test project	OFF
ONYX_BUILD_SAMPLES	Build Sample Projects	ON
ONYX_BUILD_DOCS	Generate Local Doxygen Documentation (Requires Doxygen)	OFF

• e.g. to enable ONYX_BUILD_SAMPLES:

  # From the CMake build directory
  cmake .. -DONYX_BUILD_SAMPLES=ON