Improves setup description
This commit is contained in:
92
README.md
92
README.md
@@ -50,27 +50,27 @@ _**Note:** Instead of using /BlockHunt you could use:_
|
||||
|
||||
<> = Required [] = Optional
|
||||
|
||||
| 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 |
|
||||
| Command | Description | Permission | Default allowed |
|
||||
|--------------------------------------------------------------------|---------------------------------------------------|-----------------------------|----------------------------------------------|
|
||||
| `/BlockHunt [info/i]` | Displays the plugin's info. | blockhunt.info | All players have this permission by default. |
|
||||
| `/BlockHunt <help/h>` | Shows a list of commands. | blockhunt.help | All players have this permission by 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
|
||||
|
||||
@@ -100,11 +100,33 @@ and then left-click with the wand on the opposite corner. Make sure one corner i
|
||||
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.
|
||||
properties of the arena. See [this](#arena-interface-descriptions) for information about the various settable values.
|
||||
When you've set the values as wanted, click the book. In the inventory, put all blocks you want hiders to use.
|
||||
|
||||
The last step in the setup is to set the warps. Use `/bh sw lobby \<name>` to set the lobby at your current location.
|
||||
The lobby is the location players are teleported to after joining, before the arena starts. Use `/bh sw hiders \<name>`
|
||||
to set the hiders spawn. This is where hiders are teleported once the arena starts. Use `/bh sw seekers \<name>`
|
||||
to set the seekers location at your current location. The seekers location is where seekers are teleported when the
|
||||
arena starts. Choose a place where they cannot reach or see the hiders, as they are teleported to the hiders warp once
|
||||
they are allowed to start seeking. Use `/bh sw spawn \<name>` to set the locations players will go to when exiting the
|
||||
arena.
|
||||
|
||||
You can set up a join sign, which also displays current players, by creating a sign like:
|
||||
|
||||
1. \[BlockHunt]
|
||||
2. \<name>
|
||||
|
||||
You can set up a leave sign, by creating a sign, in the arena and/or lobby, like:
|
||||
|
||||
1. \[BlockHunt]
|
||||
2. Leave
|
||||
|
||||
You can set up a shop sign, by creating a sign like:
|
||||
|
||||
1. \[BlockHunt]
|
||||
2. Shop
|
||||
|
||||
Join your new arena with `/bh join \<name>`.
|
||||
|
||||
### Arena interface descriptions
|
||||
|
||||
@@ -136,8 +158,20 @@ The amount of seconds a game will last. If the hiders are alive after this time,
|
||||
|
||||
#### blockAnnouncerTime
|
||||
|
||||
The amount of seconds
|
||||
The amount of seconds left when announcing the number of currently hiding players.
|
||||
|
||||
#### sword
|
||||
#### timeUntilHidersSword
|
||||
|
||||
The amount of seconds to wait before allowing hiders to defend themselves with a wooden sword.
|
||||
The amount of seconds to wait before allowing hiders to defend themselves with a wooden sword.
|
||||
|
||||
#### hidersTokenWin
|
||||
|
||||
The number of tokens rewarded if the hiders win.
|
||||
|
||||
#### seekersTokenWin
|
||||
|
||||
The number of tokens rewarded if the seekers win.
|
||||
|
||||
#### killTokens
|
||||
|
||||
The number of tokens rewarded if a seeker kills a hider.
|
||||
Reference in New Issue
Block a user