Add store and settings docs

Author: jonnydgreen

addons/parley/utils/parley_util.gd

@@ -49,7 +49,7 @@ class log:
 
 class resource:
 	static func get_uid(resource: Resource) -> String:
-		if not resource.resource_path:
+		if not resource or not resource.resource_path:
 			ParleyUtils.log.warn("Unable to get UID for Resource (resource: %s): resource_path is not defined. Returning empty string." % [resource])
 			return ""
 		var id: int = ResourceLoader.get_resource_uid(resource.resource_path)

docs/latest/getting-started/register-action.md

@@ -54,8 +54,8 @@ func execute(_ctx: Dictionary, values: Array) -> int:
 > to the relevant resource for editing. You can also add resources using the
 > resource editor dropdown field instead of dragging.
 
-7. You should now see that the Action is available in the Action node dropdown
-   options. Select `Advance Time` in the options to associate it with the
-   selected Action Node.
+7. You should now see that the Action is available in the Action dropdown
+   options in the Action node editor. Select `Advance Time` in the options to
+   associate it with the selected Action Node.
 8. Test out your new Action within the Dialogue Sequence by clicking the Test
    Dialogue Sequence from start button.

docs/latest/getting-started/register-character.md

@@ -1,6 +1,6 @@
 ---
 description: |
-	Register a Character
+   Register a Character
 ---
 
 As the name suggests, Characters are resources in Parley used to define

docs/latest/getting-started/register-fact.md

@@ -21,73 +21,61 @@ in the corresponding
 - You have created a basic Dialogue Sequence before. Consult the
   [getting started guide](./create-dialogue-sequence.md) for more info.
 
-<!-- TODO: update when Parley supports creation of Fact -->
-
 ## Instructions
 
 > **Note:** it is assumed that the default Parley settings are used for the fact
 > store and it is stored at: `res://facts/fact_store_main.tres`
 
-- Create a Fact script (ensure that it extends the `FactInterface` class) at:
-  `res://facts/alice_gave_coffee_fact.gd`
+1. Create a Fact script (ensure that it extends the `FactInterface` class) at:
+   `res://facts/alice_gave_coffee_fact.gd`
 
 ```gdscript
 extends FactInterface
 
-func execute(_ctx: Dictionary, _values: Array) -> bool:
-	print('Alice did indeed give coffee')
-  # Note, you can return any value here, it doesn't
-  # necessarily have to be a bool
+func execute(ctx: Dictionary, _values: Array) -> bool:
+	print('Did Alice give coffee?')
+	# Note, you can return any value here, it doesn't
+	# necessarily have to be a bool
 	return true
 ```
 
-- [OPTIONAL] If the return type of your fact, is **not** of type `bool`, it is
-  recommended to return well-known values of the fact (for example, when using a
-  [Match Node](../nodes/match-node.md)). For example:
+2. [OPTIONAL] If the return type of your fact, is **not** of type `bool`, it is
+   recommended to return well-known values of the fact (for example, when using
+   a [Match Node](../nodes/match-node.md)). For example:
 
 ```gdscript
 extends FactInterface
 
-enum Ball {
-	RED = 1,
-	YELLOW = 2,
-	PINK = 6,
-	BLUE = 5,
+enum DifficultyLevel {
+	EASY,
+	NORMAL,
+	HARD,
 }
 
 func execute(ctx: Dictionary, _values: Array) -> int:
-	return ctx.get('ball', 0)
+	return ctx.get('difficulty_level', DifficultyLevel.NORMAL)
 
-func available_values() -> Array[Ball]:
+func available_values() -> Array[DifficultyLevel]:
 	return [
-		Ball.RED,
-		Ball.YELLOW,
-		Ball.PINK,
-		Ball.BLUE,
+		DifficultyLevel.EASY,
+		DifficultyLevel.NORMAL,
+		DifficultyLevel.HARD,
 	]
 ```
 
-- Open up the inspector for `res://facts/fact_store_main.tres` in the Godot
-  Editor and click `Add Element`:
-
-![Add Element](../../../www/static/docs/register-fact/add-element.png)
-
-- Then, click the empty element and choose `New Fact`:
-
-![Click Empty Element](../../../www/static/docs/register-fact/click-empty-element.png)
-
-- Now populate the fact ID by using the same element ID (recommended but not
-  essential) and choose a sensible name for the Fact in the store:
-
-![Populate basic fact data](../../../www/static/docs/register-fact/populate-basic-fact-data.png)
-
-- Then, drag the fact script created earlier to the `<empty>` ref field:
-
-![Drag Fact Script](../../../www/static/docs/register-fact/drag-fact-script.png)
-
-<!-- TODO: change/remove this when supported Parley -->
-
-- Finally, reload the Godot project and the new fact should be available to use
-  in Parley!
-
-![Reload Godot Editor](../../../www/static/docs/register-fact/reload-godot-editor.png)
+3. Open up the `ParleyStores` dock in the Godot Editor and open the `Fact` tab.
+4. Click `Add Fact`.
+5. Give your new fact an ID. In our example, we use: `main:alice_gave_coffee`.
+6. Give your new fact a name. In our example, we use: `Alice gave coffee`.
+7. Link your created fact script with the Fact using the resource inspector
+   (labelled `Ref`).
+
+> [tip]: You can use the resource editors in `ParleyStores` to quickly navigate
+> to the relevant resource for editing. You can also add resources using the
+> resource editor dropdown field instead of dragging.
+
+8. You should now see that the Fact is available in the Fact dropdown options in
+   the Condition node editor. Select `Alice gave coffee` in the options to
+   associate it with the selected Condition node.
+9. Test out your new Fact within the Dialogue Sequence by clicking the Test
+   Dialogue Sequence from start button.

docs/latest/reference/parley-settings.md

@@ -3,4 +3,61 @@ description: |
   Parley settings
 ---
 
-Parley settings: TODO.
+Parley supports the following settings should you want to tweak some of the
+default behaviours.
+
+To access all the Parley settings, open up the Godot settings: `Project` ->
+`Project Settings` and filter by: `parley`:
+
+![parley-settings](../../../www/static/docs/reference/parley-settings.png)
+
+## Action Store Path
+
+This defines the path to the Action Store resource that is used to store
+actions. The resource extend resource type: `ParleyActionStore`.
+
+> [warn]: This path must be valid in order for Parley to function properly.
+
+Setting path: `parley/stores/action_store_path`
+
+Default: `res://actions/action_store.tres`
+
+## Fact Store Path
+
+This defines the path to the Fact Store resource that is used to store facts.
+The resource extend resource type: `ParleyFactStore`.
+
+> [warn]: This path must be valid in order for Parley to function properly.
+
+Setting path: `parley/stores/fact_store_path`
+
+Default: `res://facts/fact_store.tres`
+
+## Character Store Path
+
+This defines the path to the Character Store resource that is used to store
+characters. The resource extend resource type: `ParleyCharacterStore`.
+
+> [warn]: This path must be valid in order for Parley to function properly.
+
+Setting path: `parley/stores/character_store_path`
+
+Default: `res://characters/character_store.tres`
+
+## Dialogue Balloon Path
+
+This defines the path to the default Dialogue balloon that is used to render the
+dialogue when testing Dialogue Sequences.
+
+Setting path: `parley/dialogue/dialogue_balloon_path`
+
+Default: `res://addons/parley/components/default_balloon.tscn`
+
+## Test Scene Path
+
+This defines the path to the default test scene that is rendered when testing
+Dialogue Sequences.
+
+Setting path: `parley/test_dialogue_sequence/test_scene_path`
+
+Default: `res://addons/parley/views/test_dialogue_sequence_scene.tscn`

examples/create-condition-basic.ds

@@ -0,0 +1,94 @@
+{
+  "title": "",
+  "nodes": [
+    {
+      "id": "node:1",
+      "type": "START",
+      "position": "(620.0, 440.0)"
+    },
+    {
+      "id": "node:2",
+      "type": "END",
+      "position": "(1940.0, 500.0)"
+    },
+    {
+      "id": "node:3",
+      "type": "DIALOGUE",
+      "position": "(1400.0, 680.0)",
+      "character": "uid://ceouii84qmu0w::bob",
+      "text": "Where's my coffee??"
+    },
+    {
+      "id": "node:4",
+      "type": "DIALOGUE",
+      "position": "(1400.0, 200.0)",
+      "character": "uid://ceouii84qmu0w::bob",
+      "text": "Thanks for the coffee!"
+    },
+    {
+      "id": "node:5",
+      "type": "CONDITION",
+      "position": "(900.0, 400.0)",
+      "description": "Did Alice give coffee",
+      "combiner": "ALL",
+      "conditions": [
+        {
+          "fact_ref": "uid://cpwr6bc02ec7a",
+          "operator": 0,
+          "value": "true"
+        }
+      ]
+    }
+  ],
+  "edges": [
+    {
+      "id": "edge:1",
+      "from_node": "node:1",
+      "from_slot": 0,
+      "to_node": "node:5",
+      "to_slot": 0,
+      "should_override_colour": false,
+      "colour_override": "(0.4118, 0.4118, 0.4118, 1.0)"
+    },
+    {
+      "id": "edge:2",
+      "from_node": "node:5",
+      "from_slot": 0,
+      "to_node": "node:4",
+      "to_slot": 0,
+      "should_override_colour": false,
+      "colour_override": "(0.4118, 0.4118, 0.4118, 1.0)"
+    },
+    {
+      "id": "edge:3",
+      "from_node": "node:5",
+      "from_slot": 1,
+      "to_node": "node:3",
+      "to_slot": 0,
+      "should_override_colour": false,
+      "colour_override": "(0.4118, 0.4118, 0.4118, 1.0)"
+    },
+    {
+      "id": "edge:4",
+      "from_node": "node:4",
+      "from_slot": 0,
+      "to_node": "node:2",
+      "to_slot": 0,
+      "should_override_colour": false,
+      "colour_override": "(0.4118, 0.4118, 0.4118, 1.0)"
+    },
+    {
+      "id": "edge:5",
+      "from_node": "node:3",
+      "from_slot": 0,
+      "to_node": "node:2",
+      "to_slot": 0,
+      "should_override_colour": false,
+      "colour_override": "(0.4118, 0.4118, 0.4118, 1.0)"
+    }
+  ],
+  "stores": {
+    "character": [],
+    "fact": []
+  }
+}

examples/create-condition-basic.ds.import

@@ -0,0 +1,14 @@
+[remap]
+
+importer="parley_dialogue_ast_compiler_0.2.0"
+type="Resource"
+uid="uid://dlcr5lltkb0nr"
+path="res://.godot/imported/create-condition-basic.ds-94c6607bd22704d7fc2e128789bcd3b8.tres"
+
+[deps]
+
+source_file="res://examples/create-condition-basic.ds"
+dest_files=["res://.godot/imported/create-condition-basic.ds-94c6607bd22704d7fc2e128789bcd3b8.tres"]
+
+[params]
+