TransitAnnounce

Basics

Each transit line (be it Minecart trains, Warp-based buses or other forms of transport) or group of lines is represented by a single-word code and an extended name. For example, the Blue Line might have the code 'b', whilst the entire network of official server lines (Red, Blue, Green, Yellow) might have the code 'official' and the extended name Official Lines.

Any line may have any number of 'child' lines, representing grouping of lines into specific networks that might be affected by disruptions simultaneously. Carrying on the previous example, the Red, Blue, Green and Yellow lines would all be children of the Official Lines line, whilst bus lines would be children of the bus line, player-made transit systems would be grouped by design, etc. This means that some 'lines' within the system would not themselves represent a specific individual line, but I will continue using the term for the sake of continuity.

Once the lines have been recorded on the plugin, alerts can then be set for specific lines describing the nature of the disruption on that line. Alerts set for parent lines filter down into their children lines, so issues that affect an entire design of transit system can be easily handled without having to set the alert for each line individually. Upon joining the server the player would be presented by a brief notice alerting them to the number of lines experiencing issues at present (but without going into detail since this would get messy for large numbers of issues). The player can then use commands to view the alerts for specific lines at their discretion.

Instructions

To install TransitAnnounce simply place TransitAnnounce.jar into the plugins folder of CraftBukkit and you should be good to go!

Commands

• /transit add [code] [name] - Add a new line with the specified code and extended name.
• /transit remove [code] - Remove the specified line.
• /transit child add [parent code] [child code] - Link the specified child to the specified parent.
• /transit child remove [child code] - Unlink the specified child from its parent.
• /transit alert set [code] [message] - Set the alert message for the specified line.
• /transit alert unset [code] - Clear the alert for the specified line.
• /transit list - List all of the root lines on the plugin (ie. those without a parent), their codes and how many children they have.
• /transit list [code] - Identical to the previous command, but only lists the children of the specified line.
• /transit check - Provides a list of lines with alerts currently set.
• /transit check [code] - Prints the alert for the specified line (if any). Any alerts for parent lines are also printed.

Permissions

• transit.* - Access to all commands.
• transit.line.* - Access to the /transit add and /transit remove commands.
• transit.line.add - Access to the /transit add command.
• transit.line.remove - Access to the /transit remove command.
• transit.child.* - Access to all the /transit child commands.
• transit.child.add - Access to the /transit child add command.
• transit.child.remove - Access to the /transit child remove command.
• transit.alert.* - Access to all the /transit alert commands.
• transit.alert.set - Access to the /transit alert set command.
• transit.alert.unset - Access to the /transit alert unset command.
• transit.list - Access to the /transit list command.
• transit.check - Access to the /transit check command.

Config.yml

• joinalert - Boolean value. Inform the user of alerts upon joining the server.
• broadcast - Boolean value. Broadcast changes to alerts to the entire server.

Lines.yml

• <code> - The root key for each line. The name of the key is the code for the line.
  • name - Required string value. The extended name of the line.
  • alert - Optional string value. The current alert string for the line.
  • parentcode - Optional string value. The code of the line's parent.