MobArena/README.md
Andreas Troelsen 208a43262e Rewrite "Getting Help" section in README.
The section now includes the Discord instant invite.
2018-04-27 16:53:40 +02:00

38 lines
1.5 KiB
Markdown

MobArena [![Build Status](https://travis-ci.org/garbagemule/MobArena.svg?branch=master)](https://travis-ci.org/garbagemule/MobArena) [![Documentation Status](https://readthedocs.org/projects/mobarena/badge/?version=latest)](http://mobarena.readthedocs.io/en/latest/?badge=latest)
========
MobArena is an arena-style minigame for Spigot-based Minecraft servers
## Getting Started
If you don't want to compile the plugin yourself, grab a release artifact from
one of these two sites:
- [Bukkit](https://dev.bukkit.org/projects/mobarena)
- [Spigot](https://www.spigotmc.org/resources/34110/)
The wiki here on Github should have all the information you need to get
started using the plugin.
## Getting Help
If you run into problems or need help with something, feel free to hop on the
MobArena Discord server or IRC channel to have a chat:
- Discord: [Instant Invite](https://discordapp.com/invite/sddqVJd)
- IRC (#mobarena @ EsperNet): [KiwiIRC Web Client](https://kiwiirc.com/nextclient/#irc://irc.esper.net/#mobarena)
Remember, though, that these communication channels are _idle chat_, which
means you likely won't get a response immediately. It could take anything from
a couple of seconds to a day, but your message _will_ be seen.
## Contributing
Found a bug, got a suggestion, or want to dig into the code base? There are
many ways to contribute to the project!
Get started here: [Contributing](https://github.com/garbagemule/MobArena/blob/master/.github/CONTRIBUTING.md)