Documentation and readme updated.
This commit is contained in:
35
doc/Commands.md
Normal file
35
doc/Commands.md
Normal file
@ -0,0 +1,35 @@
|
||||
* __/gate close, c [id]__
|
||||
Closes a gate to prevent players from using it.
|
||||
|
||||
* __/gate delete, del, remove [id]__
|
||||
Removes the gate from the game.
|
||||
|
||||
* __/gate exit, e [id]__
|
||||
Changes the location where the gate will teleport players to your current location.
|
||||
|
||||
* __/gate help, ? [page]__
|
||||
Prints help pages.
|
||||
|
||||
* __/gate hide, h [id]__
|
||||
Makes a gate NOT consist of gate blocks while open.
|
||||
|
||||
* __/gate info, i [id]__
|
||||
Prints details about a certain gate.
|
||||
|
||||
* __/gate list, ls [page]__
|
||||
Prints all available gates.
|
||||
|
||||
* __/gate location, lo [id]__
|
||||
Sets the entrance of the gate to your current location.
|
||||
|
||||
* __/gate new, n [id]__
|
||||
Creates a gate at your current location.
|
||||
|
||||
* __/gate open, o [id]__
|
||||
Open a gate so players can use it.
|
||||
|
||||
* __/gate rename, rn [current name] [new name]__
|
||||
Changes the name/id of the gate.
|
||||
|
||||
* __/gate unhide,uh [id]__
|
||||
Makes that gate visible.
|
51
doc/Configuration.md
Normal file
51
doc/Configuration.md
Normal file
@ -0,0 +1,51 @@
|
||||
Starting with version 2.2.0 some features are customizable via a configuration file.
|
||||
|
||||
The configuration file will be automatically created on the the first startup after
|
||||
installing or updating the plugin.
|
||||
|
||||
|
||||
The following keys and values are available:
|
||||
|
||||
|
||||
* __maxGateBlocks__
|
||||
A positive integer defining the maximum number of blocks a gate can consist of.
|
||||
Note that increasing this value might slow down your server!
|
||||
|
||||
|
||||
* __playerGateBlockUpdateRadius__
|
||||
Defines the radius around a player where portal blocks are visible to that player.
|
||||
Adjust this value when increasing or decreasing the view-distance on the server.
|
||||
Only positive integer values are allowed.
|
||||
|
||||
|
||||
* __checkForBrokenGateFrames__
|
||||
Allowed values are _true_ and _false_ only. Setting this value to _false_ will disable
|
||||
all checks for broken frames for non-hidden gates. Disabling frame block checks
|
||||
might increase you server performance.
|
||||
|
||||
|
||||
* __saveOnChanges__
|
||||
Allowed values are _true_ and _false_ only. Disabling _save on changes_ might
|
||||
increase server performance but gates will only be saved to disk when the plugin
|
||||
gets disabled! This might lead to data loss on error.
|
||||
|
||||
|
||||
* __gateTeleportMessage__
|
||||
A string value going to displayed every time when a player travels using a gate. Will
|
||||
only be displayed if _showTeleportMessage_ is set to _true_.
|
||||
|
||||
|
||||
* __showTeleportMessage__
|
||||
A boolean (_true_ or _false_) determining wether the _teleport message_ will
|
||||
be displayed.
|
||||
|
||||
|
||||
* __gateTeleportNoPermissionMessage__
|
||||
A string value going to displayed every time when a player enters a gate and is not
|
||||
allowed to use that gate. Will only be displayed if _showTeleportNoPermissionMessage_
|
||||
is set to _true_.
|
||||
|
||||
|
||||
* __showTeleportNoPermissionMessage__
|
||||
A boolean (_true_ or _false_) determining wether the _no permission message_ will
|
||||
be displayed.
|
12
doc/Permissions.md
Normal file
12
doc/Permissions.md
Normal file
@ -0,0 +1,12 @@
|
||||
The following permissions are available: (Also have a look at the [Commands Page](http://dev.bukkit.org/bukkit-plugins/craftinc-gates/pages/commands/) to see if which commands can be executed with which permission set.)
|
||||
|
||||
* __craftincgates.info__
|
||||
Gives access to info and list commands.
|
||||
|
||||
* __craftincgates.use__
|
||||
Allows you to travel via gates.
|
||||
|
||||
* __craftincgates.manage__
|
||||
Gives access to commands manipulating gates.
|
||||
|
||||
Craft Inc. Gates will use __[Vault](http://dev.bukkit.org/bukkit-mods/vault/)__'s permission system if Vault is installed on your server.
|
Reference in New Issue
Block a user