###########################################################
#                                                         #
#     TravelGates Plugin v1.9.2 by Ghomerr [1.1-R2]       #
#                                                         #
###########################################################


This plugin is multilangual and uses a configuration file. 
This plugin must be used with Craftbukkit version 1.1-R1 or 1.1-R2. Previous version won't work. 


######################################################                                                                         
#                                                    #
#                 SETUP FROM SCRATCH                 #
#                                                    #
######################################################
Unzip the archive TravelGates-x.x.x.zip
Move the TravelGates-x.x.x.jar in your "plugins" directory (in the server directory)
Unzip the archive resources-x.x.x.zip
Create a directory named "TravelGates" in the previous "plugins" directory
Copy inside this directory the files : travelgates.conf file and the message_xx.lang of your choice (or make your own, see the section "LANGUAGE FILE" below)
Configure the configuration file as you want (see the next section below for information)
Start your server and enjoy !

If you have already installed this plugin:
    Keep your TravelGates directory to save your configuration and the saved destinations.
    Remove the old TravelGates-x.x.x.jar and replace it by the new one.
    Replace the language file if messages have been updated.
    

###########################################################
#                                                         #
#                   CONFIGURATION FILE                    #
#                                                         #
###########################################################

The configuration file is "travelgates.conf" and has to be placed in the "TravelGates" directory in your plugins directory.
"TravelGates" directory is created automatically if it does not exist.
If this directory is missing, you'd have to create it yourself because this plugin will be disabled if data can't be stored.
Each missing parameter will be ignored and the default value will be used. (See the example configuration file)

Configuration parameters:
    language                : set the languages of the players's messages. Has to be the same value as the message file name. (Example : language=en -> messages_en.lang)
    usepermissions          : (true/false) use PermissionsBukkit or PermissionsEx or Permissions 2x/3x (in that order, depending on what plugin you have)
    teleportwithsign        : (true/false) use the sign to teleport (right-click on a sign or target a sign while typing /tg) 
    teleportwithportal      : (true/false) use Nether Portals substitution 
    debug                   : (true/false) use to enable the debug mode when the plugin is loading.
    clearallinventory       : (true/false) use to clear the armor content when the "i" option is set to a destination
    tpblock                 : type[,data] use to select the teleport block:
                                - type = BEDROCK,BOOKSHELF,BRICK,CLAY,COAL_ORE,COBBLESTONE,DIAMOND_BLOCK,DIAMOND_ORE,DIRT,ENDER_STONE,FURNACE,GLASS,GLOWING_REDSTONE_ORE,GLOWSTONE,GOLD_BLOCK,GOLD_ORE,GRASS,GRAVEL,ICE,IRON_BLOCK,IRON_ORE,JACK_O_LANTERN,JUKEBOX,LAPIS_BLOCK,LAPIS_ORE,MELON_BLOCK,MOSSY_COBBLESTONE,MYCEL,NETHER_BRICK,NETHERRACK,NOTE_BLOCK,OBSIDIAN,PUMPKIN,REDSTONE,SAND,SANDSTONE,SMOOTH_BRICK,SNOW_BLOCK,SOUL_SAND,SPONGE,STONE,TNT,WOOD,WOOL,WORKBENCH
                                - data = all DyeColor for WOOL or TreeSpecies for WOOD

###########################################################
#                                                         #
#                       LANGUAGE FILE                     #
#                                                         #
###########################################################

You have to use a messages_xx.lang file corresponding to your language defined in the configuration file. 
The "xx" has to match with the value in the configuration file.
The messages file has to be placed in the TravelGates directory.
If the language file is missing, the default language field will be used, stored directly inside the plugin.


###########################################################
#                                                         #
#               PERMISSIONS CONFIGURATION                 #
#                                                         #
###########################################################

Permissions Compatibility : supports PermissionsBukkit, PermissionsEx and Permissions 2x/3x plugins (they will be searched in this order)
Permissions nodes are the followings:
# For admins:
travelgates.add         # Permission to add a Destination
travelgates.del         # Permission to remove a Destination
travelgates.admintp     # Permission to travel to an Admin's Destination
travelgates.save        # Permission to request an instant save of destinations and restrictions
travelgates.update      # Permission to update destination's data
travelgates.debug       # Permission to toggle the Debug Mode
travelgates.worlds      # Permission to display available loaded worlds
travelgates.config      # Permission to display the current configuration
travelgates.perms       # Permission to toogle permissions 
travelgates.signtp      # Permission to toggle the usage of sign teleportation
travelgates.portaltp    # Permission to toggle the usage of nether portal
travelgates.clearallinv # Permission to toggle the state of the option clear all inventory
travelgates.autosave    # Permission to toggle the auto save
travelgates.tpblock     # Perrmissions to modify the tp block
travelgates.forcetp     # Permissions to teleport from everywhere using /tg <dest>

# For users:
travelgates.teleportcmd     # Allow a player to use the command /tg <dest>
travelgates.teleporttarget  # Allow a player to use the command /tg while targetting a sign with a destination
travelgates.teleportsign    # Allow a player to use a TravelGates sign to teleport by clicking on it
travelgates.teleportportal  # Allow a player to use a TravelGates Nether Portal 
travelgates.list            # Allow a player to view the list of Destinations
travelgates.details         # Allow a player to view the detailed list of Destinations
travelgates.loc             # Allow a player to view the location of the Destination
travelgates.name            # Allow a player to view the name of the Destination where player is standing
travelgates.sign            # Allow a player to update the Portal Sign using a lever
travelgates.restrict        # Allow a player to display list of restricted destinations
travelgates.help            # Allow a player to view the Help


###########################################################
#                                                         #
#                  HOW TO USE THE PLUGIN                  #
#                                                         #
###########################################################   
    
Plugin in-game usage:
    Main command is "/travelgates" but you can use the alias listed below.
    All commands and destinations are case insensitive. (you can enter destinations without regarding if your destinations is lower case, UPPER CASE or bOtH !)
    Each command has several aliases, listed below.
    
    Admin commands:
    /tg add <destination> [-options] : add a destination. By default, the destination is the current players's Location AND direction (North/South/East/West) ! (Options are described below)
    /tg del <destination> [-s] : delete a destination
    /tg save : Force saving destinations
    /tg debug : Toggle the debug mode
    /tg options <destination> [-options] : update all desintation's options
    /tg update <destination> [-options] : same as /tg options
    /tg worlds : display available loaded worlds (to use with the -p option)
    /tg config : display current configuration
    /tg perms : toggle the permissions activation (reload permissions configuration if you enable them)
    /tg signtp : toggle the usage of sign to teleport 
    /tg portaltp : toggle the usage of the nether portal to teleport 
    /tg clearallinv : toggle the state of the clear all inventory option
    /tg autosave : toggle the auto save
    /tg tpblock : modify or toggle the tp block
   
   Users commands:
    /tg list : display all destinations available to the player.
    /tg details : display all destinations, their locations and options to the player.
    /tg loc <destination> : display the location of the destination.
    /tg name : display the name of the location where the player is standing.
    /tg help : display short help of the plugin.
    /tg <destination> [-f] : teleport player to the destination if he is standing on an existing location. If using -f, the teleportation can be done from everywhere.
    
    Other teleportation means:
    /tg while targetting a sign containing the name of an existing destination : do the same as /tg <destination>. The destination can be written at any line of the sign.
    Right click on a "TravelGates'" sign containing on a line [TG] or [TRAVELGATES] (case insensitive) and on another line or on the same line (order doesn't matter) the name of an existing destination : do the same as /tg <destination>.
    Use Nether Portals : Place a "TravelGates'" sign (see above) on a Nether Portal with the "-ON-" state (defined in language file), updated with a lever or directly by editing the sign, and use the Portal as usual. The sign has to be placed on an obsidian portal bloc facing the head of the player. You can place the destination on the Obsidian blocks or on blocks beside of the portal.
    Using a teleport block: You can be teleported if you use a teleportation block, for instance lime wool. You have to cover a rectangle surface containing the destination with this kind of block to be teleported. Max range around the destination is 5 block (6 with the destination block). All these block have to be at the same height. Just under the player location when the destination has been added.
    
Options in "add" or "options|update" commands:
    a = admin teleport only (only OP or Allowed players can travel to this destination)
    i = clear inventory while travelling to a destination (if the configuration "clearallinventory" is set to true, whole armor and the item wielded will be cleared too)
    s = force the save of new data (destinations, restrictions)
    p = set the position of your destination as following : -p(world,x,y,z) or -p(x,z,y). Conditions: -30M < x,z < +30M and 0 < y < MaxHeight and y = ? -> highest block
        (These commands with the -p option do not check the 'y' coordinate if you enter it. Use a "good" 'y' value. Use "?" if you don't know the max height.)
        (Becareful with negative coordinates. x=-5, for instance, while teleport you if your are from x=-4 to x=-5.)
        (When you type the height with this option, it will be decreased by one, because the displayed "y" value is higher than the value you can be teleported)
        -p() can be used to update a destination with the current player location
    r = set restricted destinations where players are allowed to go as following : -r{dest1,dest2,dest3}
    f = force the travel to teleport from everywhere
    
Commands aliases:
ADD: "a", "add" 
DEL: "dl", "rm", "del", "rem", "delete", "remove"
DETAILS: "dt", "det", "detail", "details"
HELP: "h", "help"
LIST: "ls", "list", "liste"
LOC: "lc", "loc", "location"
NAME: "n", "name" 
TRAVELGATES: "tg", "travelgates" 
SAVE: "s", "sv", "save"
UPDATE: "u", "o", "up", "opt", "update", "option", "options" 
DEBUG: "db","debug"
WORLDS: "w","world","worlds"
RESTRICT: "r","rst","restrict","restricts","restriction","restrictions"
CONFIG: "c","conf","config","configuration"
PERMS: "p","perm", "perms", "useperm", "useperms", "permission", "permissions", "usepermissions"
SIGNTP: "stp", "signtp", "signteleport", "teleportwithsign"
PORTALTP: "ptp", "portaltp", "portalteleport", "teleportwithportal"
CLEARALLINV: "cai", "clr", "clear", "clearall", "clearinv", "clearallinv", "clearallinventory"
AUTOSAVE: "as", "autosave"
TPBLOCK: "tpb", "tpblk", "tpblc", "tpblock", "tpbloc", "teleportblock"