libprotobuf for Unreal Engine 4 使用教程

libprotobuf for Unreal Engine 4 使用教程

1. 项目目录结构及介绍

libprotobuf/
├── build/
│   ├── linux/
│   ├── patch/
│   ├── ps4/
│   ├── ps5/
│   ├── win64/
│   └── ...
├── libprotobuf/
│   ├── include/
│   ├── lib/
│   └── ...
├── protobuf-source/
│   ├── cmake/
│   ├── src/
│   └── ...
├── generate_for_ue4.py
├── gitmodules
├── LICENSE
└── README.md

目录结构说明

• build/: 包含不同平台的构建脚本和配置文件。
  • linux/: Linux 平台的构建脚本。
  • patch/: 补丁文件，用于修复或更新 protobuf 源码。
  • ps4/: PlayStation 4 平台的构建脚本。
  • ps5/: PlayStation 5 平台的构建脚本。
  • win64/: Windows 64 位平台的构建脚本。
• libprotobuf/: 包含编译后的库文件和头文件。
  • include/: 头文件目录。
  • lib/: 库文件目录。
• protobuf-source/: Google Protocol Buffers 的源码目录。
  • cmake/: CMake 配置文件。
  • src/: 源码文件。
• generate_for_ue4.py: 用于生成 Unreal Engine 4 所需的 protobuf 文件的 Python 脚本。
• gitmodules: Git 子模块配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。

2. 项目启动文件介绍

generate_for_ue4.py

该脚本用于生成 Unreal Engine 4 所需的 protobuf 文件。使用方法如下：

python generate_for_ue4.py --proto_input <proto_file_or_path> --cpp_out <output_path>

• --proto_input: 指定输入的 .proto 文件或目录。
• --cpp_out: 指定输出的 C++ 文件路径。

示例：

python generate_for_ue4.py --proto_input Message.proto --cpp_out d:\Project\Source\ProtoFiles

3. 项目配置文件介绍

gitmodules

该文件用于配置 Git 子模块，通常包含子模块的 URL 和路径信息。

build/ 目录下的配置文件

• build/patch/diff-base-on-3.19.0.diff: 用于修复或更新 protobuf 源码的补丁文件。
• build/win64/CMakeLists.txt: Windows 64 位平台的 CMake 配置文件。
• build/linux/ue4-linux-cross-compile.cmake: Linux 平台的交叉编译配置文件。
• build/ps4/CMakeLists.txt: PlayStation 4 平台的 CMake 配置文件。
• build/ps5/CMakeLists.txt: PlayStation 5 平台的 CMake 配置文件。

环境变量配置

在编译过程中，需要设置一些环境变量，例如：

• PB_LIBRARY_PATH: 项目根目录路径。
• UE_THIRD_PARTY_PATH: Unreal Engine 第三方库路径。
• LINUX_MULTIARCH_ROOT: Linux 交叉编译工具链路径。
• ANDROID_HOME: Android SDK 路径。
• NDKROOT: Android NDK 路径。

这些环境变量在不同的平台和编译环境中可能有所不同，具体设置请参考项目文档或相关平台的编译指南。