Features
Star Mail is compatible with Dynamp. Dynmap is a web based map for Minecraft servers. You can download it here. Dynmap behaviour can be edited in the integrations.yml file.
To learn more about configuring your Dynmap, go to the configuration page here.
By default, players can send three types of mail: letters, written books, and packages. However, players with the mail.custom permission can send any item as mail.
Letters will only be enabled in setups using Minecraft 1.14 and up. Letters are similar to books, but can be crafted for cheaper. Unlike books, letter can not be placed in lecterns or used in other crafting recipes, such as those for copying written books.
Letters use the new custom model data to work with the Star Mail resource pack downloadable here.
Packages are used to send groups of items in the mail. Packages come in three types: crates, chests, and gifts. Right click with an empty package to open up a menu. Place the items you want to send in the menu, then click on the seal button. Once the package is sealed, the items will be tracked using the tracking number on the item.
Right click on a sealed package to open a menu. Click on any string to cut it and open the package. Once opened, all the items can be collected by clicking on the fishing pole, or by closing the menu. Once the package is empty, it will be consumed in a poof of smoke.
Packages can also be used to decorate. Right click on an empty package while sneaking to place it! Sealed packages can not be placed.
Information about both packages and sent mail are tracked and stored while the server is offline. To prevent large amounts of data from building up, a tracking expiration is used. This prevents inactive mail from taking up lots of space. By default, mail and packages are tracked for 30 days. The number of days until expiration is configurable in the config.yml file.
To register a mailboxes, players simply need to place a mailbox block. By default, each player can register one mailbox. Clicking on your mailbox will open a menu for viewing and collecting received mail.
Clicking on another player's mailbox will open a menu. Insert a valid mail item and click the arrow to send mail.
The menu will not open if the instant send option has been enabled in the config. Instead, clicking on another player's mailbox will instantly send valid mail items. Clicking on another player's mailbox without an item will display the owner of the mailbox.
Mailboxes will will send the owning player notifications when mail is received and shortly after joining. Players can disable these notifications in the mailbox menu.
The globalbox is a globally usable mailbox. Interacting with a globalbox will open the mail collection menu.
Star Mail makes it possible to access and send mail from anywhere. Players with sufficient permission can send mail using the /sento [player] command. The /mail command will open a virtual mailbox to access sent mail.
The postbox is a block that allows players to send mail to any other player. The post box comes in 5 varieties: BLUE, GREEN, RED, SPACE, and DEFAULT.
Interacting with the block will open a menu. The menu has three pages. The first page is titled "Insert Mail". On this page, the user must place valid mail items in the empty slots. After doing so, the user can move on to the next page.
The second page is titled "To: ". On this page, the user must use the keyboard to type out the target player's username. The closest online player's name will be suggested. Once the target user is typed or suggested, the user can move on to the final page.
The final page is titled "Send Mail". On this page, the user must click on one of the arrows to send the mail. After doing so, a short animation will play and the user will be taken back to the first page.
The warehouse stores mail entries that can be sent to players using the /warehouse send command. Storing a package in the warehouse will prevent the tracking number from expiring as long as the package remains in the warehouse. Admins can edit a warehouse entry by using the /warehouse edit command. The command will open a menu.
Item Page:
The Item page allows the user to change the item stored in the warehouse.
Contents Page:
The Contents page will only appear if the entry item is a sealed package. Updating the package's content will change the contents for all existing packages with the same tracking number. It will also update the content lore on any package being sent from the warehouse. Existing packages will not have their lore updated.
Style Page:
The Style page will only appear if the entry item is a sealed package or written letter. Selecting a different style will update the name of sealed packages without a custom name.
From Page:
The From page is used to change the name that appears after the "From: " text in the recipient's mailbox. Any item with a custom name can be used to update the text.
From version 2.1.0, StarMail introduces the Blacklist feature!
With this system, you'll be able to ban specific items from being sent via email. The blacklist is configured in the file located at StarMail/plugins/blacklist.yml. Inside this file, you'll find a list of attributes identify a specified banned item.
For each line in the blacklist, it will be possible to ban up to 3 attributes: name, type or description. it is possible to select, even more than one of them using the pipe character. Here are some examples:
/blacklist add type|name
/blacklist add type
/blacklist add name|description
...
Specifically, any item that will have the match with all the listed attributes will be banned.
Example 1: If I were to ban the NAME attribute of the item named “Axe,” then all items named “Axe” will be banned.
Example 2: If I were to ban the TYPE attribute of the item having type “DIAMOND_AXE”, then all items having type “DIAMOND_AXE” will be banned.
The same reasoning applies if more attributes were specified.