Puffin Engine - Readme

Screenshots

Install graphic cards

Intel

• $ sudo apt install libxcb1-dev xorg-dev
• $ sudo apt install mesa-vulkan-drivers vulkan-utils libegl1-mesa-dev

Nvidia

• $ sudo apt-get purge nvidia*
• $ sudo add-apt-repository ppa:graphics-drivers/ppa
• $ sudo apt upgrade
• $ sudo apt install nvidia-graphics-drivers-390
• $ sudo apt-mark hold nvidia-390
• $ lsmod | grep nvidia

Install vulkan on Linux

• Add necessary libraries: $ sudo apt install libglm-dev cmake libxcb-dri3-0 libxcb-present0 libpciaccess0
  libpng-dev libxcb-keysyms1-dev libxcb-dri3-dev libx11-dev
  libmirclient-dev libwayland-dev libxrandr-dev
• You may also need: $ sudo apt install libxcursor-dev libxinerama-dev libxi-dev
• Download Vulkan file (vulkansdk-linux-x86_64-1.1.xx.y.tar.gz) from LunarG
• Unpack to home directory: $ tar -xzf /home/user/Downloads/vulkan-sdk.tar.gz
• Change your directory: $ cd /home/user/vulkan/1.1.xx.y/
• Run install script: $ ./build_samples.sh

Set environmental variables

You must add them inside working directory, because they won't be global:

• $ export VULKAN_SDK=/home/user/vulkan/1.1.xx.y/x86_64
• $ export PATH=$VULKAN_SDK/bin:$PATH
• $ export LD_LIBRARY_PATH=$VULKAN_SDK/lib:$LD_LIBRARY_PATH
• $ export VK_LAYER_PATH=$VULKAN_SDK/etc/explicit_layer.d

Check vulkan

• $ vulkaninfo | less
• $ printenv

Run example

• $ cd /home/user/vulkan/1.1.xx.y/examples
• $ mkdir build
• $ cd build
• $ cmake ..
• $ make
• $ ./cube

Multithread

If you want use multithreaded command buffer, you must turn off validation layers in "ErrorCheck.cpp" file, by "BUILD_ENABLE_VULKAN_DEBUG" value to '0'.

Building and running

Linux

• $ ./linux64release.sh
• $ ./bin/PuffinEngine

Windows

• $ win64debug.bat
• $

Running tests

• $ ./bin/PuffinEngineTest

Compiling shaders

• $ ./puffinEngine/shaders/compile.sh

Third party libraries

The following third party packages and assets are included, and carry, their own copyright notices and license terms:

• Bitmap fonts for C/C++

• Boost

• Dear ImGui

• GLFW

• GLM

• GLI

• JSON for Modern C++

• stb

• tinyobjloader

• vulcan

• Icons

• Fonts

License

The source code and the documentation are licensed under the GPLv3.