Up to date

This page is up to date for Godot 4.0. If you still find outdated information, please open an issue.

BBCode in RichTextLabel


Label nodes are great for displaying basic text, but they have limitations. If you want to change the color of the text, or its alignment, you can only do that to the entire label. You can't make a part of the text have another color, or have a part of the text centered. To get around these limitations, you would use a RichTextLabel.

RichTextLabel allows for complex formatting of text using a markup syntax or the built-in API. It uses BBCodes for the markup syntax, a system of tags that designate formatting rules for a part of the text. You may be familiar with them if you ever used forums (also known as bulletin boards, hence the "BB" in "BBCode").

Unlike Label, RichTextLabel also comes with its own vertical scrollbar. This scrollbar is automatically displayed if the text does not fit within the control's size. The scrollbar can be disabled by unchecking the Scroll Active property in the RichTextLabel inspector.

Note that the BBCode tags can also be used to some extent in the XML source of the class reference. For more information, see Class reference primer.

See also

You can see how BBCode in RichTextLabel works in action using the Rich Text Label with BBCode demo project.

Using BBCode

By default, RichTextLabel functions like a normal Label. It has the property_text property, which you can edit to have uniformly formatted text. To be able to use BBCode for rich text formatting, you need to turn on the BBCode mode by setting bbcode_enabled. After that, you can edit the text property using available tags. Both properties are located at the top of the inspector after selecting a RichTextLabel node.


For example, BBCode [color=green]test[/color] would render the word "test" with a green color.


Most BBCodes consist of 3 parts: the opening tag, the content and the closing tag. The opening tag delimits the start of the formatted part, and can also carry some configuration options. Some opening tags, like the color one shown above, also require a value to work. Other opening tags may accept multiple options (separated by spaces within the opening tag). The closing tag delimits the end of the formatted part. In some cases, both the closing tag and the content can be omitted.

[tag option1=value1 option2=value2]content[/tag]


RichTextLabel doesn't support entangled BBCode tags. For example, instead of using:

[b]bold[i]bold italic[/b]italic[/i]


[b]bold[i]bold italic[/i][/b][i]italic[/i]

Handling user input safely

In a scenario where users may freely input text (such as chat in a multiplayer game), you should make sure users cannot use arbitrary BBCode tags that will be parsed by RichTextLabel. This is to avoid inappropriate use of formatting, which can be problematic if [url] tags are handled by your RichTextLabel (as players may be able to create clickable links to phishing sites or similar).

Using RichTextLabel's [lb] and/or [rb] tags, we can replace the opening and/or closing brackets of any BBCode tag in a message with those escaped tags. This prevents users from using BBCode that will be parsed as tags – instead, the BBCode will be displayed as text.

Example of unescaped user input resulting in BBCode injection (2nd line) and escaped user input (3rd line)

Example of unescaped user input resulting in BBCode injection (2nd line) and escaped user input (3rd line)

The above image was created using the following script:

extends RichTextLabel

func _ready():
    append_chat_line("Player 1", "Hello world!")
    append_chat_line("Player 2", "Hello [color=red]BBCode injection[/color] (no escaping)!")
    append_chat_line_escaped("Player 2", "Hello [color=red]BBCode injection[/color] (with escaping)!")

# Returns escaped BBCode that won't be parsed by RichTextLabel as tags.
func escape_bbcode(bbcode_text):
    # We only need to replace opening brackets to prevent tags from being parsed.
    return bbcode_text.replace("[", "[lb]")

# Appends the user's message as-is, without escaping. This is dangerous!
func append_chat_line(username, message):
    append_text("%s: [color=green]%s[/color]\n" % [username, message])

# Appends the user's message with escaping.
# Remember to escape both the player name and message contents.
func append_chat_line_escaped(username, message):
    append_text("%s: [color=green]%s[/color]\n" % [escape_bbcode(username), escape_bbcode(message)])

Stripping BBCode tags

For certain use cases, it can be desired to remove BBCode tags from the string. This is useful when displaying the RichTextLabel's text in another Control that does not support BBCode (such as a tooltip):

extends RichTextLabel

func _ready():
    var regex = RegEx.new()
    var text_without_tags = regex.sub(text, "", true)
    # `text_without_tags` contains the text with all BBCode tags removed.


Removing BBCode tags entirely isn't advised for user input, as it can modify the displayed text without users understanding why part of their message was removed. Escaping user input should be preferred instead.


In most cases, you can use BBCode directly as-is since text formatting is rarely a heavy task. However, with particularly large RichTextLabels (such as console logs spanning thousands of lines), you may encounter stuttering during gameplay when the RichTextLabel's text is updated.

There are several ways to alleviate this:

  • Use the append_text() function instead of appending to the text property. This function will only parse BBCode for the added text, rather than parsing BBCode from the entire text property.

  • Use push_[tag]() and pop() functions to add tags to RichTextLabel instead of using BBCode.

  • Enable the Threading > Threaded property in RichTextLabel. This won't speed up processing, but it will prevent the main thread from blocking, which avoids stuttering during gameplay. Only enable threading if it's actually needed in your project, as threading has some overhead.

Using push_[tag]() and pop() functions instead of BBCode

If you don't want to use BBCode for performance reasons, you can use functions provided by RichTextLabel to create formatting tags without writing BBCode in the text.

Every BBCode tag (including effects) has a push_[tag]() function (where [tag] is the tag's name). There are also a few convenience functions available, such as push_bold_italics() that combines both push_bold() and push_italics() into a single tag. See the RichTextLabel class reference for a complete list of push_[tag]() functions.

The pop() function is used to end any tag. Since BBCode is a tag stack, using pop() will close the most recently started tags first.

The following script will result in the same visual output as using BBCode [color=green]test [i]example[/i][/color]:

extends RichTextLabel

func _ready():
    append_text("BBCode ")  # Trailing space separates words from each other.
    append_text("test ")  # Trailing space separates words from each other.
    pop()  # Ends the tag opened by `push_italics()`.
    pop()  # Ends the tag opened by `push_color()`.


Do not set the text property directly when using formatting functions. Appending to the text property will erase all modifications made to the RichTextLabel using the append_text(), push_[tag]() and pop() functions.




Makes {text} use the bold (or bold italics) font of RichTextLabel.


Makes {text} use the italics (or bold italics) font of RichTextLabel.


Makes {text} underlined.


Makes {text} strikethrough.


Makes {text} use the mono font of RichTextLabel.


Adds new paragraph with {text}. Supports configuration options, see Paragraph options.
[p {options}]{text}[/p]
Makes {text} horizontally centered.
Same as [p align=center].


Makes {text} horizontally right-aligned.
Same as [p align=left].


Makes {text} horizontally right-aligned.
Same as [p align=right].


Makes {text} fill the full width of RichTextLabel.
Same as [p align=fill].


Indents {text} once.


Creates a hyperlink (underlined and clickable text). Can contain optional {text} or display {link} as is.
Must be handled with the "meta_clicked" signal to have an effect, see Handling [url] tag clicks.
Creates a tooltip hint that is displayed when hovering the text with the mouse. Tooltip text should not be quoted (quotes will appear as-is in the tooltip otherwise).
[hint={tooltip text displayed on hover}]{text}[/hint]
Inserts an image from the {path} (can be any valid image resource).
If {width} is provided, the image will try to fit that width maintaining the aspect ratio.
If both {width} and {height} are provided, the image will be scaled to that size.
If {valign} configuration is provided, the image will try to align to the surrounding text, see Image vertical alignment.
Supports configuration options, see Image options.
[img {options}]{path}[/img]
Makes {text} use a font resource from the {path}.
Supports configuration options, see Font options.
[font {options}]{text}[/font]
Use custom font size for {text}.


Use a different font size and color for {text}, while making the tag's contents span multiple lines if it's large enough.
A drop cap is typically one uppercase character, but [dropcap] supports containing multiple characters. margins values are comma-separated and can be positive, zero or negative. Negative top and bottom margins are particularly useful to allow the rest of the paragraph to display below the dropcap.

[dropcap font_size={size} color={color} margins={left},{top},{right},{bottom}]{text}[/dropcap]

Enables custom OpenType font features for {text}. Features must be provided as a comma-separated {list}.
Changes the color of {text}. Color must be provided by a common name (see Named colors) or using the HEX format (e.g. #ff00ff, see Hexadecimal color codes).


Draws the color behind {text}. This can be used to highlight text. Accepts same values as the color tag.


Draws the color in front of {text}. This can be used to "redact" text by using an opaque foreground color. Accepts same values as the color tag.


Use custom font outline size for {text}.
Use custom outline color for {text}. Accepts same values as the color tag.
Creates a table with the {number} of columns. Use the cell tag to define table cells.


Adds a cell with {text} to the table.
If {ratio} is provided, the cell will try to expand to that value proportionally to other cells and their ratio values.
Supports configuration options, see Cell options.
[cell {options}]{text}[/cell]
Adds an unordered list. List {items} must be provided by putting one item per line of text.


Adds an ordered (numbered) list of the given {type} (see Ordered list types). List {items} must be provided by putting one item per line of text.

[ol type={type}]{items}[/ol]

lb, rb
Adds [ and ] respectively. Allows escaping BBCode markup.
[lb]b[rb]text[lb]/b[rb] will display as [b]text[/b].
Several Unicode control character can be added using their own tags.
[lrm], [rlm], [lre], [rle], [lro], [rlo],