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
297 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 11e6e7d470
Update README.md
2018-01-15 21:52:20 +01:00
src Updated debug callback signature to match requirements for vulkan function declarations. 2018-01-14 21:17:35 +01:00
tools Specify shaders directly as arrays of bytes in source code. 2017-04-05 14:26:15 +03:00
visual-studio Removed user example file. 2018-01-14 19:29:37 +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 2018-01-15 21:52:20 +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 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 support

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

New cvars:

  • r_renderAPI - 3D API to use. Requires vid_restart.

    • 0 - OpenGL
    • 1 - Vulkan
    • 2 - DX12 (if enabled, see below)

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

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 1 then \vid_restart.
  • Q: How to check that Vulkan backend is really active? A: gfxinfo console command reports information about active rendering backend.

DX12 support

DirectX 12 backend implementation is provided mostly for educational purposes and is not included in the prebuild binaries. It can be enabled by uncommenting ENABLE_DX12 define in dx.h header and recompiling the project.

Visual Studio

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

To start the game from visual studio in quake3 project's properties go to Debugging->Command Arguments and specify command line in the form: +set fs_basepath <quake3/installation/directory>

quake3-ke