Skip to content

Building from source

Brendan Walker edited this page Aug 24, 2022 · 1 revision

Overview

This page will explain how to build the project from source on Win10. If all you want to do is run the project without modifications, you might instead consider downloading pre-built binaries from the Release page.

Downloading the source

Don't download the source from the green "Clone or download" button! The zip provided only contains the source from the /src folder and not the submodules in /thirdparty. This is a known issue with GitHub (we don't provide the zip file that this button generates). If you don't have a github client installed, get it from: https://desktop.github.com/

git clone --recursive /~https://github.com/brendanwalker/MikanXR.git

cd MikanXR

Prerequisites and Build

Prerequisites

  1. CMake
  2. Compiler - Visual Studio 16 2019

Initial Setup Script

  1. Run the InitialSetup_X64.bat Batch Script
    • This script will automatically configure and download the dependencies in the deps folder.
  2. After the initial setup phase, if you add source files or other CMake changes you can run GenerateProjectFiles_X64.bat to regenerate the MikanXR solution.

Build

  1. Open <path_to_repo>\build\Mikan.sln
  2. Change to "Release" configuration
  3. Rt-click on the Mikansolution and build (or do a "Build All..." from the build menu)
  4. Rt-click on the "INSTALL" project and build
Clone this wiki locally