Text Syntax: Difference between revisions

From Citizens Wiki
No edit summary
 
(11 intermediate revisions by 3 users not shown)
Line 1: Line 1:
Configuration syntax in Citizens is simple. Nodes within arrow brackets -- ''<>'' -- will be parsed and replaced if possible. Below are the available nodes that you can use.  
Configuration syntax in Citizens is simple. Nodes within arrow brackets -- <code>&lt;&gt;</code> -- will be parsed and replaced if possible. Below are the available nodes that you can use.  


==Chat Colors==
==Chat Colors==
Use the Chat Color character within brackets. For example, ''<a>'' would give you green.
Use the Chat Color characters the same as any other plugin. For example, <code>&a</code> would give you green.


'''Color Reference'''
'''Color Reference'''
<br>0 -- BLACK
<br>0 -- BLACK
<br>1 -- DARK BLUE
<br>1 -- <span style="color:#0000AA">DARK BLUE</span>
<br>2 -- DARK GREEN
<br>2 -- <span style="color:#00AA00">DARK GREEN</span>
<br>3 -- CYAN
<br>3 -- <span style="color:#00AAAA">CYAN</span>
<br>4 -- DARK RED
<br>4 -- <span style="color:#AA0000">DARK RED</span>
<br>5 -- PURPLE
<br>5 -- <span style="color:#AA00AA">PURPLE</span>
<br>6 -- GOLD
<br>6 -- <span style="color:#FFAA00">GOLD</span>
<br>7 -- LIGHT GRAY
<br>7 -- LIGHT GRAY
<br>8 -- GRAY
<br>8 -- GRAY
<br>9 -- BLUE
<br>9 -- <span style="color:#5555FF">BLUE</span>
<br>a -- GREEN
<br>a -- <span style="color:#55FF55">GREEN</span>
<br>b -- AQUA
<br>b -- <span style="color:#22BBBB">AQUA</span>
<br>c -- ROSE RED
<br>c -- <span style="color:#FF5555">ROSE RED</span>
<br>d -- LIGHT PURPLE
<br>d -- <span style="color:#FF55FF">LIGHT PURPLE</span>
<br>e -- YELLOW
<br>e -- <span style="color:#AAAA11">YELLOW</span>
<br>f -- WHITE
<br>f -- WHITE
'''Format Reference'''
<br>k -- Obfuscated
<br>l -- Bold
<br>m -- Strikethrough
<br>n -- Underline
<br>o -- Italic
<br>r -- Reset
[https://www.digminecraft.com/lists/color_list_pc.php Alternate color/format reference page]
You can also use hexadecimal colors in Minecraft 1.16+, using Spigot's syntax - <code>&x&f&f&0&0&e&e</code> or Essentials' syntax - <code>&#ff00ee</code> (both examples produce the same pink/magenta color).
You can also use [https://docs.adventure.kyori.net/minimessage/format.html MiniMessage].
==Special==
You can use <code>&lt;br&gt;</code> to create a newline in the middle of a text line.


==Other==
==Other==
Line 26: Line 44:


===NPC Nodes===
===NPC Nodes===
npc - NPC's name
<code>&lt;npc&gt;</code> -- NPC's name
<br>id - NPC's ID
<br><code>&lt;id&gt;</code> -- NPC's ID
<br>owner - NPC's owner
<br><code>&lt;owner&gt;</code> -- NPC's owner


===Player Nodes===
===Player Nodes===
<br>player - Player's name
<br><code>&lt;player&gt;</code> -- Player's name
<br>world - Player's world
<br><code>&lt;world&gt;</code> -- Player's world
<br><code>&lt;nearest_player&gt;</code> -- Name of the player closest to the NPC
 
===Extra Nodes===
<br><code>&lt;random_player&gt;</code> -- Random online player name
<br><code>&lt;random_npc&gt;</code> -- Random NPC name
<br><code>&lt;random_npc_id&gt;</code> -- Random NPC ID
 
==PlaceholderAPI==
 
If you have [https://www.spigotmc.org/resources/placeholderapi.6245/ PlaceholderAPI] installed on your server, you can use PAPI placeholders on NPCs and use specific Citizens PAPI placeholders anywhere that supports PAPI.
 
===External Placeholders on NPCs===
You can use any PAPI Placeholders the same as you would use them elsewhere in NPC text or commands, and non-player placeholders in NPC names/holograms/etc. [https://wiki.citizensnpcs.co/Frequently_Asked_Questions#My_PlaceholderAPI_Placeholder_Works_In_Chat.2C_But_Not_On_An_NPC See the FAQ for more details on the non-player limit].
 
===Citizens Placeholders===
<br><code>%citizens_selected_npc_name%</code> -- the name of the NPC selected by the player.
<br><code>%citizens_selected_npc_id%</code> -- the ID of the NPC selected by the player.
 
{{NavBox}}
[[Category:Configuration]]

Latest revision as of 00:45, 6 October 2022

Configuration syntax in Citizens is simple. Nodes within arrow brackets -- <> -- will be parsed and replaced if possible. Below are the available nodes that you can use.

Chat Colors

Use the Chat Color characters the same as any other plugin. For example, &a would give you green.

Color Reference
0 -- BLACK
1 -- DARK BLUE
2 -- DARK GREEN
3 -- CYAN
4 -- DARK RED
5 -- PURPLE
6 -- GOLD
7 -- LIGHT GRAY
8 -- GRAY
9 -- BLUE
a -- GREEN
b -- AQUA
c -- ROSE RED
d -- LIGHT PURPLE
e -- YELLOW
f -- WHITE

Format Reference
k -- Obfuscated
l -- Bold
m -- Strikethrough
n -- Underline
o -- Italic
r -- Reset

Alternate color/format reference page

You can also use hexadecimal colors in Minecraft 1.16+, using Spigot's syntax - &x&f&f&0&0&e&e or Essentials' syntax - &#ff00ee (both examples produce the same pink/magenta color).

You can also use MiniMessage.

Special

You can use <br> to create a newline in the middle of a text line.

Other

There are also other nodes that you can use in configuration files. Some of these do not apply to certain configuration settings, so use with care. More will be added in the future as the need arises.

NPC Nodes

<npc> -- NPC's name
<id> -- NPC's ID
<owner> -- NPC's owner

Player Nodes


<player> -- Player's name
<world> -- Player's world
<nearest_player> -- Name of the player closest to the NPC

Extra Nodes


<random_player> -- Random online player name
<random_npc> -- Random NPC name
<random_npc_id> -- Random NPC ID

PlaceholderAPI

If you have PlaceholderAPI installed on your server, you can use PAPI placeholders on NPCs and use specific Citizens PAPI placeholders anywhere that supports PAPI.

External Placeholders on NPCs

You can use any PAPI Placeholders the same as you would use them elsewhere in NPC text or commands, and non-player placeholders in NPC names/holograms/etc. See the FAQ for more details on the non-player limit.

Citizens Placeholders


%citizens_selected_npc_name% -- the name of the NPC selected by the player.
%citizens_selected_npc_id% -- the ID of the NPC selected by the player.

Retrieved from ‘https://wiki.citizensnpcs.co/index.php?title=Text_Syntax&oldid=5500’