|
|
@@ -1,55 +1,31 @@
|
|
|
-# AbbaManager
|
|
|
+# AbbaCaving
|
|
|
Simple Abba managing plugin
|
|
|
|
|
|
## Usage
|
|
|
-In order to play you must first create a game using `/abba create [name]`
|
|
|
-The game's spawn will be set where you run the command.
|
|
|
-Once the game is created, it must be opened for players to join using `/abba open [name]`
|
|
|
-The game can be closed using `/abba close`
|
|
|
-To join a game, use `/abba join [name]`, this command is enabled for all players by default.
|
|
|
-To configure the game, use `/abba config <name> ...`
|
|
|
-Once the players have joined, use `/abba start [name]` to start the game
|
|
|
-To remove a game, use `/abba remove [name]`
|
|
|
-
|
|
|
-
|
|
|
-
|
|
|
-## Features
|
|
|
-Abba inventory calculator
|
|
|
-
|
|
|
-## Planned Features
|
|
|
-- Allow betting on winner of game
|
|
|
-- iConomy/Vault/registry integration
|
|
|
+`/abba create [gameName]` to create a game at the current location of the player.
|
|
|
+To mark a chest to be used for the game, place a sign on the chest with `[abba]` on the first line and optionally the game name on the second line. When completed, the text on the first line should turn blue.
|
|
|
+Open the game with `/abba open [game]`. This allows players to join the game.
|
|
|
+When all players are ready, use `/abba start [game]` to start the countdown.
|
|
|
+After the time is up and all players have deposited their ores in the chests, use `/abba tally [game]` to calculate the scores.
|
|
|
+Once all players have left, remove the game with `/abba remove <game>`
|
|
|
|
|
|
## Commands
|
|
|
-Command | Description | permission | default
|
|
|
---- | --- | --- | ---
|
|
|
-/abba join | Joins an open abba game | AbbaCaving.join | everyone
|
|
|
-/abba leave | leaves the current abba game | AbbaCaving.leave | everyone
|
|
|
-/abba list | Lists all current games | AbbaCaving.list | everyone
|
|
|
-/abba info | Displays info about an abba game | AbbaCaving.info | everyone
|
|
|
-/abba calc | calculates current value of inventory | AbbaCaving.calc | everyone
|
|
|
-/abba create | creates a new abba game | AbbaCaving.create | OP
|
|
|
-/abba remove | Removes an Abba game | AbbaCaving.remove | OP
|
|
|
-/abba open | Opens a game so people can join | AbbaCaving.open | OP
|
|
|
-/abba close | Closes a game so people can't join | AbbaCaving.close | OP
|
|
|
-/abba config | Configures an abba game | AbbaCaving.config | OP
|
|
|
+Command | Description
|
|
|
+--- | ---
|
|
|
+/abba join | Joins an open abba game
|
|
|
+/abba leave | leaves the current abba game
|
|
|
+/abba list | Lists all current games
|
|
|
+/abba info | Displays info about an abba game
|
|
|
+/abba create | creates a new abba game
|
|
|
+/abba remove | Removes an Abba game
|
|
|
+/abba open | Opens a game so people can join
|
|
|
+/abba close | Closes a game so people can't join
|
|
|
+/abba config | Configures an abba game
|
|
|
|
|
|
## Permissions
|
|
|
Permission | Description | default
|
|
|
--- | --- | ---
|
|
|
-AbbaCaving.join | /abba join | all
|
|
|
-AbbaCaving.leave | /abba leave | all
|
|
|
-AbbaCaving.info | /abba info | all
|
|
|
-AbbaCaving.list | /abba list | all
|
|
|
-AbbaCaving.calc | /abba calc | all
|
|
|
+AbbaCaving.basic | Allows access to basic commands such as `/abba join`
|
|
|
+AbbaCaving.admin | Allows access to admin commands
|
|
|
AbbaCaving.joinFull | Allows to join full games | OP
|
|
|
AbbaCaving.joinClosed | Allows to join closed games | OP
|
|
|
-AbbaCaving.create | /abba create | OP
|
|
|
-AbbaCaving.remove | /abba remove | OP
|
|
|
-AbbaCaving.open | /abba open | OP
|
|
|
-AbbaCaving.close | /abba close | OP
|
|
|
-AbbaCaving.tp | /abba tp | OP
|
|
|
-AbbaCaving.start | /abba start | OP
|
|
|
-AbbaCaving.reload | /abba reload | OP
|
|
|
-AbbaCaving.config | /abba config | OP
|
|
|
-AbbaCaving.registerChest | Allows to register chests for an abba game
|
lennartVH01