Bukkit

Requirements

The current version of Postal will generally require the current Java, and recent developer builds of Citizen2 and Craftbukkit. Postal has an optional softdepend on Vault for permissions.

Latest dev. build Citizens2

Installation

Copy va_postal to the plugins directory.

Postal is dependent on Citizens2, so be sure to include it and make sure it is a valid installation.

By default, the postal system does not automatically start when the server starts. This can be changed in 'config.yml'. You don't want it to start anyway because there is nothing to do yet. '/postal start' starts it, but don't do that yet. Btw, '/postal' (no params) lists the postal commands.

The Minimum

• A central post office, with chest.

• One local post office, with chest.

• One address, with chest.

Initial Steps

• 1) As op'd player, go to the spot where you want the central post office and place a chest then enter '/setcentral'.

• 2) As op'd player go to where you want a local post office and place a chest then enter '/setlocal <PostOffice_Name>'.

• 3a) As op'd player, go to an address that this post office will service and place a chest then enter '/setaddr <Address_Name>' Postal will automatically pick the closest post office for you. All names should be 15 characters or less, all one word. Separate words using the underscore ie: 'Sunshine_Bay'

• 3b) Complete the address definition by marking the route waypoints that you want the post man to use. As op'd player enter '/setroute' while standing within 10 blocks of the address you just defined. You will enter the waypoint editor and, since this is a new route, you will be teleported to the post office. Left click points on the ground for the postman to follow to this new address. Your quickbar has been cleared and you will have a compass prominently pointing the way to the address to keep you from getting lost. If your version of Postal is current, you will have a HUD reporter giving you real-time distance stats, etc... Your waypoints will be highlighted and you may easily undo the last waypoint by right clicking it. Mark your final waypoint in front of your mailbox. It can be inside, or outside a building. Double click on this last waypoint, or enter '/exit' to exit the waypoint editor.

• 4) Go! '/postal start'

Finding Addresses

'/tlist' will list the names of the towns. '/alist' with no parameters will list the addresses of the post office you are closest to. '/alist <town>' will list the addresses in that town. '/plist' with no parameters will list players in, in order of proximity and the Postal address they are closest to. Using '/plist' with a partial or whole player name will list matching player addresses. '/gps' with no parameters lists the Postal address you are near, in order of closeness. '/gps' with a parameter(s) will set your compass to the requested PO/address. All the commands, where appropriate, are pretty good at completing town and address names with the minimum amount of typing.

Sending Mail

Using Book and Quill, write a letter and sign it. Take this book and type '/addr <town> <address>' This addresses the letter. Mistakes can be fixed by simply using the 'addr' command again. Now this book can be placed in any designated mailbox (chest), including post office chests. For the above example, put it in the central post office so you can see the postmaster manage out-of-town mail.

Item Shipment

Chests are used as shipping containers. Place a single chest anywhere you want to pack it. It can be inside a building or by the mailbox – it does not matter. When ready to ship, position right next to it and enter ‘/package <town> <address> [player]’. This will create a shipping label and put it in your hand. This shipping label you are holding may be placed in any mailbox to actually ship this chest.

The shipment remains where it is until the postman picks up the shipping label. When the shipping label is in the postman’s hand the chest will vanish because it is now in the postal system. It will be delivered like normal book mail.

The recipient now has the shipping label that has a complete statement describing the chest contents. The shipment may either be accepted or refused. To receive, walk to a location where you would like to place the shipment and type ‘/accept’. The shipment will appear directly in front of you. Postal will also stack chests for you if need to deal with many chests.

Alternatively, the shipment may be refused. To do so, simply type ‘/refuse’ with the shipping label in your hand and the shipment will be returned to the sender.

To include a personalized note with the shipping label, hold a written book that contains the message you want to include when you invoke the /package command. The message in this book will be included with the formal shipping label.

Central Post Office

The central post office does not service any local addresses or routes. The postmaster's routes are the local post offices. The only requirement the postmaster has is a nearby chest, preferably a double chest. The central post office may be combined with a local post office however.

If your design plan has central post office as a formal, main post office servicing a community just create the post office as you would a local post office and give the postmaster his own office, or corner with a chest. Enter '/setcentral' in his space. He will happily watch over the local post office and delegate the local routes to a postman, as well as do his international route duties. That post office will get slightly better sevice too.