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 2019-10-06 17:42:16 +02:00 committed by GitHub
parent b950deb2dd
commit 32d61423bb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -2,11 +2,17 @@
<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**.
## What's in this repository
* This repository contains Quake 3 Arena source code which can be built with modern versions of Visual Studio.
* Only Windows x64 platform is supported.
* I don't try to fix bugs inherited from the original Q3 source code distribution - in this regard this project is Q3-bugs-friendly. Still I fix things if new version of the compiler complains about something or if some functionality shows its age which leads to application instability.
* Some functionality related to ancient graphics hardware was removed. Also I removed compilation of qvm code to native instructions to simplify maintenance. This means all game code is run through QVM which is slower than native execution but fast enough for modern computers.
* No changes in terms of visual appearence or gameplay. Provided Vulkan backend is a safe measure in case of poor OpenGL support in the future (hopefully not). It produces the same pixes as OpenGL backend.
## Usage
* Build `visual-studio/quake3.sln` solution.
* Copy `quake3-ke.exe` to your local Quake-III-Arena installation folder.
* To start the game from Visual Studio go to `Debugging->Command Arguments` in quake3 project's properties and specify command line in the form: `+set fs_basepath <quake3/installation/directory>`
## Vulkan support
Vulkan backend provides the same graphics features as original OpenGL-based one including customization via r_xxx cvars and debug visualization.
@ -30,9 +36,4 @@ Vulkan backend provides the same graphics features as original OpenGL-based one
## 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](https://user-images.githubusercontent.com/4964024/28160268-4f0707d4-67c8-11e7-9009-8540789aab0b.jpeg)