MobArena/README.md
Andreas Troelsen b08c74afbd 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

35 lines
1.2 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/)
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)