#
#   888888 888888 Yb  dP 888888 88""Yb  dP"Yb  Yb  dP
#     88   88__    YbdP    88   88__dP dP   Yb  YbdP
#     88   88""    dPYb    88   88""Yb Yb   dP  dPYb
#     88   888888 dP  Yb   88   88oodP  YbodP  dP  Yb   V 1.0 for Godot 2.1.4
#
#   Copyright (C) 2018 TheRedPlanet (https://github.com/RubrumExPlaneta/)
#
#   This program is free software: you can redistribute it and/or modify
#   it under the terms of the GNU General Public License as published by
#   the Free Software Foundation, either version 3 of the License, or
#   (at your option) any later version.
#
#   This program is distributed in the hope that it will be useful,
#   but WITHOUT ANY WARRANTY; without even the implied warranty of
#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#   GNU General Public License for more details.
#
#   You should have received a copy of the GNU General Public License
#   along with this program.  If not, see <https://www.gnu.org/licenses/>.
#

This is a simple, highly customizable JRPG-style dialogue box asset I created for Godot 2.1.4. This might work on other versions of Godot, but I will only make bug fixes and such for Godot 2.1.4–please do not submit bug reports/pull requests for other versions of Godot.

What this asset CAN do out of the box...

Text Boxes (with customizable layout)
Name Tags (per dialog)
Face Chips (or, portraits, per dialog)
Typing effect (with customizable speed and skip feature)
Shaking text (with customizable strength/speed)
Automatic Line Breaks

What this asset CANNOT do out of the box...

Formatted text (bold**, italic, color, etc.)
Partial shaking effect (only part of text shaking)
Different Fonts
Name shaking effect
Questions
Transitions
Scrolling
...and a lot of other things

What do you mean, out of the box?

I say out of the box, because this asset is very easy to customize, and you can add many different features by making simple alterations to the code so that it fits your needs. (If you do decide to add new features, you will have to distribute it under the CC BY-SA 4.0 International license so that others can use it, or, even better, submit a pull request)

Will new features be added in the future?

Maybe? I might be adding some features if and when I need them myself, but other than questions (even question I might not add), I don't really have a specific TODO list in mind. Nevertheless–if you have suggestions, try submitting them to https://github.com/RubrumExPlaneta/godot-textbox/issues with the enhancement label. Who knows, maybe I'll implement them! :)

Examples

Here is a screenshot of the demo project.

Here are some pictures of what this asset can be used to create. Please do note, however, that these text boxes weren't actually created with this asset.

Download Instructions

If you want to use this in your game, simply clone the contents of the source folder into your Godot project folder and Instance the TextBox.tscn scene to whatever scene(s) you want to use the text box in. If you want a working demo, import the demo project into Godot.

lunabunn / godot-textbox