chore(release): 2.6.0 [skip ci]

# [2.6.0](v2.5.0...v2.6.0) (2022-09-20)

### Bug Fixes

* **spellcheck:** fixed a text spacing issue ([572ef1d](572ef1d)), closes [#29](#29)

### Features

* dialogue nodes now include an audio file ([2a5b341](2a5b341))

Assets/com.fluid.dialogue/LICENSE.md

@@ -1 +1,21 @@
-Edit LICENSE.md in root, contents will be replaced.
+MIT License
+
+Copyright (c) 2019 Ash Blue
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Assets/com.fluid.dialogue/README.md

@@ -1 +1,191 @@
-Edit README.md in root, contents will be replaced.
+# Fluid Dialogue
+
+A Unity dialogue system that features an easy to use drag and drop graph. ScriptableObject driven with the ability to write custom actions and conditions to create complex dialogue workflows.
+
+* **Visual graph** editor
+* Ability to create custom **actions** that execute as dialogue progresses
+* Create custom **conditions** to determine how dialogue branches
+* Built in **local database** to set and check variables for branching
+* Allows you to **bring your own UI** or use a starter example (event driven dialogue presentation)
+* Includes a simple [spell check](https://github.com/ashblue/unity-simple-spellcheck) tool that evaluates all dialogue nodes
+
+![](docs/example-dialogue.png)
+
+**Support**
+
+Join the [Discord Community](https://discord.gg/8QHFfzn) if you have questions or need help.
+
+See upcoming features and development progress on the [Trello Board](https://trello.com/b/wMrsWyxn/fluid-dialogue).
+
+## Getting Started
+
+First you'll need to [install](#installation) the package with Unity Package Manager. After that you can create a database as follows.
+
+1. Right click on the project window
+1. Create -> Fluid -> Dialogue -> Graph
+1. Click "Edit Dialogue" to customize your graph
+
+To create a custom UI to display your graph, you'll need to handle a series of events emitted by the dialogue controller. You can find a full example of this in the [Examples](#examples) folder. 
+
+### Node Types
+
+There are a few different node types. Each with a specific focus in mind.
+
+* Dialogue: Choices and text from a specific actor
+* Hub: Used to route dialogue logic without triggering any dialogue or choices
+* Choice Hub: Used to trigger a set of choices multiple times
+
+### Actors
+
+Every dialogue should have an actor assigned to it. Actors can be created with the following steps.
+
+1. Right click on the project window
+1. Create -> Fluid -> Dialogue -> Actor
+
+### Actions
+
+Actions can be added after selecting a node. They can be triggered before a node activates (enter actions) or after a node is complete (exit actions). Note that actions can activate with a delay.
+
+### Conditions
+
+Conditions are just like actions. Except if any of them return false the node will be skipped at runtime until it's evaluated again.
+
+### Local Variables
+
+To create a local variable and use it do the following.
+
+1. Right click on the project window
+1. Create -> Fluid -> Database -> Choose a variable type
+
+To use the variable simply select a node on the graph. Then click the plus sign on a condition (variable checks) or action (change variable value) in the inspector. Please note you must assign the variable you just created to use it.
+
+### Global Variables
+
+Globals are mostly the same as local variables. The difference is these will be saved to a global database that persists after the conversation is over and can be referenced across multiple conversations.
+
+The GlobalDatabaseManager will be marked DoNotDestroyOnLoad to persist between scene loads. If you want to save it and write the contents to a file run `Save()` to return a string. You can then restore the database simply by calling `Load(returned save string)`.
+
+### Examples
+
+To see the entire Fluid Dialogue workflow, it's highly recommended that you download this repo and run projects in the `Assets/Examples` folder.
+
+## Installation
+
+Fluid Dialogue is used through [Unity's Package Manager](https://docs.unity3d.com/Manual/CustomPackages.html). In order to use it you'll need to add the following lines to your `Packages/manifest.json` file. After that you'll be able to visually control what specific version of Fluid Dialogue you're using from the package manager window in Unity. This has to be done so your Unity editor can connect to NPM's package registry.
+
+```json
+{
+  "scopedRegistries": [
+    {
+      "name": "NPM",
+      "url": "https://registry.npmjs.org",
+      "scopes": [
+        "com.fluid"
+      ]
+    }
+  ],
+  "dependencies": {
+    "com.fluid.dialogue": "1.0.0"
+  }
+}
+```
+
+## APIs
+
+The following APIs are available for customizing your dialogue experience.
+
+### Custom Actions
+
+You can create your own custom actions for the dialogue tree with the following API syntax.
+
+```c#
+using CleverCrow.Fluid.Dialogues.Actions;
+using CleverCrow.Fluid.Dialogues;
+
+[CreateMenu("Custom/My Action")]
+public class CustomAction : ActionDataBase {
+    public override void OnInit (IDialogueController dialogue) {
+        // Run the first time the action is triggered
+    }
+
+    public override void OnStart () {
+        // Runs when the action begins triggering
+    }
+
+    public override ActionStatus OnUpdate () {
+        // Runs when the action begins triggering
+
+        // Return continue to span multiple frames
+        return ActionStatus.Success;
+    }
+
+    public override void OnExit () {
+        // Runs when the actions `OnUpdate()` returns `ActionStatus.Success`
+    }
+
+    public override void OnReset () {
+        // Runs after a node has fully run through the start, update, and exit cycle
+    }
+}
+```
+
+### Custom Conditions
+
+Custom conditions can be crafted with the following API.
+
+```c#
+using CleverCrow.Fluid.Dialogues;
+using CleverCrow.Fluid.Dialogues.Conditions;
+using CleverCrow.Fluid.Dialogues.Nodes;
+
+public class CustomCondition : ConditionDataBase {
+    public override void OnInit (IDialogueController dialogue) {
+        // Triggered on first time setup
+    }
+
+    public override bool OnGetIsValid (INode parent) {
+        // Place node condition logic here
+        return true;
+    }
+}
+```
+
+## Releases
+
+Archives of specific versions and release notes are available on the [releases page](https://github.com/ashblue/fluid-dialogue/releases).
+
+## Nightly Builds
+
+To access nightly builds of the `develop` branch that are package manager friendly, you'll need to manually edit your `Packages/manifest.json` as so. 
+
+```json
+{
+    "dependencies": {
+      "com.fluid.dialogue": "https://github.com/ashblue/fluid-dialogue.git#nightly"
+    }
+}
+```
+
+Note that to get a newer nightly build you must delete this line and any related lock data in the manifest, let Unity rebuild, then add it back. As Unity locks the commit hash for Git urls as packages.
+
+## Development Environment
+
+If you wish to run to run the development environment you'll need to install the latest [node.js](https://nodejs.org/en/). Then run the following from the root once.
+
+`npm install`
+
+If you wish to create a build run `npm run build` from the root and it will populate the `dist` folder.
+
+### Making Commits
+
+All commits should be made using [Commitizen](https://github.com/commitizen/cz-cli) (which is automatically installed when running `npm install`). Commits are automatically compiled to version numbers on release so this is very important. PRs that don't have Commitizen based commits will be rejected.
+
+To make a commit type the following into a terminal from the root
+
+```bash
+npm run commit
+```
+
+---
+
+This project was generated with [Oyster Package Generator](https://github.com/ashblue/oyster-package-generator).

Assets/com.fluid.dialogue/package.json

@@ -1,13 +1,32 @@
 {
-    "name": "com.fluid.dialogue",
-    "version": "0.0.0",
-    "displayName": "Fluid Dialogue",
-    "description": "A Unity dialogue system that features an easy to use drag and drop graph. ScriptableObject driven with the ability to write custom actions and conditions to create complex dialogue workflows.",
-    "unity": "2019.1",
-    "dependencies": {
-        "com.fluid.database": "2.1.0",
-        "com.fluid.unity-event-plus": "1.2.0",
-        "com.fluid.simple-spellcheck": "1.1.1",
-        "com.fluid.find-and-replace": "1.0.1"
-    }
+  "name": "com.fluid.dialogue",
+  "version": "2.6.0",
+  "displayName": "Fluid Dialogue",
+  "description": "A Unity dialogue system that features an easy to use drag and drop graph. ScriptableObject driven with the ability to write custom actions and conditions to create complex dialogue workflows.",
+  "unity": "2019.1",
+  "dependencies": {
+    "com.fluid.database": "2.1.0",
+    "com.fluid.unity-event-plus": "1.2.0",
+    "com.fluid.simple-spellcheck": "1.1.1",
+    "com.fluid.find-and-replace": "1.0.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ashblue/fluid-dialogue.git"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/ashblue/fluid-dialogue/issues"
+  },
+  "homepage": "https://github.com/ashblue/fluid-dialogue#readme",
+  "keywords": [
+    "unity",
+    "dialogue",
+    "dialogue system"
+  ],
+  "author": {
+    "name": "Ash Blue",
+    "email": "[email protected]",
+    "url": "http://blueashes.com"
+  }
 }

CHANGELOG.md

@@ -0,0 +1,11 @@
+# [2.6.0](https://github.com/ashblue/fluid-dialogue/compare/v2.5.0...v2.6.0) (2022-09-20)
+
+
+### Bug Fixes
+
+* **spellcheck:** fixed a text spacing issue ([572ef1d](https://github.com/ashblue/fluid-dialogue/commit/572ef1dfa9be9b1de53b7427c8e6cedbf2426992)), closes [#29](https://github.com/ashblue/fluid-dialogue/issues/29)
+
+
+### Features
+
+* dialogue nodes now include an audio file ([2a5b341](https://github.com/ashblue/fluid-dialogue/commit/2a5b34102a913d0c211e0d1977ae1ff84724380d))

package.json

@@ -1,6 +1,6 @@
 {
   "name": "com.fluid.dialogue",
-  "version": "0.0.0",
+  "version": "2.6.0",
   "unity": "2019.1",
   "displayName": "Fluid Dialogue",
   "description": "A Unity dialogue system that features an easy to use drag and drop graph. ScriptableObject driven with the ability to write custom actions and conditions to create complex dialogue workflows.",
@@ -11,10 +11,10 @@
     "commit": "git-cz"
   },
   "keywords": [
-  "unity",
-  "dialogue",
-  "dialogue system"
-],
+    "unity",
+    "dialogue",
+    "dialogue system"
+  ],
   "husky": {
     "hooks": {
       "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"