first shot as a contributing section in readme
[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 **MD5**: 1bd46c1fb79aae42bb13e74f5a0ff46e
21 **Package size**: 946M
22
23 ## Contributing
24
25 We're currently looking for help in the following areas:
26
27 - Modeling and texturing
28   - We're looking for someone with texturing skills to paint new glowy skins for our player models
29 - Documentation
30   - 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)
31   - Some [wiki](https://gitlab.com/xonotic/xonotic/wikis/home) pages are slightly out of date or contain links to empty pages
32   - Fixing typos everywhere and anywhere - attention to detail is important to make a good impression on potential players
33   - Even if you're new, just letting us know what you're struggling with helps so we can focus on improving those areas first
34 - Testing
35   - If you're running a server or play off-line often, please consider using the autobuild or git versions to help us find bugs
36
37 ## Developing
38
39 To compile the latest version 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).
40
41 ## Community
42
43 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).
44
45 ## Wiki
46
47 [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.
48
49 ## License
50
51 Distributed under the GPLv2 license. See the [LICENSE](LICENSE) file for more details.