Skip to content

Latest commit

 

History

History
126 lines (90 loc) · 4.43 KB

README.md

File metadata and controls

126 lines (90 loc) · 4.43 KB
Raw

KTX: a QuakeWorld server modification

KTX Logo

KTX (Kombat Teams eXtreme) is a popular QuakeWorld server modification, adding numerous features to the core features of the server.

Although it had been developed to be Quakeworld server agnostic, it has over the years been developed very close to MVDSV to which it has become an extent, thus compatibility with other Quakeworld servers might not have been maintained.

Getting Started

The following instructions will help you get KTX installed on a running MVDSV server using prebuilt binaries. Details on how to compile your own KTX binary will also be included to match specific architectures or for development purposes.

Supported architectures

The following architectures are fully supported by KTX and are available as prebuilt binaries:

  • Linux amd64 (Intel and AMD 64-bits processors)
  • Linux i686 (Intel and AMD 32-bit processors)
  • Linux aarch (ARM 64-bit processors)
  • Linux armhf (ARM 32-bit processors)
  • Windows x64 (Intel and AMD 64-bits processors)
  • Windows x86 (Intel and AMD 32-bit processors)

Prebuilt binaries

You can find the prebuilt binaries on this download page.

Prerequisites

KTX is a server mod and won't run without a proper Quakeworld server set up. MVDSV is the recommended one, but [FTE][fte] might work as well (unconfirmed with current code).

Installing

For more detailed information we suggest looking at the nQuake server, which uses MVDSV and KTX as QuakeWorld server.

Building binaries

Build from source with CMake

Assuming you have installed essential build tools and CMake

mkdir build && cmake -B build . && cmake --build build

Build artifacts would be inside build/ directory, for unix like systems it would be qwprogs.so.

You can also use build_cmake.sh script, it mostly suitable for cross compilation and probably useless for experienced CMake user. Some examples:

./build_cmake.sh linux-amd64

should build KTX for linux-amd64 platform, release version, check cross-cmake directory for all platforms

B=Debug ./build_cmake.sh linux-amd64

should build KTX for linux-amd64 platform with debug

V=1 B=Debug ./build_cmake.sh linux-amd64

should build KTX for linux-amd64 platform with debug, verbose (useful if you need validate compiler flags)

V=1 B=Debug BOT_SUPPORT=OFF ./build_cmake.sh linux-amd64

same as above but compile without bot support

G="Unix Makefiles" ./build_cmake.sh linux-amd64

force CMake generator to be unix makefiles

./build_cmake.sh linux-amd64 qvm

build KTX for linux-amd64 and QVM version, you can provide any platform combinations.

Versioning

For the versions available, see the tags on this repository.

Authors

(Listed by last name alphabetic order)

  • Ivan "qqshka" Bolsunov
  • Dominic "oldman" Evans
  • Foobar
  • Anton "tonik" Gavrilov
  • Andrew "ult" Grondalski
  • Paul Klumpp
  • Niclas "empezar" Lindström
  • Dmitry "disconnect" Musatov
  • Peter "meag" Nicol
  • Andreas "molgrum" Nilsson
  • Alexandre "deurk" Nizoux
  • Tero "Renzo" Parkkonen
  • Joseph "bogojoker" Pecoraro
  • Michał "_KaszpiR_" Sochoń
  • Jonny "dimman" Svärd
  • Vladimir "VVD" Vladimirovich
  • Florian "Tuna" Zwoch

Code of Conduct

We try to stick to our code of conduct when it comes to interaction around this project. See the CODE_OF_CONDUCT.md file for details.

License

This project is licensed under the GPL-2.0 License - see the LICENSE.md file for details.

Acknowledgments

  • Thanks to kemiKal, Cenobite, Sturm and Fang for Kombat teams 2.21 which has served as a base for KTX.
  • Thanks to Jon "bps" Cednert for the KTX logo.
  • Thanks to the fine folks on Quakeworld Discord for their support and ideas.