Implement Vulkan renderer

.gitignore

@@ -36,6 +36,8 @@ local.properties
 ## Ignore Visual Studio temporary files, build results, and
 ## files generated by popular Visual Studio add-ons.
 
+.vs
+
 # User-specific files
 *.suo
 *.user
@@ -61,11 +63,9 @@ local.properties
 *.tlb
 *.tli
 *.tlh
-*.tmp
 *.vspscc
 .builds
 *.dotCover
-.vs
 
 winquake.res
 
@@ -121,6 +121,8 @@ _UpgradeReport_Files/
 Backup*/
 UpgradeLog*.XML
 
+# Visual Studio Code
+.vscode
 
 
 ############
@@ -175,4 +177,21 @@ pip-log.txt
 ## Unix
 #############
 *.o
+*.so
+
+#############
+## clangd
+#############
+.clangd
+compile_commands.json
+
+#############
+## CLion
+#############
+.idea
 
+#############
+## CMake Builds
+#############
+[Bb]uild*/
+cmake-build-*

CMakeLists.txt

@@ -16,7 +16,7 @@
 # along with this program; if not, see <http://www.gnu.org/licenses/>.
 #============================================================================
 
-cmake_minimum_required(VERSION 3.1)
+cmake_minimum_required(VERSION 3.10)
 set(CMAKE_OSX_DEPLOYMENT_TARGET "10.9" CACHE STRING "Minimum OS X deployment version")
 
 # For checks in subdirectories
@@ -37,6 +37,7 @@ option(BuildPortableVersion "Build portable version (does not read or write file
 
 option(BuildMPEngine "Whether to create projects for the MP client (eternaljk.x86.exe)" ON)
 option(BuildMPRdVanilla "Whether to create projects for the MP default renderer (rd-eternaljk_x86.dll)" ON)
+option(BuildMPRdVulkan "Whether to create projects for the MP vulkan renderer (rd-vulkan_x86.dll)" ON)
 option(BuildMPDed "Whether to create projects for the MP dedicated server (eternaljkded.exe)" ON)
 option(BuildMPGame "Whether to create projects for the MP server-side gamecode (jampgamex86.dll)" ON)
 option(BuildMPCGame "Whether to create projects for the MP clientside gamecode (cgamex86.dll)" ON)
@@ -61,18 +62,18 @@ set(UseInternalPNGDefault    OFF)
 set(UseInternalJPEGDefault   OFF)
 set(UseInternalSDL2Default   OFF)
 
-if(WIN32)
-  set(UseInternalOpenALDefault ON)
-  set(UseInternalZlibDefault   ON)
-  set(UseInternalPNGDefault    ON)
-  set(UseInternalJPEGDefault   ON)
-  set(UseInternalSDL2Default   ON)
-endif()
-
-if(APPLE)
-  set(UseInternalJPEGDefault   ON)
-  set(UseInternalOpenALDefault ON)
-  set(UseInternalPNGDefault    ON)
+if(UseInternalLibs OR WIN32 OR APPLE)
+  if(WIN32)
+    set(UseInternalOpenALDefault ON)
+    set(UseInternalZlibDefault   ON)
+    set(UseInternalPNGDefault    ON)
+    set(UseInternalJPEGDefault   ON)
+    set(UseInternalSDL2Default   ON)
+  else()
+    set(UseInternalJPEGDefault ON)
+    set(UseInternalPNGDefault  ON)
+    set(UseInternalZlibDefault ON)
+  endif()
 endif()
 
 if(CMAKE_SYSTEM_NAME MATCHES "BSD")
@@ -91,7 +92,7 @@ if(APPLE)
 endif()
 
 # Custom CMake Modules needed
-list(INSERT CMAKE_MODULE_PATH 0 "${CMAKE_SOURCE_DIR}/CMakeModules")
+list(INSERT CMAKE_MODULE_PATH 0 "${CMAKE_SOURCE_DIR}/cmake/Modules")
 
 Include(CheckTypeSize)
 check_type_size("void*" CMAKE_SIZEOF_VOID_P)
@@ -111,7 +112,10 @@ if(WIN32)
 	endif()
 else()
 	set(X86 OFF)
-	if(CMAKE_SYSTEM_PROCESSOR MATCHES "^arm")
+	if(CMAKE_SYSTEM_PROCESSOR MATCHES "^(arm64|aarch64)$")
+		set(Architecture "arm64")
+		add_definitions(-DPNG_ARM_NEON_OPT=0)
+	elseif(CMAKE_SYSTEM_PROCESSOR MATCHES "^arm")
 		set(Architecture "arm")
 	elseif(CMAKE_SYSTEM_PROCESSOR MATCHES "^i.86$")
 		set(X86 ON)
@@ -149,6 +153,7 @@ message(STATUS "Git revision is ${GIT_SHA1}")
 # Binary names
 set(MPEngine "eternaljk.${Architecture}")
 set(MPVanillaRenderer "rd-eternaljk_${Architecture}")
+set(MPVulkanRenderer "rd-vulkan_${Architecture}")
 set(MPDed "eternaljkded.${Architecture}")
 set(MPGame "jampgame${Architecture}")
 set(MPCGame "cgame${Architecture}")
@@ -193,9 +198,17 @@ if(MSVC)
 	set(SharedDefines ${SharedDefines} "_SCL_SECURE_NO_WARNINGS")
 	set(SharedDefines ${SharedDefines} "_CRT_NONSTDC_NO_DEPRECATE")
 
-	set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /EHsc /arch:SSE2")
+	# Warnings
+	# 4244 = conversion' conversion from 'type1' to 'type2', possible loss of data
+	# 4996 = 'function': was declared deprecated
+	# 4267 = 'var' : conversion from 'size_t' to 'type', possible loss of data
+	set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /wd4244 /wd4996 /wd4267")
+	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /wd4244 /wd4996 /wd4267")
 
-	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /arch:SSE2")
+	if (Architecture STREQUAL "x86")
+		set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /arch:SSE2")
+		set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /arch:SSE2")
+	endif()
 
 	# Configure MSVC Runtime
 	include(MSVCRuntime)
@@ -244,6 +257,7 @@ elseif (("${CMAKE_C_COMPILER_ID}" STREQUAL "GNU") OR ("${CMAKE_C_COMPILER_ID}" M
 		set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall")
 		set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wno-comment")
 		set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fsigned-char")
+		set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fcommon")
 		if (X86)
 			# "x86 vm will crash without -mstackrealign since MMX
 			# instructions will be used no matter what and they
@@ -338,7 +352,7 @@ set(SharedCommonSafeFiles
 
 
 if(UseInternalJPEG)
-  add_subdirectory(lib/jpeg-9a)
+  add_subdirectory(lib/jpeg-9c)
 else()
   find_package(JPEG REQUIRED)
 endif()

Dockerfile

@@ -13,7 +13,7 @@ COPY . /usr/src/openjk
 # Build i386 arch
 RUN mkdir /usr/src/openjk/build.i386 &&\
 	cd /usr/src/openjk/build.i386 &&\
-	cmake -DCMAKE_TOOLCHAIN_FILE=CMakeModules/Toolchains/linux-i686.cmake \
+	cmake -DCMAKE_TOOLCHAIN_FILE=cmake/Toolchains/linux-i686.cmake \
 		-DCMAKE_INSTALL_PREFIX=/opt \
 		-DBuildMPCGame=OFF -DBuildMPEngine=OFF -DBuildMPRdVanilla=OFF -DBuildMPUI=OFF \
 		-DBuildSPEngine=OFF -DBuildSPGame=OFF -DBuildSPRdVanilla=OFF \

README.md

@@ -1,30 +1,134 @@
-# EternalJK
+# EternalJK - Vulkan API
+[![build](https://github.com/JKSunny/EternalJK/actions/workflows/build.yml/badge.svg)](https://github.com/JKSunny/EternalJK/actions/workflows/build.yml)
 
-This fork focuses on the jaPRO integration and Client Engine modifications.
 
-If you have any suggestions or would like to submit a bug report, please post them in [issues](https://github.com/eternalcodes/EternalJK/issues).
 
-[![Website](https://img.shields.io/badge/website-japro-brightgreen.svg)](http://playja.pro) [![Fork](https://img.shields.io/badge/repository-japro%20game%20library-blue.svg)](https://github.com/videoP/jaPRO)
+This fork is <u>centered</u> around improving the rendering backend, specifically focusing on adding the [Vulkan API](https://www.vulkan.org).\
+Other forks or mods can incorporate the latest updates from this repository.
+
+> **NOTE:** Game logic remains untouched, required changes are to include SDL2 vulkan headers and refapi. \
+>  also relocating some structures from common tr_types.h to renderer module tr_local.h <u>[*90d4de9*](https://github.com/JKSunny/EternalJK/commit/90d4de970491dccf13077aad40fcc89846e6be05)</u>, <u>[*a9b7248*](https://github.com/JKSunny/EternalJK/commit/a9b72482162f64042ed3213df65f594b2aad2781)</u>
+
+> Its increasingly difficult to maintain a clear [<kbd> list of modified files</kbd>](https://github.com/eternalcodes/EternalJK/pull/116/files), because there have been no upstream commits since 2021. \
+**engine related:* <u>[*eb18020*](https://github.com/JKSunny/EternalJK/commit/eb18020e44aba4726295c480ba2db3c6bd775fdd)</u>, <u>[*3ae2bbd*](https://github.com/JKSunny/EternalJK/commit/3ae2bbda774703b74d361272d13f8a056ee55149)</u>, <u>[*4eee7ab*](https://github.com/JKSunny/EternalJK/commit/4eee7ab042f7ec362c1f2623b8fbef0c85189382)</u> <u>[*786f077*](https://github.com/JKSunny/EternalJK/commit/786f077c67e0720bc14f4f18e8e9ebf16f018ebc)</u> 
+
+Support Initially started by porting to [Quake-III-Arena-Kenny-Edition](https://github.com/kennyalive/Quake-III-Arena-Kenny-Edition).<br />
+After that, I found [vkQuake3](https://github.com/suijingfeng/vkQuake3/tree/master/code), hence the file structure.
+
+Lastly, I stumbled across [Quake3e](https://github.com/ec-/Quake3e).<br />
+Which is highly maintained, and is packed with many additions compared to the other repositories.
+
+Therefore the vulkan renderer is now based on Quake3e. <br />A list of the additions can be found on [here](https://github.com/ec-/Quake3e#user-content-vulkan-renderer).
 
 ## License
 
 [![License](https://img.shields.io/github/license/eternalcodes/EternalJK.svg)](https://github.com/eternalcodes/EternalJK/blob/master/LICENSE.txt)
 
 OpenJK is licensed under GPLv2 as free software. You are free to use, modify and redistribute OpenJK following the terms in LICENSE.txt.
 
+## Fork branching explained
+
+### :name_badge: **Master**
+Native implemention of the Vulkan renderer module. 
+> **NOTE:** upstream repository ***EternalJK** is discontinued and is replaced with **[TaystJK](https://github.com/taysta/TaystJK)** - includes Vulkan*
+
+
+[![master-todo](https://img.shields.io/badge/todo-list-grey.svg)](https://github.com/users/JKSunny/projects/1/views/1?filterQuery=branch%3Aall)
+[![master-release](https://img.shields.io/badge/Download-This_Release-brightgreen.svg)](https://github.com/JKSunny/EternalJK/releases/tag/latest/)
+[![taystjk-release](https://img.shields.io/badge/Download-TaystJK_Release-cyan.svg)](https://github.com/taysta/TaystJK/releases/)
+
+---
+
+### :name_badge: **Beta**
+> Based on master
+
+[![master-todo](https://img.shields.io/badge/todo-list-grey.svg)](https://github.com/users/JKSunny/projects/1/views/1?filterQuery=branch%3Abeta)
+[![beta-release](https://img.shields.io/badge/Download-Beta-ef7b3c.svg)](https://github.com/JKSunny/EternalJK/releases/tag/latest-beta/)
+
+---
+
+### :name_badge: **ImGui** (archived)
+Basic implementation of [ImGui](https://github.com/ocornut/imgui) in the vulkan renderer module, [cImGui](https://github.com/cimgui/cimgui) in client, game and ui modules
+> **NOTE** Release unavailable! [build binaries](https://github.com/JACoders/OpenJK/wiki/Compilation-guide) yourself from source - ***This branch is archived and unmaintained***
+
+---
+
+### :name_badge: **PBR**
+Implementation of [PBR](https://google.github.io/filament/Filament.html#materialsystem/parameterization/standardparameters) *(Physical Based Rendering)* material system based on [Rend2](https://github.com/SomaZ/OpenJK) renderer from OpenJK \
+This adds the ability to apply *normal, roughness, metallic or specular mapping*.
+by introducing the [<kbd>.mtr</kbd>](https://jkhub.org/tutorials/rend2/new-shader-keywords-r98/) file extension which is an override for [<kbd>.shader</kbd>](https://jkhub.org/tutorials/skinning/basics-of-skinning-03-shaders-r192/)
+
+> **NOTE** Incompatible with master or beta branch! cvar r_fbo and r_vbo are enabled hard-coded.
+
+> **NOTE** Release unavailable! [build binaries](https://github.com/JACoders/OpenJK/wiki/Compilation-guide) yourself from source
+
+[![master-todo](https://img.shields.io/badge/todo-list-grey.svg)](https://github.com/users/JKSunny/projects/1/views/1?filterQuery=branch%3APBR)
+[![rend2-what-is](https://img.shields.io/badge/What_is-Rend2-yellow.svg)](https://jkhub.org/forums/topic/7468-rend2-a-modern-renderer/)
+[![rend2-showcase](https://img.shields.io/badge/See-Bespin_Reborn-yellow.svg)](https://jkhub.org/files/file/4164-bespin-duel-reborn/)
+[![rend2-pbr-retexture](https://img.shields.io/badge/See-PBR_Retexture-yellow.svg)](https://jkhub.org/files/file/4240-jedi-academy-pbr-retexture)
+
+---
+
+### :name_badge: **PBR Inspector**
+Combines **PBR** and **ImGui** branch. \
+Began as a local codebase to inspect/debug the PBR material system implementation. \
+A basic GUI is added, renders the game in a viewport and allows displaying various PBR layers \
+Other features: View collapsed shader, text/node based shader editor, profiler and a few more bits an bobs.
+
+*Started entity inspector, but this has been commented out.*
+
+> **NOTE** Release unavailable! [build binaries](https://github.com/JACoders/OpenJK/wiki/Compilation-guide) yourself from source - *Initially for personal use only, but here we are*
+
+[![master-todo](https://img.shields.io/badge/todo-list-grey.svg)](https://github.com/users/JKSunny/projects/1/views/1?filterQuery=branch%3A%22PBR+Inspector%22)
+[![pbr-inspector-devlogs](https://img.shields.io/badge/See-Devlog_videos-yellow.svg)](https://www.youtube.com/playlist?list=PLK0BIdk-GT_erDdqgLrzhGbpeIXZVRHL0)
+
+---
+
+### :name_badge: **PBR RTX Inspector**
+Based on **PBR Inspector** branch.
+
+> **NOTE** This is Work-in-progress, and is unstable. \
+> E.g. switching map requires a full restart because buffer clearing is not implemented yet.
+
+This is an effort to port RayTracing from [Q2RTX](https://github.com/NVIDIA/Q2RTX) by NVIDIA, which builds upon [Q2VKPT](https://brechpunkt.de/q2vkpt/).
+
+> **NOTE** Release unavailable! [build binaries](https://github.com/JACoders/OpenJK/wiki/Compilation-guide) yourself from source
+
+[![pbr-rtx-inspector-devlogs](https://img.shields.io/badge/See-Devlog_videos-yellow.svg)](https://www.youtube.com/embed/?listType=playlist&list=PLK0BIdk-GT_dPJyqZGN72nJ3PWv79XUw-)
+
+---
+
+### :fire: **Prototyping**
+
+Overview of prototyped features like bindless rendering, depth-z-prepass is in the **_Prototype_** tab section [here](https://jksunny.github.io/#tab-prototype) 
+
+---
+
+## :link: Forks supporting Vulkan
+
+In addition to this fork, I also have implemented the Vulkan renderer to my other forks 
+
+[![jedi-academy-openjk](https://img.shields.io/badge/Jedi_Academy-OpenJK-brightgreen.svg)](https://github.com/JKSunny/OpenJK/) - *based on master branch* \
+[![jedi-outcast-jk2mv](https://img.shields.io/badge/Jedi_Outcast_&#x2800;-JK2MV-brightgreen.svg)](https://github.com/JKSunny/jk2mv/) - *based on master branch - (Implemented modular renderer)* \
+[![jedi-knight-galaxies](https://img.shields.io/badge/Jedi_Academy-JKGalaxies-brightgreen.svg)](https://github.com/JKSunny/JediKnightGalaxies) - *based on master branch*
+
 
 ## For players
 
 Installing and running EternalJK:
 
-1. [Download the latest release](https://github.com/eternalcodes/EternalJK/releases).
+1. [Download the latest release](https://github.com/JKSunny/EternalJK/releases).
 2. Extract the file into the Jedi Academy `GameData` folder. For Steam users, this will be in `<Steam Folder>/steamapps/common/Jedi Academy/GameData/`.
 3. Run eternaljk.x86.exe (Rename to jamp.exe for better steam support)
 
+#### How to enable vulkan 
+1. Open up the console by pressing <kbd>~ Tilde</kbd> key
+2. Type "/cl_renderer rd-vulkan; vid_restart" and hit enter
+
 ## For Developers
 
 ### Contributing to EternalJK
-* [Fork](https://github.com/eternalcodes/EternalJK/fork) the EternalJK project on GitHub
+* [Fork](https://github.com/JKSunny/EternalJK/fork) the EternalJK project on GitHub
 * Create a new branch on your fork and make your changes
 * Send a [pull request](https://help.github.com/articles/creating-a-pull-request) to upstream (eternaljk/master)
 

build/build-unix-debug.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+type cmake >/dev/null 2>&1 || { echo >&2 "Can't find cmake."; exit 1; }
+
+BUILD_DIR="`uname`-`uname -m`-debug"
+mkdir "$BUILD_DIR"
+cd "$BUILD_DIR"
+cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Debug ../..
+make

build/build-unix.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+type cmake >/dev/null 2>&1 || { echo >&2 "Can't find cmake."; exit 1; }
+
+BUILD_DIR="`uname`-`uname -m`"
+mkdir "$BUILD_DIR"
+cd "$BUILD_DIR"
+cmake -G "Unix Makefiles" ../..
+make