Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #20

Closed
wants to merge 2 commits into from
Closed

Update README.md #20

wants to merge 2 commits into from

Conversation

bosaku
Copy link

@bosaku bosaku commented May 3, 2021

docs: MESSAGE HERE on line #97 - 108

docs: MESSAGE HERE on line #97 - 108
@ashblue
Copy link
Owner

ashblue commented Aug 16, 2021

This is a great idea. I'll try to fix this up a bit so it encompasses a basic usage example.

Copy link
Owner

@ashblue ashblue left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry this got buried in here. I love the example. Added a few quick suggestions that should just require a click to make this merge ready.

### Initializing a Dialogue

You can initialize a dialogue using the .Play method, as show in the following script :
https://github.com/ashblue/fluid-dialogue/blob/develop/Assets/Examples/BasicConversation/Scripts/ExampleDialoguePlayback.cs#L56
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line numbers change so let's remove that, but linking to the file is a great idea.

Suggested change
https://github.com/ashblue/fluid-dialogue/blob/develop/Assets/Examples/BasicConversation/Scripts/ExampleDialoguePlayback.cs#L56
https://github.com/ashblue/fluid-dialogue/blob/develop/Assets/Examples/BasicConversation/Scripts/ExampleDialoguePlayback.cs

https://github.com/ashblue/fluid-dialogue/blob/develop/Assets/Examples/BasicConversation/Scripts/ExampleDialoguePlayback.cs#L56

```
private void Awake () {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding in all the logic to run this to minimize the amount of digging necessary to run it.

Suggested change
private void Awake () {
using System.Collections;
using System.Linq;
using CleverCrow.Fluid.Databases;
using CleverCrow.Fluid.Dialogues.Graphs;
using UnityEngine;
public class ExampleDialoguePlayback : MonoBehaviour {
private DialogueController _ctrl;
public DialogueGraph dialogue;
public GameObjectOverride[] gameObjectOverrides;
private void Awake () {

Comment on lines +104 to +107
var database = new DatabaseInstanceExtended();
_ctrl = new DialogueController(database);
_ctrl.Play(dialogue, gameObjectOverrides.ToArray<IGameObjectOverride>());
}
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Indentation fix.

Suggested change
var database = new DatabaseInstanceExtended();
_ctrl = new DialogueController(database);
_ctrl.Play(dialogue, gameObjectOverrides.ToArray<IGameObjectOverride>());
}
var database = new DatabaseInstanceExtended();
_ctrl = new DialogueController(database);
_ctrl.Play(dialogue, gameObjectOverrides.ToArray<IGameObjectOverride>());
}

@ashblue
Copy link
Owner

ashblue commented Jan 24, 2023

Also looks like the commit message needs to be reformatted as docs: Update Readme.md. It won't compile without a proper commit message the system can read (used to determine version compiling).

@ashblue
Copy link
Owner

ashblue commented Jan 27, 2023

@all-contributors please add @bosaku for documentation

1 similar comment
@ashblue
Copy link
Owner

ashblue commented Jan 27, 2023

@all-contributors please add @bosaku for documentation

@allcontributors
Copy link
Contributor

@ashblue

I've put up a pull request to add @bosaku! 🎉

@ashblue
Copy link
Owner

ashblue commented Jan 27, 2023

Closing in favor of #37

@ashblue ashblue closed this Jan 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants