Setup
- Download Star Mail. You can find the latest version here.
- Stop your server completely.
- Place the Star Mail jar in your server's plugins directory.
- Start your server, allowing the default configuration to be generated.
- Stop your server.
- Continue to Configuration.
After installing the plugin, the default config.yml file will be generated in your server's plugins/StarMail directory.
In the "Language file" section, paste the exact name of your selected language file from the locale directory. If you do not already see your language, you will need to translate your own. Feel free to send a copy to the Star Mail chat channel on the Discord.
Default Max Mailbox:
Defines the number of mailboxes each player can register. Players or groups can be granted a higher limit through the mail.boxes.[amount] permission.
Expiration Days:
Defines the days that data will be tracked. After the configured time has passed, the data will be deleted to free up space. Set to -1 to disable expiration.
Mailbox World Blacklist:
Defines the worlds that players can not place mailboxes in.
on Join Notification Delay (Ticks):
Defines the delay in ticks (1/20th of a second) for the on join notification.
Require Blocks Permission
When true, players will require permission nodes to use mail related blocks (mailbox, global mailbox, and postbox)
Show Crate Straps
When true, the crate texture will change to include straps when sealed.
Default Send Cooldown (Seconds)
Defines the default cooldown for sending mail. The cooldown can be overridden with the mail.cooldown.[int] permission. The smallest value found (including the default) will be the effective cooldown duration.
Instant Mail Send
When true, clicking on another player's mailbox will attempt to send mail instantly instead of opening a menu.
After installing the plugin, the default integrations.yml file will be generated in your server's plugins/StarMail directory.
Enable Dynmap:
When the "Enable Dynmap" setting is set to "true", dynmap features will be enabled if the dynmap plugin is detected.
Show Plot Markers by Default:
When "Show Plot Markers by Default" is set to "true", the mailbox marker set will be displayed by default when the dynmap webpage is loaded. The display can be toggled after the page is loaded.
Min Zoom:
The min zoom defines the minimum zoom at which icons will appear. Setting the min zoom to a negative value will result in no minimum zoom.
Max Zoom:
The max zoom defines the maximum zoom at which icons will appear. Setting the max zoom to a negative value will result in no maximum zoom.
After installing the plugin, the default items.yml file will be generated in your server's plugins/StarMail directory.
To define custom mailboxes and packages, you will need to generate values for the profile and texture fields. The profile field is a UUID. One way to generate a random UUID is to search "random UUID" in a search engine.
The texture field is a signed skin texture string. To generate the string you will need a png of your item's texture. To easily generate a valid image, you can use the editor here. Next, go to MineSkin.org, upload the file and click generate. After waiting for the skin to be signed, a menu will appear. Copy the texture data to use for the texture field.
To create custom letters, you will need to add textures to the Star Mail resource pack. Assign your letter and quill textures to even CustomModelDatas between 260 and 400 (exclusive). The written letter's CustomModelData should be one higher than the letter and quill texture. In the model field, copy the CustomModelData for the letter and quill texture.
If the Locale folder does not contain your target language, you will need to translate your own. To create a successful language file, follow these guidelines.
First, copy another language file to use as a template. Rename your copy using the language's ISO 639-1 code. A list of language codes can be found here.
When creating the translation, only edit the text on the right side of the colon. You should not translate any word surrounded by the "%" character.
If you want to contribute to Star Mail, you can help out by translating any unprovided language file. Send your files to the Star Mail chat channel on the Discord.