Skip to main content
The minecraft/text package provides utilities for formatting text with Minecraft color codes and converting them for display in terminals.

​
Functions

​
Clean

func Clean(s string) string
Removes all Minecraft formatting codes from a string.
​
s
string
The string containing Minecraft formatting codes (§)
​
string
The string with all formatting codes removed

​
ANSI

func ANSI(a ...any) string
Converts Minecraft formatting codes to ANSI terminal codes for proper display.
​
a
...any
Values to convert (joined with spaces)
​
string
String with ANSI formatting codes

​
Colourf

func Colourf(format string, a ...any) string
Formats a string using HTML-style color tags that are converted to Minecraft formatting codes.
​
format
string
Format string with HTML color tags
​
a
...any
Values to substitute into the format string
​
string
String with Minecraft formatting codes (§)

​
Color Constants

Minecraft formatting codes as constants: 
const (
    Black       = "§0"
    DarkBlue    = "§1"
    DarkGreen   = "§2"
    DarkAqua    = "§3"
    DarkRed     = "§4"
    DarkPurple  = "§5"
    Gold        = "§6"
    Grey        = "§7"
    DarkGrey    = "§8"
    Blue        = "§9"
    Green       = "§a"
    Aqua        = "§b"
    Red         = "§c"
    Purple      = "§d"
    Yellow      = "§e"
    White       = "§f"
    
    // Formatting
    Obfuscated  = "§k"
    Bold        = "§l"
    Italic      = "§o"
    Reset       = "§r"
)

​
HTML Color Tags

The following HTML tags are supported in Colourf():

​
Basic Colors

  • <black>, <dark-blue>, <dark-green>, <dark-aqua>
  • <dark-red>, <dark-purple>, <gold>, <grey>
  • <dark-grey>, <blue>, <green>, <aqua>
  • <red>, <purple>, <yellow>, <white>

​
Material Colors

  • <dark-yellow>, <quartz>, <iron>, <netherite>
  • <redstone>, <copper>, <gold>, <emerald>
  • <diamond>, <lapis>, <amethyst>

​
Formatting

  • <obfuscated> - Scrambled text
  • <bold> or <b> - Bold text
  • <italic> or <i> - Italic text

​
Example Usage

​
Basic Formatting

import "github.com/sandertv/gophertunnel/minecraft/text"

// Using constants
message := text.Red + "Error: " + text.Reset + "Something went wrong"

// Clean formatting codes
clean := text.Clean(message) // "Error: Something went wrong"

​
HTML-Style Formatting

// Simple colors
msg := text.Colourf("<red>Error:</red> <white>File not found</white>")

// Nested formatting
msg = text.Colourf("<green>Success: <bold>Operation complete!</bold></green>")

// With parameters
player := "Steve"
msg = text.Colourf("<yellow>Welcome, <bold>%s</bold>!</yellow>", player)

// Multiple colors
msg = text.Colourf(
    "<red>Health: %d</red> <blue>Mana: %d</blue>",
    health, mana,
)

​
Terminal Output

// Convert to ANSI for terminal display
msg := text.Red + "Error!" + text.Reset
fmt.Println(text.ANSI(msg)) // Displays in red in terminal

// Multiple values
text.ANSI("Status:", text.Green+"Online"+text.Reset)

​
Chat Messages

// Send colored chat message
err := conn.WritePacket(&packet.Text{
    TextType: packet.TextTypeChat,
    Message:  text.Colourf("<gold>%s joined the game</gold>", playerName),
})

​
Disconnect Messages

// Colorful disconnect message
listener.Disconnect(conn, text.Colourf(
    "<red>You have been kicked!\n<white>Reason: %s</white></red>",
    reason,
))

​
Material-Themed Messages

msg := text.Colourf(
    "<diamond>Diamond Sword</diamond> <grey>x1</grey>",
)

msg = text.Colourf(
    "Rewards: <gold>10 Gold</gold>, <emerald>5 Emeralds</emerald>",
)

​
Complex Formatting

msg := text.Colourf(`
<bold><gold>==== Server Rules ====</gold></bold>
<white>1. <green>Be respectful</green></white>
<white>2. <red>No griefing</red></white>
<white>3. <blue>Have fun!</blue></white>
`)

conn.WritePacket(&packet.Text{
    TextType: packet.TextTypeRaw,
    Message:  msg,
})

​
Cleaning User Input

// Remove color codes from user input
userInput := "§4Hacked§r message"
safe := text.Clean(userInput) // "Hacked message"

// Now safe to use
broadcast(safe)