Installation

Step by Step Installation Instructions

Prerequisite

This instruction set expects you to have the following software installed (Using any specified version or latest)

During development our decisions always attempt to conclude at a path that will allow us to support Windows, Linux & Mac. Right now the official support status is that Windows is the only platform that the developers can confirm work.

General

• Visual Studio 2022 Community Edition
• Git Software
• CMake
• Vulkan SDK

Server

• Postgres 15

Setup

• Start by navigating to the folder where you would like to install Novuscore and open CMD
• Run the following command
  • git clone https://github.com/novuscore/NovusCore.git
  • cd Novuscore
  • git submodule update --init --recursive
• Start Visual Studio 2022 and open the newly created folder
• Wait for the project to load, then navigate to the toolbar "Project -> Configure Cache"
• Navigate to the toolbar "Build -> Build All"
• Artifacts can be found at "Novuscore/out/build/x64-debug/Bin"

Optional

Targets

• You can optionally enable/disable build targets through CMake Variables. (Below you can find all the variables and their default values)
  • NOVUSCORE_BUILD_ENGINE ON
  • NOVUSCORE_BUILD_GAME ON
  • NOVUSCORE_BUILD_SERVER OFF

Common Errors

PostgreSQL

• When building the Server Project you may have to manually set the path for PostgreSQL. You can do so by setting the following CMake Variable to the Root path of your PostgreSQL installation (The folder which contains the Include folder)
  • PostgreSQL_ROOT

Vulkan SDK

• When building the Engine Project you may have to manually set the paths for Vulkan SDK. You can do so by setting the following CMake Variable to the correct path for your Vulkan SDK installation
  • Vulkan_INCLUDE_DIR
  • Vulkan_LIBRARY
  • Vulkan_GLSLC_EXECUTABLE
  • Vulkan_GLSLANG_VALIDATOR_EXECUTABLE