Deprecate MinecraftFormattingConverter (see #18)

Minecrell · May 7, 2021 · 5485c5c · 5485c5c
1 parent 54ab86e
commit 5485c5c
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/main/java/net/minecrell/terminalconsole/MinecraftFormattingConverter.java b/src/main/java/net/minecrell/terminalconsole/MinecraftFormattingConverter.java
@@ -60,10 +60,16 @@
  *
  * @see <a href="http://minecraft.gamepedia.com/Formatting_codes">
  *     Formatting Codes</a>
+ * @deprecated Minecraft-specific. Also, legacy formatting codes are deprecated
+ *     and do not natively allow specifying RGB colors. Consider implementing
+ *     native support for the (JSON) chat components of your platform instead.
+ *     For more information, see
+ *     <a href="https://github.com/Minecrell/TerminalConsoleAppender/issues/18">issue #18</a>.
  */
 @Plugin(name = "minecraftFormatting", category = PatternConverter.CATEGORY)
 @ConverterKeys({ "minecraftFormatting" })
 @PerformanceSensitive("allocation")
+@Deprecated
 public final class MinecraftFormattingConverter extends LogEventPatternConverter {
 
     /**