WaterDropEngine (WDE) is a 3D rendering engine mainly designed for computer graphics and physics simulations, using Vulkan. WDE is a free and open-source project, so you can directly support it by submitting improvements and by creating new pull requests or issues. We'll be happy to answer your questions and add your new code implementation ideas.
To start creating your own application, the easiest path is the following:
First, fork the project into your own GitHub account, clone the repository using git clone https://github.com/mecanicascience/WaterDropEngine.git,
and open a terminal window inside the WaterDropEngine cloned folder. Then run git submodule init and git submodule update
to install the engine required submodules.
Once all of these is done, you are ready to start using WaterDropEngine.
Just run the CMakeFile, and you'll find the application under bin/{Debug-Release}.
You will find the examples list on the app/examples folder.
Here below is an engine scene example.
If you encountered any issue, you can describe it under the issues panel. You can also request new features there.
Please be polite, correct and precisely describe what your problem or suggestion is. Please also note that WaterDropEngine is only maintained by volunteers, so please be tolerant about the possible answer delay.
If you want to help building WaterDropEngine, you can add new issues and post your suggestions here. To develop program with WaterDropEngine, you'll first need to install the Khronos Vulkan SDK made by LunarLG.
Once your are done modifying the engine, to commit your changes to GitHub, run:
> git add *
> git commit -m "YOUR COMMIT MESSAGE"
> git push
Once everything is ready, you should be able to submit your changes as a pull request (see the Github help documentation about this for more information).
WaterDropEngine uses Vulkan and the GLFW library to draw on the screen. It also uses GLM to perform fast computations, and tinyobjloader to load objects. The GUI is drawn using Dear ImGUI. The WaterDropEngine rendering structure was highly based on the Vulkan tutorial, and the Vulkan guide.
WaterDropEngine was created and is currently maintained by Mecanica Science. You can find further information and library credits down below.
- If you want to use WaterDropEngine, you need to follow the license requirements (to sum up, you can use WaterDropEngine everywhere and for any purpose, as long as there is a copyright notice).
- You can find all WaterDropEngine versions on this link.