https://github.com/garrywhitehead/yave
Vulkan Cross-platform 3D engine
https://github.com/garrywhitehead/yave
3d-engine 3d-graphics conan cpp graphics vulkan
Last synced: 5 months ago
JSON representation
Vulkan Cross-platform 3D engine
- Host: GitHub
- URL: https://github.com/garrywhitehead/yave
- Owner: GarryWhitehead
- License: mit
- Created: 2023-04-14T08:29:26.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-07T09:13:45.000Z (about 2 years ago)
- Last Synced: 2025-04-06T03:45:24.334Z (about 1 year ago)
- Topics: 3d-engine, 3d-graphics, conan, cpp, graphics, vulkan
- Language: C++
- Homepage:
- Size: 537 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# YAVE (**Y**et **A**nother **V**ulkan **E**ngine) #
Yes, another Vulkan enigne.
What's the purpose of YAVE?
Mainly trying to create a user-friendly API which allows experimenting with Vulkan and 3D graphic techniques in an environment free of the frustrations on using the Vulkan API directly.
Is YAVE cross-platform compatiable?
Yes, YAVE works across multi-platforms - currently tested on Linux, MacOS, Windows and NVidia Jetson.
**Note:** This is very much a work in progress. There are bugs and imperfections, these will be ironed out over time with the addition of more functionality (see the list of work to do below). However, the API is in working order and I'm hoping that breaking changes can be avoided.
## Building ##
YAVE utilises the package manager [Conan](https://docs.conan.io/2/) to try and make the configuration and build process as pain-free as possible.
To begin with, you will need to download Conan using pip if not already present on your system:
```
$ pip install conan --user
```
**Note:** Python3.x is required to use Conan. If pip isn't installed on your system, information on installing can be found [here](https://pip.pypa.io/en/stable/installation/)
**Note:** A minimum version of Conan 1.53.0 is required due to recipe requirements in the Conan Center.
To setup your system for use with the YAVE library run:
```
$ ./install.sh
```
We can now build the third-party libraries required by YAVE using Conan:
```
$ mkdir build && cd build
$ conan install .. -pr:b=default -pr:h=default --build=missing -s build_type=Release
```
Now run cmake to create the configuration files:
```
$ cmake .. -DCMAKE_TOOLCHAIN_FILE="Conan/conan_toolchain.cmake" -G "Unix Makefiles"
```
**Note:** You can replace `Unix Makefiles` with whichever generator you wish to use.
Then assuming you generated makefiles, you can build all libraries/exectuables using:
```
$ cmake --build . --config Release
```
Xcode and Visual Studio users can open up the .xcodeconfig and .sln files using the respective IDE.
## Features to add / Issues to address ##
In some order of priority... maybe.
- [ ] IBL
- [ ] Optimisations (including use of Structure of Arrays)
- [ ] Add multi-threading (asset loading, pipeline generation, cmd buffers, etc.)
- [ ] Shadow mapping (and cascades)
- [ ] Skinning / Animation
- [ ] Post-processing effects
- [ ] Assimp model loading
- [ ] Terrian generation
- [ ] Wave simulation
## Third-party Libraries ##
Many thanks to the authors of the following third-party libraries which are used by YAVE:
- AMD VulkanMemoryAllocator
- GLFW
- stb
- Intel TBB
- cgltf
- jsmn
- spdlog
- Imgui
- libktx
## Assets ##
At present, the assets are cloned from the Khronos asset repository which can be found [here](https://github.com/KhronosGroup/Vulkan-Samples-Assets). This includes all licenses and are only used for testing the engine. In the future, I will add just a select few assets though would prefer to host them somewhere ouside of this repo to keep git clone times reasonable.