Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 1.38 KB

Message.md

File metadata and controls

36 lines (26 loc) · 1.38 KB
Raw

Message Library

The message library provides a service for managing translatable messages that support argument placeholders.

QuickStart

  • Note: Complete documentation is being worked on, and it will take us some time to write everything out. If you have any questions, feel free to ask in the #flashlibs channel on Discord

This library has two classes: MessageService for retrieving messages, and MessageTemplate for handling arguments. The format for arguments is ${<format>@<key>}, such as ${&a@player}. Missing arguments will render as @key in the appropriate style.

A MessageService requires a TranslationService from the Translation Library.

TranslationService translations;
MessageService messages = MessageService.of(translations);

The Plugin library can automatically provide a MessageService for your plugin.

The remaining documentation hasn't been written yet, but it should be feasible to piece together things using the javadocs. If you have any questions feel free to ask on Discord. If you'd like to help write documentation we would greatly appreciate it!