Install Guide - TheGrimsey/NovusCore GitHub Wiki

Preface

NovusCore is not production-ready at the time of writing and much can & will change before it is. There are no guarantees that current data will work in future versions of the software. We only support 64-bit systems.

The main repository is the "stable" build of NovusCore and all the

This guide tries to go through everything for inexperienced users. Some parts may be skippable by experienced users.


Part 1: Installation prerequisites.

Software required to build & run NovusCore.

CMake 3.12+

OpenSSL 1.1+

Vulkan SDK

MySQL

MySQL Server

MySQL Connector/C

Note: As of MySQL 8.0 the C API is integrated into MySQL directly and you only require MySQL Server

To build from source you will need a way to compile the code. I recommend Visual Studio Community Edition on Windows but any IDE supported by CMake will work.


Part 2: Cloning NovusCore repository.

NovusCore is divided into multiple submodules you will need to pull all of these to build the engine. You can either use a git GUI program like Github Desktop or pull it manually via the command-line (You will need git installed for this)

You can NOT use the download zip option on Github as it won't grab all submodules

To clone the repo and all submodules from the command-line use the following command:

git clone --recurse-submodules https://github.com/novuscore/NovusCore.git

To clone the repo and all submodules using Github Desktop:


Part 3: Setting up CMake.

Using CMake you can set up your workspace.

  1. Open up CMake.
  2. For source select the folder to which you cloned NovusCore (this is the root folder that includes the git files)
  3. Click Configure & select your IDE (It should default to one you have installed)
  4. Click Generate, if you have installed all required libraries there should be no errors and all paths should have been found automatically.
  5. Click Open Project to open NovusCore in your IDE of choice. CMake Output

Part 4: Building NovusCore.

After opening the NovusCore project through CMake you will want to build the project for future steps. This step is highly dependent on your IDE.

In Visual Studio you can build everything by clicking Build -> Build Solution or Ctrl + Shift + B

Part 5: Extracting data.

With the project built you will need to extract the data we need from the client. You will need a copy of the Wrath of the Lich King client.

The location of the extractor executable will be either [CMake Build Folder]\Debug\ or [CMake Build Folder]\Release\ depending on your build configuration. Grab dataextractor from there and copy it to your Wrath of the Lich King client folder. The extractor should be in the same folder as the Wow executable.

Now run the Data Extractor.

The extractor will put all the data it extracts into a folder called ExtractedData

Part 6: Setting up Client.