rakugoteam/advancedtext

Extends RichTextLabel to add support for Markdown and Ren'Py markups

AdvancedText

Extends RichTextLabel and adds support for Markdown and RenPy. Our RenPy Markup and Markdown have some extra stuff so read docs to learn it. This new version is designed in way so any one can crate its own TextParser to use with AdvancedText nodes. Read Docs

Features

• Supports Markdown and RenPy
• Adds headers supports RenPy and BBCode
• Support for variables in Rakugo Dialogue System use<var_name>
• Support Emojis For Godot use :emoji:
• Support Godot Material Icons use [icon:icon_name]

Nodes

• AdvancedTextLabel - RichTextLabel that allow to use one of included TextParsers
• AdvancedTextButton - AdvancedTextLabel that behaves like a button

Resources

• TextParser - base class for our TextParsers
• ExtendedBBCodeParser:
  • base of for our RenPy Markup and Markdown parsers
  • includes support for things mentioned in Features
• RenPyMarkup - RenPy Markup Parser with extra tags so it is 100% replaceable with Godot's BBCode
• MarkdownParser - Markdown Parser with extra stuff so it is mostly replaceable with Godot's BBCode

advancedtext's Issues

Change selected markup option at selected node

MakrupEdit ⇾ CodeEdit, add support for JSON and GDScript

This will be useful and is easy to add, but GDScript support will be just for showing code examples rather editing real code.

Add Markup Switcher

RakugoTextLabel ⇾ AdvancedTextLabel

To do:

• #12
• #11
• #10
• #8
• #25
• #26
• #9

Add Example of AdvancedTextLabel that can be edit when you click on it.

variables directory field

support for Rakugo

• Rakugo game settings ⇾ moved to Project Settings
• Rakugo global vars ⇾ moved to Rakugo Project

Add Markup Edit

text highlight

Add Select Node Mode

Add mode that to edit text in selected node for scene tree of type:

• AdvancedTextLabel
• RitchTextLabel
• CodeEdit
• TextEdit

This mode hide files panel:

Switch between modes:

This code is in MakrupTextEditor.gd

Integrate with Godot

Move here ChocieButton from Rakugo Visual Novel GUI Template

Make it an example or even better turn it into the node type.

Restore Previous Files Session

This code is partally done in addons/advanced-text/MarkupTextEditor/EditorHelper.gd , and it is in MakrupTextEditor.gd.

This should:

• write/load editor setting to ProjectSettings
• save open files on editor close to EditorHelper.files_ram
• restore files on editor open from EditorHelper.files_ram

Add Support for Godot Material-Icons

Missing file 'res://addons/advanced-text/MarkupTextEditor/FileRam.gd'

AdvancedText/project.godot

Line 81 in bb63947

FilesRam="*res://addons/advanced-text/MarkupTextEditor/FileRam.gd"

This file is missing from the repository and cannot be loaded.

Project Settings for AdvancedTextLabel

• default markup
• default variables to load

Split Code and Scenes of MakrupTextEditor

Split MakrupTextEditor.gd and MakrupTextEditor.tscn
Progress here: milestone 1.6

use emojis.gd for highlight emojis

As highlight emojis using color region for ":" as start and end for region breaks highlight other than markdown one.
So we can try to use for these emojis.gd - this also will be better than using coloring regions as it highlights only correct emojis.

Remove project-settings-helpers dependence

I can remove project-settings-helpers dependence, as @theludovyc proved on his stream, using just ProjectSettings is simpler. works and fix every problem I head.

Make Emojis popup works agian

multiline text edit field

preview

support for handling web links

It will just open os web browser if link starts from http:// or https://

Fix bug with loading default markup option from Project Settings on scene start

Now when we have scene with AdvancedTextLabel, that has markup setting setup to default it brakes scene on start.

Add Preview Switcher

• Switch that enable/disable preview at all
• Switch to switch between bottom and right preview
  

Fix using vars from dict, maybe use json

For some reason is not possible to save exported dict, so for using vars from dict in text we can:

1. just have dict with predefined var just for test
2. json to load dict from
3. array of helper class that has name (str) and value (str) that can be converted to dict

I think option 1. will be enough, probably most users will overwrite it in using code anyway.

load/save `markup_text` in current selected AdvancedTextLabel

support for handling links to other *.md, *.txt files

It will replace current file/markup text with one from link if link start with res:// or user:// and ends with *.md or *.txt.
Maybe it should be part of an example scene called Text Browser, as it will need some buttons to navigate back and forward.

Adds support headers

Adds support for 4 headers:

• Adds AdvancedTextLabel fields for fonts for 1, 2 and 3 headers.
• Adds support for it each markup:
  • Markdown standard # times header level
  • BBCode [H1] - where number is header level
  • Ren'Py {H1} - where number is header level

Add help for each markup language

Add Right Preview

Expand Markdown

• use alt text for image size, for example: ![32x32](res://path/to/image.png)

Add CSS like syntax for some BBCode that don't have markup equivalent:

• table css mix markdown

@table=2 {
|cell|cell|
}

• text alignment tags

@center {
  Centered Text
}

• effects

@wave amp=50 freq=2{
  Waving Text
}

Separate RakugoTextPasser / RakugoTextLabel ⇾ AdvancedTextLabel

We should separate RakugoTextParser / RakugoTextLabel from Rakugo.
and create out of it AdvancedTextLabel - one plugin will be easier to maintain then 3,
all of them will had the almost same code for Node based on RichTextLabel and Markup Text Edit Tool
It will allow for easier maintaining and updating this code.
So we need:

• #7

• #6

• Split RakugoTextParser into:

  • #3
  • #4
  • #5

load/save *.md, *.txt files

Markdown Parser (base on Extended BBCode Parser)

Make sure that TextEdit and Previews are in sync

Make sure that TextEdit text is also display and update in current Preview.

Docs for AdvancedText

Try to use:

• GDScriptify
• MyST - already used by RakugoDocs

Stuff that need docs 🔴 (first):

• AdvancedTextLabel
• CodeEdit
• MarkupEditor tool - only how to use it
• Makrups ⇽ can be taken and update from RakugoDocs

Stuff that need docs 🟢 (later):

• How JSON config files for CodeEdit works
• BBCode Parser
• RenPy Parser (after splitting convert_renpy_markup() to smaller methods)
• Markdown Parser (after splitting convert_markdown() to smaller methods)
• MarkupEditor tool - code (after splitting its code to smaller scripts/scenes)

file *.md, *.txt field

Add Color picker

Fix Help Popup don’t showing up

Fix bugs that make Help Popup doesn't show up after pressing button.
It should show help tab for chosen markup mode in text edit.

Extended BBCode Parser (BBCode with values and opt. emojis)

choosing markup

Make sure that highlight and previews works for chosen markup

Make sure that highlight and previews works for chosen markup.
Make sure that TextEdit highlight text for chosen markup.
Make sure that both RightPreview and BottomPreview use right render mode for chosen markup

Improve UI/UX of tool

Edit tool for Text Nodes markup text

This tool made creating dialogue lines and text to display using AdvancedTextLabel easier.

To Do

• #13
• #14
• #15
• #17
• #20
• #21
• #16
• #18
• #19
• #32
• Rakugo support: somehow generate JSON from RakugoVars / Characters (maybe move it to Rakugo)

Add Bottom Preview

Improve highlight of markup languages

simple edit

AdvancedTextLabel doesn't load/apply selected header fonts

In version 1.1 just like in the tile

Ren'Py Markup Parser (base on Extended BBCode Parser)