v1.8 Demo

Two Nodes:

• RicherTextLabel: Reduce effort needed to display state data and stylize it.
• RichTextAnimation: For dialogue and cinematics, animates text in and out.

• Multi bbcode tags + easy closing + auto color names: [deep_sky_blue;b]Bold blue[] and [orange;i]Italic orange[].
• Integer tags for absolute font size, float tags are relative font_size: [32]Big text[] and [0.5]half text.[]
• Auto emojis: I'm :smile: with results. You get a :+1:.
• Effects automatically installed when you use them: We on the [sin]sinewave[] vibe.
  • Many premade effects. See Tags section below.
• Context strings: Only $coins coins, $player.name? Travel to $location.get_name("west") for more coins.
  • Can call functions or get nested properties.
  • Niceifys integers with commas. 1234 -> 1,234
  • Niceifys objects by calling to_rich_string() if it can.
  • Niceifys arrays by joining them into a comma seperated list.
• Easy font selection dropdown detects all fonts in the project.
  • Automatically creates Bold, Italic, and Bold Italic font variations if they don't exist.
  • Tweakable boldness and italic slant.
• Automatic opening and closing quotes.
• Customize how Markdown gets converted: _italic_ -> [i]%s[] -> [i]italic[] *cough* -> [i]*%s*[] -> [i]*cough*[].
• Auto color formatting: "My [%s]colored string[] is easy." % [Color.DEEP_SKY_BLUE]
• RichTextAnimation for fading in and out.
  • 7 transition effects. (Some unstable/untested.)
  • Click2Continue node that can display at the last visible character.
  • [hold] [h] Tag to pause animation until user. Wait...[h] Did you hear...[h] *Bang*!
  • [wait] [w] Tag to wait in seconds. (Defaults to 1) Let me thing.[w] Hmm...[w]...[w]...
  • [pace] [p] Set pace of animations. A slow talker [p=.1]talks like this...[p] While fast talkers [p=3]talk like this...
• Many more I can't rememember... there are a lot of features.

This node is meant for dialogue systems and cinematics.

If shortcut_expression = true you can use the <code expression> pattern instead of the [!code expression] pattern.

Did you hear something...[wait][$play_sound("gurgle")] Uh oh![$player.fear = 100.0] Ahh...
Did you hear something...[wait]<play_sound("gurgle")> Uh oh!<player.fear = 100.0> Ahh...

If shortcut_bookmark = true you can use the #bookmark pattern instead of the [#bookmark] pattern.

He told me#quote the haunted forest#endquote wasn't so haunted.#end
He told me[#quote] the haunted forest[#endquote] wasn't so haunted.[#end]

If a font has "emoji" (any case) in it's name, it will be used for emojis instead of the default font.

Emojis sometimes lag on some computers, which I get around by creating a custom FontVariant that uses the emoji font as a base and ThemeDB.fallback_font as a fallback font. This seems to prevent lag spikes.

If an emoji tag is used :smile: or [:smile:] an emoji_font metadata key will be created with the font.

Pipes | post process strings.

There are two ways to use them.

• Inside expressions {$score+2|pipe}
• Or as a tag [|pipe]Text to be passed.[]

# These are all doing the same thing.
"We'll visit {location|capitalize} tomorrow."
"We'll visit {location.capitalize()} tomorrow."
"We'll visit [|capitalize]$location[] tomorrow."

# Arguments can also be passed as a space seperated list:
# These are all the same.
"Day of week: {time.day_of_week|substr 0 3}"
"Day of week: {time.day_of_week.substr(0, 3)}"
"Day of week: [|substr 0 3]$time.day_of_week[]"

The real power is in adding your own. Pipes try to use a method inside the context node.

func cap(x):
	return x.capitalize()

func oooify(x):
	if cow_mode == CowMode.ACTIVATED:
		return x.replace("o", "[sin]ooo[/sin]").replace("O", "[sin]OOO[/sin]")
	else:
		return x

# Pipes can be chained.
# Location name gets capitalized, and all it's O's stretched out.
"We'll visit {location|cap|ooify}."

# Or we may want to change entire the dialogue based on state data.
[|ooify]Wow those cows were mooing.[]

Or maybe you want to stylize content based on the characters mood.

# If returning BBCode, it has to be old fashioned style.
func mood(s: String, npc_id: String):
	match npcs[npc_id].emotion:
		Emotion.HAPPY: return "[color=yellow]%s[/color]" % s
		Emotion.SAD: return "[color=aqua]%s[/color]" % s
		Emotion.ANGRY: return "[color=red]%s[/color]" % s
		_: return s

"Mary: [i;|mood mary]What I'm saying will be colored based on my mood.[]"
"John: [i;|mood john]What I'm saying will be colored based on my mood.[]"

• 1.8
  • Fixed support for built in effects: pulse wave tornado shake fade rainbow
  • Removed Godot 4.4.dev feature: PROPERTY_HINT_DICTIONARY_TYPE
• 1.7.1
  • Fixed FontHelper erroring on built projects.
• 1.7
  • Changed set_bbcode to queue for the end of the frame.
  • Moved tag state and stack to STACK_STATE object.
  • Moved font_cache and font functions to FontHelper.
  • Removed _random and set as meta property since it's rarely used.
• 1.6.3
  • Fixed color property not being settable from script.
  • Fixed alignment error and used slightly more efficient method.
• 1.6.2
  • Removed Godot 4.4.dev feature: horizontal_alignment property.
• 1.6.1
  • Removed Godot 4.4.dev feature: Explicitly typed dictionary.
• 1.6
  • Added outline_color to set the default outline color.
  • Added outline modes:
    • CUSTOM to apply default outline_color to all text.
    • CUSTOM_DARKEN to apply outline_color to non colored text, but darken outlines otherwise.
    • CUSTOM_LIGHTEN to apply outline_color to non colored text, but lighten outlines otherwise.
  • Renamed OutlineStyle to OutlineMode to match property outline_mode.
  • Fixed OutlineMode.OFF not turning off outlines.
• 1.5
  • Added [!] meta tag which calls an expression when pressed.
  • Added [^] hint tag which calls an expression to display in a popup when hovered.
  • Added custom tooltip for hint tags which now use the RicherTextLabel.
  • Added meta_auto_https which opens urls in a browser.
  • Added fit_width which will set custom_minimum_size.x = get_content_width().
  • Handles \n better now.
  • Removed alignment since original RichTextLabel now has horizontal_alignment.
• 1.4.2
  • Fixed custom RichTextEffects not working on built projects.
• 1.4.1
  • Fixed variables not being resetable to defaults.
• 1.4
  • Changed how bbcode is initialized when not yet inside the tree.
  • Made node selection slightly faster by moving all @export to _get_property_list.
  • Made node selection slightly faster by caching project fonts.
  • Renamed scripts to lowercase to match Godots prefered style.
  • Renamed context_nice_* properties to context_rich_*.
• 1.3 BREAKING CHANGES
  • Change: Class name RicherTextLabel from RichTextLabel2 to prevent future problems.
  • Change: Objects can implement to_rich_string() instead of to_string_nice().
  • advance() only skips to next [wait] [hold] or `[$expression] instead of all triggers.
  • advance() returns true if still playing.
  • Added tiny wait timer when forcing a finish, so the user doesn't accidentally skip text.
  • Fixed scene sizes being massive by preventing auto fonts saving to disk.
  • Fixed fit_content not working. Now override_fitContent really forces custom_minimum_size.
  • Fixed cursor based effects being very laggy.
  • Fixed ctc_position handling on new lines.
  • Fixed animations jumping when nearly finished.
  • Fixed set_bbcode being called many times in a row.
• 1.2
  • Added pipes |. See README.
  • Added auto styling of decimal numbers:
    • autostyle_numbers_pad_decimals Enable?
    • autostyle_numbers_decimals Number of decimals.
  • Added 4 new effects:
    • [curspull] shows how to animate based on cursor position.
    • [wack] randomly scales and rotates characters.
    • [beat] pulses it's scale and color every second.
    • [secret] hides characters unless cursor is nearbye.
  • Animation
    • Added 3 new animations:
      • [fromcursor] which transitions letters to and from cursor position.
      • [growin] scales characters in, overshooting, then scaling to proper size.
      • [offin] moves characters in from an left offset.
  • Tweaked [cuss] [heart] [rain] [sway] [uwu].
  • Fixed regression in effects based on text characters.
  • Fixed Markdown symbols catching when inside [] {} or <>.
• 1.1
  • Added context_state: Dictionary for passing additional arguments available in expressions.
  • Added {} pattern for including complex expressions. Example: {lerp(score, 2, 0.2) * PI}.
  • Added autostyle_emojis to disable emoji detection.
  • Changed bracket escapes to be [[] pattern instead of \[] pattern.
  • Fixed emoji_font not loading.
  • Fixed emoji_scale not affecting emojis.
  • Fixed effects not animating after an emoji was used.
  • Fixed custom_effects each having text metadata.
  • Fixed Markdown detection not working when around tags.
  • Added many more comments.
  • Animation
    • Added ctc_offset.
    • Added ctc_on_wait to control whether ctc is visible while waiting for timer.
    • Added ctc_on_finish to control whether ctc is visible when animation finishes.
    • Added default_wait_time for the [wait] and [w] tags.
    • Added signals for when waiting starts and stops.
    • Added signals for when hold starts and stops.
    • Added signal_quotes and signals for when a "quote" starts and stops.
    • Added signal_stars and signals for when stars start and stop.
    • Fixed expression triggers.
    • Fixed bookmark triggers.
    • Fixed tags [wait][w][hold][h][pace][p][skip].
    • Fixed ctc showing up properly.
    • Renamed signals so their function is more obvious.