Difference between revisions of "Color Codes"

Revision as of 17:18, 13 November 2005

What are they?

Color codes are used to add color to text. They were introduced in Quake III Arena and are available in most Q3 engine based games, including Enemy Territory. They can be used with most text that gets displayed ingame, including player names, chat or notices.

Usage: a caret character (^) followed by another character. Each character produces a different colour.
Example: ^1red ^2green ^4blue
Produces: red green blue

What colors are available?

There are 32 colors available -- internally, the game has a table of all 32 colors (starting with color #0) and uses the ASCII value of the character following the caret plus 16 to determine which color to use, looping back around to color #0 after color #31. The index lookup could be described in C code as '(*char + 16) & 31'.

The following table shows what the index of each color is, its HTML color code equivalent, and the characters that will produce the color in-game if placed after a caret:

Code Examples

Here is a little php script that can be used to parse colorcodes and return the HTML formatted, colored string:

// ©2003 Deus@pooHunter.de
// This script uses the original RGB-values that were used in RtCW:OSP which I received directly from rhea.
// AFAIK these RGB values did not change in ET/ETPro 
function parse_gamecolors($string)
{
	$string = ereg_replace("(\^)?$", "^", $string);
	$string = ereg_replace("\^\^", "&#94^", $string);
	$string = ereg_replace("(\^)?$", "", $string);
	$string = ereg_replace("\^<", "^|", $string);
	$string = ereg_replace("\<", "<", $string);
	$string = ereg_replace("\^>", "^^", $string);
	$string = ereg_replace("\>", ">", $string);
	$string = ereg_replace("\^\^", "^>", $string);
	$string = "<font color=\"#FFFFFF\">".$string."</font>";

	$color_def = array
	(
		0  => "#000000",	1  => "#FF0000",	2  => "#00FF00",	3  => "#FFFF00",
		4  => "#0000FF",	5  => "#00FFFF",	6  => "#FF00FF",	7  => "#FFFFFF",
		8  => "#FF7F00",	9  => "#7F7F7F",	10 => "#BFBFBF",	11 => "#007F00",
		12 => "#7FFF00",	13 => "#00007F",	14 => "#7F0000",	15 => "#7F4000",
		16 => "#FF9933",	17 => "#007F7F",	18 => "#7F007F",	19 => "#007F7F",
		20 => "#7F00FF",	21 => "#3399CC",	22 => "#CCFFCC",	23 => "#006633",
		24 => "#FF0033",	25 => "#B21919",	26 => "#993300",	27 => "#CC9933",
		28 => "#999933",	29 => "#FFFFBF",	30 => "#FFFF7F"
	);

	$color_chardef = array
	(
		"#000000"	=> array (	0 => "0",	1 => "P",	2 => "p"	),
		"#FF0000"	=> array (	0 => "1",	1 => "Q",	2 => "q"	),
		"#00FF00"	=> array (	0 => "2",	1 => "R",	2 => "r"	),
		"#FFFF00"	=> array (	0 => "3",	1 => "S",	2 => "s"	),
		"#0000FF"	=> array (	0 => "4",	1 => "T",	2 => "t"	),
		"#00FFFF"	=> array (	0 => "5",	1 => "U",	2 => "u"	),
		"#FF00FF"	=> array (	0 => "6",	1 => "V",	2 => "v"	),
		"#FFFFFF"	=> array (	0 => "7",	1 => "W",	2 => "w"	),
		"#FF7F00"	=> array (	0 => "8",	1 => "X",	2 => "x"	),
		"#7F7F7F"	=> array (	0 => "9",	1 => "Y",	2 => "y"	),
		"#BFBFBF"	=> array (	0 => ":",	1 => "Z",	2 => "z",
						3 => ";",	4 => "[",	5 => "{"	),
		"#007F00"	=> array (	0 => "<",	1 => "\\",	2 => "|"	),
		"#7FFF00"	=> array (	0 => "=",	1 => "]",	2 => "}"	),
		"#00007F"	=> array (	0 => ">"					),
		"#7F0000"	=> array (	0 => "?"					),
		"#7F4000"	=> array (	0 => "@",	1 => "`"			),
		"#FF9933"	=> array (	0 => "A",	1 => "a",	2 => "!"	),
		"#007F7F"	=> array (	0 => "B",	1 => "b"			),
		"#7F007F"	=> array (	0 => "C",	1 => "c",	2 => "#"	),
		"#007F7F"	=> array (	0 => "D",	1 => "d",	2 => "$"	),
		"#7F00FF"	=> array (	0 => "E",	1 => "e",	2 => "%"	),
		"#3399CC"	=> array (	0 => "F",	1 => "f",	2 => "&"	),
		"#CCFFCC"	=> array (	0 => "G",	1 => "g",	2 => "'"	),
		"#006633"	=> array (	0 => "H",	1 => "h",	2 => "("	),
		"#FF0033"	=> array (	0 => "I",	1 => "i",	2 => ")"	),
		"#B21919"	=> array (	0 => "J",	1 => "j"			),
		"#993300"	=> array (	0 => "K",	1 => "k",	2 => "+"	),
		"#CC9933"	=> array (	0 => "L",	1 => "l",	2 => ","	),
		"#999933"	=> array (	0 => "M",	1 => "m",	2 => "-"	),
		"#FFFFBF"	=> array (	0 => "N",	1 => "n",	2 => "."	),
		"#FFFF7F"	=> array (	0 => "O",	1 => "o",	2 => "/"	)
	);
		
	for ($cd1 = 0; $cd1 < 31; $cd1++)
	{
		for ($cd2 = 0; $cd2 < count($color_chardef[$color_def[$cd1]]); $cd2++)
		{
			$string = str_replace("^". $color_chardef[$color_def[$cd1]][$cd2], "</FONT><FONT COLOR=\"" . $color_def[$cd1] . "\">", $string);
		}
	}
	return $string;
}

Alternately, this piece of PHP uses the color indexes directly (as shown above) to achieve the same effect. Its behavior very closely mimics the game's internal color parsing behavior.

$osp_colors = array(
	0 => "#000000",		1 => "#ff0000",		2 => "#00ff00",		3 => "#ffff00",
	4 => "#0000ff",		5 => "#00ffff",		6 => "#ff00ff",		7 => "#ffffff",
	8 => "#ff7f00",		9 => "#7f7f7f",		10 => "#bfbfbf",	11 => "#bfbfbf",
	12 => "#007f00",	13 => "#7f7f00",	14 => "#00007f",	15 => "#7f0000",
	16 => "#7f3f00",	17 => "#ff9919",	18 => "#007f7f",	19 => "#7f007f",
	20 => "#007fff",	21 => "#7f00ff",	22 => "#3399cc",	23 => "#ccffcc",
	24 => "#006633",	25 => "#ff0033",	26 => "#b21919",	27 => "#993300",
	28 => "#cc9933",	29 => "#999933",	30 => "#ffffbf",	31 => "#ffff7f"
);

function colorize($text)
{
    global $osp_colors;

    $curcolor = -1;
    $nextcolor = 7;
    
    for ($x = 0; $x < strlen($text); $x++) {
        if ($text[$x] == '^' && $text[$x + 1] != '^') {
            $nextcolor = (ord($text[$x + 1]) + 16) & 31;
            $x++;
            continue;
        }
        if ($curcolor != $nextcolor) {
            if ($curcolor != -1)
                $buf .= "</font>";
            $curcolor = $nextcolor;
            $buf .= sprintf("<font color=\"%s\">", $osp_colors[$curcolor]);
            
        }
        $buf .= htmlspecialchars($text[$x]);
    }

    if ($curcolor != -1)
        $buf .= "</font>";
    
    return $buf;
}