Skip to content

Commit

Permalink
Add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Redned235 committed Jul 2, 2024
1 parent d62cf02 commit 2b3be1f
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Build

on:
push:
branches: [ rewrite ]
branches: [ master ]

jobs:
build:
Expand Down
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <map> | Adds a layer to a spleef arena. |
| /spleef layer remove <map> <index> | Removes a layer from a spleef arena. |
| /spleef layer clear <map> | Clears all layers from a spleef arena. |
| /spleef layer index <map> <from> <to> | Changes the index of a layer. |
| /spleef layer list <map> | 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)

0 comments on commit 2b3be1f

Please sign in to comment.