MobArena plugin for Minecraft
Go to file
Andreas Troelsen 252c2b4c01 Introducing MobArena Labs.
This commit introduces the concept of MobArena Labs as well as the first
explicitly experimental feature in the form of custom entity type lists
for the cleanup procedure.

MobArena Labs is an attempt at a compromise between the otherwise rigid
approach to functionality due to maintainability concerns and some of
the esoteric feature requests we see on Github. The compromise manifests
itself as follows:

- All experimental functionality is opt-in and set up primarily in a new
  file, `labs.yml`, which must be created manually. Nothing is provided
  for users by default, so the "I know what I'm doing"-attitude required
  for this functionality to work hopefully helps convey the user-facing
  downside; that experimental functionality is much more likely to break
  between releases, and that compatibility issues are ignored.

- The other side of the coin is that we can try new things as long as
  they are _local to MobArena_, i.e. no external dependencies. Some of
  the esoteric and niche feature requests we see on Github could make it
  into the plugin as experimental features. If enough servers make use
  of them and provide feedback, they could end up as regular features
  with stability and robustness concerns on par with core parts of the
  plugin. We use bStats to help visualize feature usage (or lack thereof
  so we can remove unused functionality if it is problematic).

The first experimental feature is the ability to customize the list of
entity types that MobArena looks for when clearing the arena region of
residual entities such as arrows and experience orbs. This is called the
Housekeeper, and it has its own section in `labs.yml`. It can be toggled
on or off with the `enabled` flag, and the list of entities is specified
with the `entities` list. Because the original code was hardcoded in the
ArenaImpl class, no effort has been made to make the Housekeeper and its
settings per-arena configurable.

Closes #667
2021-08-07 23:25:22 +02:00
.github Replace Travis CI with Github Actions. 2021-04-15 17:24:56 +02:00
.mvn/wrapper Add Maven Wrapper. 2020-11-04 01:21:50 +01:00
src Introducing MobArena Labs. 2021-08-07 23:25:22 +02:00
.gitignore Clean up .gitignore. 2020-11-08 19:27:22 +01:00
LICENSE Add LICENSE 2018-04-27 16:32:02 +02:00
README.md Replace Travis CI with Github Actions. 2021-04-15 17:24:56 +02:00
changelog.md Make piglins and hoglins immune to zombification 2021-08-07 16:05:18 +02:00
mvnw Add Maven Wrapper. 2020-11-04 01:21:50 +01:00
mvnw.cmd Add Maven Wrapper. 2020-11-04 01:21:50 +01:00
pom.xml Switch to Spigot API and bump version to 1.17. 2021-07-30 18:21:39 +02:00

README.md

MobArena Build Status

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:

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

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