With Flower, you can not only setup your dialogs but also trigger functions (like showing images, playing audios, executing customized C#...) by plain text.
You can create your content in a text file efficiently, easily integrate with your own game logic with default Dialog and Button features.
For extensibility, you can customize your own commands and effects with parameters for objects in Godot.
✨Supported for Godot4.x C# version.
Demo(Chinese) : https://youtu.be/JsLSjzkFric
- Setup Flower
- Writing Content
- Commands
- Dialog
- Button
- Effects
- Variables
- Stop and Resume System
- Async Commands
- Settings
- Customized Event Functions
- Contribute
-
Setup Flower, UniCoroutine, Resources into your Godot project.
-
Create FlowerSystem.
FlowerSystem flowerSys; flowerSys = FlowerManager.instance.GetOrCreateFlowerSystem("FlowerSample"); flowerSys.SetupDialog();
-
Assign your dialog content via plain text file or string list.
Load the "start.txt" file from Resources folder and execute.
flowerSys.ReadTextFromResource("res://Resources/start.txt");
Assign content via a string list, that means you can generate content dynamically.
flowerSys.SetTextList(new List<string>{"This is Flower System![w]"});
You can write your dialog text in the plain text file, and calling keyword commands for visual and auditory purpose and gameplay controlling.
Use brackets [keyword] (by defult) to set the keyword commands.
- If you want to print the brackets (SPECIAL_CHAR_STAR), just repeat it to make the words not a command.
- ex : ( [[w] -> print "[w]" )
1. text: Hello![l]World![w]
result: Hello!(wait for press)
result: Hello!World!(wait for press)
2. text: Hello![r]World![w]
result: Hello!
World!(wait for press)
3. text: Hello![lr]World![w]
result: Hello!(wait for press)
result: Hello!
World!(wait for press)
4. text: Hello![w]World![w]
result: Hello!(wait for press)
result: World!(wait for press)
[audio,bgm,res://Resources/bgm.mp3,true,0,audioTransit_1_2000]
[image,fg1,res://Resources/character_image.png,0,0,10,spFadeIn_1000]
It's raining...
[particle,p1,res://Resources/rain_cpu_particle.tscn,0,-360]
[wait,1000]
[w]
[remove,p1]
It clears up.[w]
[remove,fg1,spFadeOut_1000]
| Type | Keywords | Commands |
|---|---|---|
| 💬 | l | Wait for press. |
| 💬 | r | Change the line. |
| 💬 | lr | Wait for press, and change the line. |
| 💬 | w | Wait for press, and erase the text. |
| 💬 | c | Erase the text. |
| 👀 | hide | Hide the text panel. |
| 👀 | show | Show the text panel. |
| 📌 | stop | Stop the system. |
| 📌 | resume | Resume the system. |
| 💬 | #VAR_NAME | Display the variable value. |
| ⏱ | wait | Waiting. |
| 🖼 | image | Show the image. |
| 🔊 | audio | Play the audio. |
| ⚡️ | effect | Apply the object effect. |
| ✨ | particle | Spawn a particle object. |
| 🗑 | remove | Remove the scene object. |
| ⏱ | wait_audio | Wait until the audio finishes playing. |
The Command Functions should follow the parameters : (List parameters). Parsing parameters and Executing.
private void CustomizedFunction(List<string> _params)
{
// Parse parameters.
var resultValue = int.Parse(_params[0]) + int.Parse(_params[1]);
GD.Print($"Hi! This is called by CustomizedFunction with the result of parameters : {resultValue}");
}Register this command and using [UsageCase] to call this customized command.
flowerSys.RegisterCommand("UsageCase", CustomizedFunction);- DialogPrefab has to contain CanvasGroup component and "DialogPanel/DialogText" object with Unity UI Text component.
- Default will load "DefaultDialogPrefab" in resources folder.
flowerSys.SetupDialog();flowerSys.RemoveDialog();flowerSys.Next();- ButtonGroup is a container to contain Buttons, if you want to setup Buttons, you need to setup ButtonGroup first.
- ButtonGroupPrefab need to contain CanvasGroup component and "ButtonPanel" object.
- Default will load "DefaultButtonGroupPrefab" in resource folder.
flowerSys.SetupButtonGroup();- Default will load "DefaultButtonPrefab" in resource folder.
- The Button object will be appeneded to "ButtonGroup->ButtonPanel"
flowerSys.SetupButton("Button Demo.",()=>{
// Your code here...
flowerSys.Resume(); // Resume system.
flowerSys.RemoveButtonGroup(); // Remove the button group.
});| Effect Name | Target | Commands |
|---|---|---|
| spFadeIn | 🖼CanvasItem | Set sprite alpha from 0 to current. |
| spFadeOut | 🖼CanvasItem | Set sprite alpha from current to 0. |
| moveTo | 🧊Node2D/3D | Move to the position (pixel). |
| audioTransit | 🔊AudioStreamPlayer2D | Set the volume from current to value. |
| canvasGroupTransit | 🖼CanvasItem | Set the alpha from current to value. |
Define a IEnumerator task for rotating objects.
IEnumerator CustomizedRotationTask(string key, Node obj, float endTime){
if(obj is Node2D){
var startRotationDegree = (obj as Node2D).RotationDegrees;
var endRotationDegree = (obj as Node2D).RotationDegrees+180;
yield return flowerSys.EffectTimerTask(key, endTime, (percent)=>{
// Update function.
var currentDegree = Mathf.Lerp(startRotationDegree, endRotationDegree, percent);
(obj as Node2D).RotationDegrees = currentDegree;
});
}else if(obj is Node3D){
var startRotationDegree = (obj as Node3D).RotationDegrees;
var endRotationDegree = (obj as Node3D).RotationDegrees + new Vector3(0,0,180);
yield return flowerSys.EffectTimerTask(key, endTime, (percent)=>{
// Update function.
var x = Mathf.Lerp(startRotationDegree.X, endRotationDegree.X, percent);
var y = Mathf.Lerp(startRotationDegree.Y, endRotationDegree.Y, percent);
var z = Mathf.Lerp(startRotationDegree.Z, endRotationDegree.Z, percent);
(obj as Node3D).RotationDegrees = new Vector3(x, y, z);
});
}
yield return null;
}The Effect Functions should follow the parameters : (string key, List parameters). Parsing parameters, Extracting targets and Executing tasks.
private void EffectCustomizedRotation(string key, List<string> _params){
try{
// Parse parameters.
float endTime;
try{
endTime = float.Parse(_params[0])/1000;
}catch(Exception e){
throw new Exception($"Invalid effect parameters.\n{e}");
}
// Extract targets.
Node sceneObj = flowerSys.GetSceneObject(key);
// Apply tasks.
CoroutineSystem.instance.StartCoroutine(CustomizedRotationTask($"CustomizedRotation-{key}", sceneObj, endTime));
}catch(Exception){
GD.PushError($"Effect - CustomizedRotation @ [{key}] failed.");
}
}Register this effect and using customizedRotation_endTime as the EffectName.
flowerSys.RegisterEffect("customizedRotation", EffectCustomizedRotation);You can setup variables and using in dialogs / commands / effects with VAR_CHAR (Default '#')
flowerSys.SetVariable("myInfo", "( ﾟдﾟ)");
flowerSys.SetVariable("myXPosition", "300");
flowerSys.SetVariable("myTransitTime", "2000");Hello [#myInfo].
[image, img_1, test_image, #myXPosition, 0]
[effect, img_1, spFadeOut_#myTransitTime]
Use [stop] command or .Stop() function to pause the system.
Use .Resume() function to resume the system.
flowerSys.Resume();Async Commands can be executed asynchronously.
| Type | Keywords |
|---|---|
| 🖼 | async_image |
| 🔊 | async_audio |
| ⚡️ | async_effect |
| 🗑 | async_remove |
The center of the screen is (x:0, y:0), and the unit is pixel.
The screen size is fixed, according to the project setting. (display/window/size/viewport) for example, if your screen size is 1280/720, and scale to 1920/1080, the (0,0) is still mapped to (640,360).
Get the Scene Object that match the key.
flowerSys.GetSceneObject("Scene Object Key")Query the Scene Objects that match the regular expression pattern.
flowerSys.QuerySceneObject("Regular Expression Pattern")flowerSys.RegisterToSceneObject("KEY", gameObject)To apply global settings like Music & Sound Volumes, etc.
You can use Variables to inject the setting values to Commands for New Objects.
You can use Query Scene Objects to query the target scene objects by Key, and apply the settings to Exist Objects.
- Turn on Auto mode.
flowerSys.processMode = ProcessModeType.Auto;
- Turn off Auto mode.
flowerSys.processMode = ProcessModeType.Normal;
You can customized your own text updating function, for example, updating the text to TextMesh.
flowerSys.SetupDialog("DefaultDialogPrefab", false);flowerSys.textUpdated += (object sender, TextUpdateEventArgs args)=>{
// Your text updating function here...
// GD.Print(args.text);
};You can customized your own log function, for example, only handling error logs and stop the game or storing the logs into log files.
flowerSys.isDefaultLogEnable=false;flowerSys.logHappened += (object sender, LogEventArgs args)=>{
GD.Print($"[{args.type}]{args.message}");
};Do you want to improve Flower? Welcome :)!
If you find some bugs, have any suggestion for features / improvements, feel free to create issues or send pull requests. (●'◡'●)