Jackalope / jen (public) (License: GPLv3 or later version) (since 2018-10-24) (hash sha1)
----> ABOUT:

3D rendering and computing framework based on Vulkan API.

Libraries:
- simdcpp submodule (see my simdcpp repo)
- jmath submodule (see my jmath repo)
- mesh (constexpr generation of cubes, spheres, icosahedrons subdivisions)
- atlas (1D lines and 2D rectangles cutting)
- jlib submodule (see my jlib repo)
- jrf submodule (see my jrf repo)
- vkw (Vulkan API C++ wrapper)
Modules:
- compute (run compute shaders on gpu)
- graphics (draw models with clustered forward rendering and onscreen text)
- resource manager (load meshes, models, textures, scene data from
files and create related objects in graphics module)

----> INSTALLING:

To download all the parts of this framework it's enough to launch
git clone with recursive flag:

$ git clone —recursive ssh://rocketgit@ssh.rocketgit.com/user/Jackalope/jen

After this look at git tags:

$ git tag

It is recommended to use a tagged version instead of the latest commit,
because the first commit after the tagged one mostly includes incompatible
parts of future changes for the next version.

$ git checkout v0.1.0

----> DEPENDENCIES:

To use JEN as CMake subdirectory and successfully build programs with it
you need to make sure you have all of its dependencies:
- compiler: Clang or GCC, support for C++17. Clang 10+ or GCC 9+ is recommended,
compiling on Windows OS is tricky and requires something like MinGW with MSYS,
there are also some complications to go through to make dependencies work;
- GLFW3 library, supported version is 3.2.1;
- FreeType library, if graphics module will be used;
- Vulkan API headers, and optional validation layers to debug sneaky problems,
you also need Vulkan support in your graphics driver to run compiled programs;
- LibZip can be necessary, if JRF is used to read zip files;
- CMake, for obvious reasons;
- glslangValidator to compile shader for the graphics module.

CMake must be able to find GLFW3, Vulkan and FreeType (for graphics)
with find_package().

----> HOW TO USE IT:

To use JEN, you need to add it as a subdirectory:

add_subdirecroty(${PATH_TO_JEN})

There are several configuration options:
- JEN_MODULE_COMPUTE - turn compute module on for compiling and including;
- JEN_MODULE_GRAPHICS - turn graphics module on ...;
- JEN_MULTITHREADED_DRAW_FRAME - draw_frame function will use thread pool queue
instead of linear executing;
- JEN_MODULE_RESOURCE_MANAGER - resource manager module ON, if graphics is ON;
- JEN_VLK_VALIDATION - enable Vulkan Validation Layers to debug some errors
related to JEN. This will often produce false-positive,
as well as true-positive errors.

Look in CMakeLists.txt at JenExamples repo for details on how to use and
configure JEN automatically:

$ git clone ssh://rocketgit@ssh.rocketgit.com/user/Jackalope/JenExamples

Also I recommend to compile and run examples to make sure it works correctly.

----> SUPPORTED HARDWARE:

JEN has not been tested well, because it requires running it on large amount of
different hardware to do so. It must work with mesa driver and modern
Intel i965 GPUs as well as AMD GPUs.


----> DOCUMENTATION:

You can generate Doxygen documentation, to do so
turn on any of JEN_DOXYGEN_* options and run documentation target in cmake:

$ cmake -G %1 -DJEN_DOXYGEN_HTML=ON -DJEN_DOXYGEN_LATEX=ON
$ cmake —build —target documentation

Resource manager is not documented because it still requires large enhancements.
List of commits:
Subject Hash Author Date (UTC)
CMake compilation flags improvements. d601a47cde61ed2f1408d29eefac96eea59f8cd2 Jackalope 2020-06-05 07:52:15
Update jrf-0.3.0 abeec591e143c53f960ab1703c7b4001c72b4061 Jackalope 2020-06-04 21:12:56
Increment version to 0.2.1 6d9b0c9f788e93a2c4a13e4f1792112dca699ca3 Jackalope 2020-06-04 21:30:35
Version 0.2.0 d6d2564a42613aa4eb64ab623226717cdf0fd5c2 Jackalope 2020-06-01 13:17:28
JEN_NATIVE option. Better build type flags selection. b77b104ecd4aa47553941cf6bcf9531176bbdc5c Jackalope 2020-06-01 13:17:19
Compilation fixes. 49eec7c7159bbc58dd899cef498beeec2b965e32 Jackalope 2020-06-01 12:42:03
Remove debug overlay from framework settings, instead load on request. 33c0b44a748570c1c8dcce58794fdac21d517156 Jackalope 2020-06-01 12:24:31
Shaders shading bug fix. Shader shared code moved for including with extention. 7de6429997bda227a175db8fba81e8f960b1a340 Jackalope 2020-06-01 12:23:05
Window laggy input fixes. 1d136d616277dde9262a3093c802f3d24ca8aa5d Jackalope 2020-06-01 12:21:00
New shading type SHADOW_MAPPING is added to remove experimental shadow mapping from DEFAULT. d4651206b1798ddec7e3275352f48445b8a184d2 Jackalope 2020-06-01 04:01:29
Debug pipelines crash fix. 9b0a75d94e30eb7fd45360f7fe10429bf05c243e Jackalope 2020-06-01 04:00:24
Window improvements. scroll_diff and cursor_diff members. Update noclip screen. 8d659590a0fb52e1e24683305a7ee8699bdff6da Jackalope 2020-06-01 01:30:50
Update jlib 0.4.1 Update jrf 0.2.2 d36e5263523a9b0443476b2db8d856e86086af81 Jackalope 2020-05-31 23:58:41
Update jmath 0.1.2. 8d3566336ef87f73318e84cde87bdf841240dcdc Jackalope 2020-05-31 23:57:25
Use scanf instead of fgets for interactive device selection. fd7ff8b61ef1e21852d6c0a15ab0d17d09c5cccc Jackalope 2020-05-31 23:56:34
Include FreeType as system library to prevent warnings. dc92c7f8acdaa90b25cf272f1730d338111780fc Jackalope 2020-05-31 23:54:37
Add glfw required version. 3.3.1 is not working. ee727d7efda88af1e8a227b542f5b79d0ba6f301 Jackalope 2020-05-31 23:53:33
GCC Compatibility. c828a38456627d0383d431165b802f97fd303349 Jackalope 2020-05-29 16:48:24
Solved clang compiler warnings from compute module. b9416237761f8648bbddb7e7ba59e833a7879528 Jackalope 2020-05-28 11:09:55
CMake: two shaders targets, instead of single target per shader. a708650319e44c7b98056f3bc85a896dd65d96f3 Jackalope 2020-05-28 11:06:13
Hints:
Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://rocketgit.com/user/Jackalope/jen

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@ssh.rocketgit.com/user/Jackalope/jen

Clone this repository using git:
git clone git://git.rocketgit.com/user/Jackalope/jen

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a merge request:
... clone the repository ...
... make some changes and some commits ...
git push origin main