BoomingTech / Piccolo构建详细教程

430 阅读2分钟

Piccolo引擎是一个用于GAMES104课程的小型游戏引擎。

持续构建状态

构建类型状态
构建WindowsBuild Windows
构建LinuxBuild Linux
构建MacOSBuild macOS

先决条件

要构建Piccolo,你必须首先安装以下工具。

Windows 10/11

  • Visual Studio 2019(或更新的)。
  • CMake 3.19 (或更高版本)
  • Git 2.1 (或更高版本)

macOS >= 10.15 (x86_64)

  • Xcode 12.3 (或更近的版本)
  • CMake 3.19 (或更高版本)
  • Git 2.1 (或更高版本)

Ubuntu 20.04

  • apt安装以下软件包
sudo apt install libxrandr-dev
sudo apt install libxrender-dev
sudo apt install libxinerama-dev
sudo apt install libxcursor-dev
sudo apt install libxi-dev
sudo apt install libglvnd-dev
sudo apt install libvulkan-dev
sudo apt install cmake
sudo apt install clang
sudo apt install libc++-dev
sudo apt install libglew-dev
sudo apt install libglfw3-dev
sudo apt install vulkan-validationlayers
sudo apt install mesa-vulkan-drivers
  • NVIDIA驱动(AMD和Intel的驱动是开源的,因此会被mesa-vulkan-drivers自动安装)

构建Piccolo

在Windows上构建

你可以执行build_windows.bat。这个批处理文件将生成项目,并自动构建Piccolo引擎发布配置。构建成功后,你可以在bin目录中找到PiccoloEditor.exe。

或者你可以使用下面的命令先生成Visual Studio项目,然后在构建目录下打开解决方案,手动构建。

cmake -S . -B build

在macOS上构建

下面的构建说明只在x86_64的特定硬件上测试,不支持M1芯片。对于M1兼容,我们将在以后发布。

要编译Piccolo,你必须安装最新的Xcode版本。然后在项目的根目录下运行 "cmake",生成一个Xcode的项目。

cmake -S . -B build -G "Xcode"

并且你可以通过以下方式构建该项目

cmake --build build --config Release

或者你可以执行build_macos.sh来构建二进制文件。

在Ubuntu 20.04上构建

你可以执行build_linux.sh来构建二进制文件。

文档

关于文档,请参考Wiki部分。

其他

生成编译数据库

Unix Makefiles 生成器可用时,你可以用以下命令构建compile_commands.jsoncompile_commands.jsonclangd 语言服务器所需要的文件,它是Emacs中cpp lsp-mode的后端。

用于Windows。

cmake -DCMAKE_TRY_COMPILE_TARGET_TYPE="STATIC_LIBRARY" -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -S . -B compile_db_temp -G "Unix Makefiles"
copy compile_db_temp\compile_commands.json .

使用Physics Debug Renderer

目前Physics Debug Renderer只在Windows上可用。你可以使用下面的命令来生成带有调试器项目的解决方案。

cmake -S . -B build -DENABLE_PHYSICS_DEBUG_RENDERER=ON

注意。

  1. 在重新生成解决方案之前,请清理构建目录。我们在直接用以前的CMakeCache重新生成时遇到了构建问题。
  2. 物理调试渲染器将在你启动PiccoloEditor时运行。我们已经在两个场景之间同步了摄像机的位置。但是物理调试渲染器中的初始摄像机模式是错误的。向下滚动鼠标滚轮一次,就会把物理调试渲染器的摄像机改为正确的模式。