From 65e6126bd63f3a769268ed62e153a3bcd5acdbaa Mon Sep 17 00:00:00 2001 From: Michael Adaixo Date: Sun, 9 Jun 2024 23:44:25 +0100 Subject: [PATCH] tutorials --- src/content/docs/guides/UsingFlowPilot.md | 13 +++++++++++++ src/content/docs/guides/YourFirstFlowPilotAsset.md | 14 ++++++++++++++ src/content/docs/guides/example copy.md | 11 ----------- src/content/docs/guides/example.md | 11 ----------- 4 files changed, 27 insertions(+), 22 deletions(-) create mode 100644 src/content/docs/guides/UsingFlowPilot.md create mode 100644 src/content/docs/guides/YourFirstFlowPilotAsset.md delete mode 100644 src/content/docs/guides/example copy.md delete mode 100644 src/content/docs/guides/example.md diff --git a/src/content/docs/guides/UsingFlowPilot.md b/src/content/docs/guides/UsingFlowPilot.md new file mode 100644 index 0000000..f703bc5 --- /dev/null +++ b/src/content/docs/guides/UsingFlowPilot.md @@ -0,0 +1,13 @@ +--- +title: Using FlowPilot +description: Guide on how to use FlowPilot +--- + +To use FlowPilot: + +1. Add `FlowPilotComponent` to any Actor you'd like. This can be a level actor or blueprint. (You control its lifetime) +2. Add a FlowPilot Asset reference. +3. Select Execution mode for the FlowPilot +4. Tick if you wish FlowPilot starts on Begin Play + - In case you don't, you can manually call `StartFlow` from the `FlowPilotComponent`. See more on the reference page. +4. Run the game \ No newline at end of file diff --git a/src/content/docs/guides/YourFirstFlowPilotAsset.md b/src/content/docs/guides/YourFirstFlowPilotAsset.md new file mode 100644 index 0000000..da1ca59 --- /dev/null +++ b/src/content/docs/guides/YourFirstFlowPilotAsset.md @@ -0,0 +1,14 @@ +--- +title: Your first FlowPilot Asset +description: Introductory guide to setup your first FlowPilot Asset +--- + +To create a FlowPilot Asset: +1. Open your Content Browser +![image](https://github.com/Mikea15/UEFlowPilot/assets/1379861/cc776893-ee83-43d5-b862-17b6205d99a7) +2. Right Click to Open the Create New Object Menu and Select *Data Asset* from the *Miscellaneous* menu +![image](https://github.com/Mikea15/UEFlowPilot/assets/1379861/f0f8b11e-2686-425a-8384-704bf9460a6a) +3. Done. + +You can now open this asset and edit it with the editor. +You can now reference this asset in a `FlowPilotComponent` diff --git a/src/content/docs/guides/example copy.md b/src/content/docs/guides/example copy.md deleted file mode 100644 index 13e06fc..0000000 --- a/src/content/docs/guides/example copy.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Example Guide 2 -description: A guide in my new Starlight docs site. ---- - -Guides lead a user through a specific task they want to accomplish, often with a sequence of steps. -Writing a good guide requires thinking about what your users are trying to do. - -## Further reading - -- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework diff --git a/src/content/docs/guides/example.md b/src/content/docs/guides/example.md deleted file mode 100644 index ebd0f3b..0000000 --- a/src/content/docs/guides/example.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Example Guide -description: A guide in my new Starlight docs site. ---- - -Guides lead a user through a specific task they want to accomplish, often with a sequence of steps. -Writing a good guide requires thinking about what your users are trying to do. - -## Further reading - -- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework