SQEE Readme

About SQEE

SQEE is library containing all sorts of useful stuff for 3D applications, particularly games. Some features include:

A Vulkan Window class that manages the swapchain and synchronisation
An easy to use Vulkan memory allocator
Vector, Matrix, Quaternion, and more maths utilities
Vulkan Mesh, Texture, Pipeline, DrawItem, Armature, and more
Resource Cache and Handle templates for managing assets
Small utilities such as stack only string and vector types
ImGui integration and some custom wrappers and widgets
Much much more

SQEE intergrates a few third party libraries. In no particular order, they are:

Building SQEE

To build SQEE, you will need GLFW >= 3.3. Everything else is included in the repo. On linux, you can grab GFLW from your distro's repos, if available and up to date. Otherwise, you can build it manually from the link above.

A C++ 17 capable compiler is required. Building SQEE is fairly simple, have a look at linux.yml and windows.yml for how.

SQEE CMake options:

SQEE_STATIC_LIB - Build SQEE and its dependencies as a static library. Otherwise, build as shared. Defaults to False.

Licence Information

SQEE Licences

The SQEE Project is Copyright (c) 2022 James Gangur (jagoly). All code created by me in the repository is released under the GNU GPL Version 3, which can be read here. Any assets created by me in this repository are released under the Creative Commons CC-BY-SA licence, which can be read here.

Bundled Source Licences

For licence information for the bundled libraries, see the links above.

jagoly/sqee