MobArena/README.md

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)
Replace Travis CI with Github Actions. This commit introduces a Github Actions workflow in the form of the file `.github/workflows/build.yml`, replacing Travis CI and its `.travis.yml` file. The new workflow does a little bit more than Travis CI: it uploads an artifact after a successful build. Due to a known issue with Github's package UI, the MobArena.jar file is dynamically zipped on download, so we get MobArena.jar.zip containing just MobArena.jar. It's redundant, but there doesn't seem to be a simple way around it at the time of this commit, so we'll leave it be. For now, the workflow runs on every push to every branch. I'm probably going to regret that, but we'll leave that as it is for now as well. 2021-04-15 17:24:56 +02:00			`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)`
Convert all GitHub wiki pages into ReStructuredText documents, set up ReadTheDocs 2017-11-29 19:51:42 +01:00			`========`

			`MobArena is an arena-style minigame for Spigot-based Minecraft servers`
Add build status to README.md 2017-11-19 17:17:31 +01:00
Rewrite README. 2017-03-12 12:17:01 +01:00
			`## Getting Started`
Convert all GitHub wiki pages into ReStructuredText documents, set up ReadTheDocs 2017-11-29 19:51:42 +01:00
Rewrite README. 2017-03-12 12:17:01 +01:00			`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/)`
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:13:31 +01:00			`- [Hangar](https://hangar.papermc.io/garbagemule/MobArena)`
Rewrite README. 2017-03-12 12:17:01 +01:00
			`The wiki here on Github should have all the information you need to get`
			`started using the plugin.`

Convert all GitHub wiki pages into ReStructuredText documents, set up ReadTheDocs 2017-11-29 19:51:42 +01:00
Rewrite README. 2017-03-12 12:17:01 +01:00			`## Getting Help`
Convert all GitHub wiki pages into ReStructuredText documents, set up ReadTheDocs 2017-11-29 19:51:42 +01:00
Rewrite "Getting Help" section in README. The section now includes the Discord instant invite. 2018-04-27 16:53:40 +02:00			`If you run into problems or need help with something, feel free to hop on the`
Update README with new Discord invite. Also removes the IRC links - sorry old pal. 2018-09-23 16:21:43 +02:00			`MobArena Discord server to have a chat: [Instant Invite](https://discord.gg/5tnwQvC)`
Rewrite README. 2017-03-12 12:17:01 +01:00
Update README with new Discord invite. Also removes the IRC links - sorry old pal. 2018-09-23 16:21:43 +02:00			`Remember, though, that this communication channel is _idle chat_, which`
Rewrite "Getting Help" section in README. The section now includes the Discord instant invite. 2018-04-27 16:53:40 +02:00			`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.`
Rewrite README. 2017-03-12 12:17:01 +01:00
Convert all GitHub wiki pages into ReStructuredText documents, set up ReadTheDocs 2017-11-29 19:51:42 +01:00
Add "Contributing" section to README. This replaces the "Bugs and Suggestions" section. 2018-04-27 16:49:31 +02:00			`## Contributing`
Convert all GitHub wiki pages into ReStructuredText documents, set up ReadTheDocs 2017-11-29 19:51:42 +01:00
Add "Contributing" section to README. This replaces the "Bugs and Suggestions" section. 2018-04-27 16:49:31 +02:00			`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)`