Improve with custom color codes

Allow you set your own color codes for the map colors.

Author: broken1arrow

Item Creator/src/main/java/org/broken/arrow/library/itemcreator/meta/map/MapRendererData.java

@@ -1,11 +1,12 @@
 package org.broken.arrow.library.itemcreator.meta.map;
 
 import org.broken.arrow.library.itemcreator.ItemCreator;
+import org.broken.arrow.library.itemcreator.meta.map.color.parser.AmpersandHexColorParser;
+import org.broken.arrow.library.itemcreator.meta.map.color.parser.ColorParser;
 import org.broken.arrow.library.itemcreator.meta.map.cursor.MapCursorAdapter;
 import org.broken.arrow.library.itemcreator.meta.map.cursor.MapCursorWrapper;
-import org.broken.arrow.library.itemcreator.meta.map.font.CharacterSprite;
-import org.broken.arrow.library.itemcreator.meta.map.font.MapFontWrapper;
 import org.broken.arrow.library.itemcreator.meta.map.font.customdraw.MapTextRenderer;
+import org.broken.arrow.library.itemcreator.meta.map.font.customdraw.RenderState;
 import org.broken.arrow.library.itemcreator.meta.map.pixel.ImageOverlay;
 import org.broken.arrow.library.itemcreator.meta.map.pixel.MapPixel;
 import org.broken.arrow.library.itemcreator.meta.map.pixel.MapColoredPixel;
@@ -44,6 +45,7 @@ public class MapRendererData {
     private final List<MapPixel> pixels = new ArrayList<>();
     private MapRenderHandler dynamicRenderer;
     private char[] fontChars = Characters.getFontCharsArray();
+    private ColorParser colorParser = new AmpersandHexColorParser();
 
     /**
      * Constructs a new MapRendererData instance with no associated {@link MapRenderer}.
@@ -146,6 +148,33 @@ public void addText(@Nonnull final TextOverlay textOverlay) {
         pixels.add(textOverlay);
     }
 
+    /**
+     * Applies the global {@link ColorParser} to the text at the specified index.
+     * <p>
+     * This works like the per-text parser, but uses the global parser set for all text
+     * instances that do not have a per-instance override.
+     *
+     * @see org.broken.arrow.library.itemcreator.meta.map.font.MapFontWrapper#applyColorParser(String, int, RenderState)
+     * @param text        the text to parse
+     * @param index       the starting position in the text
+     * @param renderState the current render state to update with color/style
+     * @return the number of characters consumed by the formatting code, or 0 if none
+     */
+    public int applyGlobalColorParser(@Nonnull final String text, final int index, @Nonnull final RenderState renderState) {
+        return colorParser.tryParse(text, index, renderState);
+    }
+
+    /**
+     * Sets the global {@link ColorParser} used for all text instances that do not
+     * have a per-text parser set.
+     *
+     * @see org.broken.arrow.library.itemcreator.meta.map.font.MapFontWrapper#applyColorParser(String, int, RenderState)
+     * @param colorParser the global color parser to use
+     */
+    public void setGlobalColorParser(@Nonnull final ColorParser colorParser) {
+        this.colorParser = colorParser;
+    }
+
     /**
      * Adds an image overlay to the map at the specified coordinates.
      *
@@ -343,9 +372,8 @@ private void setPixels(@Nonnull final MapCanvas canvas) {
                 if (mapFont instanceof MinecraftFont)
                     canvas.drawText(mapPixel.getX(), mapPixel.getY(), mapFont, textOverlay.getText());
                 else {
-                    MapTextRenderer mapTextRenderer = new MapTextRenderer(canvas, textOverlay.getMapFontWrapper(), textOverlay.getText());
+                    final MapTextRenderer mapTextRenderer = new MapTextRenderer(canvas, this, textOverlay);
                     mapTextRenderer.drawCustomFontText(mapPixel.getX(), mapPixel.getY());
-                    // drawCustomFontText(canvas, mapPixel.getX(), mapPixel.getY(), textOverlay.getText(), textOverlay.getMapFontWrapper());
                 }
             }
             if (mapPixel instanceof ImageOverlay) {

Item Creator/src/main/java/org/broken/arrow/library/itemcreator/meta/map/color/parser/AmpersandHexColorParser.java

@@ -1,6 +1,5 @@
 package org.broken.arrow.library.itemcreator.meta.map.color.parser;
 
-import org.broken.arrow.library.itemcreator.meta.map.font.customdraw.MapTextRenderer;
 import org.broken.arrow.library.itemcreator.meta.map.font.customdraw.RenderState;
 
 import javax.annotation.Nonnull;
@@ -18,7 +17,7 @@ public final class AmpersandHexColorParser implements ColorParser {
      * @return how many characters were consumed (0 = not a formatting code)
      */
     @Override
-    public int tryParse(String text, int i, RenderState state) {
+    public int tryParse(@Nonnull String text, int i, @Nonnull RenderState state) {
         if (i + 1 >= text.length())
             return 0;
 

Item Creator/src/main/java/org/broken/arrow/library/itemcreator/meta/map/color/parser/ColorParser.java

@@ -2,14 +2,21 @@
 
 import org.broken.arrow.library.itemcreator.meta.map.font.customdraw.RenderState;
 
+import javax.annotation.Nonnull;
+
+/**
+ * Handle the colors from a text and provide the length of your color code
+ * to ignore when create the text.
+ */
+@FunctionalInterface
 public interface ColorParser {
     /**
      * @param text        Full user input
      * @param i           Current index
      * @param renderState Modify if parsed successfully
      * @return number of characters consumed (0 = not parsed)
      */
-    int tryParse(String text, int i, RenderState renderState);
+    int tryParse(@Nonnull final String text, final int i,@Nonnull final RenderState renderState);
 }
 
 

Item Creator/src/main/java/org/broken/arrow/library/itemcreator/meta/map/font/MapFontWrapper.java

@@ -1,6 +1,9 @@
 package org.broken.arrow.library.itemcreator.meta.map.font;
 
 import net.md_5.bungee.api.ChatColor;
+import org.broken.arrow.library.itemcreator.meta.map.color.parser.AmpersandHexColorParser;
+import org.broken.arrow.library.itemcreator.meta.map.color.parser.ColorParser;
+import org.broken.arrow.library.itemcreator.meta.map.font.customdraw.RenderState;
 import org.bukkit.map.MapFont;
 import org.bukkit.map.MinecraftFont;
 
@@ -25,11 +28,10 @@
  * character sprites can be added.
  */
 public class MapFontWrapper {
-
-
     private final Map<Character, CharacterSprite> chars = new HashMap<>();
     private int height = 0;
     private IntUnaryOperator defaultFontSpacing = (charter) -> 8;
+    private ColorParser colorParser;
 
     /**
      * just a check if the front is malleable
@@ -109,6 +111,61 @@ public int applyDefaultFontSpacing(char ch) {
         return defaultFontSpacing.applyAsInt(ch);
     }
 
+    /**
+     * Applies the current {@link ColorParser} to the text at the specified index.
+     * <p>
+     * The parser will attempt to detect a formatting sequence (such as Minecraft-style
+     * codes or custom hex codes—the default implementation) starting at {@code index}
+     * and update the {@link RenderState} with the corresponding color and/or style.
+     * <p>
+     * By default, the following codes are supported:
+     * <ul>
+     *     <li>{@code &0 - &f}: standard color codes</li>
+     *     <li>{@code &#fff}: 3-digit hex color</li>
+     *     <li>{@code &#ffffff}: 6-digit hex color</li>
+     *     <li>{@code &l}: bold text</li>
+     *     <li>{@code &o}: shadow effect</li>
+     *     <li>{@code &r}: reset color and styles</li>
+     * </ul>
+     * <p>
+     * See {@link RenderState#applyFormattingCode(char)} and
+     * {@link RenderState#translateChatColor(char)} for details on the default parser's behavior.
+     * <p>
+     * You can also provide a custom {@link ColorParser} to define alternative parsing logic
+     * or support additional formatting sequences.
+     * <p>
+     * This method returns the number of characters consumed by the formatting sequence,
+     * allowing the caller to advance the cursor appropriately. If no sequence is found,
+     * it returns 0. If no parser is set, it returns -1.
+     * <p>
+     * <strong>Note:</strong> This method is intended for internal use by the API and
+     * usually does not need to be invoked directly.
+     *
+     * @param text        the text to parse
+     * @param index       the starting position in the text
+     * @param renderState the current render state to update with color/style
+     * @return the number of characters consumed by the formatting code, 0 if none found, or -1 if no parser is set
+     */
+    public int applyColorParser(@Nonnull final String text, final int index,@Nonnull final RenderState renderState) {
+        if(colorParser == null)
+            return -1;
+        return colorParser.tryParse( text,  index, renderState);
+    }
+
+    /**
+     * Sets the {@link ColorParser} used to interpret color and style codes
+     * in this text instance.
+     * <p>
+     * By default, the API uses the global parser from {@link MapFontWrapper} (typically
+     * {@link AmpersandHexColorParser}). This method allows overriding it for this
+     * specific text, including using lambda-based or custom parser implementations.
+     *
+     * @param colorParser the color parser to use for this text
+     */
+    public void setColorParser(@Nonnull final ColorParser colorParser) {
+        this.colorParser = colorParser;
+    }
+
     /**
      * Sets the default spacing function for characters.
      * <p>

Item Creator/src/main/java/org/broken/arrow/library/itemcreator/meta/map/font/customdraw/MapTextRenderer.java

@@ -1,16 +1,16 @@
 package org.broken.arrow.library.itemcreator.meta.map.font.customdraw;
 
 import org.broken.arrow.library.itemcreator.ItemCreator;
-import org.broken.arrow.library.itemcreator.meta.map.color.parser.AmpersandHexColorParser;
-import org.broken.arrow.library.itemcreator.meta.map.color.parser.ColorParser;
+import org.broken.arrow.library.itemcreator.meta.map.MapRendererData;
 import org.broken.arrow.library.itemcreator.meta.map.font.CharacterSprite;
 import org.broken.arrow.library.itemcreator.meta.map.font.MapFontWrapper;
+import org.broken.arrow.library.itemcreator.meta.map.pixel.TextOverlay;
 import org.bukkit.map.MapCanvas;
 import org.bukkit.map.MapPalette;
 
+import javax.annotation.Nonnull;
 import java.awt.*;
 
-
 /**
  * Responsible for rendering text using a custom pixel-based {@link MapFontWrapper} onto a {@link MapCanvas}.
  * <p>
@@ -27,23 +27,27 @@
  * Each visible pixel is drawn directly into the map canvas at the computed coordinate.
  */
 public class MapTextRenderer {
+    private final MapRendererData mapRendererData;
     private final MapCanvas canvas;
     private final MapFontWrapper font;
     private final String text;
 
+
     /**
      * Creates a new custom font renderer.
      *
-     * @param canvas the target map canvas to draw on
-     * @param font   the custom font wrapper providing character sprites and spacing rules
-     * @param text   the raw input text containing characters and formatting codes
+     * @param canvas          the target map canvas to draw on
+     * @param mapRendererData the rendered data instance with your global settings.
+     * @param textOverlay     the custom text overlay wrapper providing character sprites and spacing rules
      */
-    public MapTextRenderer(final MapCanvas canvas, final MapFontWrapper font, final String text) {
+    public MapTextRenderer(@Nonnull final MapCanvas canvas, @Nonnull final MapRendererData mapRendererData, @Nonnull final TextOverlay textOverlay) {
         this.canvas = canvas;
-        this.font = font;
-        this.text = text;
+        this.mapRendererData = mapRendererData;
+        this.font = textOverlay.getMapFontWrapper();
+        this.text = textOverlay.getText();
     }
 
+
     /**
      * Draws the configured text to the map canvas starting at the given coordinate.
      * <p>
@@ -67,8 +71,11 @@ public void drawCustomFontText(int x, int y) {
         for (int i = 0; i < text.length(); i++) {
             char ch = text.charAt(i);
 
-            ColorParser parser = new AmpersandHexColorParser();
-            int consumed = parser.tryParse(text, i, renderState);
+            int consumed;
+            consumed = this.font.applyColorParser(text, i, renderState);
+            if (consumed <= 0)
+                consumed = this.mapRendererData.applyGlobalColorParser(text, i, renderState);
+
             if (consumed > 0) {
                 i += consumed - 1;
                 continue;
@@ -98,7 +105,6 @@ public void drawCustomFontText(int x, int y) {
     }
 
 
-
     /**
      * Draws all visible pixels of a sprite at an offset.
      * Any pixel in the sprite marked as {@code true} is drawn to the final canvas.
@@ -129,9 +135,9 @@ private void drawPixelsOffset(CharacterSprite sprite, int startX, int startY, Co
      * older versions use {@link MapPalette#matchColor(Color)}.
      *
      * @param canvas the target map canvas to draw on
-     * @param x location where draw in digonal direction.
-     * @param y location where draw in vertical direction.
-     * @param color the color to set for the pixel
+     * @param x      location where draw in digonal direction.
+     * @param y      location where draw in vertical direction.
+     * @param color  the color to set for the pixel
      */
     private void setMapPixel(MapCanvas canvas, int x, int y, Color color) {
         if (ItemCreator.getServerVersion() < 20.0F) {

Item Creator/src/main/java/org/broken/arrow/library/itemcreator/meta/map/pixel/TextOverlay.java

@@ -1,7 +1,10 @@
 package org.broken.arrow.library.itemcreator.meta.map.pixel;
 
+import org.broken.arrow.library.itemcreator.meta.map.color.parser.AmpersandHexColorParser;
+import org.broken.arrow.library.itemcreator.meta.map.color.parser.ColorParser;
 import org.broken.arrow.library.itemcreator.meta.map.font.CharacterSprite;
 import org.broken.arrow.library.itemcreator.meta.map.font.MapFontWrapper;
+import org.broken.arrow.library.itemcreator.meta.map.font.customdraw.RenderState;
 
 import javax.annotation.Nonnull;
 import java.awt.*;
@@ -65,6 +68,21 @@ public void setMapFont(final char[] chars, @Nonnull final Font font) {
         }
     }
 
+    /**
+     * Sets the {@link ColorParser} used for interpreting color and style codes
+     * in the text.
+     * <p>
+     * The parser is responsible for detecting formatting sequences and updating
+     * the {@link RenderState} accordingly. By default, the API uses
+     * {@link AmpersandHexColorParser}, but this method allows you to replace it
+     * with a custom implementation, including lambda-based parsers.
+     *
+     * @param colorParser the color parser to use
+     */
+    public void setColorParser(@Nonnull final ColorParser colorParser) {
+        mapFontWrapper.setColorParser(colorParser);
+    }
+
 
     /**
      * Gets the {@link org.bukkit.map.MapFont} used to render this text overlay.