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 2018-01-14 17:37:43 +01:00 committed by GitHub
parent d213baea81
commit db385ce13a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -11,14 +11,11 @@ This repository contains updated version of the original Q3 codebase with reorga
## Vulkan support ## Vulkan support
Vulkan backend provides the same graphics features as original OpenGL-based one including customization via r_xxx cvars and debug visualization. Vulkan backend provides the same graphics features as original OpenGL-based one including customization via r_xxx cvars and debug visualization.
## 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 ENABLED_DX12 in dx.h header and recompiling the project.
#### New cvars: #### New cvars:
* **r_renderAPI** - 3D API to use. Requires vid_restart. * **r_renderAPI** - 3D API to use. Requires vid_restart.
* 0 - OpenGL * 0 - OpenGL
* 1 - Vulkan * 1 - Vulkan
* 2 - DX12 (if enabled, see above). * 2 - DX12 (if enabled, see below).
* **r_twinMode** - Debug feature to compare rendering output between OpenGL/Vulkan/DX12 APIs. Requires vid_restart. * **r_twinMode** - Debug feature to compare rendering output between OpenGL/Vulkan/DX12 APIs. Requires vid_restart.
@ -28,9 +25,12 @@ DirectX 12 backend implementation is provided mostly for educational purposes an
* Q: How to enable twin mode from Q3 console? A: `\r_twinMode 1` or `\r_twinMode 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. * 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 ## Visual Studio
The project files are provided for Visual Studio 2017. Free community version is available online. 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. To start the game from visual studio in quake3 project's properties go to `Debugging->Command Arguments` and specify command line like the following with the path changed to actual game location: `+set fs_basepath e:/games/quake3`
![quake3-ke](https://user-images.githubusercontent.com/4964024/28160268-4f0707d4-67c8-11e7-9009-8540789aab0b.jpeg) ![quake3-ke](https://user-images.githubusercontent.com/4964024/28160268-4f0707d4-67c8-11e7-9009-8540789aab0b.jpeg)