Skip to content

Getting Started

Krzysiek Justyński edited this page Apr 10, 2021 · 9 revisions

Example project

In Releases, you can find an example project called Flower, so you can easily check how this plug-in works. It includes

  • Flow plugin
  • additional C++ nodes
  • simple map with a single Flow Graph - which I used to create a video presentation.

Adding Flow plugin to your own project

  1. Unpack plug-in to the Plugins folder in your project folder. If you don't have such a folder yet, simply create it.
  2. First of all, open Project Settings in the editor. Change World Settings to the Flow World Settings class and restart the editor. By default, this special class starts the Flow assigned to the map, just when starting the game. So it serves as a replacement for BeginPlay in the level blueprint.
  3. You can assign Flow Asset to the map via the Flow toolbar above the main viewport. Assigning it directly via the World Settings editor window also works.

It's important to perform Step 3 after Step 2. Otherwise, reference to the Flow Asset might be improperly saved in the map and it wouldn't work. If that happened, just try to revert your map. And assign the Flow Asset again.

Including GitHub repository to your own repository

You can include this plugin repository as a dependency of your own Git project. It can be done by using Git submodules.

git submodule add -b 4.26 https://github.com/MothCocoon/FlowGraph.git Plugins/Flow