Skip to content

Latest commit

 

History

History
197 lines (135 loc) · 6.48 KB

Build.md

File metadata and controls

197 lines (135 loc) · 6.48 KB

Build instructions.

Install dependencies

Android (PC)

When building from PC.
Install Android Studio with NDK.

Android (device)

When building from Android device:

  • Install Linux terminal: termux (github, f-droid, play store)
  • In terminal install: git, clang, cmake.
    pkg install git
pkg install clang
pkg install cmake
  • Optional: github and f-droid version of termux can access to external storage, allow this and clone repository to public path like /sdcard/Code.
  • Optional: install code editor.

Linux

In terminal run:

sudo apt install build-essential pkg-config libx11-dev libxcursor-dev \
    libxinerama-dev libasound2-dev libpulse-dev libudev-dev \
    libxi-dev libxrandr-dev yasm liburing-dev libpng-dev libbz2-dev libwayland-dev \
    libxkbcommon-dev

Optional: install clang

sudo apt install clang
sudo apt install libc++-dev
sudo apt install libc++abi-dev

Install CMake.
Install VSCode with CMake and C++ plugins.

MacOS

Install CMake.
Install XCode.

Windows

Install CMake.
Install Visual Studio 2022.
Optional: install ClangCL in Visual Studio components.

Download third party dependencies

Script AE/build_scripts/clone_3party.bat will copy git repositories to local folder AE/../3party.

You can replace path to your local git server to get stable and safe connection.

Currently script is written only for Windows platform, on other platforms you can get access through your local git-server.

Alternative
Download prebuild binaries which is used in CI and extract it to the AE-Bin/external folder:
Android
Linux x64 GCC-13
Linux x64 Clang-16
MacOS arm64
Windows x64 MSVC
Windows x64 Clang
Then Build engine and samples

Build third party dependencies

Open folder AE/engine/external and run scripts for required platforms and compiler version.

Libraries and headers will be installed to the AE/../AE-Bin/external folder.

Android (PC)

update-all-win.bat - to load header-only sources.
update-all-android-clang.bat - to compile static (.a) libs.

Android (device)

You should build dependencies on PC or download them.

Linux

update-all-linux.sh - to load header-only sources.
update-all-linux-x64-clang16.sh or update-all-linux-x64-gcc13.sh - to compile static (.a) libs.

MacOS

update-all-macos.sh - to load header-only sources.

ARM64:
update-all-macos-arm64-clang15.sh - to compile static (.a) libs.

x64 on ARM64 platform:

How to install x64 compiler on ARM64

From stackoverflow :

# launch x86_64 shell
arch -x86_64 zsh
# install x86_64 variant of brew
arch -x86_64 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
# install x86_64 variant of clang
arch -x86_64 /usr/local/bin/brew install llvm
# compile using x86_64 variant of clang
/usr/local/opt/llvm/bin/clang++ -arch x86_64 omp_ex.cpp

update-all-macos-x64-onarm-clang15.sh - to compile static (.a) libs.

x64:
update-all-macos-x64-clang15.sh - to compile static (.a) libs.

Windows

update-all-win.bat - to load header-only sources.
update-all-win-x64-msvc143.bat or update-all-win-x64-clang17.bat - to compile static (.lib) and dynamic (.dll) libs.

To compile Metal shaders put MetalTools for Windows into the folder AE-Bin/external/win-x64/MetalTools:

bin
  air-lld.exe
  metal.exe
lib
  clang
    ...

Build engine and samples

Open folder AE/build_scripts, select target platform and compiler, then call init script to create solution or call build script to build project from console.

Run VulkanHeaderGen (VS: in 'Engine/ToolApps') to generate Vulkan loader from current header files.

Android (PC)

Script AE/build_scripts/build-*.bat will build project from console.
To use Android IDE open project in folder AE/android from IDE.

Android (device)

For example you have folder structure:

/sdcard/Code
  AE      -- from git
  AE-Bin  -- from git or downloaded, see 'Download third party dependencies'
  AE-Temp -- from git or downloaded, see 'Compile resources'
  build   -- empty

Then, in termux:

cd /sdcard/Code/build
cmake -DAE_ENABLE_VULKAN=ON "../AE"
cmake --build . --config Debug

Note: app launcher is in progress.

Compile resources

Projects which is require precompiled resources has cmake targets with .PackRes suffixes.
You should run it first to compile resources.

From console: cmake --build . --config <config> --target <project>.PackRes.
From IDE: build target <project>.PackRes.

Compiled resources will be stored in AE/../AE-Temp folder. They can be used on all platforms.

Update file paths (optional)

Visual Studio, VSCode, Notepad++ and some other IDEs allows to open file in URL format like a file://absolute/path/to/a/file.txt, but it requires absolute paths. Source code may contain links to other source files or docs which is written as URLs.
Use IDE or another tool to replace path [](https://github.com/azhirnov/as-en/blob/dev/AE/) to an absolute path like a file://C:/Projects/AE/.

Setup IDE and environment (optional)

Associate file extensions .as, .glsl with Visual Studio, Notepad++ or other IDE or text editor. This text editor will be used to open files by links like file://path.

Visual Studio

Open TOOLS- > Options..., select Text Editor -> File Extension and add file extensions as a C++ source:
.as - AngelScript file with AsEn preprocessor.
.glsl, .msl - shader language.
.glsl_dbg - for shader debugger.
.mm - for ObjC code.