quick/Quake-III-Arena-VS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Artem Kharytoniuk 2017-12-25 20:14:28 +01:00
parent 8139d0dd4c
commit fd0d330d83
1 changed files with 3 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -2,9 +2,7 @@
<img src="https://ci.appveyor.com/api/projects/status/github/kennyalive/Quake-III-Arena-Kenny-Edition?svg=true" alt="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.
The general direction is to simplify the things. The codebase should be easy to build, executable does not require additional shared libraries to work and we do not talk about OOP here. Only Windows platform is supported.
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.
@ -13,8 +11,7 @@ The general direction is to simplify the things. The codebase should be easy to
## 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.
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.
@ -22,8 +19,7 @@ Initially DirectX 12 backend was an exercise to learn this graphics API. It turn
* **r_twinMode** - Debug feature to compare rendering output between OpenGL/Vulkan/DX12 APIs.
If enabled, renderer uses multiple APIs and renders current frame to two or three side-by-side windows. Requires vid_restart.
*r_twinMode* is a bitmask. The following values can be combined to enable different graphics backends: 1 - OpenGL, 2 - Vulkan, 4 - DX12. For example: r_twinMode=7 (1+2+4) - enables all backends and renders to 3 windows. r_twinMode=3 (1+2) - enables OpenGL and Vulkan backends and renders to 2 windows.
*r_twinMode* is a bitmask. The following values can be combined to enable additional graphics backends: 1 - OpenGL, 2 - Vulkan, 4 - DX12. For example: r_twinMode=7 (1+2+4) - enables all backends and renders to 3 windows. r_twinMode=1 - enables Vulkan backend in addition to active backend defined by *r_renderAPI*.
#### Additional information:
* Q: How to start game with vulkan support? A: `quake3-ke.exe +set r_renderAPI 1`.