Building

Getting Source

git clone https://github.com/crownengine/crown.git

Prerequisites

Android

1. Install Android NDK (>= r21e LTS):

   • https://developer.android.com/ndk/downloads

2. Set NDK path and ABI version:

export ANDROID_NDK_ROOT=<android_ndk>
export ANDROID_NDK_ABI=23

1. Install LuaJIT dependencies:

sudo apt-get install libc6-dev-i386

1. Build for Android.

HTML5

1. Install emsdk:

   • https://emscripten.org/docs/getting_started/downloads.html

2. Set emsdk path:

export EMSCRIPTEN=<emsdk>/upstream/emscripten

1. Build for HTML5.

Linux (Ubuntu >= 20.04)

1. Install dependencies:

sudo apt install build-essential mesa-common-dev libgl1-mesa-dev \
libpulse-dev libxrandr-dev libdecor-0-dev libc6-dev-i386 libgtk-3-dev

sudo add-apt-repository ppa:vala-team
sudo apt install valac libgee-0.8-dev

# Optionally, to build docs:
sudo apt-get install python3-sphinx

Note

If you encounter any errors while adding the Vala PPA, please update ca-certificates first:

sudo apt update
sudo apt install ca-certificates

1. Build for Linux.

Windows (MSYS2)

1. Install MSYS2:

   • https://www.msys2.org/

2. Add MSYS2 bin to your PATH; for a default install this would be:

C:\msys64\usr\bin

1. Open MSYS2 MINGW64 shell and install dependencies:

    pacman -Sy make mingw-w64-x86_64-gcc mingw-w64-x86_64-pkgconf \
    mingw-w64-x86_64-gtk3 mingw-w64-x86_64-sassc \
    mingw-w64-x86_64-vala mingw-w64-x86_64-libgee

# Optionally, to build docs:
pacman -Sy mingw-w64-x86_64-python-sphinx

1. Build for Windows (MSYS2).

Windows (VS Code)

1. Install Visual Studio Code:

   • https://code.visualstudio.com

2. Install C/C++ extension for VS Code:

   • https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools

3. Install MSYS2.

4. Build for Windows (VS Code).

Windows (VS 2022)

1. Install Visual Studio 2022:

   • https://visualstudio.microsoft.com/downloads

2. If you want to build tools, install Windows (MSYS2).

3. Build for Windows (VS 2022).

Build

Android

make android-arm-release MAKE_JOBS=4

HTML5

make wasm-release MAKE_JOBS=4

Linux

make tools-linux-release64 MAKE_JOBS=4

Windows (MSYS2)

Open MSYS2 MINGW64 shell:

export MINGW=/mingw64
make tools-mingw-release64 MAKE_JOBS=4

Windows (VS Code)

Open Visual Studio Code Shell:

$env:MINGW = "C:\\msys64\\mingw64"
make tools-mingw-release64 MAKE_JOBS=4

Windows (VS 2022)

1. Open Visual Studio 2022 Command Prompt:

make tools-windows-release64 MAKE_JOBS=4

1. To build tools, open a MSYS2 MINGW64 shell:

export MINGW=/mingw64
make tools-mingw-release64 MAKE_JOBS=4