MobArena/README.md
Andreas Troelsen 1a7109a1d4 Add Hangar link to README.
We'll get around to the Gradle plugin and auto-publishing at some point,
but for now, let's at least just link to the project page.
2023-11-13 12:21:40 +01:00

36 lines
1.3 KiB
Markdown

MobArena [![Build Status](https://github.com/garbagemule/MobArena/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/garbagemule/MobArena/actions/workflows/build.yml)
========
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/)
- [Hangar](https://hangar.papermc.io/garbagemule/MobArena)
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 to have a chat: [Instant Invite](https://discord.gg/5tnwQvC)
Remember, though, that this communication channel is _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)