Pinkfish colour codes

From Discworld MUD Wiki
Jump to: navigation, search

It is possible to give your finger/who messages some colour using Pinkfish Color Codes.

Syntax

Pinkfish colour codes are encapsulated by "%^" and contain the colour that the text following the code should be displayed in, until a line ending or RESET colour code is found. So in order to send the text foobar in red, use %^RED%^foobar%^RESET%^. If you want to quote the literal text %^, it should be sent as %%^^. If that doesn't work try %%^%%^^^.

General Use (soul commands, spells, etc)

When used in .reference or .plan or soul emotes, these colours only shown if the recipient has "output usercolour = on" enabled. For example: alias .reference %^RED%^This text is red%^RESET%^; %^GREEN%^This text is green%^RESET%^; %^B_MAGENTA%^This text is.. something else%^RESET%^ will result in:

PinkfishColourExample01.png

but only if option "output usercolour" is set to "on". The default value for this option is "off".

Use in item descriptions

However, the usercolour setting seems to be ignored when Pinkfish Colour Codes are used on item descriptions. Casting SSS on an item and using pinkfish colours work, even if option "output usercolour" is turned off. For example:

PinkfishColourExample02.PNG

Available Colours

RED     BLUE     ORANGE     YELLOW     GREEN     BLACK     WHITE     CYAN
MAGENTA B_RED    B_BLUE     B_ORANGE   B_YELLOW  B_GREEN   B_MAGENTA B_BLACK
B_WHITE B_CYAN   FLASH      BOLD       REVERSE   UNDERLINE INITTERM  RESET
WINDOW  ENDTERM  STATUS

Client Compatibility

Although it was originally intended to convert to ANSI colour encoding, nowadays they are converted to whatever colour system your terminal uses (ANSI, MXP, etc). It is worth noting, however, that CMud (and possibly zMud) as well consider the '%' character a special character, so when entering these codes you may want to turn off Triggers/Parsing.