Configuration Explanation

Initial Configuration

Contents

• Language File
• Language File Description Table
• Variables

HelpTicket Language File (top)

All configuration user interaction of Mail are stored in language.yml file. To use colors please reference the default minecraft color coding conventions @ http://www.minecraftwiki.net/wiki/Classic_server_protocol#Color_Codes. Colors will work with all nodes unless stated otherwise

This is a copy of the default file:

header: '&7[&cMail&7] &f'
mail:
  inbox:
    new:
      general: '&aYou have got a message!'
      singular: '&fYou have &a%numMessages new message &fin your mailbox!'
      plural: '&fYou have &a%numMessages new messages &fin your mailbox!'
    check: '&fUse &b/mail &fto check your inbox.'
    empty:
      general: '&fYour inbox is empty!'
      other: '&f%player''s inbox is empty!'
  delete:
    singular: '&fSuccessfully deleted message number &a%messageNumber!'
    plural: '&fSuccessfully deleted all your mail'
  sent: '&fYour message has been sent to &a%messageReceiver - %messageMessage'
  message:
    long: '&7[%messageLocalIndex] &f%messageSender: &7%messageLongMessage &8[%messageSendDate&8]'
    short: '&7[%messageLocalIndex] &f%messageSender: &7%messageShortMessage'
  error:
    permissions: '&cYou do not have permissions to do that'
    help: '&eInvalid Syntax, use "/mail ?" for help.'
    invalid_selected: '&cThat message doesn''t exist.'
    not_long_enough: '&cYour message has to be longer then &4%messageLength words'
  command:
    header: '&c--[Mail Command Help]--'
    command: '&3%command: &b%explanation'

Language file description table (top)

The language file may look daunting however here is an explanation of every node available.

Node	Description
header	The value of this node will be used in all user interaction as a precursor to the message
mail.new.general	General new mail message sent when a new mail is received
mail.new.singular	Sent when you login This will be shown when the number of messages is 1 Allowed variables include: %numMesssages
mail.new.plural	Sent when you login This will be shown when the number of messages are greater then 1 Allowed variables include: %numMesssages
mail.inbox.check	Generic message to check your inbox
mail.empty.general	Generic empty inbox message
mail.empty.other	Generic empty inbox message when looking at others inbox'
mail.delete.singular	Message shown when deleting a single message from your inbox Allowed variables include: %messageNumber
mail.delete.plural	Message shown when deleting all messages from your inbox
mail.sent	Message sent to you when you send a message Allowed variables include: %messageReceiver, %messageMessage
mail.message.long	Long message shown when reading a specific message Allowed variables include: %messageId, %messageLocalIndex, %messageSender, %messageLongMessage, %messageShortMessage, %messageSendDate
mail.message.short	short message shown when viewing multiple messages Allowed variables include: %messageId, %messageLocalIndex, %messageSender, %messageLongMessage, %messageShortMessage, %messageSendDate
mail.error.permissions	Message sent when a user doesn't have permissions for a command
mail.error.help	Help Message sent when a command is entered incorrectly
mail.error.invalid_selected	Sent when a requested message does not exist
mail.error.not_long_enough	Sent when you sent a mail under 3 words Allowed variables include: %messageLength
mail.command.header	Header of /mail help
mail.command.command	Content of /mail help. This will be used as a template for the commands Allowed variables include: %command, %explanation

Variables (top)

Some explaination's of variables used int he language.yml

Variable	Description
%messageId	The Database Id of the Message
%messageLocalId	Localized id of the message in regards to all the players open mail
%messageSender	Sender of the message
%messageReceiver	Receiver of the message
%messageLongMessage	Contents of the message
%messageShortMessage	First 30 characters of the contents of the message
%messageSendDate	Date that the message was sent