diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index d7eadab..fe7a639 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -2,7 +2,7 @@ name: Build on: push: - branches: [ rewrite ] + branches: [ master ] jobs: build: diff --git a/README.md b/README.md index e69de29..0c1489f 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,31 @@ +# ArenaSpleef + +A spleef plugin using [BattleArena](https://github.com/BattlePlugins/BattleArena) + +ArenaSpleef is the classic spleef plugin that dates back to the early days of Minecraft. Players are given a shovel and must break blocks under other players to make them fall into the void. The last player standing wins! + +## Documentation +Full documentation for ArenaSpleef can be found on the [BattleDocs](https://docs.battleplugins.org/books/additional-gamemodes/chapter/spleef) website. + +## Commands +| Command | Description | +|---------------------------------------|------------------------------------------------| +| /spleef layer add | Adds a layer to a spleef arena. | +| /spleef layer remove | Removes a layer from a spleef arena. | +| /spleef layer clear | Clears all layers from a spleef arena. | +| /spleef layer index | Changes the index of a layer. | +| /spleef layer list | Lists all layers in a spleef arena. | + +## Permissions +| Permission | Command | +|-----------------------------------------|----------------------| +| battlearena.command.spleef.layer.add | /spleef layer add | +| battlearena.command.spleef.layer.remove | /spleef layer remove | +| battlearena.command.spleef.layer.clear | /spleef layer clear | +| battlearena.command.spleef.layer.index | /spleef layer index | +| battlearena.command.spleef.layer.list | /spleef layer list | + +## Links +- Website: [https://www.battleplugins.org](https://www.battleplugins.org) +- Download: [https://modrinth.com/plugin/arenaspleef](https://modrinth.com/plugin/arenaspleef) +- Discord: [BattlePlugins Discord](https://discord.com/invite/J3Hjjb8)