quick/Quake-III-Arena-VS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
The cradle of Quake III Arena
290 Commits 1 Branch 0 Tags 10 MiB
C 80%
C++ 18.9%
Python 0.4%
Lua 0.3%
Assembly 0.2%
Other 0.1%
Go to file
Artem Kharytoniuk e86e65f173
Update README.md
2017-12-31 19:52:43 +01:00
src Simplified r_twinMode usage. 2017-12-31 19:48:28 +01:00
tools Specify shaders directly as arrays of bytes in source code. 2017-04-05 14:26:15 +03:00
visual-studio DX12: added macro DISABLE_DX12 that allows to disable DX12 backend. 2017-12-25 16:57:33 +01:00
.gitignore Added vulkan validation layers config. 2017-05-28 13:18:54 +03:00
appveyor.yml Minor update. 2017-06-08 23:51:08 +03:00
changelog.md Update changelog.md 2017-05-30 09:43:24 +03:00
COPYING.txt The Quake III Arena sources as originally released under the GPL license on August 20, 2005. 2012-01-31 13:41:34 -06:00
README.md Update README.md 2017-12-31 19:52:43 +01:00
README.txt The Quake III Arena sources as originally released under the GPL license on August 20, 2005. 2012-01-31 13:41:34 -06:00

README.md

Welcome to the Quake 3 source code!

Project Badge

This repository contains updated version of the original Q3 codebase with reorganized code structure, compatibility fixes, build setup for the latest Visual Studio and modifications that update the core tech but preserve original gameplay, look and feel.

Usage

  • Build visual-studio/quake3.sln solution.
  • Copy quake3-ke.exe to your local Quake-III-Arena installation folder.

Vulkan and DX12 support

Vulkan backend provides the same graphics features as original OpenGL-based one including customization via r_xxx cvars and debug visualization.

Initially DirectX 12 backend was an exercise to learn this graphics API. It turned out the implementation is quite concise, so it was merged into the main branch. There is an option to compile the project without DX12 backend. For this, uncomment DISABLE_DX12 macro in dx.h header.

New cvars:

  • r_renderAPI - 3D API to use: 0 - OpenGL, 1 - Vulkan, 2 - DX12. Requires vid_restart.

  • r_twinMode - Debug feature to compare rendering output between OpenGL/Vulkan/DX12 APIs. Requires vid_restart.

    • r_twinMode=1 : one additional window is created. If the main window uses graphics API defined by r_renderAPI then the additional window will use graphics API with index (r_renderAPI+1)%3
    • r_twinMode=2 : two additional windows are created and all 3 graphics APIs are active simultaneously.

Additional information:

  • Q: How to start game with vulkan support? A: quake3-ke.exe +set r_renderAPI 1.
  • Q: How to enable vulkan support from Q3 console? A: \r_renderAPI 1 then \vid_restart.
  • Q: How to enable twin mode from Q3 console? A: \r_twinMode 1 or \r_twinMode 2 then \vid_restart.
  • Q: How to check that Vulkan backend is really active? A: gfxinfo console command reports information about active rendering backend.

Visual Studio

The project files are provided for Visual Studio 2017. Free community version is available online.

visual-studio/quake3.vcxproj.user.example file is provided with example configuration options to start the game from visual studio and to enable vulkan validation layers.

quake3-ke