Skip to content

Messages

Denis Istratov edited this page Jul 28, 2023 · 2 revisions

Using MiniMessages format

Sample usage

messages.yml in resource (jar) folder:

error: "<red>Error!</red>"
someRoot:
  message1: "<green>Hi, %name%!</green>"
  message2:
    - "<green>Message start!</green>"
    - "<green>End!</green>"

Using in plugin:

@Override
public void onEnable() {
      Messages messages = Messages.of(this); //Init Messages
      CommandSender sender = ...; //Getting CommandSender
      messages.get("error").send(sender); //Getting error message
      messages.get("someRoot.message1").replaceAll("%name%", sender.getName()).send(sender); //Getting someRoot.message1 message
      messages.get("someRoot.message2").send(sender); //Getting someRoot.message2 message
}

Ways of getting Message object

1. Load messages.yml from jar by default

Messages messages = Messages.of(this);

2. Load custom file from jar by default

Messages messages = Messages.of(this, "filename.yml");

3. Load using ConfigurationSection

Messages messages = Messages.of(getConfig().getConfigurationSection("messages"), this);

For old versions(<1.18)

Messages messages = Messages.legacy(this); //the creation methods are similar to '.of' methods

Clone this wiki locally