Type1J / Godot-Rich-Text-Effect-Test-Project

This is a test project for the new godot RichTextEffect class. It also comes with some example implementations of custom text effects. View ReadMe for details.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Godot: Rich Text Effect Testing Project:

This is a test project for the new Godot feature RichTextEffect (godotengine/godot#23658). This project was made so that I could test the new real time effects feature that I added to the RichTextLabel node. It also helps to test for regressions or inconsistencies in rich text behavior. For more details regarding the RichTextEffect feature, please click the link to the pull request above.

Installation:

The best way to install this project is to clone this project into your Godot source code directory's projects folder, as this folder is ignored by Godot's git configuration.

Note: If you are running OSX or Windows operating systems, these commands will need to be changed to better reflect your operating system's CLI.


cd [GODOT_SOURCE_DIRECTORY_HERE]/projects
git clone git@github.com:Eoin-ONeill-Yokai/Godot-Rich-Text-Effect-Test-Project.git ./test_rich-text-effect

Once you've done that, you need to checkout my branch of the Godot game engine by running:


cd [GODOT_SOURCE_DIRECTORY_HERE]
git remote add eoinoneill git@github.com:Eoin-ONeill-Yokai/godot.git
git checkout eoinoneill/rich-text-plus

You can then compile the Godot game engine and run the project by running the following commands.


cd [GODOT_SOURCE_DIRECTORY_HERE]
scons -j[THREADCOUNT] platform=x11 && ./projects/test_rich-text-effect/launch.sh

//If you're on windows, you'll want to run something like...
scons -j[THREADCOUNT] platform=windows && .\bin\godot.win.tools.* -e .\projects\test_rich-text-effect

The Future:

While I am currently in the process of wrapping up the rich text effect pull request (godotengine/godot#23658), I believe that this repository could be useful for sample text effects and perhaps as a testing ground for more RichTextLabel features down the line. Thus, I decided to openly share this repository for those who are interested.

About

This is a test project for the new godot RichTextEffect class. It also comes with some example implementations of custom text effects. View ReadMe for details.


Languages

Language:GDScript 96.8%Language:Shell 3.2%