Attempts to improve command code a bit
This commit is contained in:
101
README.md
101
README.md
@@ -50,30 +50,37 @@ _**Note:** Instead of using /BlockHunt you could use:_
|
||||
|
||||
<> = Required [] = Optional
|
||||
|
||||
|Command|Description|Permission|| |:--|:--|:--|:--| |`/BlockHunt [info/i]`|Displays the plugin's info.|blockhunt.info|_
|
||||
All players have this permission from default._| |`/BlockHunt <help/h>`|Shows a list of commands.|blockhunt.help|_All
|
||||
players have this permission from default._| |`/BlockHunt <reload/r>`|Reloads all
|
||||
configs.|blockhunt.reload|blockhunt.admin| |`/BlockHunt <join/j> <arenaName>`|Joins a BlockHunt
|
||||
game.|blockhunt.join|blockhunt.player| |`/BlockHunt <leave/l>`|Leave a BlockHunt game.|blockhunt.leave|blockhunt.player|
|
||||
|`/BlockHunt <list/li>`|Shows a list of available arenas.|blockhunt.list|blockhunt.player| |`/BlockHunt <shop/sh>`|Opens
|
||||
the BlockHunt shop.|blockhunt.shop|blockhunt.player| |`/BlockHunt <start/go> <arenaName>`|Forces an arena to
|
||||
start.|blockhunt.start|blockhunt.moderator| |`/BlockHunt <wand/w>`|Gives you the wand selection
|
||||
tool.|blockhunt.create|blockhunt.admin| |`/BlockHunt <create/c> <arenaName>`|Creates an arena from your
|
||||
selection.|blockhunt.create|blockhunt.admin| |`/BlockHunt <set/s> <arenaName>`|Opens a panel to set
|
||||
settings.|blockhunt.set|blockhunt.moderator| |`/BlockHunt <setWarp/sw> <lobby/hiders/seekers/spawn> <arenaName>`|Sets
|
||||
warps for your arena.|blockhunt.setWarp|blockhunt.moderator| |`/BlockHunt <remove/delete> <arenaName>`|Deletes an
|
||||
Arena.|blockhunt.remove|blockhunt.admin| |`/BlockHunt <tokens/t> <set/add/take> <%playerName%> <amount>`|Change someones
|
||||
tokens.|blockhunt.tokens|blockhunt.admin| ||Able to join full games.|blockhunt.joinfull|blockhunt.moderator| ||Able to
|
||||
join/leave using join/leave signs.|blockhunt.joinsign|blockhunt.player| ||Able to create a join/leave
|
||||
sign.|blockhunt.signcreate|blockhunt.moderator| ||Gives you the
|
||||
BlockChooser.|blockhunt.shop.blockchooser|blockhunt.admin| ||Gives you the ability to do all commands
|
||||
in-game.|blockhunt.allcommands|Operators|
|
||||
| Command | Description | Permission | Default allowed |
|
||||
|--------------------------------------------------------------------|---------------------------------------------------|-----------------------------|-------------------------------------------------|
|
||||
| `/BlockHunt [info/i]` | Displays the plugin's info. | blockhunt.info | All players have this permission from default._ |
|
||||
| `/BlockHunt <help/h>` | Shows a list of commands. | blockhunt.help | All players have this permission from default._ |
|
||||
| `/BlockHunt <reload/r>` | Reloads all configs. | blockhunt.reload | blockhunt.admin |
|
||||
| `/BlockHunt <join/j> <arenaName>` | Joins a BlockHunt game. | blockhunt.join | blockhunt.player |
|
||||
| `/BlockHunt <leave/l>` | Leave a BlockHunt game. | blockhunt.leave | blockhunt.player |
|
||||
| `/BlockHunt <list/li>` | Shows a list of available arenas. | blockhunt.list | blockhunt.player |
|
||||
| `/BlockHunt <shop/sh>` | Opens the BlockHunt shop. | blockhunt.shop | blockhunt.player |
|
||||
| `/BlockHunt <start/go> <arenaName>` | Forces an arena to start. | blockhunt.start | blockhunt.moderator |
|
||||
| `/BlockHunt <wand/w>` | Gives you the wand selection tool. | blockhunt.create | blockhunt.admin |
|
||||
| `/BlockHunt <create/c> <arenaName>` | Creates an arena from your selection. | blockhunt.create | blockhunt.admin |
|
||||
| `/BlockHunt <set/s> <arenaName>` | Opens a panel to set settings. | blockhunt.set | blockhunt.moderator |
|
||||
| `/BlockHunt <setWarp/sw> <lobby/hiders/seekers/spawn> <arenaName>` | Sets warps for your arena. | blockhunt.setWarp | blockhunt.moderator |
|
||||
| `/BlockHunt <remove/delete> <arenaName>` | Deletes an Arena. | blockhunt.remove | blockhunt.admin |
|
||||
| `/BlockHunt <tokens/t> <set/add/take> <%playerName%> <amount>` | Change someones tokens. | blockhunt.tokens | blockhunt.admin |
|
||||
| | Able to join full games. | blockhunt.joinfull | blockhunt.moderator |
|
||||
| | Able to join/leave using join/leave signs. | blockhunt.joinsign | blockhunt.player |
|
||||
| | Able to create a join/leave sign. | blockhunt.signcreate | blockhunt.moderator |
|
||||
| | Gives you the BlockChooser. | blockhunt.shop.blockchooser | blockhunt.admin |
|
||||
| | Gives you the ability to do all commands in-game. | blockhunt.allcommands | Operators |
|
||||
|
||||
### Other special permissions
|
||||
|
||||
|Permission|Description| |:--|:--| |`blockhunt.*`|All BlockHunt permissions.| |`blockhunt.player`|All player related
|
||||
permissions.| |`blockhunt.moderator`|All moderator related permissions.| |`blockhunt.admin`|All admin related
|
||||
permissions.| |`*`|All permissions on your server, including BlockHunt's permissions.|
|
||||
| Permission | Description |
|
||||
|-----------------------|--------------------------------------------------------------------|
|
||||
| `blockhunt.*` | All BlockHunt permissions. |
|
||||
| `blockhunt.player` | All player related permissions. |
|
||||
| `blockhunt.moderator` | All moderator related permissions. |
|
||||
| `blockhunt.admin` | All admin related permissions. |
|
||||
| `*` | All permissions on your server, including BlockHunt's permissions. |
|
||||
|
||||
## How to set up?
|
||||
|
||||
@@ -83,4 +90,54 @@ Use this video to manage your way through the set-up phase!
|
||||
" target="_blank"><img src="http://img.youtube.com/vi/msPQ1UMiHWg/0.jpg"
|
||||
alt="" width="240" height="180" border="10" /></a>
|
||||
|
||||
**Thanks to [Koz4Christ](https://www.youtube.com/user/koz4christ/) for this video!**
|
||||
**Thanks to [Koz4Christ](https://www.youtube.com/user/koz4christ/) for this video!**
|
||||
|
||||
### Textual guide
|
||||
|
||||
To start setting up your arena, start by using the `/bh wand` command to get the setup wand. Mark the corners of a
|
||||
square containing your entire arena, like you'd create a WorldGuard region. Right-click with the wand on one corner,
|
||||
and then left-click with the wand on the opposite corner. Make sure one corner is below the bottom of the arena, and
|
||||
that the other is above the top of the arena.
|
||||
|
||||
Use `/bh create \<name>` to create your new arena with name \<name>. Use `/bh set \<name>` to get a GUI for setting the
|
||||
properties of the arena. You can set the maximum number of players that can play at once, the minimum amount of players
|
||||
for a game to start, the amount of seekers required to start, the amount of seconds to keep the players in the lobby (
|
||||
allowing other players to join) before starting the arena, the number of seconds to wait until seekers can start
|
||||
seeking, the amount of time a game will last, the amount of seconds between each time the number of remaining hiders is
|
||||
announced, the number of seconds before the game ends the hiders will be given swords.
|
||||
|
||||
### Arena interface descriptions
|
||||
|
||||
#### maxPlayers
|
||||
|
||||
The maximum amount of players that can join this arena.
|
||||
|
||||
#### minPlayers
|
||||
|
||||
The minimum amount of players required for a round to start.
|
||||
|
||||
#### amountSeekersOnStart
|
||||
|
||||
The number of players made into seekers when the game starts.
|
||||
|
||||
#### timeInLobbyUntilStart
|
||||
|
||||
The amount of seconds to wait in the lobby until the game actually starts. During this time, players can use an item in
|
||||
their inventory to choose their hide block. Other players can join during this time, until the game starts.
|
||||
|
||||
#### waitingTimeSeeker
|
||||
|
||||
The number of seconds seekers have to wait before they are allowed to start seeking. This is basically how long the
|
||||
seekers count for until they start searching for the hiders.
|
||||
|
||||
#### gameTime
|
||||
|
||||
The amount of seconds a game will last. If the hiders are alive after this time, they win.
|
||||
|
||||
#### blockAnnouncerTime
|
||||
|
||||
The amount of seconds
|
||||
|
||||
#### sword
|
||||
|
||||
The amount of seconds to wait before allowing hiders to defend themselves with a wooden sword.
|
||||
Reference in New Issue
Block a user