Vulk: Advanced 3D engine
What is it ?
Vulk is a 3D engine aimed to provide the best graphical experience with Vulkan API. It is written fully in Python. It depends on C modules for the communication with Vulkan.
What is the project goal ?
Easy to use: you don’t need to understand Vulkan to use VULK.
Modular: every single part of the api must be modular.
Full: you shouldn’t need to customize core code, it should suits everyone needs.
The API documentation is generated after each commit by Travis CI servers into the dedicated repo vulk-api. You can check it here: API documentation
To build the API (in vulk-api folder), execute the following commands:
pip install -r requirements.txt python setup.py api
To make a beautiful API documentation, we must respect conventions. The documentation must be in markdown and respect the following syntax:
''' Description of the function *Parameters:* - `parameter 1`: Parameters is a list and must be quoted with ` ` - `parameter 2`: The description should be precise and can be on several lines (keep the indentation) *Returns:* Here we describe the return value *Exemple:* [3 backticks] Here you can put your code [3 backticks] **Note: You can add informations at the end of the docstring, The name must be inside the following values: [Note|Seealso|Warning|Todo] '''
Stay in touch
You can contact me by opening issue (bug or interesting discussion about the project). If you want a fast and pleasant talk, join the irc channel: #vulk. I’m connected from 9AM to 6PM (France).
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.