25
edits
Modding:Colors & Object Rendering: Difference between revisions
Jump to navigation
Jump to search
Modding:Colors & Object Rendering (view source)
Revision as of 01:57, 8 August 2022
, 01:57, 8 August 2022→Color Markup Language
imported>CaptainTechnicality54384 (Created page with "= Overview = Colors are defined in display.text. Each color is defined by a single letter. &<nowiki><code> means to set the foreground color, ^<code> means to set the backgro...") |
|||
| (37 intermediate revisions by 10 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Modding Resources]]{{Modding Info}} | |||
= Overview = | = Overview = | ||
Colors are defined in | Colors are defined in <code>Display.txt</code>. | ||
Each color is defined by a single letter. &<nowiki><code> means to set the foreground color, ^<code> means to set the background color. | Each color is defined by a single letter. <code><nowiki>&</nowiki></code> means to set the foreground color, <code>^</code> means to set the background color. | ||
Only the preset letter codes are allowed, adding new colors isn't totally trivial at the moment. | Only the preset letter codes are allowed, adding new colors isn't totally trivial at the moment. | ||
{ | {{Color Table}} | ||
To get a palette file for these colors, refer to [[Visual_Style#Palette]]. | |||
In XML files, such as ObjectBlueprints.xml, the ampersand (&) must be replaced by the encoded ampersand (&amp;) | |||
{| class="wikitable tablesorter tablesorter-default stickyTableHeaders" | {| class="wikitable tablesorter tablesorter-default stickyTableHeaders" | ||
!Prefix | !Prefix | ||
| Line 82: | Line 17: | ||
| colspan="1" |Foreground | | colspan="1" |Foreground | ||
|&<nowiki><code></nowiki> | |&<nowiki><code></nowiki> | ||
|<nowiki> | |&amp;<nowiki><code></nowiki> | ||
|- | |- | ||
| colspan="1" |Background | | colspan="1" |Background | ||
| Line 90: | Line 25: | ||
= Render Part = | = Render Part = | ||
ColorString contains the foreground and background string for the ascii and tiles. | ColorString contains the foreground and (optionally) the background string for the ascii and tiles. Examples: <code>&B</code> or <code>&B^r</code> | ||
TileColor is identical to ColorString, but applies only to tiles. If this is not specified, a tile falls back to using the ColorString. | |||
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, | |||
{{qud char|&M^g|Like this}}! | |||
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: | |||
<syntaxhighlight lang="xml"> | |||
<part Name="Render" DisplayName="&Cb&Be&ba&cd&Ce&Bd&y bracelet" ColorString="&C"></part> | |||
</syntaxhighlight> | |||
The [https://qud-colorgen.herokuapp.com/ qud-colorgen] utility (created by crayon) is an external tool that can help you create these complex color strings, however the newer Markup language the game uses might be good enough for your purposes. | |||
Note that if a detail color is not specified, it will default to the background viridian color. | |||
== Color Markup Language == | |||
Most default text in the game is colored grey (&y), so you'll often see an <code>&y</code> at the end of strings to reset the color back to normal. When putting strings using the basic color codes together to make sentences extremely confusing color bleed becomes possible. Because of this there is new system which parses text in double curly braces: <code><nowiki>{{color|text}}</nowiki></code>. If you want to ensure colors "return" to what they were set to, you can leave out the color. <code><nowiki>"{{|&RThis text is red}} and this will be whatever the color was before red"</nowiki></code> | |||
In general, every string for rendering, except the color string/detail color on render part should use the new Markup language. | |||
Text can also be colored as follows using any of the color templates defined in StreamingAssets\Base\Colors.xml. | |||
<pre> | |||
{{color template|your text to color here}} | |||
</pre> | |||
=== List of possible templates === | |||
{{#invoke:ColorParse|shaderlist}} | |||
=== Anonymous Templates === | |||
To create a temporary template, the format is: <pre>{{[color pattern delimited by -] [type]|[text]}}</pre> | |||
For example:<pre>{{R-R-R-R-R-M-M sequence|mumble mouth}}</pre> | |||
The list of possible types are: | |||
{| class = "wikitable" | |||
!Type | |||
!Pattern | |||
!Example | |||
|- | |||
|sequence | |||
| repeats the pattern. | |||
| {{Qud shader|blaze|texttexttexttext}} | |||
|- | |||
| alternation | |||
| stretches the pattern so it fits the entire word. | |||
| {{Qud shader|ghostly|texttexttexttext}} | |||
|- | |||
| chaotic | |||
| chooses colors randomly out of the colors specified. | |||
| | |||
|- | |||
| bordered | |||
| | |||
| {{qud shader|horned|texttexttexttext}} | |||
|} | |||
=See Also= | |||
* [[Visual Style]] | |||
{{Modding Navbox}} | |||