Merge remote-tracking branch 'org/main'

Author: Jowan-Spooner

.github/FUNDING.yml

@@ -1,9 +1,9 @@
 # These are supported funding model platforms
 
-github: coppolaemilio
-patreon: coppolaemilio
+github: jowan-spooner
+patreon: jowanspooner
 open_collective: # Replace with a single Open Collective username
-ko_fi: coppolaemilio
+ko_fi: jowan_spooner
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
 community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
 liberapay: # Replace with a single Liberapay username

.github/ISSUE_TEMPLATE/bug_report.md

@@ -27,8 +27,8 @@ If applicable, add screenshots to help explain your problem.
 
 **System (please complete the following information):**
  - OS: [e.g. Windows, Linux]
- - Godot Version: [e.g. 3.2.3]
- - Dialogic Version: [e.g. 1.0]
+ - Godot Version: [e.g. 4.2.2]
+ - Dialogic Version: [e.g. 2.0 Alpha 14, please be specific!]
 
 ## Solutions
 

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,6 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Dialogic 1 Repository
+    url: https://github.com/dialogic-godot/dialogic-1/issues
+    about: Please post anything related to Dialogc 1.x (Godot 3.x) on the Dialogic 1 Repository!
+

.github/workflows/unit_test.yml

@@ -22,7 +22,7 @@ jobs:
       fail-fast: false
       matrix:
         # Insert here the Godot version you want to run your tests with.
-        godot-version: ['4.2.1']
+        godot-version: ['4.3']
 
     name: "CI Unit Test v${{ matrix.godot-version }}"
     runs-on: 'ubuntu-22.04'
@@ -31,7 +31,7 @@ jobs:
 
     steps:
       - name: "Checkout your Repository"
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           lfs: true
 
@@ -93,7 +93,7 @@ jobs:
 
       - name: "Upload Unit Test Reports"
         if: ${{ always() }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: "godot-version"
           path: |

.github/workflows/unit_test_report.yml

@@ -17,8 +17,9 @@ jobs:
 
     - name: "Publish Test Report"
       if: ${{ always() }}
-      uses: dorny/test-reporter@v1.6.0
+      uses: dorny/test-reporter@v1.9.1
       with:
+        artifact: "godot-version"
         name: "test_report"
-        path: "reports/**/results.xml"
-        reporter: java-junit
+        path: "**/reports/**/results.xml"
+        reporter: java-junit

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 - 2023 Emilio Coppola
+Copyright (c) 2020 - present Emilio Coppola
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,10 +2,18 @@
   <img width="1280" alt="cover" src="https://user-images.githubusercontent.com/2206700/189457799-6327bab0-b085-4421-8640-6a18e395d17d.png">
 </p>
 
-<h1 align="center">Dialogic</h1>
+<h1 align="center">Dialogic 2</h1>
 
 <p align="center">
-  Create dialogs, characters and scenes to display conversations in your Godot games.
+  Create <b>Dialogs</b>, <b>Visual Novels</b>, <b>RPGs</b>, and <b>manage Characters</b> with Godot to create your Game!
+</p>
+
+<p align="center">
+  <a href="https://discord.gg/DjcDgDaTMe" target="_blank" style="text-decoration:none"><img alt="Discord" src="https://img.shields.io/discord/628713677239091231?logo=discord&labelColor=CFC9C8&color=646FA9"></a>
+  <a href="https://godotengine.org/download/" target="_blank" style="text-decoration:none"><img alt="Godot v4.3+" src="https://img.shields.io/badge/Godot-v4.3+-%23478cbf?labelColor=CFC9C8&color=49A9B4" /></a>
+  <a href="https://docs.dialogic.pro/introduction.html" target="_blank" style="text-decoration:none"><img alt="Dialogic 2 Documentation" src="https://img.shields.io/badge/documention-online-green?labelColor=CFC9C8&color=6BCD69"></a>
+  <a href="https://github.com/dialogic-godot/dialogic/actions/workflows/unit_test.yml" target="_blank style="text-decoration:none"><img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/dialogic-godot/dialogic/unit_test.yml?labelColor=CFC9C8&color=DBDCB8"></a>
+  <a href="https://github.com/dialogic-godot/dialogic/releases"  target="_blank" style="text-decoration:none"><img alt="Latest Dialogic Release" src="https://img.shields.io/github/v/release/dialogic-godot/dialogic?include_prereleases&labelColor=CFC9C8&color=CBA18C"></a>
 </p>
 
 ## Table of Contents
@@ -16,36 +24,57 @@
 - [Credits](#credits)
 - [License](#license)
 
-## Version (Currently in Alpha) 
-
-Dialogic 2.0 is a major rewrite of the plugin including many compatibility-breaking changes. It is currently developed exclusively for Godot 4 and requires at least Godot 4.1.
+## Version
 
-![Godot v4.0](https://img.shields.io/badge/Godot-v4.1-%23478cbf)
+Dialogic 2 **requires at least Godot 4.3**.
 
-[If you are looking for the Godot 3.5 version you can find it here.](https://github.com/dialogic-godot/dialogic/tree/dialogic-1)
+[If you are looking for the Godot 3.x version (Dialogic 1.x) you can find it here.](https://github.com/dialogic-godot/dialogic-1)
 
 ## Installation
-Follow the installation instructions on our [Getting Started](https://dialogic-docs.coppolaemilio.com/getting-started.html#1-installation--activation) documentation.
+Follow the installation instructions on our [Getting Started](https://docs.dialogic.pro/getting-started.html#1-installation--activation) documentation.
 
 Dialogic comes with an auto-updater so you can install future versions right from within the plugin.
 
 ## Documentation
-As the plugin is still in alpha state, only limited documentation is available. However you can read all the existing documentation here:
-[Dialogic Documentation](https://dialogic-docs.coppolaemilio.com/)
+You can find the official documentation of Dialogic here: [Dialogic Documentation](https://docs.dialogic.pro/)
+
+There is a Class Reference as well: [Class Reference](https://docs.dialogic.pro/class_index.html)
+
+
+## Connect with us!
+If you need help or want to share your Dialogic projects, take a look at the following options:
+
+- Ask questions, or report bugs on our [Discord](https://discord.gg/DjcDgDaTMe)
+- Report bugs and issues on the [GitHub Issues Page](https://github.com/dialogic-godot/dialogic/issues)
+- Ask questions on [GitHub Discussions](https://github.com/dialogic-godot/dialogic/discussions)
 
 ## Testing
-Dialogic uses [Unit Tests](https://en.wikipedia.org/wiki/Unit_testing) to ensure specific parts function as expected. These tests run on every git push and pull request. The framework to do these tests is called [gdUnit4](https://github.com/MikeSchulze/gdUnit4) and our tests reside in the [addons/dialogic/Tests/Unit](https://github.com/dialogic-godot/dialogic/tree/main/addons/dialogic/Tests/Unit) path. We recommend installing the `gdUnit4` add-on from the `AssetLib`, with this add-on, you can run tests locally.
+Dialogic uses [Unit Tests](https://en.wikipedia.org/wiki/Unit_testing) to ensure specific parts function as expected. These tests run on every git push and pull request. The framework to do these tests is called [gdUnit4](https://github.com/MikeSchulze/gdUnit4) and our tests reside in the [/Tests/Unit](https://github.com/dialogic-godot/dialogic/tree/main/Tests/Unit) path. We recommend installing the `gdUnit4` add-on from the `AssetLib`, with this add-on, you can run tests locally.
 
 To get started, take a look at the existing files in the path and read the documentation to [create your first test](https://mikeschulze.github.io/gdUnit4/first_steps/firstTest/).
 
+## Interacting with the Source Code
+All methods and variables in the Dialogic 2 source **code prefixed with an underscore (`_`)** are considered *private*, for instance: `_remove_character()`.
+
+While you can use them, they may change in their behavior or change their signature, causing breakage in your code while moving between versions.
+Most private methods are used inside public ones; if you need help, check the documentation.
+
+**Public methods and variables can be found in our [Class Reference](https://docs.dialogic.pro/class_index.html).**
+
+During the Alpha and Beta version stages, code may change at any Dialogic Release to allow drafting a better design.
+Changelogs will accommodate for these changes and inform you on how to update your code.
+
+
 ## Credits
-Made by [Emilio Coppola](https://github.com/coppolaemilio) and [Jowan-Spooner](https://github.com/Jowan-Spooner).
+Made by [Jowan-Spooner](https://github.com/Jowan-Spooner) and [Emilio Coppola](https://github.com/coppolaemilio).
 
-Contributors: [zaknafean](https://github.com/zaknafean), [thebardsrc](https://github.com/thebardsrc), [and more!](https://github.com/dialogic-godot/dialogic/graphs/contributors).
+Contributors: [CakeVR](https://github.com/CakeVR), [Exelia](https://github.com/exelia-antonov), [zaknafean](https://github.com/zaknafean), [and more!](https://github.com/dialogic-godot/dialogic/graphs/contributors).
 
 Special thanks: [Arnaud](https://github.com/arnaudvergnet), [AnidemDex](https://github.com/AnidemDex), [ellogwen](https://github.com/ellogwen), [Tim Krief](https://github.com/timkrief), [Toen](https://twitter.com/ToenAndreMC), Òscar, [Francisco Presencia](https://francisco.io/), [M7mdKady14](https://github.com/M7mdKady14).
 
-### Thank you to all my [Patreons](https://www.patreon.com/coppolaemilio) and Github sponsors for making this possible!
+### Thank you to all my [Patreons](https://www.patreon.com/jowanspooner) and Github sponsors for making this possible!
 
 ## License
 This project is licensed under the terms of the [MIT license](https://github.com/dialogic-godot/dialogic/blob/main/LICENSE).
+
+Dialogic may use the [Roboto font](https://fonts.google.com/specimen/Roboto), licensed under [Apache license, Version 2.0](https://github.com/dialogic-godot/dialogic/tree/main/addons/dialogic/Example%20Assets/Fonts/LICENSE.txt).

Tests/Resources/unit_test_character.dch

@@ -0,0 +1,19 @@
+{
+"@path": "res://addons/dialogic/Resources/character.gd",
+"@subpath": NodePath(""),
+"_translation_id": "",
+"color": Color(1, 1, 1, 1),
+"custom_info": {
+"sound_mood_default": "",
+"sound_moods": {},
+"style": ""
+},
+"default_portrait": "",
+"description": "",
+"display_name": "unit_test_character",
+"mirror": false,
+"nicknames": [""],
+"offset": Vector2(0, 0),
+"portraits": {},
+"scale": 1.0
+}

Tests/Resources/unit_test_character.dch.uid

@@ -0,0 +1 @@
+uid://ciqdfnu6b3se

Tests/Unit/glossary_resource_test.gd

@@ -6,7 +6,7 @@ const NAME_ENTRY := "Example Name"
 const EXAMPLE_TITLE := "Example Title"
 const ALTERNATIVE_ENTRIES := ["A", "BE", "VERY LONG ENTRY"]
 
-const SAMPLE_ENTRY := {
+var SAMPLE_ENTRY := {
 	DialogicGlossary.TITLE_PROPERTY: EXAMPLE_TITLE,
 	DialogicGlossary.NAME_PROPERTY: NAME_ENTRY,
 	DialogicGlossary.ALTERNATIVE_PROPERTY: ALTERNATIVE_ENTRIES
@@ -18,7 +18,7 @@ const SAMPLE_ENTRY := {
 func test_add_entry() -> void:
 	var glossary: DialogicGlossary = DialogicGlossary.new()
 
-	assert(glossary.try_add_entry(SAMPLE_ENTRY), "Unable to add entry.")
+	assert(glossary.try_add_entry(SAMPLE_ENTRY.duplicate()), "Unable to add entry.")
 
 	const NAME_COUNTER := 1
 	var total_entry_count := ALTERNATIVE_ENTRIES.size() + NAME_COUNTER
@@ -36,7 +36,7 @@ func test_add_entry() -> void:
 func test_replace_entries() -> void:
 	var glossary: DialogicGlossary = DialogicGlossary.new()
 
-	assert(glossary.try_add_entry(SAMPLE_ENTRY), "Unable to add entry.")
+	assert(glossary.try_add_entry(SAMPLE_ENTRY.duplicate()), "Unable to add entry.")
 
 	const NEW_NAME := "NEW NAME"
 
@@ -55,7 +55,7 @@ func test_replace_entries() -> void:
 func test_remove_entry() -> void:
 	var glossary: DialogicGlossary = DialogicGlossary.new()
 
-	assert(glossary.try_add_entry(SAMPLE_ENTRY), "Unable to add entry.")
+	assert(glossary.try_add_entry(SAMPLE_ENTRY.duplicate()), "Unable to add entry.")
 
 	const NAME_COUNTER := 1
 	var total_entry_count := ALTERNATIVE_ENTRIES.size() + NAME_COUNTER
@@ -72,5 +72,5 @@ func test_remove_entry() -> void:
 func test_add_duplicates() -> void:
 	var glossary: DialogicGlossary = DialogicGlossary.new()
 
-	assert(glossary.try_add_entry(SAMPLE_ENTRY), "Unable to add entry.")
-	assert(not glossary.try_add_entry(SAMPLE_ENTRY), "Entry should not have been added.")
+	assert(glossary.try_add_entry(SAMPLE_ENTRY.duplicate()), "Unable to add entry.")
+	assert(not glossary.try_add_entry(SAMPLE_ENTRY.duplicate()), "Entry should not have been added.")