Modding:Colors & Object Rendering: Difference between revisions

From Caves of Qud Wiki
Jump to navigation Jump to search
m (move color table into template)
(→‎Render Part: visual example because we have the technology)
Line 25: Line 25:
ColorString contains the foreground and (optionally) the background string for the ascii and tiles. Examples: <code>&B</code> or <code>&B^r</code>
ColorString contains the foreground and (optionally) the background string for the ascii and tiles. Examples: <code>&B</code> or <code>&B^r</code>


DetailColor changes the "third" color used only for tiles, not the ascii. DetailColor is always just a single character. Example: <code>g</code>
DetailColor changes the "third" color used only for tiles, not the ascii. DetailColor is always just a single character. Example: <code>g</code>  
 
So <code>ColorString="&M^g"</code> would be foreground bright magenta with a background color of green.


So <code>ColorString="&M^g"</code> would be foreground bright magenta with a background color of green,
{{qud char|&amp;M^g|Like this}}!
TileColor overrides ColorString when tiles are being used.
TileColor overrides ColorString when tiles are being used.



Revision as of 18:40, 10 August 2019

This page is about modding. See the modding overview for an abstract on modding.
This page is about modding. See the modding overview for an abstract on modding.

Overview

Colors are defined in display.text.

Each color is defined by a single letter. &<code> means to set the foreground color, ^<code> means to set the background color.

Only the preset letter codes are allowed, adding new colors isn't totally trivial at the moment.

Code Name Hex
r dark red / crimson #a64a2e
R red / scarlet #d74200
o dark orange #f15f22
O orange #e99f10
w brown #98875f
W gold / yellow #cfc041
g dark green #009403
G green #00c420
b dark blue #0048bd
B blue / azure #0096ff
c dark cyan / teal #40a4b9
C cyan #77bfcf
m dark magenta / purple #b154cf
M magenta #da5bd6
k #0f3b3a
K dark grey / black #155352
y grey #b1c9c3
Y white #ffffff

In XML files, such as ObjectBlueprints.xml, the ampersand (&) must be replaced by the encoded ampersand (&amp;)

Prefix Text Xml
Foreground &<code> &amp;<code>
Background ^<code> ^<code>

Render Part

ColorString contains the foreground and (optionally) the background string for the ascii and tiles. Examples: &B or &B^r

DetailColor changes the "third" color used only for tiles, not the ascii. DetailColor is always just a single character. Example: g

So ColorString="&M^g" would be foreground bright magenta with a background color of green, Like this! TileColor overrides ColorString when tiles are being used.

If you want to color an item's display name, you enter color codes directly in the display name itself, for example the beaded bracelet:

<part Name="Render" DisplayName="&amp;Cb&amp;Be&amp;ba&amp;cd&amp;Ce&amp;Bd&amp;y bracelet" ColorString="&amp;C"></part>

Additional Notes

Most default text in the game is colored with the bright grey (&y) color, so you'll often see an &y at the end of strings to reset the color back to normal.

For help formatting a string with colors, check out the super-useful qud-colorgen utility (created by crayon).

See Also