UE4编译grpc,编译打包

732 阅读6分钟

本文已参与「新人创作礼」活动,一起开启掘金创作之路。

一.源码下载与编译

1.下载UE4.27.2源码

需要先注册UE的账号:

www.unrealengine.com/zh-CN/

需要有github.com账号

github.com/

登录ue4官网,点击个人,然后关联。

(注意有的人是很久之前注册过的,也关联过GitHub账号的,但是没有加入EpicGame的team,导致下载不了源码引擎。可以点解除关联,然后再重新关联,EpicGame会给你发邮箱加入开发者team。)

image.png

image.png

点击GitHub头像,左下角说明已经加入了ue4的开发者team,可以访问ue4的私有库.

2.选择对应的版本下载即可

在中国大陆地区不建议使用git clone的方式,建议使用下载压缩包

git clone -b v4.27.2 https://github.com/EpicGames/UnrealEngine.git

image.png

3.下载代码,修改Setup.bat

代码下载完成后,进行解压缩。修改Setup.bat文件,搜索set PROMPT_ARGUMENT=--prompt ,在其后面增加如下

set PROMPT_ARGUMENT=--prompt   --cache=D:\uedepTmpLinux --threads=40   --exclude=iOS  --exclude=Android  --exclude=Win32 --exclude=osx32 --exclude=osx64

根据需求进行修改,这个代码是开启多线程,进行缓存,排除不需要的依赖 点击Setup.bat,等待一段时间,差不多一个小时左右,主要依赖网络的速度。

image.png

4.生成解决方案

点击GenerateProjectFiles.bat,生成UE4.sln解决方案

image.png

5.编译UE4工程

打开UE4.sln,选择如下方式,进行编译,差不多需要40分钟左右,具体依赖于电脑的配置。

image.png

6.编译完成后,选择UnrealVersionSelector-Win64-Shipping.exe,进行注册

image.png

二.Demo的编译与打包

7.编译demo

选择项目进行编译,该demo采用插件的方式,开发了grpc client,可以在游戏的过程中发送grpc请求。

git clone https://github.com/vizor-games/InfraworldRuntimeExample.git

选中InfraworldDemo.uproject,右键选择下图所示的1,即可生成解决方案,选择2可以进行引擎的切换

image.png

image.png

8.编译InfraworldRuntimeExample

需要把插件放在plugins目录下,也可以下载使用预先编译好的插件。

git clone https://github.com/vizor-games/InfraworldRuntime.git

image.png

选择如下编译方式,进行编译

image.png

9.编译完成,看效果

具体如下所示(没啥事不要总是点击重新编译,这个会花费很多时间的

image.png

10.Windows平台打包

  • 按照下图所示之后,然后选择文件夹,如WindowsPackage

image.png

image.png

image.png

点击InfraworldDemo.exe即可运行。

image.png

三.Linux版本的编译与打包

11.UE4打包Linux版本的grpc库

在讨论这个问题的时候,并不是说把grpc版本下载下载,直接使用cmake的方式进行编译,这个是常规C++的项目,进行的操作,我们采用的是UE4加载grpc的方式,需要按照规则进行处理。 下载如下代码

git clone https://github.com/vizor-games/InfraworldRuntime.git

image.png

安装需要有些编译的组件

安装m4
wget http://mirrors.kernel.org/gnu/m4/m4-1.4.13.tar.gz 
tar -xzvf m4-1.4.13.tar.gz \
cd m4-1.4.13 
./configure –-prefix=/usr/local
make &&sudo  make install

安装autoconf
wget http://mirrors.kernel.org/gnu/autoconf/autoconf-2.65.tar.gz 
tar -xzvf autoconf-2.65.tar.gz 
cd autoconf-2.65 
./configure –prefix=/usr/local 
make && sudo make install

安装automake
wget http://mirrors.kernel.org/gnu/automake/automake-1.11.tar.gz 
tar xzvf automake-1.11.tar.gz  
cd automake-1.11 \
./configure –-prefix=/usr/local 
make && sudo make install

安装libtool
wget http://mirrors.kernel.org/gnu/libtool/libtool-2.2.6b.tar.gz 
tar xzvf libtool-2.2.6b.tar.gz 
cd libtool-2.2.6b 
./configure –prefix=/usr/local 
make && sudo make install

安装golang
wget -c https://dl.google.com/go/go1.17.8.linux-amd64.tar.gz -O - | sudo tar -xz -C /usr/local
vi /etc/profile
#添加路径
export PATH=$PATH:/usr/local/go/bin
#保存之后,让其生效
source /etc/profile
#验证golang环境是搭建好
go version  或者go env


安装完成后修改 Setup.sh代码

#!/bin/bash

# Exit on errors if any
set -e

###############################################################################
# Should be defined as an environment variable, will be v1.3.x otherwise
branch=${branch:-v1.23.x}
clean=${clean:-true}

VAR_GIT_BRANCH=$branch
VAR_CLEAR_REPO=$clean

REMOTE_ORIGIN="https://github.com/grpc/grpc.git"
GOSUPPORT_REMOTE_ORIGIN="https://github.com/golang/protobuf.git"

SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
GRPC_FOLDER_NAME=grpc
GRPC_ROOT="${SCRIPT_DIR}/${GRPC_FOLDER_NAME}"

DEPS=(git automake autoconf libtool make strip go pkg-config)

# Linux needs an existing UE installation
#UE_ROOT=${UE_ROOT:-"/var/lib/jenkins/UE_4.27.2-release"}
UE_ROOT=${UE_ROOT:-"/home/xiedeju/UE4.27/"}

if [ ! -d "$UE_ROOT" ]; then
    echo "UE_ROOT directory ${UE_ROOT} does not exist, please set correct UE_ROOT"
    exit 1
fi;

UE_PREREQUISITES="${UE_ROOT}/Engine/Extras/ThirdPartyNotUE/SDKs/HostLinux/Linux_x64/v19_clang-11.0.1-centos7/x86_64-unknown-linux-gnu"
###############################################################################

OPENSSL_LIB="${UE_ROOT}/Engine/Source/ThirdParty/OpenSSL/1.1.1k/lib/Linux/x86_64-unknown-linux-gnu"
OPENSSL_INCLUDE="${UE_ROOT}/Engine/Source/ThirdParty/OpenSSL/1.1.1k/include/Linux/x86_64-unknown-linux-gnu"

echo "SCRIPT_DIR=${SCRIPT_DIR}"
echo "GRPC_ROOT=${GRPC_ROOT}"

# Check if all tools are installed
for i in ${DEPS[@]}; do
    if [ ! "$(which ${i})" ];then
       echo "${i} not found, install via 'apt-get install ${i}'" && exit 1
    fi
done

# Check if ran under Linux
if [ $(uname) != 'Linux' ]; then
    echo "Can not work under $(uname) operating system, should be Linux! Exiting..."
    exit 1
fi;

# Clone or pull
if [ ! -d "$GRPC_ROOT" ]; then
    echo "Cloning repo into ${GRPC_ROOT}"
    git clone $REMOTE_ORIGIN $GRPC_ROOT
else
    # [[ ${VAR_CLEAR_REPO} ]] && cd $GRPC_ROOT && git merge --abort || true; git clean -fdx && git checkout -f .
    echo "Pulling repo"
    #(cd $GRPC_ROOT && git pull)
    (cd $GRPC_ROOT)
    
fi

echo "Checking out branch ${VAR_GIT_BRANCH}"
#(cd $GRPC_ROOT && git fetch)
#(cd $GRPC_ROOT && git checkout -f)

(cd $GRPC_ROOT && git checkout -t origin/$VAR_GIT_BRANCH || true)

# Update submodules
(cd $GRPC_ROOT && git submodule update --init)

if [ "$VAR_CLEAR_REPO" = "true" ]; then
    echo "Cleaning repo and submodules because VAR_CLEAR_REPO is set to ${VAR_CLEAR_REPO}"
    (cd $GRPC_ROOT && make clean)
    (cd $GRPC_ROOT && git clean -fdx)
    (cd $GRPC_ROOT && git submodule foreach git clean -fdx)
elif [ "$VAR_CLEAR_REPO" = "false" ]; then
    echo "Cleaning is not needed!"
else
    echo "Undefined behaviour, VAR_CLEAR_REPO is ${VAR_CLEAR_REPO}!"
    exit 1
fi

# Copy INCLUDE folders, should copy:
#   - grpc/include
#   - grpc/third_party/protobuf/src
HEADERS_DIR="${SCRIPT_DIR}/GrpcIncludes"
PROTOBUF_SRC_DIR="${HEADERS_DIR}/third_party/protobuf"

# (re)-create headers directory
if [ -d "$HEADERS_DIR" ]; then
    printf '%s\n' "Removing old $HEADERS_DIR"
    rm -rf "$HEADERS_DIR"
fi

mkdir $HEADERS_DIR
mkdir -p $PROTOBUF_SRC_DIR

cp -R "${GRPC_ROOT}/include" $HEADERS_DIR
cp -R "${GRPC_ROOT}/third_party/protobuf/src" $PROTOBUF_SRC_DIR

# Compute arch string using uname
UNAME_MACH=$(echo $(uname -m) | tr '[:upper:]' '[:lower:]')
UNAME_OS=$(echo $(uname) | tr '[:upper:]' '[:lower:]')
UNAME_ARCH="${UNAME_MACH}-unknown-${UNAME_OS}-gnu"

LIBCXX_UE_DIR="${UE_ROOT}/Engine/Source/ThirdParty/Linux/LibCxx/include"
LIBC_UE_DIR="${UE_ROOT}/Engine/Source/ThirdParty/Linux/LibCxx/include"

export CC="${UE_PREREQUISITES}/bin/clang"
export CC_FOR_BUILD=${CC}
export CXX="${UE_PREREQUISITES}/bin/clang++"
export CXX_FOR_BUILD=${CXX}

# we need this to avoid 'unknow flavor: old-gnu' error
if [ ! -e "${UE_PREREQUISITES}/bin/lld-gnu" ]; then
    ln -s "${UE_PREREQUISITES}/bin/ld.lld" "${UE_PREREQUISITES}/bin/lld-gnu"
fi

find "${UE_PREREQUISITES}/usr/lib64" -name '*.o' -exec cp -vfs '{}' "${UE_PREREQUISITES}/lib64" ";"

# this thing avoid us from gcc usage, we don't need it
export VALID_CONFIG_gcov=0

# force compile protobuf, libz and libares
export HAS_SYSTEM_CARES=false
export HAS_SYSTEM_PROTOBUF=false
export HAS_SYSTEM_ZLIB=false

# funny, but in grpc Makefile LD and LDXX associated with compilers
export LD="${CC}"
export LDXX="${CXX}"

export DEFAULT_CC="${CC}"
export DEFAULT_CXX="${CXX}"

export CFLAGS="-fPIC -Wno-error --sysroot=${UE_PREREQUISITES}"
export CFLAGS_FOR_BUILD=${CFLAGS}
export CXXFLAGS="-std=c++14 -fPIC -nostdinc++ -Wno-expansion-to-defined -Wno-error -I${LIBCXX_UE_DIR} -I${LIBCXX_UE_DIR}/c++/v1 -I${OPENSSL_INCLUDE}"
export CXXFLAGS_FOR_BUILD=${CXXFLAGS}

export LIBRARY_PATH="${UE_PREREQUISITES}/usr/lib64"

export LDFLAGS="-L${UE_ROOT}/Engine/Source/ThirdParty/Linux/LibCxx/lib/Linux/${UNAME_ARCH} -L${OPENSSL_LIB} -fuse-ld=${UE_PREREQUISITES}/bin/lld-gnu"
export LDFLAGS_FOR_BUILD=${LDFLAGS}

export LDLIBS="-lc++ -lc++abi -lc"

export PROTOBUF_LDFLAGS_EXTRA="${LDFLAGS} ${LDLIBS}"

# Create an alias 'clocale -> xlocale.h' (if does not exist)
if [ ! -e "${LIBCXX_UE_DIR}/c++/v1/xlocale.h" ]; then
    if [ ! -e "${LIBCXX_UE_DIR}/c++/v1/clocale" ]; then
        echo "${LIBCXX_UE_DIR}/c++/v1/clocale must exist in UE src dir. Exiting..." && exit 1
    fi

    (cd "${LIBCXX_UE_DIR}/c++/v1" && ln -s clocale xlocale.h)
    echo "Created an alias to xlocale.h"
fi

echo "CFLAGS=${CFLAGS}, CXXFLAGS=${CXXFLAGS}, LDFLAGS=${LDFLAGS}, LDLIBS=${LDLIBS}, PROTOBUF_LDFLAGS_EXTRA=${PROTOBUF_LDFLAGS_EXTRA}"

# Build GRPC
(cd $GRPC_ROOT && make CC=${CC} CXX=${CXX})

# Copy artifacts
LIBS_DIR="${SCRIPT_DIR}/GrpcLibraries"
BIN_DIR="${SCRIPT_DIR}/GrpcPrograms"

echo "LIBS_DIR is ${LIBS_DIR}"
echo "BIN_DIR is ${BIN_DIR}"

if [ $(uname) != 'Darwin' ]; then
    ARCH_LIBS_DIR="${LIBS_DIR}/"$(uname)
    ARCH_BIN_DIR="${BIN_DIR}/"$(uname)
else
    ARCH_LIBS_DIR="${LIBS_DIR}/Mac"
    ARCH_BIN_DIR="${BIN_DIR}/Mac"
fi

echo "ARCH_LIBS_DIR is ${ARCH_LIBS_DIR}"
echo "ARCH_BIN_DIR is ${ARCH_BIN_DIR}"

# Remove old libs and binaries directories
if [ -d "$ARCH_LIBS_DIR" ]; then
    printf '%s\n' "Removing old $ARCH_LIBS_DIR"
    rm -rf "$ARCH_LIBS_DIR"
fi
if [ -d "$ARCH_BIN_DIR" ]; then
    printf '%s\n' "Removing old $ARCH_BIN_DIR"
    rm -rf "$ARCH_BIN_DIR"
fi

# Create platform-specific artifacts directory
mkdir -p $ARCH_LIBS_DIR
mkdir -p $ARCH_BIN_DIR

SRC_LIBS_FOLDER_GRPC=$GRPC_ROOT/libs/opt
SRC_LIBS_FOLDER_PROTOBUF=$PROTOBUF_ROOT/src/.libs

# Force recursively copy
if [ -d "$SRC_LIBS_FOLDER_PROTOBUF" ]; then
    echo "Copying protobuf libraries from ${SRC_LIBS_FOLDER_PROTOBUF} to ${ARCH_LIBS_DIR}"
    (cd $SRC_LIBS_FOLDER_PROTOBUF && find . -name '*.a' -exec cp -vf '{}' $ARCH_LIBS_DIR ";")
fi

if [ -d "$SRC_LIBS_FOLDER_GRPC" ]; then
    echo "Copying grpc libraries from ${SRC_LIBS_FOLDER_GRPC} to ${ARCH_LIBS_DIR}"
    (cd $SRC_LIBS_FOLDER_GRPC && find . -name '*.a' -exec cp -vf '{}' $ARCH_LIBS_DIR ";")
fi

# Strip all symbols from libraries
(cd $ARCH_LIBS_DIR && strip -S *.a)

# Copy binaries (plugins & protoc)
echo "Copying executables to ${ARCH_BIN_DIR}"
(cp -a "${GRPC_ROOT}/bins/opt/." $ARCH_BIN_DIR)
(cp -a "${GRPC_ROOT}/bins/opt/protobuf/." $ARCH_BIN_DIR)

# This seems to be a hack, should modify (cp -a "${GRPC_ROOT}/bins/opt/." $BIN_DIR) to copy only files, bot dirs
(cd $ARCH_BIN_DIR && rm -rf protobuf)

#
# Build go support
GOROOT_DIR="${GRPC_ROOT}/go_packages"
GOPROTO_DIR="${GOROOT_DIR}/src/github.com/golang/protobuf"

echo "Building golang support in ${GOPROTO_DIR}"
if [ ! -d "${GOPROTO_DIR}" ]; then
    (cd $GRPC_ROOT && git clone $GOSUPPORT_REMOTE_ORIGIN $GOPROTO_DIR)
else
    (cd $GOPROTO_DIR && git pull)
fi

# Add gopath with protobuf libs
export GOPATH=$GOROOT_DIR

#
# Run go build
(cd "${GOPROTO_DIR}/protoc-gen-go" && go build)
(cp "${GOPROTO_DIR}/protoc-gen-go/protoc-gen-go" $ARCH_BIN_DIR)

# Strip binaries (programs)
(cd $ARCH_BIN_DIR && strip -S *)

# Finnaly, clean all stuff
rm "${LIBCXX_UE_DIR}/c++/v1/xlocale.h"
rm "${UE_PREREQUISITES}/bin/lld-gnu"
find "${UE_PREREQUISITES}/lib64" -name '*.o' -type f -delete

# Copy source
echo 'BUILD DONE!'

image.png

image.png

image.png

执行 ./Setup.sh ,会进行代码下载以及编译。(注意grpc源码下载以及编译问题)

等待执行完成,进行编译后,将会生成如下所示。

image.png

image.png

提供给外部使用的Linux版本的grpc的库如下所示,只有这15个库,多余的话,可能会产生重定义的情况

image.png

12.打包Linux版本的demo

需要依赖windows版本编译出来的UEditor出现的图形界面(UBT命令行也可以编译),进行编译

image.png

选择对应的文件夹,然后开始打包

image.png

image.png

四.报错处理

1.遇到如下错误,是由于代码是从windows上下载下来的

.ibtoolize: error: AC_CONFIG_MACRO_DIRS([m4]) conflicts with ACLOCAL_AMFLAGS=-I m4

可以输入如下命令:

find . -type f -print0 | xargs -0 dos2unix

参考链接1

参考链接2

2.遇到如下报错

Syntax error: "(" unexpected

可以采用

sudo dpkg-reconfigure dash

参考链接

3.有时候编译的时候,可能会将部分warning提示error,导致无法进行进行编译

可以在下面的build.cs中增加

bEnableUndefinedIdentifierWarnings = false;

image.png

如果还有提示错误,可以考虑将部分warning禁用,增加如下代码,建议将其封装成一个头文件,让plugins下面的头文件,依赖该头文件,可以禁用错误。

/*
 * Copyright 2018 Vizor Games LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the
 * License for the specific language governing permissions and limitations
 * under the License.
 */

// Disable some warnings in GRPC
#if PLATFORM_WINDOWS
	#pragma warning(push)
	#pragma warning (disable : 4125)// decimal digit terminates...
	#pragma warning (disable : 4647)// behavior change __is_pod...
	#pragma warning (disable : 4668)// 'symbol' is not defined as a preprocessor macro...
	#pragma warning (disable : 4456)// declaration of 'size' hides previous local declaration
	#pragma warning (disable : 4577)// 'noexcept' used with no exception handling mode specified
	#pragma warning (disable : 4946)// reinterpret_cast used between related classes
	#pragma warning (disable : 4005)// 'TEXT': macro redefinition
	#pragma warning (disable : 4582)// constructor is not implicitly called
	#pragma warning (disable : 4583)// destructor is not implicitly called
	#pragma warning (disable : 4800)// Implicit conversion from 'type' to bool. Possible information loss

	#ifdef WINDOWS_PLATFORM_TYPES_GUARD
		#pragma warning(push)
		#include "Windows/HideWindowsPlatformTypes.h"
	#endif
#elif PLATFORM_COMPILER_CLANG
	#pragma clang diagnostic push
	#pragma clang diagnostic ignored "-Wundef"
	#pragma clang diagnostic ignored "-Wshadow"
#endif

4.遇到符号重定义,可以查看是哪些库函数出现了重定义

image.png

切换路径到库所在的路径下面

nm -A * 2>/dev/null | grep "T BN_value_one"