Skip to content

Latest commit

 

History

History
110 lines (89 loc) · 4.81 KB

Setup.md

File metadata and controls

110 lines (89 loc) · 4.81 KB
Raw

Instructions for building Principia on Windows

Before starting, make sure the following are installed on your machine:

  • Visual Studio 2022 version 17.8.6 with C# and C++ support;
  • Windows SDK 10.0.22621;
  • .NET Framework 4.7.2 SDK (and Targeting Pack).

The solution contains a C# project named coverage_analyser which requires the Enterprise edition of Visual Studio to build. It's only a development tool for our own use, so if you use a different edition, just do Project > Unload Project on that project. You will still be able to build and test the mod.

These instructions use the git Powershell provided by GitHub for Windows. We assume a working installation of Kerbal Space Program version 1.12.5 is found in <KSP directory>.

The repository is found at https://github.com/mockingbirdnest/Principia.git. Pick a directory <root> in which you will install Principia and its dependencies. This directory should not contain any of the following subfolders:

  • Principia;
  • KSP Assemblies;
  • Google.

This project depends upon:

  • the KSP assemblies Assembly-CSharp.dll and Assembly-CSharp-firstpass.dll, found in <KSP directory>\KSP_x64_Data\Managed;
  • the Unity assemblies UnityEngine.CoreModule.dll, UnityEngine.dll, UnityEngine.ImageConversionModule.dll, UnityEngine.IMGUIMode.dll, UnityEngine.InputLegacyModule.dll, UnityEngine.PhysicsModule.dll, UnityEngine.TextRenderingModule.dll and UnityEngine.UI.dll, found in <KSP directory>\KSP_x64_Data\Managed;
  • our fork of the Google glog library;
  • our fork of the Google googletest and googlemock libraries;
  • our fork of the Google protobuf library;
  • our fork of the Google benchmark library;
  • our fork of the Google gipfeli library;
  • our fork of the Google Abseil C++ library;
  • our fork of the LLNL zfp library;
  • our modified excerpts of the Chromium codebase (for stack tracing support in glog on Windows).

Installation steps

Dowloading Principia

In <root>, run git clone https://github.com/mockingbirdnest/Principia.git.

KSP and Unity assemblies

In order to build for KSP 1.12.5, copy the corresponding KSP 1.12.5 assemblies to <root>\KSP Assemblies\1.12.5

Building

In <root>, run the following command:

.\Principia\rebuild_all_solutions.ps1

Instructions for building Principia on Linux and macOS

Note that the released binaries for Linux and macOS are built using Azure pipelines. The instructions below are best effort.

Build Prerequisites

Before starting, make sure the following are installed on your machine:

Linux

  • Plugin build prerequisites: unzip wget binutils make automake libtool curl cmake;
  • Adapter build prequisites: msbuild
  • Clang version 17, which can be installed thus: 
    wget https://apt.llvm.org/llvm.sh
chmod +x llvm.sh
sudo ./llvm.sh 17 all

macOS

  • Plugin build prerequisites: autoconf automake libtool;
  • Adapter build prequisites: msbuild. It is included as part of Mono, and can alternatively be installed directly using a package manager. You might be able to build it using Visual Studio for Mac, but this is untested.
  • Clang version 17, which can be installed thus: 
    brew install llvm@17

Note that the resulting binary targets macOS 10.13 (High Sierra) but running with old versions of macOS may or may not work.

Installing the dependencies

In <root>/Principia, run the following command:

./install_deps.sh

This will install and compile all the third-party components that Principia uses. Don't proceed with the next step unless this step has completed without errors.

KSP and Unity assemblies

In order to build the adapter, you will need references to the KSP and Unity assemblies. Principia expects to find these in a directory adjacent to the principia directory. For example, in order to build for KSP 1.12.5, the assembly directory should be linked to ../KSP Assemblies/1.12.5 (relative to the Principia directory).

A shell script is provided that will do this automatically on macOS:

./add_ksp_assemblies_macos.sh

Building Principia

In <root>/Principia, run the following command:

make

See the Makefile for more options. If some of the unit tests fail, you may or may not be able to run the resulting version of Principia.