GH-991 Add MOTD feature (#1094)

* Add MOTD feature

* fix example motd content

* Review.

* Fix.

* Move MOTD to message files

* Fix.

* Remove duplicated title.

---------

Co-authored-by: vLuckyyy <[email protected]>

Author: Jakubk15

eternalcore-core/src/main/java/com/eternalcode/core/feature/joinmessage/PlayerJoinMessageController.java

@@ -41,12 +41,6 @@ void onPlayerJoin(PlayerJoinEvent event) {
                 .send();
         }
 
-        this.noticeService.create()
-            .notice(translation -> translation.event().welcome())
-            .placeholder("{PLAYER}", player.getName())
-            .player(player.getUniqueId())
-            .sendAsync();
-
         event.setJoinMessage(StringUtils.EMPTY);
 
         this.noticeService.create()

eternalcore-core/src/main/java/com/eternalcode/core/feature/motd/MotdJoinController.java

@@ -0,0 +1,42 @@
+package com.eternalcode.core.feature.motd;
+
+import com.eternalcode.core.feature.motd.messages.MotdMessages;
+import com.eternalcode.core.injector.annotations.Inject;
+import com.eternalcode.core.injector.annotations.component.Controller;
+import com.eternalcode.core.notice.NoticeService;
+import com.eternalcode.core.placeholder.Placeholders;
+import org.bukkit.entity.Player;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.Listener;
+import org.bukkit.event.player.PlayerJoinEvent;
+
+@SuppressWarnings("Convert2MethodRef")
+@Controller
+class MotdJoinController implements Listener {
+
+    private static final Placeholders<Player> PLACEHOLDERS = Placeholders.<Player>builder()
+        .with("{PLAYER}", player -> player.getName())
+        .with("{TIME}", player -> String.valueOf(player.getWorld().getTime()))
+        .with("{WORLD}", player -> player.getWorld().getName())
+        .build();
+
+    private final NoticeService noticeService;
+    private final MotdMessages motdMessages;
+
+    @Inject
+    MotdJoinController(NoticeService noticeService, MotdMessages motdMessages) {
+        this.noticeService = noticeService;
+        this.motdMessages = motdMessages;
+    }
+
+    @EventHandler
+    void onPlayerJoin(PlayerJoinEvent event) {
+        Player player = event.getPlayer();
+
+        this.noticeService.create()
+            .notice(this.motdMessages.motdContent())
+            .player(player.getUniqueId())
+            .formatter(PLACEHOLDERS.toFormatter(player))
+            .send();
+    }
+}

eternalcore-core/src/main/java/com/eternalcode/core/feature/motd/messages/ENMotdMessages.java

@@ -0,0 +1,32 @@
+package com.eternalcode.core.feature.motd.messages;
+
+import com.eternalcode.multification.bukkit.notice.BukkitNotice;
+import com.eternalcode.multification.notice.Notice;
+import eu.okaeri.configs.OkaeriConfig;
+import eu.okaeri.configs.annotation.Comment;
+import lombok.Getter;
+import lombok.experimental.Accessors;
+import org.bukkit.Sound;
+
+import java.util.List;
+
+@Getter
+@Accessors(fluent = true)
+public class ENMotdMessages extends OkaeriConfig implements MotdMessages {
+
+    @Comment("# Message of the Day (MOTD) content that will be sent to players when they join the server.")
+    @Comment("# Out of the box supported placeholders: {PLAYER}, {WORLD}, {TIME}")
+    @Comment("# You can add your own placeholders using the PlaceholderAPI.")
+    @Comment("# You can check our Notification Generator: https://www.eternalcode.pl/notification-generator")
+    public Notice motdContent = BukkitNotice.builder()
+        .chat(List.of(
+                "<green>Welcome to the server,</green> <gradient:#ee1d1d:#f1b722>{PLAYER}</gradient>",
+                "<green>Have a good time playing!</green>",
+                "<green>The current time in {WORLD} is: </green><gradient:#2c60d5:#742ccf>{TIME}</gradient> <green>ticks",
+                "<green>If you need any help, don't hesitate to ask our staff using the </green><dark_green><click:suggest_command:'/helpop'>/helpop</click> command!</dark_green>"
+            )
+        )
+        .title("<gradient:#9d6eef:#A1AAFF:#9d6eef>EternalCore</gradient>", "<white>Welcome back to the server!")
+        .sound(Sound.BLOCK_NOTE_BLOCK_PLING)
+        .build();
+}

eternalcore-core/src/main/java/com/eternalcode/core/feature/motd/messages/MotdMessages.java

@@ -0,0 +1,8 @@
+package com.eternalcode.core.feature.motd.messages;
+
+import com.eternalcode.multification.notice.Notice;
+
+public interface MotdMessages {
+
+    Notice motdContent();
+}

eternalcore-core/src/main/java/com/eternalcode/core/feature/motd/messages/PLMotdMessages.java

@@ -0,0 +1,32 @@
+package com.eternalcode.core.feature.motd.messages;
+
+import com.eternalcode.multification.bukkit.notice.BukkitNotice;
+import com.eternalcode.multification.notice.Notice;
+import eu.okaeri.configs.OkaeriConfig;
+import eu.okaeri.configs.annotation.Comment;
+import lombok.Getter;
+import lombok.experimental.Accessors;
+import org.bukkit.Sound;
+
+import java.util.List;
+
+@Getter
+@Accessors(fluent = true)
+public class PLMotdMessages extends OkaeriConfig implements MotdMessages {
+
+    @Comment("# Treść wiadomości dnia (MOTD), która zostanie wysłana do graczy po wejściu na serwer.")
+    @Comment("# Domyślnie obsługiwane placeholdery: {PLAYER}, {WORLD}, {TIME}")
+    @Comment("# Możesz dodać własne placeholdery korzystając z PlaceholderAPI.")
+    @Comment("# Generator powiadomień znajdziesz tutaj: https://www.eternalcode.pl/notification-generator")
+    public Notice motdContent = BukkitNotice.builder()
+        .chat(List.of(
+                "<green>Witaj na serwerze,</green> <gradient:#ee1d1d:#f1b722>{PLAYER}</gradient>",
+                "<green>Miłej zabawy!</green>",
+                "<green>Aktualny czas w {WORLD} to: </green><gradient:#2c60d5:#742ccf>{TIME}</gradient> <green>tików",
+                "<green>Jeśli potrzebujesz pomocy, napisz do administracji komendą </green><dark_green><click:suggest_command:'/helpop'>/helpop</click></dark_green>"
+            )
+        )
+        .title("<gradient:#9d6eef:#A1AAFF:#9d6eef>EternalCore</gradient>", "<white>Witamy ponownie na serwerze!")
+        .sound(Sound.BLOCK_NOTE_BLOCK_PLING)
+        .build();
+}

eternalcore-core/src/main/java/com/eternalcode/core/translation/Translation.java

@@ -13,6 +13,7 @@
 import com.eternalcode.core.feature.itemedit.messages.ItemEditMessages;
 import com.eternalcode.core.feature.jail.messages.JailMessages;
 import com.eternalcode.core.feature.language.Language;
+import com.eternalcode.core.feature.motd.messages.MotdMessages;
 import com.eternalcode.core.feature.msg.messages.MsgMessages;
 import com.eternalcode.core.feature.randomteleport.messages.RandomTeleportMessages;
 import com.eternalcode.core.feature.seen.messages.SeenMessages;
@@ -99,8 +100,6 @@ interface EventSection {
         List<Notice> firstJoinMessage();
 
         Map<EntityDamageEvent.DamageCause, List<Notice>> deathMessageByDamageCause();
-
-        Notice welcome();
     }
 
     interface InventorySection {
@@ -258,4 +257,6 @@ interface ContainerSection {
     BurnMessages burn();
     // vanish section
     VanishMessages vanish();
+    // motd section
+    MotdMessages motd();
 }

eternalcore-core/src/main/java/com/eternalcode/core/translation/implementation/ENTranslation.java

@@ -13,6 +13,7 @@
 import com.eternalcode.core.feature.itemedit.messages.ENItemEditMessages;
 import com.eternalcode.core.feature.jail.messages.ENJailMessages;
 import com.eternalcode.core.feature.language.Language;
+import com.eternalcode.core.feature.motd.messages.ENMotdMessages;
 import com.eternalcode.core.feature.msg.messages.ENMsgMessages;
 import com.eternalcode.core.feature.randomteleport.messages.ENRandomTeleportMessages;
 import com.eternalcode.core.feature.seen.messages.ENSeenMessages;
@@ -356,9 +357,6 @@ public static class ENEventSection extends OkaeriConfig implements EventSection
             Notice.actionbar("<red>► {PLAYER} <white>logged off the server!"),
             Notice.actionbar("<red>► {PLAYER} <white>left the server!")
         );
-
-        @Comment({" ", "# {PLAYER} - Player who joined"})
-        public Notice welcome = Notice.title("<yellow>EternalCode.pl", "<yellow>Welcome back to the server!");
     }
 
 
@@ -578,4 +576,7 @@ public static class ENLanguageSection extends OkaeriConfig implements LanguageSe
 
     @Comment({" ", "# This section is responsible for vanish-related stuff."})
     public ENVanishMessages vanish = new ENVanishMessages();
+
+    @Comment({" ", "# This section is responsible for the messages of the MOTD feature."})
+    public ENMotdMessages motd = new ENMotdMessages();
 }

eternalcore-core/src/main/java/com/eternalcode/core/translation/implementation/PLTranslation.java

@@ -13,6 +13,7 @@
 import com.eternalcode.core.feature.itemedit.messages.PLItemEditMessages;
 import com.eternalcode.core.feature.jail.messages.PLJailMessages;
 import com.eternalcode.core.feature.language.Language;
+import com.eternalcode.core.feature.motd.messages.PLMotdMessages;
 import com.eternalcode.core.feature.msg.messages.PLMsgMessages;
 import com.eternalcode.core.feature.randomteleport.messages.PLRandomTeleportMessages;
 import com.eternalcode.core.feature.seen.messages.PLSeenMessages;
@@ -376,9 +377,6 @@ public static class PLEventSection extends OkaeriConfig implements EventSection
             Notice.actionbar("<red>► {PLAYER} <white>wylogował się z serwera!"),
             Notice.actionbar("<red>► {PLAYER} <white>opuścił serwer!")
         );
-
-        @Comment({" ", "# {PLAYER} - Gracz który dołączył do serwera"})
-        public Notice welcome = Notice.title("<yellow>{PLAYER}", "<yellow>Witaj ponownie na serwerze!");
     }
 
     @Comment({
@@ -602,4 +600,7 @@ public static class PLLanguageSection extends OkaeriConfig implements LanguageSe
 
     @Comment({" ", "# Ta sekcja odpowiada za wiadomości dotyczące trybu niewidoczności graczy"})
     public PLVanishMessages vanish = new PLVanishMessages();
+
+    @Comment({" ", "# Ta sekcja odpowiada za funkcję MOTD (Message of the Day)"})
+    public PLMotdMessages motd = new PLMotdMessages();
 }