Merge pull request #212 from food-please/main

Add Cutscenes: trigger-able sequences of events such as dialogues, treasure chests, & area transitions

Author: NathanLovato

.gitattributes

@@ -0,0 +1,2 @@
+# Normalize EOL for all files that Git considers text files.
+* text=auto eol=lf

CHANGELOG.md

@@ -1,6 +1,34 @@
 # Changelog
 
-## v0.1.0 Project Demo 🏃 2023-05-19
+## v0.2.0 Cutscene Demo 💬
+
+### New
+
+The demo scene has been reworked to include cutscenes, the videogame equivalent of a short scene in a film. For example, dialogue may be displayed, the scene may switch to show key NPCs performing an event, or the inventory may be altered. Gameplay on the field is **stopped** until the cutscene concludes, though this may span a combat scenario (e.g. epic bossfight).
+
+The demo introduces:
+- 3 main classes: Custcenes, Interactions, and Triggers
+- 5 template Cutscenes
+	- Tresasure chests (that can be closed!)
+	- Lock-able doors
+	- Item pickups
+	- Simple area transitions (all within the same scene, for now)
+	- conversations, implemented via Dialogic 2
+- 3 simple areas to explore
+- Music and sound effects sprinkled throughout the demo
+- A simple inventory implementation
+- Screen transitions, both fade and texture-based
+
+### Changes
+
+- Reworked the demo scenario, adding a handful of areas to explore, a (fetch) quest to fulfill, and a simple puzzle to solve. If you're stuck, try talking to the energetic child...
+- Rearranged the folder structure.
+- Included the Dialogic 2 Alpha addon. ***Note that input has been modified to respond to the input events being released, rather than pressed.***
+- Miscellaneous fixes throughout the demo.
+
+***
+
+## v0.1.0 Project Demo 🏃
 
 ### New
 

CREDITS.md

@@ -1,5 +1,35 @@
 # Credits for external assets. 
-  
+
+Apple Cider
+Author: Zane Little Music
+URL: https://ko-fi.com/s/da7750d2a9 (accessed 2023-12-29)
+License: [CC0](https://creativecommons.org/publicdomain/zero/1.0/) 
+
+Emotes Pack
+Author: Kenney
+URL: https://kenney.nl/assets/emotes-pack (accessed 2023-06-02)
+License: [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
+
+Impact Sounds
+Author: Kenney
+URL: https://kenney.nl/assets/impact-sounds (accessed 2023-12-20)
+License: [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
+
+Insect Factory
+Author: Zane Little Music
+URL: https://opengameart.org/content/insect-factory-wii-style-music (accessed 2023-06-06)
+License: [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
+
+Interface Sounds
+Author: Kenney
+URL: https://kenney.nl/assets/interface-sounds (accessed 2023-12-20)
+License: [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
+
+RPG Audio
+Author: Kenney
+URL: https://kenney.nl/assets/rpg-audio (accessed 2023-12-20)
+License: [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
+
 Tiny Series (Tiny Town & Tiny Dungeon)  
 Author: Kenney  
 URL: https://kenney.nl/assets/tiny-town & https://kenney.nl/assets/tiny-dungeon (accessed 2023-02-22)  

README.md

@@ -4,7 +4,7 @@
 
 OpenRPG is a tool and a demo to create Role Playing Games with turn-based combat.
 
-➡ Follow us on [Twitter](https://twitter.com/NathanGDQuest) and [YouTube](https://www.youtube.com/c/gdquest/) for free game creation tutorials, tips, and news! Get one of our [Godot game creation courses](https://gdquest.mavenseed.com/courses) to support our work on Free Software.
+➡ Follow us on [Twitter](https://twitter.com/NathanGDQuest) and [YouTube](https://www.youtube.com/c/gdquest/) for free game creation tutorials, tips, and news! Get one of our [Godot game creation courses](https://www.gdquest.com/product/) to support our work on Free Software.
 
 ## Project Goal
 

addons/dialogic/Editor/CharacterEditor/char_edit_p_section_exports.gd

@@ -0,0 +1,89 @@
+@tool
+extends DialogicCharacterEditorPortraitSection
+
+## Section that allows setting values of exported scene variables
+## for custom portrait scenes
+
+var current_portrait_data := {}
+
+
+func _get_title() -> String:
+	return "Settings"
+
+
+func _init():
+	hint_text = "The settings here are @export variables from the used scene."
+
+
+func _load_portrait_data(data:Dictionary) -> void:
+	_recheck(data)
+
+
+## Recheck section visibility and reload export fields.
+## This allows reacting to changes of the portrait_scene setting.
+func _recheck(data:Dictionary):
+	if data.get('scene', '').is_empty() and ProjectSettings.get_setting('dialogic/portraits/default_portrait', '').is_empty():
+		hide()
+		get_parent().get_child(get_index()-1).hide()
+		get_parent().get_child(get_index()+1).hide()
+	else:
+		get_parent().get_child(get_index()-1).show()
+
+		current_portrait_data = data
+		load_portrait_scene_export_variables()
+
+
+func load_portrait_scene_export_variables():
+	var scene = null
+	if !current_portrait_data.get('scene', '').is_empty():
+		scene = load(current_portrait_data.get('scene'))
+	elif !ProjectSettings.get_setting('dialogic/portraits/default_portrait', '').is_empty():
+		scene = load(ProjectSettings.get_setting('dialogic/portraits/default_portrait', ''))
+	else:
+		scene = load(character_editor.def_portrait_path)
+
+	if !scene:
+		return
+
+	for child in $Grid.get_children():
+		child.queue_free()
+
+	scene = scene.instantiate()
+	var skip := false
+	for i in scene.script.get_script_property_list():
+		if i['usage'] & PROPERTY_USAGE_EDITOR and !skip:
+			var label = Label.new()
+			label.text = i['name'].capitalize()
+			$Grid.add_child(label)
+
+			var current_value :Variant = scene.get(i['name'])
+			if current_portrait_data.has('export_overrides') and current_portrait_data['export_overrides'].has(i['name']):
+				current_value = str_to_var(current_portrait_data.export_overrides[i['name']])
+				if current_value == null and typeof(scene.get(i['name'])) == TYPE_STRING:
+					current_value = current_portrait_data['export_overrides'][i['name']]
+
+			var input :Node = DialogicUtil.setup_script_property_edit_node(i, current_value, set_export_override)
+			input.size_flags_horizontal = SIZE_EXPAND_FILL
+			$Grid.add_child(input)
+
+		if i['usage'] & PROPERTY_USAGE_GROUP:
+			if i['name'] == 'Main':
+				skip = true
+				continue
+			else:
+				skip = false
+
+	$Label.visible = $Grid.get_child_count() == 0
+
+
+## On any change, save the export override to the portrait items metadata.
+func set_export_override(property_name:String, value:String = "") -> void:
+	var data:Dictionary = selected_item.get_metadata(0)
+	if !data.has('export_overrides'):
+		data['export_overrides'] = {}
+	if !value.is_empty():
+		data.export_overrides[property_name] = value
+	else:
+		data.export_overrides.erase(property_name)
+	changed.emit()
+	update_preview.emit()

addons/dialogic/Editor/CharacterEditor/char_edit_p_section_exports.tscn

@@ -0,0 +1,23 @@
+[gd_scene load_steps=2 format=3 uid="uid://cfcs7lb6gqnmd"]
+
+[ext_resource type="Script" path="res://addons/dialogic/Editor/CharacterEditor/char_edit_p_section_exports.gd" id="1_isys8"]
+
+[node name="Settings" type="VBoxContainer"]
+custom_minimum_size = Vector2(0, 35)
+offset_right = 367.0
+offset_bottom = 82.0
+script = ExtResource("1_isys8")
+
+[node name="Label" type="Label" parent="."]
+layout_mode = 2
+theme_type_variation = &"DialogicHintText"
+theme_override_colors/font_color = Color(0, 0, 0, 1)
+text = "There are no exported variables to override. Add @export properties to the root script of your scene and make sure it's in @tool mode."
+autowrap_mode = 3
+
+[node name="Grid" type="GridContainer" parent="."]
+layout_mode = 2
+size_flags_horizontal = 3
+size_flags_vertical = 3
+theme_override_constants/h_separation = 10
+columns = 2

addons/dialogic/Editor/CharacterEditor/char_edit_p_section_layout.gd

@@ -0,0 +1,43 @@
+@tool
+extends DialogicCharacterEditorPortraitSection
+
+## Tab that allows setting size, offset and mirror of a portrait.
+
+
+func _get_title() -> String:
+	return "Scale, Offset & Mirror"
+
+
+func _load_portrait_data(data:Dictionary) -> void:
+	%IgnoreScale.set_pressed_no_signal(data.get('ignore_char_scale', false))
+	%PortraitScale.value = data.get('scale', 1.0)*100
+	%PortraitOffset.set_value(data.get('offset', Vector2()))
+	%PortraitMirror.set_pressed_no_signal(data.get('mirror', false))
+
+
+func _on_portrait_scale_value_changed(value:float) -> void:
+	var data:Dictionary = selected_item.get_metadata(0)
+	data['scale'] = value/100.0
+	update_preview.emit()
+	changed.emit()
+
+
+func _on_portrait_mirror_toggled(button_pressed:bool)-> void:
+	var data:Dictionary = selected_item.get_metadata(0)
+	data['mirror'] = button_pressed
+	update_preview.emit()
+	changed.emit()
+
+
+func _on_ignore_scale_toggled(button_pressed:bool) -> void:
+	var data:Dictionary = selected_item.get_metadata(0)
+	data['ignore_char_scale'] = button_pressed
+	update_preview.emit()
+	changed.emit()
+
+
+func _on_portrait_offset_value_changed(property:String, value:Vector2) -> void:
+	var data:Dictionary = selected_item.get_metadata(0)
+	data['offset'] = value
+	update_preview.emit()
+	changed.emit()

addons/dialogic/Editor/CharacterEditor/char_edit_p_section_layout.tscn

@@ -0,0 +1,64 @@
+[gd_scene load_steps=3 format=3 uid="uid://crke8suvv52c6"]
+
+[ext_resource type="Script" path="res://addons/dialogic/Editor/CharacterEditor/char_edit_p_section_layout.gd" id="1_76vf2"]
+[ext_resource type="PackedScene" uid="uid://dtimnsj014cu" path="res://addons/dialogic/Editor/Events/Fields/Vector2.tscn" id="2_c8kyi"]
+
+[node name="Layout" type="HFlowContainer"]
+offset_right = 428.0
+offset_bottom = 128.0
+size_flags_horizontal = 3
+script = ExtResource("1_76vf2")
+
+[node name="Label3" type="Label" parent="."]
+layout_mode = 2
+text = "Ignore Main Scale: "
+
+[node name="IgnoreScale" type="CheckBox" parent="."]
+unique_name_in_owner = true
+layout_mode = 2
+tooltip_text = "This portrait will ignore the main scale."
+
+[node name="HBoxContainer" type="HBoxContainer" parent="."]
+layout_mode = 2
+
+[node name="Label" type="Label" parent="HBoxContainer"]
+layout_mode = 2
+text = "Scale:"
+
+[node name="PortraitScale" type="SpinBox" parent="HBoxContainer"]
+unique_name_in_owner = true
+layout_mode = 2
+tooltip_text = "A scale to be applied on top of the main scale 
+(unless ignore main scale is pressed)."
+value = 100.0
+allow_greater = true
+suffix = "%"
+
+[node name="HBoxContainer2" type="HBoxContainer" parent="."]
+layout_mode = 2
+
+[node name="Label2" type="Label" parent="HBoxContainer2"]
+layout_mode = 2
+text = "Offset:"
+
+[node name="PortraitOffset" parent="HBoxContainer2" instance=ExtResource("2_c8kyi")]
+unique_name_in_owner = true
+layout_mode = 2
+tooltip_text = "Offset that is applied on top of the main portrait offset."
+
+[node name="MirrorOption" type="HBoxContainer" parent="."]
+layout_mode = 2
+
+[node name="Label" type="Label" parent="MirrorOption"]
+layout_mode = 2
+text = "Mirror:"
+
+[node name="PortraitMirror" type="CheckBox" parent="MirrorOption"]
+unique_name_in_owner = true
+layout_mode = 2
+tooltip_text = "Mirroring that is applied on top of the main portrait mirror."
+
+[connection signal="toggled" from="IgnoreScale" to="." method="_on_ignore_scale_toggled"]
+[connection signal="value_changed" from="HBoxContainer/PortraitScale" to="." method="_on_portrait_scale_value_changed"]
+[connection signal="value_changed" from="HBoxContainer2/PortraitOffset" to="." method="_on_portrait_offset_value_changed"]
+[connection signal="toggled" from="MirrorOption/PortraitMirror" to="." method="_on_portrait_mirror_toggled"]

addons/dialogic/Editor/CharacterEditor/char_edit_p_section_main.gd

@@ -0,0 +1,35 @@
+@tool
+extends DialogicCharacterEditorPortraitSection
+
+## Tab that allows setting a custom scene for a portrait.
+
+func _get_title() -> String:
+	return "Scene"
+
+func _init():
+	hint_text = "You can use a custom scene for this portrait."
+
+func _ready() -> void:
+	%ScenePicker.file_filter = "*.tscn, *.scn; Scenes"
+	%ScenePicker.resource_icon = get_theme_icon('PackedScene', 'EditorIcons')
+	%ScenePicker.placeholder = 'Default scene'
+
+	%OpenSceneButton.icon = get_theme_icon("ExternalLink", "EditorIcons")
+
+
+func _load_portrait_data(data:Dictionary) -> void:
+	%ScenePicker.set_value(data.get('scene', ''))
+	%OpenSceneButton.visible = !data.get('scene', '').is_empty()
+
+
+func _on_scene_picker_value_changed(prop_name:String, value:String) -> void:
+	var data:Dictionary = selected_item.get_metadata(0)
+	data['scene'] = value
+	update_preview.emit()
+	changed.emit()
+	%OpenSceneButton.visible = !data.get('scene', '').is_empty()
+
+
+func _on_open_scene_button_pressed():
+	if !%ScenePicker.current_value.is_empty() and FileAccess.file_exists(%ScenePicker.current_value):
+		DialogicUtil.get_dialogic_plugin().get_editor_interface().open_scene_from_path(%ScenePicker.current_value)

addons/dialogic/Editor/CharacterEditor/char_edit_p_section_main.tscn

@@ -0,0 +1,42 @@
+[gd_scene load_steps=5 format=3 uid="uid://djq4aasoihexj"]
+
+[ext_resource type="Script" path="res://addons/dialogic/Editor/CharacterEditor/char_edit_p_section_main.gd" id="1_ht8lu"]
+[ext_resource type="PackedScene" uid="uid://7mvxuaulctcq" path="res://addons/dialogic/Editor/Events/Fields/FilePicker.tscn" id="2_k8xs0"]
+
+[sub_resource type="Image" id="Image_sbh6e"]
+data = {
+"data": PackedByteArray(255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 255, 255, 0, 255, 94, 94, 127, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 255, 255, 0, 255, 93, 93, 255, 255, 94, 94, 127, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 255, 255, 0, 255, 93, 93, 255, 255, 93, 93, 255, 255, 94, 94, 127, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 255, 255, 0, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 94, 94, 127, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 93, 93, 231, 255, 94, 94, 54, 255, 94, 94, 57, 255, 93, 93, 233, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 231, 255, 94, 94, 54, 255, 94, 94, 57, 255, 93, 93, 233, 255, 93, 93, 255, 255, 93, 93, 255, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 97, 97, 42, 255, 255, 255, 0, 255, 255, 255, 0, 255, 97, 97, 42, 255, 93, 93, 233, 255, 93, 93, 232, 255, 93, 93, 41, 255, 255, 255, 0, 255, 255, 255, 0, 255, 97, 97, 42, 255, 93, 93, 233, 255, 93, 93, 232, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 96, 96, 45, 255, 93, 93, 44, 255, 255, 255, 0, 255, 97, 97, 42, 255, 97, 97, 42, 255, 255, 255, 0, 255, 96, 96, 45, 255, 93, 93, 44, 255, 255, 255, 0, 255, 97, 97, 42, 255, 97, 97, 42, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 96, 96, 45, 255, 93, 93, 235, 255, 94, 94, 234, 255, 95, 95, 43, 255, 255, 255, 0, 255, 255, 255, 0, 255, 96, 96, 45, 255, 93, 93, 235, 255, 94, 94, 234, 255, 95, 95, 43, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 93, 93, 235, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 233, 255, 95, 95, 59, 255, 96, 96, 61, 255, 93, 93, 235, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 233, 255, 95, 95, 59, 255, 96, 96, 61, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 93, 93, 255, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0, 255, 255, 255, 0),
+"format": "RGBA8",
+"height": 16,
+"mipmaps": false,
+"width": 16
+}
+
+[sub_resource type="ImageTexture" id="ImageTexture_mbv6v"]
+image = SubResource("Image_sbh6e")
+
+[node name="Scene" type="GridContainer"]
+offset_right = 298.0
+offset_bottom = 86.0
+size_flags_horizontal = 3
+script = ExtResource("1_ht8lu")
+
+[node name="HBox" type="HBoxContainer" parent="."]
+layout_mode = 2
+size_flags_horizontal = 3
+
+[node name="ScenePicker" parent="HBox" instance=ExtResource("2_k8xs0")]
+unique_name_in_owner = true
+layout_mode = 2
+size_flags_horizontal = 3
+file_filter = "*.tscn, *.scn; Scenes"
+placeholder = "Default scene"
+resource_icon = SubResource("ImageTexture_mbv6v")
+
+[node name="OpenSceneButton" type="Button" parent="HBox"]
+unique_name_in_owner = true
+layout_mode = 2
+icon = SubResource("ImageTexture_mbv6v")
+
+[connection signal="value_changed" from="HBox/ScenePicker" to="." method="_on_scene_picker_value_changed"]
+[connection signal="pressed" from="HBox/OpenSceneButton" to="." method="_on_open_scene_button_pressed"]