Fix a teleport closet (MakMorn)
[crawl.git] / README.md
1 [![Build Status](https://travis-ci.org/crawl/crawl.svg?branch=master)](https://travis-ci.org/crawl/crawl)
2
3 # Dungeon Crawl Stone Soup
4
5 Dungeon Crawl Stone Soup is a game of dungeon exploration, combat and magic, involving characters of diverse skills, worshipping deities of great power and caprice. To win, you'll need to be a master of tactics and strategy, and prevail against overwhelming odds.
6
7 ## Contents
8
9 1. [How to Play](#how-to-play)
10 3. [Community](#community)
11 5. [How you can help](#how-you-can-help)
12 4. [License and history information](#license-and-history-information)
13
14 ## How to Play
15
16 If you'd like to dive in immediately, we suggest one of:
17
18 * Start a game and pick a tutorial (select tutorial in the game menu),
19 * Read [quickstart.md](crawl-ref/docs/quickstart.md) (in the [docs/](crawl-ref/docs/) directory), or
20 * For the studious, [read Crawl's full manual](crawl-ref/docs/crawl_manual.rst).
21
22 There is also an ingame list of frequently asked questions which you can access by typing
23 `?Q`.
24
25 #### Internet Play
26
27 You can play Crawl online, competing with other players or watching them. Click "Play Online Now!" on [the Crawl homepage](https://crawl.develz.org/) to find your closest server. You can play in your browser or over SSH.
28
29 #### Offline Play
30
31 Both classical ASCII and tiles (GUI) versions of Crawl are available to [download for Linux, Windows and OS X](https://crawl.develz.org/download.htm).
32
33 ## Community
34
35 * Our official homepage: [crawl.develz.org](https://crawl.develz.org/)
36   * Online webtiles play
37   * Offline downloads
38   * A community forum
39 * The official [/r/dcss subreddit](https://www.reddit.com/r/dcss/)
40 * [/r/roguelikes Discord](https://discord.gg/S5F2H32)
41 * IRC: ##crawl on Freenode (or ##crawl-dev to chat development)
42
43 ## How you can help
44
45 If you like the game and you want to help make it better, there are a number
46 of ways to do so. For a detailed guide to the crawl workflow, look at
47 the [contributor's guide](crawl-ref/docs/develop/contribution-process.md).
48
49 ### Reporting bugs
50
51 At any time, there will be bugs -- finding and reporting them is a great help.
52 Many of the online servers host the regularly updated development version. Bugs
53 should be reported to [our bug tracker](https://crawl.develz.org/mantis/). Besides pointing out bugs, new ideas on how to improve interface or gameplay are welcome. These can be added to [the development wiki](https://crawl.develz.org/wiki/).
54
55 ### Map making
56 Crawl creates levels by combining many hand-made (but often randomised) maps, known as *vaults*. Making them is fun and
57 easy. It's best to start with simple entry vaults: see [simple.des](crawl-ref/source/dat/des/arrival/simple.des) for examples. You can also read [the level-design manual](crawl-ref/docs/develop/levels/introduction.txt) for more help.
58
59 If you're ambitious, you can create new vaults for anywhere in the game. If you've
60 made some vaults, you can test them on your own system (no compiling needed) and
61 submit them to [our bug tracker](https://crawl.develz.org/mantis/).
62
63 ### Monster Speech & Item Descriptions
64 Monster speech provides a lot of flavour. Just like vaults, varied speech depends
65 upon a large set of entries. Speech syntax is effective but unusual, so you may want to read [the formatting guide](crawl-ref/docs/develop/monster_speech.txt).
66
67 Current item descriptions can be read in-game with `?/` or out-of-game
68 them in [dat/descript/](crawl-ref/source/dat/descript/). The following conventions should be more or less obeyed:
69 * Descriptions ought to contain flavour text, ideally pointing out major weaknesses/strengths.
70 * No numbers, please.
71 * Citations are okay, but try to stay away from the most generic ones.
72
73 ### Tiles
74 We're always open to improvements to existing tiles or variants of often-used tiles (eg floor tiles). If you want to give this a shot, please [contact us](#community) via forums or IRC. In case you drew some tiles of your own, you can submit them to [our bug tracker](https://crawl.develz.org/mantis/).
75
76 ### Patches
77 For developers (both existing & aspiring!), you can download/fork the source code and write patches. Bug fixes as well as new features are very much welcome.
78
79 For large changes, it's always a good idea to [talk with the dev team](#community) first, to see if any plans already exist and if your suggestion is likely to be accepted.
80
81 Please be sure to read [docs/develop/coding_conventions.txt](crawl-ref/docs/develop/coding_conventions.txt) too.
82
83 ## License and history information
84
85 Crawl is licensed as GPLv2+. See [LICENSE](LICENSE) for the full text.
86
87 Crawl is a descendant of Linley's Dungeon Crawl. The final alpha of Linley's Dungeon Crawl (v4.1) was released by Brent Ross in 2005. Since 2006, the Dungeon Crawl Stone Soup team has continued development. [CREDITS.txt](crawl-ref/CREDITS.txt) contains a full list of contributors.
88
89 Crawl uses the following open source packages; thanks to their developers:
90
91 * The Lua scripting language, for in-game functionality and user macros ([license](crawl-ref/docs/license/lualicense.txt)).
92 * The PCRE library, for regular expressions ([license](crawl-ref/docs/license/pcre_license.txt)).
93 * The SQLite library, as a database engine ([license](https://www.sqlite.org/copyright.html)).
94 * The SDL and SDL_image libraries, for tiles display ([license](crawl-ref/docs/license/lgpl.txt)).
95 * The libpng library, for tiles image loading ([license](crawl-ref/docs/license/libpng-LICENSE.txt)).
96
97 Thank you, and have fun crawling!