XQF
===

![XQF logo](pixmaps/128x128/xqf.png)

DESCRIPTION
-----------

XQF is a server browser and launcher for games using id Tech engines, Unreal engines and many others (see the [wiki/Supported-games](https://github.com/XQF/xqf/wiki/Supported-games) page for details). XQF is a front-end to QStat and uses the GTK+ 2 toolkit.

To learn more about what's new in XQF, please read the file [NEWS.md](NEWS.md) and the [ChangeLog](ChangeLog).


DOWNLOADS
---------

See the Wiki page: [wiki/Downloads](https://github.com/XQF/xqf/wiki/Downloads).


INSTALLATION
------------

[![Build status](https://travis-ci.org/XQF/xqf.svg?branch=master)](https://travis-ci.org/XQF/xqf)

```sh
git clone https://github.com/XQF/xqf.git
cd xqf
mkdir build
cd build
cmake ..
make
make install
```

On Debian or Ubuntu, use ``cmake -DWITH_QSTAT=/usr/bin/quakestat -DCMAKE_INSTALL_PREFIX=/usr ..``.

For extended information, read this Wiki page: [wiki/How-to-build](https://github.com/XQF/xqf/wiki/How-to-build).


LINKS
-----

* Current home page: [xqf.github.io](http://xqf.github.io)
* XQF Wiki: [github.com/XQF/xqf/wiki](https://github.com/XQF/xqf/wiki)
* Mail list: [sf.net/p/xqf/mailman/](https://sourceforge.net/p/xqf/mailman/)
* IRC Channel: [#xqf@Freenode](irc://chat.freenode.net/xqf)
* XMPP Conference: [xqf@conference.jabber.ru](xmpp://xqf@conference.jabber.ru?join)
* Source code repository: [github.com/XQF/xqf](https://github.com/XQF/xqf/) (up to date Git repository)
* Online translation tool: [transifex.com/projects/p/xqf](https://www.transifex.com/projects/p/xqf/)
* Continuous integration tool: [travis-ci.org/XQF/xqf](https://travis-ci.org/XQF/xqf)
* Historical archives: [sf.net/p/xqf](https://sourceforge.net/projects/xqf/) (previously published files, old SVN repository, and old ticket list)
* QStat, the tool on which XQF is based: [github.com/multiplay/qstat](https://github.com/multiplay/qstat)


HOW TO CONTRIBUTE
-----------------

The best way to contribute code is to fork this project. To contribute translation please visit our Transifex project. You will find more details on the wiki: [wiki/How-to-contribute](https://github.com/XQF/xqf/wiki/How-to-contribute).


COPYRIGHT
---------

XQF is Copyright © 1998-2000 Roman Pozlevich.
See the wiki page for contributors: [wiki/Contributors](https://github.com/XQF/xqf/wiki/Contributors).

Copying is allowed under the terms of the GNU General Public License.  
See the file [COPYING](COPYING) for more details.


HISTORY
-------

XQF was originally written by Roman Pozlevich in 1998. It has been maintained and improved by a devoted team over the years with following major developers:

1998-2000 Roman Pozlevich <roma@botik.ru>  
2000-2002 Bill Adams <bill@evilbill.org>  
2000-2003 Alex Burger <alex_b@users.sf.net>  
2001-2010 Ludwig Nussel <ludwig.nussel@suse.de>  
2001-2014 Jordi Mallach <jordi@debian.org>  
2013-2015 Thomas Debesse <xqf@illwieckz.net>  
2015-2015 Artem Vorotnikov <artem@vorotnikov.me>