GH-5: Chat component support (#14)

Author: tajobe

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## [Unreleased]
 ### Added
+- GH-5: JSON Chat Component (JSON) support in messages (@tajobe)
+  - Uses legacy conversion for Boss and Title announcements, full component support for Chat
 - GH-4: Sound support (@tajobe)
 - GH-3: Title type announcement sender (@tajobe)
 - MIT license

README.md

@@ -34,7 +34,7 @@ Messages can be sent server-wide or controlled by permissions after a delay and
     - ...additional options depending on announcement type
   - `Chat` type announcement:
     - `messages`(ChatMessage list): Message(s) to send
-      - `message`(string): message string
+      - `message`([Chat Component]): message component (plain text, or json, see examples)
       - `sound`(SoundConfig, optional): Override announcement SoundConfig
   - `Boss` type announcement:
     - `hold`(duration*): Time for boss bar to be on screen
@@ -43,16 +43,16 @@ Messages can be sent server-wide or controlled by permissions after a delay and
     - `animate`(boolean): if bar should animate over hold time
     - `reverseAnimation`(boolean): if animation should be reversed
     - `messages`(BossBarMessage list):
-      - `message`(string): message string
+      - `message`([Chat Component]): message component (plain text, or json, see examples)
       - `sound`(SoundConfig, optional): Override announcement SoundConfig
       - ...boss bar config overrides per message eg hold, color, style, animate, etc...
   - `Title` type announcement:
     - `fadeIn`(duration*): Time it takes for title to fade in
     - `stay`(duration*): Time for title to stay on screen
     - `fadeOut`(duration*): Time it takes for title to fade out
     - `messages`(TitleMessage list):
-      - `title`(string): title string
-      - `subtitle`(string): subtitle string, appears below title slightly smaller
+      - `title`([Chat Component]): title component (plain text, or json, see examples)
+      - `subtitle`([Chat Component]): subtitle component (plain text, or json, see examples), appears below title slightly smaller
       - `sound`(SoundConfig, optional): Override announcement SoundConfig
       - ...title config overrides eg fadeIn, stay, fadeOut...
 - `config-version`: **Internal use for configuration migrations, do not edit**
@@ -120,6 +120,59 @@ announcements:
 config-version: 1
 ```
 
+#### Chat Components
+
+Message contents are parsed as [Chat Component]s. This means that in addition to the normal `message: some message`, you can use JSON or YAML-formatted components.
+
+```yaml
+  - type: Chat
+    repeat: 30s
+    messages:
+      - message: {
+        "extra": [
+          {
+            "color": "gold",
+            "text": "This is a "
+          },
+          {
+            "bold": true,
+            "color": "gold",
+            "clickEvent": {
+              "action": "open_url",
+              "value": "https://www.spigotmc.org/wiki/the-chat-component-api/"
+            },
+            "hoverEvent": {
+              "action": "show_text",
+              "contents": "Chat Component API"
+            },
+            "text": "TextComponent"
+          },
+          { "text": " announcement!" }
+        ]
+      }
+```
+or
+```yaml
+  - type: Chat
+    repeat: 30s
+    messages:
+      - message:
+          extra:
+            - color: gold
+              text: "This is a "
+            - bold: true
+              color: gold
+              text: TextComponent
+              clickEvent:
+                action: open_url
+                value: "https://www.spigotmc.org/wiki/the-chat-component-api/"
+              hoverEvent:
+                action: show_text
+                "contents": "Chat Component API"
+            - text: " announcement!"
+```
+
 [Sound]: https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Sound.html
 [BarColor]: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/boss/BarColor.html
 [BarStyle]: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/boss/BarStyle.html
+[Chat Component]: https://www.spigotmc.org/wiki/the-chat-component-api/

src/main/kotlin/org/simplemc/simpleannounce/SimpleAnnounce.kt

@@ -5,11 +5,14 @@ import com.fasterxml.jackson.databind.ObjectMapper
 import com.fasterxml.jackson.databind.module.SimpleModule
 import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator
 import com.fasterxml.jackson.dataformat.yaml.YAMLMapper
+import com.fasterxml.jackson.module.kotlin.addDeserializer
 import com.fasterxml.jackson.module.kotlin.readValue
 import com.fasterxml.jackson.module.kotlin.registerKotlinModule
+import net.md_5.bungee.api.chat.BaseComponent
 import org.bukkit.command.Command
 import org.bukkit.command.CommandSender
 import org.bukkit.plugin.java.JavaPlugin
+import org.simplemc.simpleannounce.config.BaseComponentDeserializer
 import org.simplemc.simpleannounce.config.DurationDeserializer
 import org.simplemc.simpleannounce.config.DurationSerializer
 import org.simplemc.simpleannounce.config.SimpleAnnounceConfig
@@ -27,7 +30,8 @@ class SimpleAnnounce : JavaPlugin() {
         private const val RELOAD_COMMAND = "simpleannouncereload"
 
         private val durationModule = SimpleModule()
-            .addDeserializer(Duration::class.java, DurationDeserializer())
+            .addDeserializer(Duration::class, DurationDeserializer())
+            .addDeserializer(BaseComponent::class, BaseComponentDeserializer())
             .addSerializer(DurationSerializer())
     }
 

src/main/kotlin/org/simplemc/simpleannounce/config/BaseComponentDeserializer.kt

@@ -0,0 +1,23 @@
+package org.simplemc.simpleannounce.config
+
+import com.fasterxml.jackson.core.JsonParser
+import com.fasterxml.jackson.databind.DeserializationContext
+import com.fasterxml.jackson.databind.JsonDeserializer
+import com.fasterxml.jackson.databind.JsonNode
+import net.md_5.bungee.api.chat.BaseComponent
+import net.md_5.bungee.chat.ComponentSerializer
+
+class BaseComponentDeserializer : JsonDeserializer<BaseComponent>() {
+    override fun deserialize(p: JsonParser, ctxt: DeserializationContext): BaseComponent? {
+        val json = p.readValueAsTree<JsonNode>().toString()
+        return try {
+            ComponentSerializer.deserialize(json)
+        } catch (_: IllegalArgumentException) {
+            throw ctxt.weirdKeyException(
+                BaseComponent::class.java,
+                json,
+                "Couldn't parse TextComponent",
+            )
+        }
+    }
+}

src/main/kotlin/org/simplemc/simpleannounce/config/SimpleAnnounceConfig.kt

@@ -4,6 +4,7 @@ import com.fasterxml.jackson.annotation.JsonAlias
 import com.fasterxml.jackson.annotation.JsonIgnore
 import com.fasterxml.jackson.annotation.JsonTypeInfo
 import com.fasterxml.jackson.annotation.JsonUnwrapped
+import net.md_5.bungee.api.chat.BaseComponent
 import org.bukkit.Sound
 import org.bukkit.boss.BarColor
 import org.bukkit.boss.BarStyle
@@ -68,7 +69,7 @@ data class SimpleAnnounceConfig(
             override val excludesPermissions: List<String> = emptyList(),
             @field:JsonAlias("message") override val messages: List<ChatMessage>,
         ) : AnnouncementConfig<ChatMessage>() {
-            data class ChatMessage(val message: String, override val sound: SoundConfig? = null) : Message
+            data class ChatMessage(val message: BaseComponent, override val sound: SoundConfig? = null) : Message
         }
 
         data class Boss(
@@ -82,14 +83,10 @@ data class SimpleAnnounceConfig(
             @field:JsonUnwrapped val barConfig: BarConfig = BarConfig(),
         ) : AnnouncementConfig<Boss.BossBarMessage>() {
             data class BossBarMessage(
-                val message: String,
+                val message: BaseComponent,
                 override val sound: SoundConfig? = null,
                 @field:JsonUnwrapped val barConfig: BarConfig? = null,
-            ) : Message {
-                init {
-                    require(message.length <= 64) { "Boss Bar text must be <= 64 characters" }
-                }
-            }
+            ) : Message
 
             data class BarConfig(
                 val hold: Duration = 5.seconds,
@@ -118,8 +115,8 @@ data class SimpleAnnounceConfig(
             @field:JsonUnwrapped val titleConfig: TitleConfig = TitleConfig(),
         ) : AnnouncementConfig<Title.TitleMessage>() {
             data class TitleMessage(
-                val title: String,
-                val subtitle: String? = null,
+                val title: BaseComponent,
+                val subtitle: BaseComponent? = null,
                 override val sound: SoundConfig? = null,
                 @field:JsonUnwrapped val titleConfig: TitleConfig? = null,
             ) : Message

src/main/kotlin/org/simplemc/simpleannounce/sender/BossBarSender.kt

@@ -15,7 +15,7 @@ class BossBarSender(
         val barConfig = message.barConfig ?: announcement.barConfig
 
         // create the bar
-        val bar = Bukkit.createBossBar(message.message, barConfig.color, barConfig.style)
+        val bar = Bukkit.createBossBar(message.message.toLegacyText(), barConfig.color, barConfig.style)
         bar.progress = if (barConfig.reverseAnimation) 1.0 else 0.0
 
         // show bar to players

src/main/kotlin/org/simplemc/simpleannounce/sender/ChatSender.kt

@@ -9,6 +9,6 @@ class ChatSender(
 ) : AnnouncementSender<Chat.ChatMessage, Chat>(plugin, announcement) {
     override fun run() {
         val message = getNextMessage()
-        send(message) { it.sendMessage(message.message) }
+        send(message) { it.spigot().sendMessage(message.message) }
     }
 }

src/main/kotlin/org/simplemc/simpleannounce/sender/TitleSender.kt

@@ -13,8 +13,8 @@ class TitleSender(
 
         send(message) {
             it.sendTitle(
-                message.title,
-                message.subtitle,
+                message.title.toLegacyText(),
+                message.subtitle?.toLegacyText(),
                 titleConfig.fadeInTicks,
                 titleConfig.stayTicks,
                 titleConfig.fadeOutTicks,

src/main/resources/config.yml

@@ -31,7 +31,7 @@
 # Chat type:
 
 # messages(ChatMessage list):
-# - message(string): <message string>
+# - message(Chat Component): <message component (string or JSON component, see https://www.spigotmc.org/wiki/the-chat-component-api/)>
 #   sound(SoundConfig, optional): <Override announcement Sound config per message>
 #
 # Boss type:
@@ -42,7 +42,7 @@
 # animate(boolean): <if bar should animate over hold time>
 # reverseAnimation(boolean): <if animation should be reversed>
 # messages(BossBarMessage list):
-# - message(string): <message string>
+# - message(Chat Component): <message component (string or JSON component, see https://www.spigotmc.org/wiki/the-chat-component-api/)>
 #   sound(SoundConfig, optional): <Override announcement Sound config per message>
 #   <boss bar config overrides eg hold, color, style, animate, etc...see above>
 #
@@ -52,8 +52,8 @@
 # stay(duration): <Time for title to stay on screen>
 # fadeOut(duration): <Time it takes for title to fade out>
 # messages(TitleMessage list):
-# - title(string): <title string>
-#   subtitle(string): <subtitle string, appears below title slightly smaller>
+# - title(Chat Component): <title component (string or JSON component, see https://www.spigotmc.org/wiki/the-chat-component-api/)>
+#   subtitle(Chat Component): <subtitle component (string or JSON component, see https://www.spigotmc.org/wiki/the-chat-component-api/), appears below title slightly smaller>
 #   sound(SoundConfig, optional): <Override announcement Sound config per message>
 #   <title config overrides eg fadeIn, stay, fadeOut...see above>
 #
@@ -111,4 +111,29 @@ announcements:
     color: PURPLE
     style: SOLID
     animate: true
+  - type: Chat
+    repeat: 5m
+    messages:
+      - message: {
+        "extra": [
+          {
+            "color": "gold",
+            "text": "This is a "
+          },
+          {
+            "bold": true,
+            "color": "gold",
+            "clickEvent": {
+              "action": "open_url",
+              "value": "https://www.spigotmc.org/wiki/the-chat-component-api/"
+            },
+            "hoverEvent": {
+              "action": "show_text",
+              "contents": "Chat Component API"
+            },
+            "text": "TextComponent"
+          },
+          { "text": " announcement!" }
+        ]
+      }
 config-version: 1