Paste format: Difference between revisions
Initial draft |
m small changes |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 4: | Line 4: | ||
== Escape characters == | == Escape characters == | ||
With the exception of text decorations, all character attribute changes ( | With the exception of text decorations, all character attribute changes (links, colors, and protections) are prefixed by an '''escape character''' (<code>U+001B</code>), followed by an escape code. After an escape code is written, it must either be followed by a segment of text, '''or''' followed by another escape code. The list of all possible escape codes can be seen below. | ||
=== Changing colors === | === Changing colors === | ||
<small>'''''Important''': For best performance, you may (optionally) write the escape codes | <small>'''''Important''': For best performance, you may (optionally) write the following escape codes for each <u>change</u> in value, rather than just for each character. This condition only applies for setting and resetting colors.''</small> | ||
==== Text colors ==== | ==== Text colors ==== | ||
To change the current text color, you | To change the current text color, you would write an escape character (<code>\x1B</code>), followed by the capital letter <code>F</code>, followed by a hex-encoded RGB value. | ||
Example: To change the current text color to a pure green, you | Example: To change the current text color to a pure green, you would write the sequence <code>\x1BF00ff00</code>. | ||
==== Cell colors ==== | ==== Cell colors ==== | ||
Changing the cell color works very similarly to changing the text color. The formatting begins with an escape character (<code>\x1B</code>), followed by the lowercase letter <code>b</code>, finally ending with a hex-encoded RGB value. | Changing the cell color works very similarly to changing the text color. The formatting begins with an escape character (<code>\x1B</code>), followed by the lowercase letter <code>b</code>, finally ending with a hex-encoded RGB value. | ||
Example: To set the current background color to a pure magenta, you | Example: To set the current background color to a pure magenta, you would write the sequence <code>\x1Bbff00ff</code>. | ||
==== Resetting colors ==== | ==== Resetting colors ==== | ||
To reset the currently set color, you | To reset the currently set color, you would simply write an escape character (<code>\x1B</code>), immediately followed by the lowercase letter <code>x</code>. Keep in mind that this will reset '''both'' text '''and''' cell colors to their default values, as defined in the world's [https://wiki.ourworldoftext.com/wiki/World#World_Settings configuration settings]. | ||
=== Links & protections === | === Links & protections === | ||
| Line 27: | Line 27: | ||
In order to apply a link to some text, you first write an escape character (<code>\x1B</code>), then the characters <code>$u</code>, and ending with stringified text, '''including the quotes''', containing the contents of your link. | In order to apply a link to some text, you first write an escape character (<code>\x1B</code>), then the characters <code>$u</code>, and ending with stringified text, '''including the quotes''', containing the contents of your link. | ||
Example: If you wanted to apply the link <code><nowiki>http://owot.me</nowiki></code> to the text "<code>hi</code>", you would write <code>\x1B$u"<nowiki>http:// | Example: If you wanted to apply the link <code><nowiki>http://owot.me</nowiki></code> to the text "<code>hi</code>", you would write <code>\x1B$u"<nowiki>http://owot.me</nowiki>"h\x1B$u"<nowiki>http://owot.me</nowiki>"i</code>. | ||
=== Protections === | === Protections === | ||
To apply protections to some text, you start by writing an escape character (<code>\x1B</code>), followed by a '''protection value.''' The protection value can be one of <code>P0</code> (public), <code>P1</code> (members-only), or <code>P2</code> (owner-only). | To apply protections to some text, you start by writing an escape character (<code>\x1B</code>), followed by a '''protection value.''' The protection value can be one of <code>P0</code> (public), <code>P1</code> (members-only), or <code>P2</code> (owner-only). | ||
Example: To apply an owner-only protection to the text "sample", you | Example: To apply an owner-only protection to the text "sample", you would write <code>\x1BP2s\x1BP2a\x1BP2m\x1BP2p\x1BP2l\x1BP2e</code>. | ||
== Text decorations == | == Text decorations == | ||
| Line 39: | Line 39: | ||
OWOT uses the Unicode code point range <code>U+20F1</code> to <code>U+20FF</code> to store text decorations. The specific code point to be used is determined by encoding a character's formatting in binary (offset by a hex value of <code>0x20F0</code>). The bit order for each decoration is the same as it appears on the [https://wiki.ourworldoftext.com/images/2/20/Text_decorations_menu_2024_03_24.png official client's text decorations menu], and setting a bit to <code>1</code> enables a decoration. | OWOT uses the Unicode code point range <code>U+20F1</code> to <code>U+20FF</code> to store text decorations. The specific code point to be used is determined by encoding a character's formatting in binary (offset by a hex value of <code>0x20F0</code>). The bit order for each decoration is the same as it appears on the [https://wiki.ourworldoftext.com/images/2/20/Text_decorations_menu_2024_03_24.png official client's text decorations menu], and setting a bit to <code>1</code> enables a decoration. | ||
Example: If | Example: If you wanted to make the character "A" appear bold and italicized, you would write <code>A\u20FC</code>. | ||