feat: document shadow color (#191)

KyoriPowered · Jan 9, 2025 · 12d9329 · 12d9329
1 parent 2b468de
commit 12d9329
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 0 deletions.
diff --git a/source/minimessage/format.rst b/source/minimessage/format.rst
@@ -82,6 +82,33 @@ Examples
 .. image:: /minimessage/images/color_verbose_2.png
    :alt: The result of parsing ``<color:#FF5555>This is a <color:#55FF55>test!``, shown in-game in the Minecraft client's chat window
 
+Shadow Color
+************
+
+Color the shadow of the next parts
+
+Tag
+   * :mm:`<shadow:_hex_>`, for hex color
+   * :mm:`<shadow:_color_:[alpha_as_float]>`, for named colors with optional alpha
+   * :mm:`<!shadow>` as an alias to disable the shadow (equalivent to :mm:`<shadow:#00000000>`)
+Arguments
+   * ``_hex_``, a hex color string with the format ``#RRGGBB`` or ``#RRGGBBAA``.
+   * ``_color_``, any minecraft named color constant
+   * ``[alpha_as_float]``, a float value between 0 and 1, representing the alpha value of the shadow. Optional, defaults to 0.25.
+Examples
+   * :mm:`<shadow:yellow>Hello <shadow:aqua:0.5>World</shadow>!`
+   * :mm:`<shadow:#FF5555>This is a <shadow:#55FF55>test!`
+   * :mm:`<shadow:#000000FF><b>Thicc`
+
+.. image:: /minimessage/images/shadow_1.png
+   :alt: The result of parsing ``<shadow:yellow>Hello <shadow:aqua:0.5>World</shadow>!``, shown in-game in the Minecraft client's chat window
+
+.. image:: /minimessage/images/shadow_2.png
+   :alt: The result of parsing ``<shadow:#FF5555>This is a <shadow:#55FF55>test!``, shown in-game in the Minecraft client's chat window
+
+.. image:: /minimessage/images/shadow_3.png
+   :alt: The result of parsing ``<shadow:#000000FF><b>Thicc``, shown in-game in the Minecraft client's chat window
+
 Decoration
 ***********
 

diff --git a/source/minimessage/images/shadow_1.png b/source/minimessage/images/shadow_1.png
diff --git a/source/minimessage/images/shadow_2.png b/source/minimessage/images/shadow_2.png
diff --git a/source/minimessage/images/shadow_3.png b/source/minimessage/images/shadow_3.png