README.md

   1 # Xonotic
   2
   3 ![Xonotic Logo](https://xonotic.org/static/img/xonotic_logo_web.svg)
   4
   5 Xonotic is an addictive, arena-style first person shooter with crisp movement and a wide array of weapons. It combines intuitive mechanics with in-your-face action to elevate your heart rate.
   6
   7 ## License
   8
   9 Xonotic is and will always be free and open source. It is available under the [copyleft](https://www.gnu.org/copyleft/)-style [GPLv3+](https://www.gnu.org/licenses/gpl-3.0.html) license (see the [COPYING](COPYING) file for details).
  10
  11 ## Download
  12
  13 Stable releases and related info are available at https://xonotic.org/download
  14
  15 [Beta builds](https://gitlab.com/xonotic/xonotic/-/wikis/Autobuilds) are available at https://beta.xonotic.org/autobuild
  16
  17 The source code included in stable releases and autobuilds can be [compiled as described on the wiki](https://gitlab.com/xonotic/xonotic/-/wikis/Compiling).  This is much "lighter" than a full git clone.
  18
  19 *Please note, [Gitlab](https://gitlab.com/xonotic/) is our home for repositories, issue tracking, wikis, etc. The repositories on GitHub are mirrors of GitLab's unless specified otherwise.*
  20
  21 ## Community
  22
  23 The community is primarily active in the [forums](https://forums.xonotic.org/) and [chat rooms](https://gitlab.com/xonotic/xonotic/-/wikis/Chat-Rooms).
  24
  25 ## Documentation
  26
  27 [Halogene's Newbie Guide](https://xonotic.org/guide) gives gameplay and client configuration advice.
  28 [Frequently Asked Questions](https://xonotic.org/faq) cover common tech support topics.
  29 [The GitLab wiki](https://gitlab.com/xonotic/xonotic/-/wikis/home) has detailed articles and links for many relevant topics.
  30 [Command Alias & Cvar Search](https://xonotic.org/tools/cacs) is a web interface to browse Xonotic console features.
  31 [Doxygen](https://xonotic.org/doxygen) makes it easier to discover details and dependencies in the code.
  32
  33 ## Developing
  34
  35 To compile the latest revision from git, [follow this guide](https://gitlab.com/xonotic/xonotic/wikis/Repository_Access). Learn more about the [directory structure here](https://gitlab.com/xonotic/xonotic/wikis/Git). Check out [our project page on GitLab](https://gitlab.com/groups/xonotic) to see [development activity](https://gitlab.com/groups/xonotic/-/activity) and code ([xonotic-data.pk3dir](https://gitlab.com/xonotic/xonotic-data.pk3dir) is where most development takes place).
  36
  37 Please ensure you've read and understood [CONTRIBUTING.md](CONTRIBUTING.md) before pushing commits or opening merge requests.
  38
  39 ## Contributing
  40
  41 We're looking for help in the following areas:
  42
  43 - [Translations](https://www.transifex.com/team-xonotic/xonotic/)
  44   - More info [on the wiki](https://gitlab.com/xonotic/xonotic/-/wikis/home#translating)
  45 - [Modeling and texturing](https://gitlab.com/xonotic/xonotic-data.pk3dir/issues?label_name=Area%3A+Assets)
  46 - Documentation
  47   - Some of it is still scattered in [Docs](https://gitlab.com/xonotic/xonotic/tree/master/Docs) instead of being on our [wiki](https://gitlab.com/xonotic/xonotic/wikis/home)
  48   - Some [wiki](https://gitlab.com/xonotic/xonotic/wikis/home) pages are slightly out of date or contain links to empty pages
  49   - Fixing typos everywhere and anywhere - attention to detail is important to make a good impression on potential players
  50   - Even if you're new, just letting us know what you're struggling with helps so we can focus on improving those areas first
  51 - Testing
  52   - If you're running a server or play off-line often, please consider using the [autobuild](https://gitlab.com/xonotic/xonotic/wikis/Autobuilds) or [git](https://gitlab.com/xonotic/xonotic/wikis/Repository_Access) versions to help us find bugs (when playing online, the server's version of the gamecode is downloaded and used by all clients so you have to play offline or run your own server for testing)
  53 - PR
  54   - Please don't create anything that looks official (social media accounts, entries on pages like steam, etc.) without contacting us, we like to manage things ourselves to keep the information up to date
  55   - All other kinds of PR are very welcome - make videos or articles, share links, spread the word
  56