Piccolo

Piccolo Engine (ранее Pilot Engine)

Предварительные условия

Чтобы собрать 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 (или более поздняя версия)

Убунту 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)

Построить Пикколо

Создавать на базе Windows

Вы можете выполнить build_windows.bat . Этот пакетный файл будет генерировать проекты и автоматически создавать конфигурацию выпуска Piccolo Engine . После успешной сборки вы можете найти PiccoloEditor.exe в каталоге bin .

Или вы можете использовать следующую команду, чтобы сначала сгенерировать проект 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.

Дополнительный

Уровень проверки Vulkan: ошибка проверки

Мы заметили, что некоторые разработчики в Windows обнаружили, что PiccoloEditor.exe может работать нормально, но при отладке сообщали об исключении Vulkan Validation Layer: Validation Error. Вы можете решить эту проблему, установив Vulkan SDK (подойдет новейшая официальная версия).

Создать базу данных компиляции

Вы можете собрать compile_commands.json с помощью следующих команд, если доступны генераторы Unix Makefiles . compile_commands.json — это файл, необходимый языковому серверу clangd , который является бэкэндом для режима cpp lsp в Emacs.

Для Windows:

 cmake -DCMAKE_TRY_COMPILE_TARGET_TYPE="STATIC_LIBRARY" -DCMAKE_EXPORT_COMPILE_COMMANDS=ON -S . -B compile_db_temp -G «Unix Makefiles» скопировать compile_db_tempcompile_commands.json .

Использование средства визуализации отладки физики

В настоящее время Physics Debug Renderer доступен только в Windows. Вы можете использовать следующую команду для создания решения с помощью проекта отладчика.

 cmake -S . -B сборка -DENABLE_PHYSICS_DEBUG_RENDERER=ON

Примечание:

1. Пожалуйста, очистите каталог сборки перед повторной генерацией решения. Мы столкнулись с проблемами сборки при непосредственной регенерации с помощью предыдущего CMakeCache.

2. Physics Debug Renderer запустится при запуске PiccoloEditor. Мы синхронизировали положение камеры между обеими сценами. Но начальный режим камеры в Physics Debug Renderer неправильный. Один раз прокрутив колесо мыши вниз, камера Physics Debug Renderer перейдет в правильный режим.

Сборка Linux
Сборка macOS