e4e10e7d7c0b4bce010c9326156ce58a30cf6ac8
[xonotic/xonotic.git] / README.md
1 # Xonotic
2
3 ![Xonotic Logo](http://xonotic.org/static/img/xonotic-logo.png)
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. Xonotic is and will always be free-to-play. It is available under the [copyleft](https://www.gnu.org/copyleft/)-style [GPLv2](http://www.gnu.org/licenses/gpl-2.0.html) license.
6
7 *Please note, [Gitlab](http://gitlab.com/xonotic/) is our home for repositories, issue tracking, wikis, etc. The repositories on GitHub are mirrors of GitLab's unless specified otherwise.*
8
9 ## Download
10
11 ### LATEST RELEASE: Xonotic 0.8.2 for Linux, Windows, and macOS
12
13 If you're just here to play, you can download Xonotic as a zip package, torrent, or by using one of [these alternative methods](http://xonotic.org/download/).
14
15 - [Download as torrent](http://dl.xonotic.org/xonotic-0.8.2.zip.torrent)
16 - [Download as zip](http://dl.xonotic.org/xonotic-0.8.2.zip)
17
18 No installation required, just unpack and run. Got questions? See the [FAQ](http://xonotic.org/faq) or [live chat](http://xonotic.org/chat/) with us.
19
20 **sha256sum**: a22f7230f486c5825b55cfdadd73399c9b0fae98c9e081dd8ac76eca08359ad5  
21 **shasum**: 9a1726e3d0d4e5e23c1e799734397c63e5df6ec9  
22 **MD5**: 1bd46c1fb79aae42bb13e74f5a0ff46e  
23 **Package size**: 946M  
24
25 ## Contributing
26
27 We're mainly looking for help in the following areas:
28
29 - [Modeling and texturing](https://gitlab.com/xonotic/xonotic-data.pk3dir/issues?label_name=Area%3A+Assets)
30 - Documentation
31   - 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)
32   - Some [wiki](https://gitlab.com/xonotic/xonotic/wikis/home) pages are slightly out of date or contain links to empty pages
33   - Fixing typos everywhere and anywhere - attention to detail is important to make a good impression on potential players
34   - Even if you're new, just letting us know what you're struggling with helps so we can focus on improving those areas first
35 - Testing
36   - 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)
37 - PR
38   - Please don't create anything that looks official (social media accounts, entries on pages like steam, etc.), we like to do that ourselves so we can manage things and keep the information up to date
39   - All other kinds of PR are very welcome - make videos or articles, share links, spread the word
40
41 ## Developing
42
43 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), or check out [our project page on GitLab](https://gitlab.com/groups/xonotic) to see development activity and code ([xonotic-data](https://gitlab.com/xonotic/xonotic-data.pk3dir) is where most development takes place).
44
45 ## Community
46
47 The community is primarily active in the [forums](http://forums.xonotic.org/) and IRC, `#xonotic` on either `irc.freenode.net` (developer chat) or `irc.quakenet.org` (player chat).
48
49 ## Wiki
50
51 [Our Gitlab wiki](https://gitlab.com/xonotic/xonotic/wikis/home) has a lot of information related to developing, playing or otherwise contributing to the game.
52
53 ## License
54
55 Distributed under the GPLv2 license. See the [LICENSE](LICENSE) file for more details.