Dependencies

Windows

• Visual Studio
• MSVC
• A GPU that supports Vulkan 1.3
• CMake
• Git (including the git bash)
• Git LFS

Linux

• make
• gcc compiler/libc that supports C++ 17
• CMake
• Vulkan-Loader and GPU drivers
• A GPU that supports Vulkan 1.2

Ubuntu and other binary distros

On Ubuntu and maybe countless other binary distros, you are going to need some additional packages. For Ubuntu listed below

sudo apt-get install x11-xserver-utils libgl1-mesa-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev gcc make g++ libxmu-dev libxi-dev libgl-dev libglu1-mesa-dev libvulkan1 mesa-vulkan-drivers vulkan-utils libvulkan-dev libasound2-dev libflac-dev libogg-dev libtool libvorbis-dev libopus-dev libsndfile1-dev libglew-dev libssl-dev

Install

1. Clone the engine using git: git clone https://madladsquad.com/docs/UntitledVulkanGameEngine.git --recursive
2. Enter the new folder
3. Run the install.sh script. This will install the necessary files for the game engine, but will not compile it. If the script failed, check out how to clean up your environment in the troubleshooting section below. Run instructions below:
   • On Windows, git bundles Git Bash which emulates the bash shell found on Linux, so you can run it with ./install.sh or run bash install.sh into CMD
   • On Linux, just run it with the terminal by using ./install.sh
4. Answer the prompts
5. Wait
6. If there is an error, read through the error log and go to Troubleshooting

After the installation script is finished, you can now create your project. To create a project, use the same script running instructions below and do the following

1. Run ./create-project.sh
2. Enter your application’s name
3. Wait
4. If there was an error, read the error log and go to Troubleshooting

Troubleshooting

Cleaning up your environment when the installation fails

Builds sometimes fail and while it’s important to report build problems to us here, it’s also important to know how to rebuild once the problem is resolved. The issue is, without proper cleanup, you can’t rerun the ./install.sh script. Below are some things you can do:

1. Delete the build folders under the UVKBuildTool and UVKShaderCompiler folders
2. Delete the Projects folder
3. Redownload the UVKShaderCompiler’s dependencies
   1. Go to UVKShaderCompiler/ThirdParty/shaderc/third_party/
   2. Delete all folders
   3. Go to ../utils
   4. Run python3 git-sync-deps, py git-sync-deps, python git-sync-deps or just ./git-sync-deps to redownload them
4. Go back to the engine directory
5. Rerun install.sh

Visual Studio: Command Line error /02 and /RTC1 options are incompatible

This is a very common generation error, to fix it right-click on the UntitledVulkanGameEngine project in the Solution Explorer and click the Properties button.

Next, navigate to the C/C++ section, expand the list and click on the Code Generation. Inside the list view, you should see a setting called Basic Runtime Checks, which you need to set to Default

Other errors

Don’t see your error here? Please create an issue to the GitHub issue tracker and send us your build log with your system instructions. This way, we can resolve your problem and if needed document it here if needed. Thanks for using the UntitledVulkanGameEngine :grinning:

This site is open source. Improve this page.